Hooks for extending Skeletest.

Use defaultHooks instead of using Hooks directly, to minimize breaking changes.

The implementation of a Skeletest hook in Hooks.

A hook of type Hook ctx inp out means:

• The hook takes a value of type ctx with extra read-only information that may be relevant for the hook.
• The hook takes an action of type inp -> IO out and returns a potentially modified action of the same type.

ctx/inp should generally be accessed with OverloadedRecordDot or record destructuring, to minimize breaking changes when adding fields to them.

Modify the specs in the test suite.

Modify how a test is executed

Modify what happens if a test fails.

Modify the action to run specs.

Modify the test summary at the end of the report.

Run the given hook earlier if possible.

Run the given hook later if possible.

Create a hook.

Example

hooks :: Hooks
hooks =
  defaultHooks
    { runSpecs = runEarly . mkHook $ ctx run -> pre >=> run >=> post
    }
  where
    pre inp = do
      inp' <- doStuff inp
      pure inp'
    post out = do
      out' <- doMoreStuff out
      pure out'

Like mkHook, except for read-only hooks that don't need to modify anything.

Like mkHook, except only supports modifying the input.

Like mkHook_, except with only a before action.

Like mkHook, except only supports modifying the output.

Like mkHook_, except with only an after action.

The specification for boxed output.

Find the first marker in the given list with the given type.

Helper for isJust . findMarker MyMarker@.

Return true if the given marker name is present.

Map the tree with the given processing function.

To preprocess trees with pre and postprocess with post:

>>> mapSpecTrees (\go -> post . map go . pre) spec

Traverse the tree with the given processing function.

To preprocess trees with pre and postprocess with post:

>>> traverseSpecTrees (\go -> post <=< mapM go <=< pre) spec