Test.Tasty.Process

Documentation

processTest :: TestName -> TestProcess -> TestTree

Create a TestTree from a TestProcess. Here is an example of how to use the function to create a test.

exampleTest :: TestTree
exampleTest =
  setTimeout (1000000) $
    processTest
      "Simple test"
      TestProcess
        { process =
          (proc "test-executable-simple" [])
        , input = Nothing
        , exitCodeCheck = equals ExitSuccess
        , stdoutCheck = equals "Hello, world!n"
        , stderrCheck = equals ""
        }

data TestProcess

TestProcess is a data type that represents a process to be tested.

Constructors

TestProcess

Fields

• process :: CreateProcess

  The process to be tested.

• input :: Maybe String

  The input to be sent to the process. If Nothing, no input will be sent.

• exitCodeCheck :: ExitCodeCheck

  The check to be performed on the exit code of the process.

• stdoutCheck :: OutputCheck

  The check to be performed on the stdout of the process.

• stderrCheck :: OutputCheck

  The check to be performed on the stderr of the process.

Instances

IsTest (TestProcess, IO (Maybe Handle, Maybe Handle, Maybe Handle, ProcessHandle))

Defined in Test.Tasty.Process

Methods

run :: OptionSet -> (TestProcess, IO (Maybe Handle, Maybe Handle, Maybe Handle, ProcessHandle)) -> (Progress -> IO ()) -> IO Result

testOptions :: Tagged (TestProcess, IO (Maybe Handle, Maybe Handle, Maybe Handle, ProcessHandle)) [OptionDescription]

proc :: FilePath -> [String] -> CreateProcess

Re-export of proc from System.Process with correct default values.

Construct a CreateProcess record for passing to createProcess, representing a command to be passed to the shell.

shell :: String -> CreateProcess

Re-export of shell from System.Process with correct default values.

Construct a CreateProcess record for passing to createProcess, representing a raw command with arguments. See RawCommand for precise semantics of the specified FilePath.

defaultProcess :: TestProcess

The template process configuration.

type ExitCodeCheck = ExitCode -> Either String ()

ExitCodeCheck represents a function that given the ExitCode of a process, returns () if the exit code is expected, or a reason otherwise.

type OutputCheck = String -> Either String ()

OutputCheck represents a function that given the output of a process, returns () if the output is expected, or a reason otherwise.

equals :: (Show a, Eq a) => a -> a -> Either String ()

A helper function for creating equality checks.

>>> equals "str" "str"
Right ()

>>> equals ExitSuccess ExitSuccess
Right ()

>>> equals "expected value" "actual value"
Left "expected : \"expected value\"\nactual   : \"actual value\"\n"

ignored :: a -> Either String ()

A helper function to ignore checks.

>>> ignored "any value"
Right ()

setTimeout :: Integer -> TestTree -> TestTree

Set the timeout (in microseconds) for a TestTree.