Safe Haskell	None
Language	GHC2021

Skeletest.Internal.Hooks

Contents

Runtime
Hook implementation
Hook DSL
Specific hooks

Synopsis

data Hooks = Hooks {
- modifySpecRegistry :: ModifySpecRegistryHook
- runTest :: RunTestHook
- onTestFailure :: OnTestFailureHook
- runSpecs :: RunSpecsHook
- modifyTestSummary :: ModifyTestSummaryHook
}
defaultHooks :: Hooks
data UserHooks
setUserHooks :: Hooks -> IO ()
userHooks :: UserHooks
newtype Hook ctx inp out = Hook [HookDef ctx inp out]
data HookDef ctx inp out = HookDef {
- priority :: HookPriority
- impl :: ctx -> (inp -> IO out) -> inp -> IO out
}
data HookPriority
- = NoPriority
- | EarlyPriority
- | LatePriority
runHook :: Hook ctx inp out -> ctx -> inp -> (inp -> IO out) -> IO out
runEarly :: Hook ctx inp out -> Hook ctx inp out
runLate :: Hook ctx inp out -> Hook ctx inp out
mkHook :: (ctx -> (inp -> IO out) -> inp -> IO out) -> Hook ctx inp out
mkHook_ :: (ctx -> inp -> IO ()) -> (ctx -> inp -> out -> IO ()) -> Hook ctx inp out
mkPreHook :: (ctx -> inp -> IO inp) -> Hook ctx inp out
mkPreHook_ :: (ctx -> inp -> IO ()) -> Hook ctx inp out
mkPostHook :: (ctx -> inp -> out -> IO out) -> Hook ctx inp out
mkPostHook_ :: (ctx -> inp -> out -> IO ()) -> Hook ctx inp out
type ModifySpecRegistryHook = Hook ModifySpecRegistryHookContext SpecRegistry SpecRegistry
data ModifySpecRegistryHookContext = ModifySpecRegistryHookContext {
- testTargets :: TestTargets
}
type RunTestHook = Hook RunTestHookContext () TestResult
data RunTestHookContext = RunTestHookContext {
- testInfo :: TestInfo
}
type OnTestFailureHook = Hook OnTestFailureHookContext SomeException TestResult
data OnTestFailureHookContext = OnTestFailureHookContext {
- testInfo :: TestInfo
}
type RunSpecsHook = Hook RunSpecsHookContext SpecRegistry TestExitCode
data RunSpecsHookContext = RunSpecsHookContext
type ModifyTestSummaryHook = Hook ModifyTestSummaryHookContext Text Text
data ModifyTestSummaryHookContext = ModifyTestSummaryHookContext

Documentation

data Hooks Source #

Hooks for extending Skeletest.

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

Constructors

Hooks
Fields modifySpecRegistry :: ModifySpecRegistryHook runTest :: RunTestHook onTestFailure :: OnTestFailureHook runSpecs :: RunSpecsHook modifyTestSummary :: ModifyTestSummaryHook

Instances

Instances details

Monoid Hooks Source #
Instance details Defined in Skeletest.Internal.Hooks Methods mempty :: Hooks # mappend :: Hooks -> Hooks -> Hooks # mconcat :: [Hooks] -> Hooks #
Semigroup Hooks Source #
Instance details Defined in Skeletest.Internal.Hooks Methods (<>) :: Hooks -> Hooks -> Hooks # sconcat :: NonEmpty Hooks -> Hooks # stimes :: Integral b => b -> Hooks -> Hooks #

defaultHooks :: Hooks Source #

Runtime

data UserHooks Source #

Instances

Instances details

HasField field Hooks (Hook ctx inp out) => HasField (field :: k) UserHooks (ctx -> inp -> (inp -> IO out) -> IO out) Source #
Instance details Defined in Skeletest.Internal.Hooks Methods getField :: UserHooks -> ctx -> inp -> (inp -> IO out) -> IO out #

setUserHooks :: Hooks -> IO () Source #

userHooks :: UserHooks Source #

Hook implementation

newtype Hook ctx inp out Source #

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.

Constructors

Hook [HookDef ctx inp out]

Instances

Instances details

Monoid (Hook ctx inp out) Source #
Instance details Defined in Skeletest.Internal.Hooks.HookDef Methods mempty :: Hook ctx inp out # mappend :: Hook ctx inp out -> Hook ctx inp out -> Hook ctx inp out # mconcat :: [Hook ctx inp out] -> Hook ctx inp out #
Semigroup (Hook ctx inp out) Source #
Instance details Defined in Skeletest.Internal.Hooks.HookDef Methods (<>) :: Hook ctx inp out -> Hook ctx inp out -> Hook ctx inp out # sconcat :: NonEmpty (Hook ctx inp out) -> Hook ctx inp out # stimes :: Integral b => b -> Hook ctx inp out -> Hook ctx inp out #

data HookDef ctx inp out Source #

Constructors

HookDef
Fields priority :: HookPriority impl :: ctx -> (inp -> IO out) -> inp -> IO out

data HookPriority Source #

Constructors

NoPriority
EarlyPriority
LatePriority

runHook :: Hook ctx inp out -> ctx -> inp -> (inp -> IO out) -> IO out Source #

Hook DSL

runEarly :: Hook ctx inp out -> Hook ctx inp out Source #

Run the given hook earlier if possible.

runLate :: Hook ctx inp out -> Hook ctx inp out Source #

Run the given hook later if possible.

mkHook :: (ctx -> (inp -> IO out) -> inp -> IO out) -> Hook ctx inp out Source #

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'

mkHook_ :: (ctx -> inp -> IO ()) -> (ctx -> inp -> out -> IO ()) -> Hook ctx inp out Source #

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

mkPreHook :: (ctx -> inp -> IO inp) -> Hook ctx inp out Source #

Like mkHook, except only supports modifying the input.

mkPreHook_ :: (ctx -> inp -> IO ()) -> Hook ctx inp out Source #

Like mkHook_, except with only a before action.

mkPostHook :: (ctx -> inp -> out -> IO out) -> Hook ctx inp out Source #

Like mkHook, except only supports modifying the output.

mkPostHook_ :: (ctx -> inp -> out -> IO ()) -> Hook ctx inp out Source #

Like mkHook_, except with only an after action.