Test.Sandbox.Internals

Documentation

type Port = Int

type SandboxStateRef = IORef SandboxState

type Sandbox = ExceptT String (ReaderT SandboxStateRef IO)

data PortID

Constructors

PortNumber PortNumber

runSandbox :: Sandbox a -> SandboxStateRef -> IO (Either String a)

errorHandler :: String -> IO a

runSandbox' :: SandboxStateRef -> Sandbox a -> IO a

data SandboxState

Constructors

SandboxState

Fields

• ssName :: String
• ssDataDir :: FilePath
• ssProcesses :: Map String SandboxedProcess
• ssProcessOrder :: [String]
• ssAllocatedPorts :: Map String Port
• ssAvailablePorts :: [Port]
• ssFiles :: Map String FilePath
• ssVariables :: Map String ByteString

data SandboxedProcess

Constructors

SandboxedProcess

Fields

• spName :: String
• spBinary :: FilePath
• spArgs :: [String]
• spWait :: Maybe Int
• spCapture :: Maybe Capture
• spInstance :: Maybe SandboxedProcessInstance
• spPid :: Maybe ProcessID
• spPGid :: Maybe ProcessGroupID
• spHandles :: [Handle]
• spEnvs :: Maybe [(String, String)]
• spCwd :: Maybe FilePath

data Capture

Constructors

CaptureStdout

CaptureStderr

CaptureBoth

CaptureStdoutWithFile FilePath

CaptureStderrWithFile FilePath

CaptureBothWithFile FilePath FilePath

data SandboxedProcessInstance

Constructors

RunningInstance ProcessHandle Handle (Maybe Handle) [Handle]

StoppedInstance ExitCode (Maybe String)

get :: Sandbox SandboxState

put :: SandboxState -> Sandbox SandboxState

pretty :: SandboxState -> String

header :: SandboxState -> String

footer :: String

newSandboxState :: String -> FilePath -> IO SandboxStateRef

registerProcess

Arguments

:: String

Process Name

-> FilePath

Path to the application binary

-> [String]

Arguments to pass on the command-line

-> Maybe Int

Time to wait (in s.) before checking that the process is still up

-> Maybe Capture

Which outputs to capture (if any)

-> Maybe [(String, String)]

Evironment variables

-> Maybe FilePath

Working directory for the new process

-> Sandbox SandboxedProcess

isValidProcessName :: String -> Bool

getProcess :: String -> Sandbox SandboxedProcess

updateProcess :: SandboxedProcess -> Sandbox SandboxedProcess

secondInµs :: Int

setFile' :: String -> String -> SandboxState -> IO (FilePath, SandboxState)

bufferSize :: Int

hReadWithTimeout :: Handle -> Int -> Sandbox ByteString

connectTo :: HostName -> PortID -> IO Handle

inet_addr :: HostName -> IO HostAddress

sendToPort :: String -> String -> Int -> Sandbox String

getNewPort :: String -> Sandbox Port

isBindable' :: Port -> IO Bool

isBindable :: Port -> IO Bool

startProcess :: SandboxedProcess -> Sandbox SandboxedProcess

formatCommandLine :: String -> [String] -> String

stopProcess :: SandboxedProcess -> Sandbox SandboxedProcess

getAvailablePids :: Sandbox [ProcessID]

cleanUpProcesses :: Sandbox ()

hSignalProcess :: Signal -> ProcessHandle -> IO ()

killProcess :: ProcessHandle -> IO ()

hGetProcessID :: ProcessHandle -> IO ProcessID

interactWithProcess :: SandboxedProcess -> String -> Int -> Sandbox String

getProcessInputHandle :: SandboxedProcess -> Sandbox Handle

getProcessCapturedOutputHandle :: SandboxedProcess -> Sandbox Handle

getProcessBinary :: SandboxedProcess -> Sandbox FilePath

findExecutables :: [FilePath] -> IO [FilePath]

tryBinary :: FilePath -> IO (Maybe FilePath)

getProcessCandidateBinaries :: SandboxedProcess -> [FilePath]

expand :: String -> IO String

whenM :: Monad m => m Bool -> m () -> m ()

setVariable

Arguments

:: Serialize a

=> String

Variable key for future reference

-> a

Variable value

-> Sandbox a

Sets a custom variable in the sandbox monad.

checkVariable

Arguments

:: String

Variable key

-> Sandbox Bool

Checks that a custom sandbox variable is set.

getVariable

Arguments

:: Serialize a

=> String

Variable key

-> a

Default value if not found

-> Sandbox a

Returns the value of a previously set sandbox variable (or a provided default value if unset)

unsetVariable

Arguments

:: String

Variable key

-> Sandbox ()

Unsets a custom variable.

isVerbose :: Sandbox Bool

verbosityKey :: String

isCleanUp :: Sandbox Bool

cleanUpKey :: String

displayBanner :: Sandbox ()

installSignalHandlers :: Sandbox ()

data SandboxSeed

Constructors

SandboxFixedSeed Int

SandboxRandomSeed

Instances

Generic SandboxSeed

Defined in Test.Sandbox.Internals

Associated Types

type Rep SandboxSeed :: Type -> Type

Methods

from :: SandboxSeed -> Rep SandboxSeed x

to :: Rep SandboxSeed x -> SandboxSeed

Serialize SandboxSeed

Defined in Test.Sandbox.Internals

Methods

put :: Putter SandboxSeed

get :: Get SandboxSeed

type Rep SandboxSeed

Defined in Test.Sandbox.Internals

type Rep SandboxSeed = D1 ('MetaData "SandboxSeed" "Test.Sandbox.Internals" "test-sandbox-0.1.9-7VIKFLuztYLBj00GkIPGRv" 'False) (C1 ('MetaCons "SandboxFixedSeed" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int)) :+: C1 ('MetaCons "SandboxRandomSeed" 'PrefixI 'False) (U1 :: Type -> Type))

data SandboxTestOptions

Constructors

SandboxTestOptions

Fields

• stoSeed :: Maybe SandboxSeed
• stoMaximumGeneratedTests :: Maybe Int
• stoMaximumUnsuitableGeneratedTests :: Maybe Int
• stoMaximumTestSize :: Maybe Int

Instances

Generic SandboxTestOptions

Defined in Test.Sandbox.Internals

Associated Types

type Rep SandboxTestOptions :: Type -> Type

Methods

from :: SandboxTestOptions -> Rep SandboxTestOptions x

to :: Rep SandboxTestOptions x -> SandboxTestOptions

Serialize SandboxTestOptions

Defined in Test.Sandbox.Internals

Methods

put :: Putter SandboxTestOptions

get :: Get SandboxTestOptions

type Rep SandboxTestOptions

Defined in Test.Sandbox.Internals

type Rep SandboxTestOptions = D1 ('MetaData "SandboxTestOptions" "Test.Sandbox.Internals" "test-sandbox-0.1.9-7VIKFLuztYLBj00GkIPGRv" 'False) (C1 ('MetaCons "SandboxTestOptions" 'PrefixI 'True) ((S1 ('MetaSel ('Just "stoSeed") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe SandboxSeed)) :*: S1 ('MetaSel ('Just "stoMaximumGeneratedTests") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Int))) :*: (S1 ('MetaSel ('Just "stoMaximumUnsuitableGeneratedTests") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "stoMaximumTestSize") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Int)))))

putOptions :: SandboxTestOptions -> Sandbox ()

getOptions :: Sandbox (Maybe SandboxTestOptions)

optionsVariable :: String