GHC 10.0.0.20260917 · lts/ghc-10.0.x · 8fef28d · 2026-11-02
Modulesandwich-0.3.1.0Haskell2010
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.
it' :: HasCallStack=> NodeOptionsCustom options for this node
-> StringString label for the example.
-> ExampleT context m ()The test example
-> Free (SpecCommand context m) ()Define a single test example.
describe' :: HasCallStack=> NodeOptionsCustom options for this node
-> StringLabel for this group
-> SpecFree context m ()Child spec tree
-> SpecFree context m ()Define a group of tests.
parallel' :: HasCallStack=> NodeOptionsCustom options for this node
-> SpecFree context m ()Child spec tree
-> SpecFree context m ()Run a group of tests in parallel.
Options for an individual test node.
Show NodeOptionsDefined in sandwich-0.3.1.0 · Test.Sandwich.Types.SpecReasonable default node options.
The visibility threshold of the node. See the main docs for an explanation of this.
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.
Whether to time this node.
introduce' :: (HasCallStack, Typeable intro)=> NodeOptionsCustom options for this node
-> StringString label for this node
-> Label l introLabel under which to introduce the value
-> ExampleT context m introAction 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.
introduceWith' :: HasCallStack=> NodeOptionsCustom options for this node
-> StringString label for this node
-> Label l introLabel 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.
before' :: HasCallStack=> NodeOptionsCustom options for this node
-> StringString 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.
beforeEach' :: HasCallStack=> Maybe SrcLocLocation of this call
-> NodeOptionsCustom options for this node
-> StringString 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.
after' :: HasCallStack=> NodeOptionsCustom options for this node
-> StringString 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.
afterEach' :: HasCallStack=> Maybe SrcLocLocation of this call
-> NodeOptionsCustom options for this node
-> StringLabel 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.
around' :: HasCallStack=> NodeOptionsCustom options for this node
-> StringString 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.
aroundEach' :: (Monad m, HasCallStack)=> Maybe SrcLocLocation of this call
-> NodeOptionsCustom options for this node
-> StringString 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 ()