This module contains the core definitions related to ingredients.
Ingredients themselves are provided by other modules (usually under
- data Ingredient
- tryIngredients :: [Ingredient] -> OptionSet -> TestTree -> Maybe (IO Bool)
- ingredientOptions :: Ingredient -> [OptionDescription]
- ingredientsOptions :: [Ingredient] -> [OptionDescription]
- suiteOptions :: [Ingredient] -> TestTree -> [OptionDescription]
Ingredients make your test suite tasty.
Ingredients represent different actions that you can perform on your test suite. One obvious ingredient that you want to include is one that runs tests and reports the progress and results.
Another standard ingredient is one that simply prints the names of all tests.
Similar to test providers (see
IsTest), every ingredient may specify
which options it cares about, so that those options are presented to
the user if the ingredient is included in the test suite.
An ingredient can choose, typically based on the
OptionSet, whether to
run. That's what the
Maybe is for. The first ingredient that agreed to
run does its work, and the remaining ingredients are ignored. Thus, the
order in which you arrange the ingredients may matter.
Usually, the ingredient which runs the tests is unconditional and thus should be placed last in the list. Other ingredients usually run only if explicitly requested via an option. Their relative order thus doesn't matter.
That's all you need to know from an (advanced) user perspective. Read on if you want to create a new ingredient.
TestManager is the second kind of ingredient. It is typically used for
test management purposes (such as listing the test names), although it
can also be used for running tests (but, unlike
TestReporter, it has
to launch the tests manually). It is therefore more general than
TestReporter is provided just for convenience.
The function's result should indicate whether all the tests passed.
TestManager case, it's up to the ingredient author to decide
what the result should be. When no tests are run, the result should
True. Sometimes, even if some tests run and fail, it still
makes sense to return
ingredientOption, but folds over multiple ingredients.