Module B0_testing.Test

The type for test source positions. This is the type of Stdlib.__POS__.

It is an optional argument of most combinators to short-circuit the best effort failure location tracking performed via backtraces which may be unreliable in certain scenarios (e.g. closures). The idea is that the argument is simply used with Stdlib.__POS__. For example:

Test.string ~__POS__ s0 s1;

Note that at the moment not all functions make use of the argument.

Formatters for test runners and tested values.

main f executes f (), logs the resulting testing status and returns 0 if all tests passed and 1 otherwise for use with Stdlib.exit. Usually f calls functions that call test. See the example.

test name f logs "Test %s" name and executes f (). The test fails if any failure is reported in f or if f raises an unexpected exception. See the example.

stop stops the current loop, test, or main. Note that this does not increment failed checks, use fail or failstop for that.

pass () increments the number of successfull checks.

failf fmt… increments the number of failed checks. The test continues to execute, use stop and failstop to stop the test.

failf fmt… is like fail but stops the test.

log fmt … logs a message formatted by fmt.

log_fail fmt … is like log but formatted for failures. This does not increment failed checks, use fail to register a failure.

range ~first ~last f calls f n with n ranging over the range [first;last]. If a failure occurs for n, logs "%s in range [%d;%d] failed on %d" kind first last n. If f performs a failstop the loop is stopped but not the test. kind defaults to "Test".

block ~fail f runs f (), if that results in n > 0 failed checks, fail n ~checks is called afterwards with checks the total number of checks that were performed. If f peforms a failstop the block is stopped but not the test. It is possible to fail stop the test by stoppping in fail.

holds b asserts that b is true. msg is logged if the assertion fails.

raises exn f tests that f () raises exception exn.

raises is_exn f tests that f () raises an exception exn that satisfies is_exn exn.

invalid_arg f tests that f () raises Invalid_argument _.

failure f tests that f () raises Failure _.

Equality testers.

eq t v0 v1 assert v0 and v1 are equal are equal using equality tester t.

neq t v0 v1 assert v0 and v1 are not equal using equality tester t.

bool b0 b1 asserts that b0 and b1 are equal.

char c0 c1 asserta that c0 and c1 are equal.

int i0 i1 asserts that i0 and i1 are equal.

int32 i0 i1 asserts that i0 and i1 are equal.

uint32 i0 i1 asserts that i0 and i1 are equal.

int64 i0 i1 asserts that i0 and i1 are equal.

uint64 i0 i1 asserts that i0 and i1 are equal.

nativeint i0 i1 asserts that i0 and i1 are equal.

float f0 f1 asserts that f0 and f1 are equal. This uses Float.equal so it can be used to assert NaN values, also you should be aware of the limitations that are involved in testing floats for equality.

string s0 s1 asserts that s0 and s1 are equal.

binary_string s0 s1 asserts that s0 and s1 are equal assuming that s0 and s1 is binary data.

styled_string s0 s1 asserts that s0 and s1 are equal assuming that s0 and s1 have ANSI escape sequences.

string s0 s1 asserts that s0 and s1 are equal.

list ~elt l0 l1 assert lists l0 and l1 are equal using elt to test elements (default to Eq.any).

array ~elt a0 a1 assert arrays a0 and a1 are equal using elt to test elements (defaults to Eq.any).

get_some gets the value of Some _ and fails and stops if that is not possible.

option ~some:(module M) v0 v1 asserts options v0 and v1 are equal according to M's equality (otherwise Stdlib.(=) is used).

get_ok gets the value of Ok _ and failstops if that is not possible. Calls pass on success.

get_ok' is like get_ok but uses error to render the error.

result ~ok r0 r1 asserts results r0 and r1 are equal according to ok (defaults to Eq.any).

result ~ok ~error r0 r1 asserts results r0 and r1 are equal according to ok and error (both default to El.eq

Randomized testing.

Command line