mirror of
https://github.com/hasura/graphql-engine.git
synced 2024-12-15 17:31:56 +03:00
12c3eddef7
This PR proposes some changes to the hspec testsuite: * It amends the framework to make it easier to test from the ghci REPL * It introduces a new module `Fixture`, distinguished from `Context` by: * using a new concept of `SetupAction`s which bundle setup and teardown actions into one abstraction, making test system state setup more concise, modularized and safe (because the fixture know knows about the ordering of setup actions and can do partial rollbacks) * somewhat opinionated, elides the `Options` of `Context`, preferring instead that tests that care about stringification of json numbers manage that themselves. (Note that this PR builds on #4390, so contains some spurious commits which will become irrelevant once that PR is merged) PR-URL: https://github.com/hasura/graphql-engine-mono/pull/4630 GitOrigin-RevId: 619c8d985aed0aa42de31d6f16891d0782f4b4b5
52 lines
1.5 KiB
Haskell
52 lines
1.5 KiB
Haskell
-- | TestEnvironment shared by tests. We intentionally use an abstract type to
|
|
-- wrap up the values we need for tests, with accessors. This way, the
|
|
-- tests are less liable to refactorings when we add or change the
|
|
-- testEnvironment.
|
|
module Harness.TestEnvironment
|
|
( TestEnvironment (..),
|
|
Server (..),
|
|
getServer,
|
|
serverUrl,
|
|
stopServer,
|
|
)
|
|
where
|
|
|
|
import Control.Concurrent (ThreadId, killThread)
|
|
import Data.Word
|
|
import Hasura.Prelude
|
|
|
|
-- | A testEnvironment that's passed to all tests.
|
|
data TestEnvironment = TestEnvironment
|
|
{ server :: Server
|
|
}
|
|
|
|
instance Show TestEnvironment where
|
|
show TestEnvironment {server} = "<TestEnvironment: " ++ urlPrefix server ++ ":" ++ show (port server) ++ " >"
|
|
|
|
-- | Information about a server that we're working with.
|
|
data Server = Server
|
|
{ -- | The port to connect on.
|
|
port :: Word16,
|
|
-- | The full URI prefix e.g. http://localhost
|
|
urlPrefix :: String,
|
|
-- | The thread that the server is running on, so we can stop it later.
|
|
threadId :: ThreadId
|
|
}
|
|
|
|
-- | Retrieve the 'Server' associated with some 'TestEnvironment'.
|
|
getServer :: TestEnvironment -> Server
|
|
getServer TestEnvironment {server} = server
|
|
|
|
-- | Extracts the full URL prefix and port number from a given 'Server'.
|
|
--
|
|
-- @
|
|
-- > serverUrl (Server 8080 "http://localhost" someThreadId)
|
|
-- "http://localhost:8080"
|
|
-- @
|
|
serverUrl :: Server -> String
|
|
serverUrl Server {urlPrefix, port} = urlPrefix ++ ":" ++ show port
|
|
|
|
-- | Forcibly stop a given 'Server'.
|
|
stopServer :: Server -> IO ()
|
|
stopServer Server {threadId} = killThread threadId
|