Test.HUnit.Base

The basic structure used to create an annotated tree of test cases.

Shorthand for a test case that asserts equality (with the expected value on the left-hand side, and the actual value on the right-hand side).

Shorthand for a test case that asserts equality (with the actual value on the left-hand side, and the expected value on the right-hand side).

Creates a test from the specified Testable, with the specified label attached to it.

Since Test is Testable, this can be used as a shorthand way of attaching a TestLabel to one or more tests.

Creates a test case resulting from asserting the condition obtained from the specified AssertionPredicable.

Unconditionally signals that a failure has occurred.

Asserts that the specified condition holds.

Asserts that the specified actual value is equal to the expected value. The output message will contain the prefix, the expected value, and the actual value.

If the prefix is the empty string (i.e., ""), then the prefix is omitted and only the expected and actual values are output.

Signals an assertion failure if a non-empty message (i.e., a message other than "") is passed.

When an assertion is evaluated, it will output a message if and only if the assertion fails.

Test cases are composed of a sequence of one or more assertions.

Asserts that the specified actual value is equal to the expected value (with the expected value on the left-hand side).

Asserts that the specified actual value is equal to the expected value (with the actual value on the left-hand side).

Asserts that the condition obtained from the specified AssertionPredicable holds.

Allows the extension of the assertion mechanism.

Since an Assertion can be a sequence of Assertions and IO actions, there is a fair amount of flexibility of what can be achieved. As a rule, the resulting Assertion should be the body of a TestCase or part of a TestCase; it should not be used to assert multiple, independent conditions.

If more complex arrangements of assertions are needed, Tests and Testable should be used.

A specialized form of Assertable to handle lists.

The result of an assertion that hasn't been evaluated yet.

Most test cases follow the following steps:

1. Do some processing or an action.

2. Assert certain conditions.

However, this flow is not always suitable. AssertionPredicate allows for additional steps to be inserted without the initial action to be affected by side effects. Additionally, clean-up can be done before the test case has a chance to end. A potential work flow is:

1. Write data to a file.

2. Read data from a file, evaluate conditions.

3. Clean up the file.

4. Assert that the side effects of the read operation meet certain conditions.

5. Assert that the conditions evaluated in step 2 are met.

Used to signify that a data type can be converted to an assertion predicate.

Provides a way to convert data into a Test or set of Test.

Keeps track of the remaining tests and the results of the performed tests. As each test is performed, the path is removed and the counts are updated as appropriate.

A data structure that hold the results of tests that have been performed up until this point.

Uniquely describes the location of a test within a test hierarchy. Node order is from test case to root.

Composed into Paths.

Determines the paths for all TestCases in a tree of Tests.

Counts the number of TestCases in a tree of Tests.

Report generator for reporting the start of a test run.

Report generator for reporting problems that have occurred during a test run. Problems may be errors or assertion failures.

Performs a test run with the specified report generators.

This handles the actual running of the tests. Most developers will want to use HUnit.Text.runTestTT instead. A developer could use this function to execute tests via another IO system, such as a GUI, or to output the results in a different manner (e.g., upload XML-formatted results to a webservice).

Note that the counts in a start report do not include the test case being started, whereas the counts in a problem report do include the test case just finished. The principle is that the counts are sampled only between test case executions. As a result, the number of test case successes always equals the difference of test cases tried and the sum of test case errors and failures.