Test.Sandwich.Contexts

Functions for retrieving context information from within tests.

Documentation

getContext :: (HasLabel context l a, MonadReader context m) => Label l a -> m a

Get a context by its label.

getContextMaybe :: (MonadReader context m, KnownSymbol l, Typeable context, Typeable a) => Label l a -> m (Maybe a)

Try to get a context by its label. If not is in scope, returns Nothing.

getRunRoot :: HasBaseContextMonad context m => m (Maybe FilePath)

Get the root folder of the on-disk test tree for the current run. Will be Nothing if the run isn't configured to use the disk.

getCurrentFolder :: HasBaseContextMonad context m => m (Maybe FilePath)

Get the on-disk folder corresponding to the current node. Will be Nothing if the run isn't configured to use the disk, or if the current node is configured not to create a folder.

getCommandLineOptions :: forall a context m. (HasCommandLineOptions context a, MonadReader context m) => m (CommandLineOptions a)

Get the command line options, if configured. Using the runSandwichWithCommandLineArgs family of main functions will introduce these, or you can introduce them manually.

getSomeCommandLineOptions :: forall context m. (HasSomeCommandLineOptions context, MonadReader context m) => m SomeCommandLineOptions

Get existentially wrapped command line options, if configured. Using the runSandwichWithCommandLineArgs family of main functions will introduce these, or you can introduce them manually.

getUserCommandLineOptions :: (HasCommandLineOptions context a, MonadReader context m) => m a

Get the user command line options, if configured. This just calls getCommandLineOptions and pulls out the user options.

Low-level context management helpers

pushContext :: forall m l a intro context. Label l intro -> intro -> ExampleT (LabelValue l intro :> context) m a -> ExampleT context m a

Push a label to the context.

popContext :: forall m l a intro context. Label l intro -> ExampleT context m a -> ExampleT (LabelValue l intro :> context) m a

Remove a label from the context.