Documentation

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.

Since: tasty-0.1

These are the two ways in which one test may depend on the others.

This is the same distinction as the hard vs soft dependencies in TestNG.

Since: tasty-1.2

The name of a test or a group of tests.

Since: tasty-0.1

Parse the command line arguments and run the tests.

When the tests finish, this function calls exitWith with the exit code that indicates whether any tests have failed. Most external systems (stack, cabal, travis-ci, jenkins etc.) rely on the exit code to detect whether the tests pass. If you want to do something else after defaultMain returns, you need to catch the exception and then re-throw it. Example:

import Test.Tasty
import Test.Tasty.HUnit
import System.Exit
import Control.Exception

test = testCase "Test 1" (2 @?= 3)

main = defaultMain test
  `catch` (\e -> do
    if e == ExitSuccess
      then putStrLn "Yea"
      else putStrLn "Nay"
    throwIO e)

Since: tasty-0.1

The after combinator declares dependencies between tests.

If a TestTree is wrapped in after, the tests in this tree will not run until certain other tests («dependencies») have finished. These dependencies are specified using an AWK pattern (see the «Patterns» section in the README).

Moreover, if the DependencyType argument is set to AllSucceed and at least one dependency has failed, this test tree will not run at all.

Tasty does not check that the pattern matches any tests (let alone the correct set of tests), so it is on you to supply the right pattern.

Examples

after AllFinish "Foo" $
   

after AllFinish "$0 == \"Tests.Foo.Bar\"" $
   

after AllFinish "$NF == \"Bar\"" $
   

Since: tasty-1.2

Customize the test tree based on the run-time options.

Since: tasty-0.6

Locally set the option value for the given test subtree.

Since: tasty-0.1

List of the default ingredients. This is what defaultMain uses.

At the moment it consists of listingTests and consoleTestReporter.

Since: tasty-0.4.2

A shortcut for creating Timeout values.

Since: tasty-0.8

Create a named group of test cases or other groups. Tests are executed in parallel. For sequential execution, see sequentialTestGroup.

Since: tasty-0.1

Create a named group of test cases or other groups. Tests are executed in order. For parallel execution, see testGroup.

Like after, but accepts the pattern as a syntax tree instead of a string. Useful for generating a test tree programmatically.

Examples

after_ AllFinish (EQ (Field NF) (StringLit "Bar")) $
   

Since: tasty-1.2

This ingredient doesn't do anything apart from registering additional options.

The option values can be accessed using askOption.

Since: tasty-0.6

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

When the tests finish, this function calls exitWith with the exit code that indicates whether any tests have failed. See defaultMain for details.

Since: tasty-0.4

Locally adjust the option value for the given test subtree.

Since: tasty-0.1

Acquire the resource to run this test (sub)tree and release it afterwards.

Since: tasty-0.5