Test.Tasty.Runners

tasty-0.11.0.3: Modern and extensible testing framework

Safe Haskell | None
Language | Haskell2010

Test.Tasty.Runners

Contents

- Working with the test tree
- Ingredients
- Standard console ingredients
  - Console test reporter
  - Tests list
- Command line handling
- Running tests
- Options
  - Patterns
- Utilities

Description

API for test runners

Synopsis

- data TestTree
  - = forall t . IsTest t => SingleTest TestName t
  - | TestGroup TestName [TestTree]
  - | PlusTestOptions (OptionSet -> OptionSet) TestTree
  - | forall a . WithResource (ResourceSpec a) (IO a -> TestTree)
  - | AskOptions (OptionSet -> TestTree)
- foldTestTree :: Monoid b => TreeFold b -> OptionSet -> TestTree -> b
- data TreeFold b = TreeFold {
  - foldSingle :: forall t. IsTest t => OptionSet -> TestName -> t -> b
  - foldGroup :: TestName -> b -> b
  - foldResource :: forall a. ResourceSpec a -> (IO a -> b) -> b
  }
- trivialFold :: Monoid b => TreeFold b
- data ResourceSpec a = ResourceSpec (IO a) (a -> IO ())
- newtype Traversal f = Traversal {
  - getTraversal :: f ()
  }
- newtype Ap f a = Ap {
  - getApp :: f a
  }
- data Ingredient
  - = TestReporter [OptionDescription] (OptionSet -> TestTree -> Maybe (StatusMap -> IO (Time -> IO Bool)))
  - | TestManager [OptionDescription] (OptionSet -> TestTree -> Maybe (IO Bool))
- type Time = Double
- tryIngredients :: [Ingredient] -> OptionSet -> TestTree -> Maybe (IO Bool)
- ingredientOptions :: Ingredient -> [OptionDescription]
- ingredientsOptions :: [Ingredient] -> [OptionDescription]
- consoleTestReporter :: Ingredient
- listingTests :: Ingredient
- newtype ListTests = ListTests Bool
- testsNames :: OptionSet -> TestTree -> [TestName]
- optionParser :: [OptionDescription] -> Parser OptionSet
- suiteOptionParser :: [Ingredient] -> TestTree -> Parser OptionSet
- defaultMainWithIngredients :: [Ingredient] -> TestTree -> IO ()
- data Status
  - = NotStarted
  - | Executing Progress
  - | Done Result
- data Result = Result {
  - resultOutcome :: Outcome
  - resultDescription :: String
  - resultShortDescription :: String
  - resultTime :: Time
  }
- data Outcome
  - = Success
  - | Failure FailureReason
- data FailureReason
  - = TestFailed
  - | TestThrewException SomeException
  - | TestTimedOut Integer
- resultSuccessful :: Result -> Bool
- data Progress = Progress {
  - progressText :: String
  - progressPercent :: Float
  }
- type StatusMap = IntMap (TVar Status)
- launchTestTree :: OptionSet -> TestTree -> (StatusMap -> IO (Time -> IO a)) -> IO a
- newtype NumThreads = NumThreads {
  - getNumThreads :: Int
  }
- suiteOptions :: [Ingredient] -> TestTree -> [OptionDescription]
- coreOptions :: [OptionDescription]
- data TestPattern
- parseTestPattern :: String -> TestPattern
- noPattern :: TestPattern
- testPatternMatches :: TestPattern -> [String] -> Bool
- formatMessage :: String -> IO String

# Working with the test tree

data TestTree

The main data structure defining a test suite.

It consists of individual test cases and properties, organized in named groups which form a tree-like hierarchy.

There is no generic way to create a test case. Instead, every test provider (tasty-hunit, tasty-smallcheck etc.) provides a function to turn a test case into a `TestTree`.

Groups can be created using `testGroup`.

Constructors

forall t . IsTest t => SingleTest TestName t | A single test of some particular type
TestGroup TestName [TestTree] | Assemble a number of tests into a cohesive group
PlusTestOptions (OptionSet -> OptionSet) TestTree | Add some options to child tests
forall a . WithResource (ResourceSpec a) (IO a -> TestTree) | Acquire the resource before the tests in the inner tree start and release it after they finish. The tree gets an `IO` action which yields the resource, although the resource is shared across all the tests.
AskOptions (OptionSet -> TestTree) | Ask for the options and customize the tests based on them

foldTestTree

Arguments

:: Monoid b |
=> TreeFold b | the algebra (i.e. how to fold a tree)
-> OptionSet | initial options
-> TestTree | the tree to fold
-> b |

