Test

console

console : (() ->{Reporter, e} a) ->{Console, e} aSource

Re-exported from Test.Reporter.

Handles progress by printing failures and the final summary to standard output, preserving run’s report format. Start events and non-failing outcomes are silent. Returns the action’s result without exiting; effects besides Reporter pass through.

describe

describe : String -> List (Test e) -> Test eSource

A named group of tests. Group names form the path a failure is reported under.

documentation

documentation : (() ->{Reporter, e} a) ->{Console, e} aSource

Re-exported from Test.Reporter.

Prints group headings and indented case names with their outcomes as leaves complete. Full failure messages and the summary follow. Group names shared by consecutive paths are printed once. Returns the action’s result without exiting.

execute

execute : Test e ->{Reporter, e} SummarySource

Executes the suite without printing or exiting, returning its summary and reporting progress through Reporter. Other body effects pass through to the caller. The first failing expectation ends only its body. Runtime crashes and unhandled effects propagate without a synthetic completion event.

import Expect
import Test

result : Test.Summary
result = Test.silent { Test.execute (Test.test "pure" { Expect.equal 1 1 }) }

result.passed == 1
result.verdict == Test.RunPassed

A custom handler can collect progress in memory:

import List
import Test
import Tuple

collect action =
    handle action() with events = [] on
        Test.report event -> resume () with [event | events]
        return value -> (value, List.reverse events)

collected = collect { Test.execute (Test.test "one" {}) }
summary = Tuple.first collected
events = Tuple.second collected

summary.verdict == Test.RunPassed
events == [ Test.SuiteStarted 1, Test.CaseStarted ["one"], Test.CaseFinished ["one"] Test.CasePassed, Test.SuiteFinished summary ]

only

only : Test e -> Test eSource

Focuses the run: when a suite contains only, just the focused tests run and other test bodies count as skipped. Todos remain todos unless explicitly skipped. The run is incomplete.

progress

progress : (() ->{Reporter, e} a) ->{Console, e} aSource

Re-exported from Test.Reporter.

Prints one progress character for each completed leaf: . for a pass, F for a failure, and * for a skipped leaf or todo. Group validation failures also print F. Full failure messages and the summary follow the progress line. Returns the action’s result without exiting.

run

run : Test e ->{Environment, Console, FileSystem, e} StatusSource

Runs the suite using command-line output options and answers the status for main to return: failure unless every test passed and the run was complete. Other effects the tests perform pass through to the caller, which handles them around the run. Use execute with a reporter handler to choose output and exit policy yourself. Command-line options select progress or documentation output and an optional JSON file; see Test.Reporter.run.

silent

silent : (() ->{Reporter, e} a) ->{e} aSource

Re-exported from Test.Reporter.

Discards progress events and returns the action’s result. Effects besides Reporter pass through, so pure suites can execute without IO.

skip

skip : Test e -> Test eSource

A test or group that is not run. Its leaves, including todos, count as skipped and make the run incomplete; an empty subtree adds no skipped leaves.

test

test : String -> (() ->{Expect, e} ()) -> Test eSource

A named test. The body’s expectations run as statements; the first that fails ends the body and fails the test.

todo

todo : String -> Test eSource

A test that is not written yet. It is counted and makes the run incomplete.