Modulesandwich-0.3.1.0Haskell2010

Test.Sandwich.Nodes

This module exports the special "primed" versions of the test tree nodes. These primed versions accept an additional options argument, which allows you to do things like control the visibility thresholds of the nodes.

1 type
15 values

Packagesandwich-0.3.1.0
Exports16
LanguageHaskell2010
LicenceBSD-3-Clause
SourceNodes.hs

Basic nodes

3 declarations

valueit'

:: HasCallStack
=> NodeOptions
Custom options for this node
-> String
String label for the example.
-> ExampleT context m ()
The test example
-> Free (SpecCommand context m) ()

Define a single test example.

valuedescribe'

:: HasCallStack
=> NodeOptions
Custom options for this node
-> String
Label for this group
-> SpecFree context m ()
Child spec tree
-> SpecFree context m ()

Define a group of tests.

valueparallel'

:: HasCallStack
=> NodeOptions
Custom options for this node
-> SpecFree context m ()
Child spec tree
-> SpecFree context m ()

Run a group of tests in parallel.

Node options

5 declarations

datadata NodeOptions

Options for an individual test node.

Instances1Show

Show NodeOptionsDefined in sandwich-0.3.1.0 · Test.Sandwich.Types.Spec

valuedefaultNodeOptions :: NodeOptions

Reasonable default node options.

valuenodeOptionsVisibilityThreshold :: NodeOptions -> Int

The visibility threshold of the node. See the main docs for an explanation of this.

valuenodeOptionsCreateFolder :: NodeOptions -> Bool

Whether to create a folder in the on-disk test results for this node. Defaults to True, but can be turned off to reduce extraneous folders from nodes like Parallel.

valuenodeOptionsRecordTime :: NodeOptions -> Bool

Whether to time this node.

Context manager nodes

8 declarations

valueintroduce'

:: (HasCallStack, Typeable intro)
=> NodeOptions
Custom options for this node
-> String
String label for this node
-> Label l intro
Label under which to introduce the value
-> ExampleT context m intro
Action to produce the new value (of type intro)
-> (HasCallStack => intro -> ExampleT context m ())
Action to clean up the new value
-> SpecFree (LabelValue l intro :> context) m ()
Child spec tree
-> SpecFree context m ()

Introduce a new value and make it available to the child spec tree.

valueintroduceWith'

:: HasCallStack
=> NodeOptions
Custom options for this node
-> String
String label for this node
-> Label l intro
Label under which to introduce the value
-> ((HasCallStack => intro -> ExampleT context m [Result]) -> ExampleT context m ())
Callback to receive the new value and the child tree.
-> SpecFree (LabelValue l intro :> context) m ()
Child spec tree
-> SpecFree context m ()

Introduce a new value in an around fashion, so it can be used with context managers like withFile or bracket.

valuebefore'

:: HasCallStack
=> NodeOptions
Custom options for this node
-> String
String label for this context manager
-> ExampleT context m ()
Action to perform
-> SpecFree context m ()
Child spec tree
-> SpecFree context m ()

Perform an action before a given spec tree.

valuebeforeEach'

:: HasCallStack
=> Maybe SrcLoc
Location of this call
-> NodeOptions
Custom options for this node
-> String
String label for this context manager
-> ExampleT context m ()
Action to perform
-> SpecFree context m ()
Child spec tree
-> SpecFree context m ()

Perform an action before each example in a given spec tree.

valueafter'

:: HasCallStack
=> NodeOptions
Custom options for this node
-> String
String label for this context manager
-> ExampleT context m ()
Action to perform
-> SpecFree context m ()
Child spec tree
-> SpecFree context m ()

Perform an action after a given spec tree.

valueafterEach'

:: HasCallStack
=> Maybe SrcLoc
Location of this call
-> NodeOptions
Custom options for this node
-> String
Label for this context manager
-> ExampleT context m ()
Action to perform
-> SpecFree context m ()
Child spec tree
-> SpecFree context m ()

Perform an action after each example in a given spec tree.

valuearound'

:: HasCallStack
=> NodeOptions
Custom options for this node
-> String
String label for this node
-> (ExampleT context m [Result] -> ExampleT context m ())
Callback to run the child tree
-> SpecFree context m ()
Child spec tree
-> SpecFree context m ()

Run an action around the given child subtree. Useful for context managers like withFile or bracket.

valuearoundEach'

:: (Monad m, HasCallStack)
=> Maybe SrcLoc
Location of this call
-> NodeOptions
Custom options for this node
-> String
String label for this context manager
-> (ExampleT context m [Result] -> ExampleT context m ())
Callback to run the child tree
-> SpecFree context m ()
Child spec tree
-> SpecFree context m ()