Fold a test tree into a single value.

The fold result type should be a monoid. This is used to fold multiple results in a test group. In particular, empty groups get folded into `mempty`.

Apart from pure convenience, this function also does the following useful things:

1. Keeping track of the current options (which may change due to `PlusTestOptions` nodes)
2. Filtering out the tests which do not match the patterns

Thus, it is preferred to an explicit recursive traversal of the tree.

Note: right now, the patterns are looked up only once, and won't be affected by the subsequent option changes. This shouldn't be a problem in practice; OTOH, this behaviour may be changed later.

data TreeFold b

An algebra for folding a `TestTree`.

Instead of constructing fresh records, build upon `trivialFold` instead. This way your code won't break when new nodes/fields are indroduced.

Constructors

TreeFold |
Fields foldSingle :: forall t. IsTest t => OptionSet -> TestName -> t -> b foldGroup :: TestName -> b -> b foldResource :: forall a. ResourceSpec a -> (IO a -> b) -> b

trivialFold :: Monoid b => TreeFold b

`trivialFold` can serve as the basis for custom folds. Just override the fields you need.

Here's what it does:

- single tests are mapped to `mempty` (you probably do want to override that)
- test groups are returned unmodified
- for a resource, an IO action that throws an exception is passed (you want to override this for runners/ingredients that execute tests)

data ResourceSpec a

`ResourceSpec` describes how to acquire a resource (the first field) and how to release it (the second field).

Constructors

ResourceSpec (IO a) (a -> IO ()) |

newtype Traversal f

Monoid generated by `*>`

Constructors

Traversal |
Fields getTraversal :: f ()

Instances

Applicative f => Monoid (Traversal f) |

newtype Ap f a

Monoid generated by ``liftA2` (`<>`)`

Constructors

Ap |
Fields getApp :: f a

Instances

Monad f => Monad (Ap f) |
Functor f => Functor (Ap f) |
Applicative f => Applicative (Ap f) |
(Applicative f, Monoid a) => Monoid (Ap f a) |

# Ingredients

data Ingredient

`Ingredient`s 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.

There are two kinds of ingredients.

The first kind is `TestReporter`. If the ingredient that agrees to run is a `TestReporter`, then tasty will automatically launch the tests and pass a `StatusMap` to the ingredient. All the ingredient needs to do then is to process the test results and probably report them to the user in some way (hence the name).

