Run the spec, configuring the options from the command line.
Modulesandwich-0.3.1.0Haskell2010
Test.Sandwich
Contents
Synopsis
- value runSandwichWithCommandLineArgs
- value runSandwichWithCommandLineArgs'
- value parseCommandLineArgs
- value runSandwich
- value runSandwich'
- value it
- value describe
- value parallel
- value introduce
- value introduceWith
- value before
- value beforeEach
- value after
- value afterEach
- value around
- value aroundEach
- value defaultParallelNodeOptions
- value parallelN
- value parallelN'
- value parallelNFromArgs
- value parallelNFromArgs'
- value parallelSemaphore
- type HasParallelSemaphore
- value timeActionByProfile
- value timeAction
- value withTimingProfile
- value withTimingProfile'
- value managedAsync
- value managedAsyncWithUnmask
- value managedWithAsync
- value managedWithAsync_
- Packagesandwich-0.3.1.0
- Exports31
- LanguageHaskell2010
- LicenceBSD-3-Clause
- SourceSandwich.hs
Sandwich is a test framework for Haskell. See the documentation for details and usage examples.
Running tests with command line args
These functions will read command line arguments when setting up your tests. These flags allow you filter the test tree, configure formatters, and pass your own custom options.
# Run using the terminal UI formatter, webdriver headless mode, filtering to nodes matching "Login"
stack run my-tests -- --tui --headless -f Login
Run the spec, configuring the options from the command line and adding user-configured command line options. The options will become available as a test context, which you can access by calling getCommandLineOptions.
Running tests
Run the spec with the given Options.
Run the spec with optional custom CommandLineOptions. When finished, return the exit reason, the number of "it" nodes which failed, and the total failed nodes (which includes "it" nodes, and may also include other nodes like "introduce" nodes).
Basic nodes
The basic building blocks of tests.
value
it :: HasCallStack=> StringLabel for the example.
-> ExampleT context m ()The test example
-> Free (SpecCommand context m) ()
Define a single test example.
value
describe :: HasCallStack=> StringLabel for this group
-> SpecFree context m ()Child spec tree
-> SpecFree context m ()
Define a group of tests.
Run a group of tests in parallel.
Context manager nodes
For introducing new contexts into tests and doing setup/teardown.
value
introduce :: (HasCallStack, Typeable intro)=> 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.
value
introduceWith :: HasCallStack=> 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.
value
before :: HasCallStack=> StringLabel 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.
value
beforeEach :: HasCallStack=> StringString label for this context manager
-> ExampleT context m ()Action to perform
-> SpecFree context m ()Child spec tree
-> SpecFree context m ()
value
after :: HasCallStack=> StringLabel 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.
value
around Run an action around the given child subtree. Useful for context managers like withFile or bracket.
value
aroundEach Parallel nodes
Wrapper around parallel. Introduces a semaphore to limit the parallelism to N threads.
value
parallelN' :: MonadUnliftIO m=> NodeOptionsNode options
-> IntNumber of threads
-> SpecFree (LabelValue"parallelSemaphore"
QSem :> context) m ()-> SpecFree context m ()
value
parallelNFromArgs :: (MonadUnliftIO m, HasCommandLineOptions context a)=> (CommandLineOptions a -> Int)Callback to extract the semaphore size
-> SpecFree (LabelValue"parallelSemaphore"
QSem :> context) m ()-> SpecFree context m ()
Same as parallelN, but extracts the semaphore size from the command line options.
value
parallelNFromArgs' :: (MonadUnliftIO m, HasCommandLineOptions context a)=> NodeOptionsNode options
-> (CommandLineOptions a -> Int)Callback to extract the semaphore size
-> SpecFree (LabelValue"parallelSemaphore"
QSem :> context) m ()-> SpecFree context m ()
Timing
For timing actions within your tests. Test tree nodes are timed by default.
value
timeActionByProfile :: (MonadUnliftIO m, MonadReader context m, HasTestTimer context)=> ProfileNameProfile name
-> EventNameEvent name
-> m a-> m a
Time a given action with a given profile name and event name. Use when you want to manually specify the profile name.
value
timeAction :: (MonadUnliftIO m, HasBaseContextMonad context m, HasTestTimer context)=> EventNameEvent name
-> m a-> m a
Time a given action with a given event name. This name will be the "stack frame" of the given action in the profiling results. This function will use the current timing profile name.
value
withTimingProfile :: Monad m=> ProfileNameProfile name
-> SpecFree (LabelValue"testTimerProfile"
TestTimerProfile :> context) m ()-> SpecFree context m ()
Introduce a new timing profile name.
value
withTimingProfile' Introduce a new timing profile name dynamically. The given ExampleT should come up with the name and return it.
Managed async
If you want to run asyncs within your tests, we can help keep track of them and make sure they get cleaned up.
Launch a managed async thread, tracking it with the run ID from BaseContext.
Like managedAsync, but the action receives an unmask function.
Run a managed async thread scoped to a callback.
Like managedWithAsync, but ignores the Async handle.
Exports
module Test.Sandwich.Contexts
module Test.Sandwich.Expectations
module Test.Sandwich.Logging
module Test.Sandwich.Misc
module Test.Sandwich.Nodes
module Test.Sandwich.Options
module Test.Sandwich.TH