`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 if it wants them to be run). It is therefore more general than `TestReporter`. `TestReporter` is provided just for convenience.

The function's result should indicate whether all the tests passed.

In the `TestManager` case, it's up to the ingredient author to decide what the result should be. When no tests are run, the result should probably be `True`. Sometimes, even if some tests run and fail, it still makes sense to return `True`.

Constructors

TestReporter [OptionDescription] (OptionSet -> TestTree -> Maybe (StatusMap -> IO (Time -> IO Bool))) | For the explanation on how the callback works, see the documentation for `launchTestTree`.
TestManager [OptionDescription] (OptionSet -> TestTree -> Maybe (IO Bool)) |

type Time = Double

Time in seconds. Used to measure how long the tests took to run.

tryIngredients :: [Ingredient] -> OptionSet -> TestTree -> Maybe (IO Bool)

Run the first `Ingredient` that agrees to be run.

If no one accepts the task, return `Nothing`. This is usually a sign of misconfiguration.

ingredientOptions :: Ingredient -> [OptionDescription]

Return the options which are relevant for the given ingredient.

Note that this isn't the same as simply pattern-matching on `Ingredient`. E.g. options for a `TestReporter` automatically include `NumThreads`.

ingredientsOptions :: [Ingredient] -> [OptionDescription]

Like `ingredientOption`, but folds over multiple ingredients.

# Standard console ingredients

NOTE: the exports in this section are deprecated and will be removed in the future. Please import Test.Tasty.Ingredients.Basic if you need them.

## Console test reporter

consoleTestReporter :: Ingredient

A simple console UI

## Tests list

listingTests :: Ingredient

The ingredient that provides the test listing functionality

newtype ListTests

This option, when set to `True`, specifies that we should run in the «list tests» mode

Constructors

ListTests Bool |

Instances

Eq ListTests |
Ord ListTests |
IsOption ListTests |

testsNames :: OptionSet -> TestTree -> [TestName]

Obtain the list of all tests in the suite

# Command line handling

optionParser :: [OptionDescription] -> Parser OptionSet

Generate a command line parser from a list of option descriptions

suiteOptionParser :: [Ingredient] -> TestTree -> Parser OptionSet

The command line parser for the test suite

defaultMainWithIngredients :: [Ingredient] -> TestTree -> IO ()

Parse the command line arguments and run the tests using the provided ingredient list

# Running tests

data Status

Current status of a test

Constructors

NotStarted | test has not started running yet
Executing Progress | test is being run
Done Result | test finished with a given result

data Result

A test result

Constructors

Result |
Fields resultOutcome :: Outcome Did the test fail? If so, why? resultDescription :: String `resultDescription` may contain some details about the test. For a passed test it's ok to leave it empty. Providers like SmallCheck and QuickCheck use it to provide information about how many tests were generated. For a failed test, `resultDescription` should typically provide more information about the failure. resultShortDescription :: String The short description printed in the test run summary, usually `OK` or `FAIL`. resultTime :: Time How long it took to run the test, in seconds.

data Outcome

Outcome of a test run

Note: this is isomorphic to ``Maybe` `FailureReason``. You can use the `generic-maybe` package to exploit that.

Constructors

Success | test succeeded
Failure FailureReason | test failed because of the `FailureReason`

Instances

Show Outcome |
Generic Outcome |
type Rep Outcome |

data FailureReason

If a test failed, `FailureReason` describes why

Constructors

TestFailed | test provider indicated failure of the code to test, either because the tested code returned wrong results, or raised an exception
TestThrewException SomeException | the test code itself raised an exception. Typical cases include missing example input or output files. Usually, providers do not have to implement this, as their `run` method may simply raise an exception.
TestTimedOut Integer | test didn't complete in allotted time

Instances

Show FailureReason |

resultSuccessful :: Result -> Bool

`True` for a passed test, `False` for a failed one.

data Progress

Test progress information.

This may be used by a runner to provide some feedback to the user while a long-running test is executing.

Constructors

Progress |
Fields progressText :: String textual information about the test's progress progressPercent :: Float `progressPercent` should be a value between 0 and 1. If it's impossible to compute the estimate, use 0.

type StatusMap = IntMap (TVar Status)

Mapping from test numbers (starting from 0) to their status variables.

This is what an ingredient uses to analyse and display progress, and to detect when tests finish.

launchTestTree

Arguments

:: OptionSet |
-> TestTree |
-> (StatusMap -> IO (Time -> IO a)) | A callback. First, it receives the `StatusMap` through which it can observe the execution of tests in real time. Typically (but not necessarily), it waits until all the tests are finished. After this callback returns, the test-running threads (if any) are terminated and all resources acquired by tests are released. The callback must return another callback (of type ``Time` -> `IO` a`) which additionally can report and/or record the total time taken by the test suite. This time includes the time taken to run all resource initializers and finalizers, which is why it is more accurate than what could be measured from inside the first callback.
-> IO a |

Start running all the tests in a test tree in parallel, without blocking the current thread. The number of test running threads is determined by the `NumThreads` option.

newtype NumThreads

Number of parallel threads to use for running tests.

Note that this is not included in `coreOptions`. Instead, it's automatically included in the options for any `TestReporter` ingredient by `ingredientOptions`, because the way test reporters are handled already involves parallelism. Other ingredients may also choose to include this option.

Constructors

NumThreads |
Fields getNumThreads :: Int

Instances

Eq NumThreads |
Num NumThreads |
Ord NumThreads |
IsOption NumThreads |

# Options

suiteOptions :: [Ingredient] -> TestTree -> [OptionDescription]

All the options relevant for this test suite. This includes the options for the test tree and ingredients, and the core options.

coreOptions :: [OptionDescription]

The list of all core options, i.e. the options not specific to any provider or ingredient, but to tasty itself. Currently contains `TestPattern` and `Timeout`.

## Patterns

data TestPattern

A pattern to filter tests. For the syntax description, see http://documentup.com/feuerbach/tasty#using-patterns

Instances

Read TestPattern |
Show TestPattern |
IsOption TestPattern |

parseTestPattern :: String -> TestPattern

Parse a pattern

noPattern :: TestPattern

A pattern that matches anything.

testPatternMatches :: TestPattern -> [String] -> Bool

Test a path (which is the sequence of group titles, possibly followed by the test title) against a pattern

# Utilities

formatMessage :: String -> IO String

Catch possible exceptions that may arise when evaluating a string. For normal (total) strings, this is a no-op.

This function should be used to display messages generated by the test suite (such as test result descriptions).

See e.g. https://github.com/feuerbach/tasty/issues/25