package alcotest
Build not yet checkedInstall
dune-project
Dependency
Authors
Maintainers
Sources
sha256=62c095deda5cdd66c30684f7b1f25b5775d1d3d3ded927c7b893b4a6834ddb47
sha512=6f779fa96faf96b5b462ddc428aeaaa73a6be96771dbbad6a05b7bb00dae246648891c211e26174729c1f40128410ad96f2512101ae8b7d61f968ee61534b3d0
doc/alcotest/Alcotest/index.html
Module AlcotestSource
A lightweight and colourful test framework.
Alcotest provides a simple interface to perform unit tests. It exposes a simple TESTABLE module type, a check function to assert test predicates and a run function to perform a list of unit -> unit test callbacks.
From these descriptions, Alcotest builds a quiet and colorful output where only faulty runs are fully displayed at the end of the run (with the full logs ready to inspect).
Release 1.10.1
include Alcotest_engine.V1.Cli.S with type return = unit
The return type of each test case run by Alcotest. For the standard Alcotest module, return = unit. The concurrent backends Alcotest_lwt and Alcotest_async set return = unit Lwt.t and return = unit Async.Deferred.t respectively.
When a test runs. The command line sets up a context, a set of tags that starts with quick and slow: -q removes slow, and --tags adds or removes tags. `Quick, `Slow and `Tag s hold when quick, slow and s are in the context, `And, `Or and `Not combine them, and `Always always holds.
A test case is a UTF-8 encoded documentation string, when it runs and a function to execute. Typically, the testing function calls the helper functions provided below (such as check and fail).
test_case n t f is the test case n using the function f, which runs when t holds.
test name f is the test case name using the function f. It only runs when tags hold, which defaults to `Always.
group name cases is a test case that stands for cases, which run in place under the test name test.name, so that they can be selected together. Groups nest. name must not be empty. cases only run when tags hold as well as their own, and tags defaults to `Always.
A group is recognised by physical equality on the returned tuple, so it can appear several times and under different parents. A new tuple built from it is a plain test case, whose function runs all of cases. Functions on a list of test cases, like List.filter, see the group and not its cases.
The test subcommand matches names as a regular expression, so test top also selects top.name. Use test '^top$' to select only the cases outside of groups. A test called top.name next to a group name in top is a duplicate test path if their indices overlap.
A test is a UTF-8 encoded name and a list of test cases. The name can be used for filtering which tests to run on the CLI.
suite name cases is the test name with the test cases cases.
type 'a with_options =
?stdout:Alcotest_engine.Formatters.stdout ->
?stderr:Alcotest_engine.Formatters.stderr ->
?and_exit:bool ->
?verbose:bool ->
?compact:bool ->
?tail_errors:[ `Unlimited | `Limit of int ] ->
?quick_only:bool ->
?show_errors:bool ->
?json:bool ->
?filter:(name:string -> index:int -> [ `Run | `Skip ]) ->
?log_dir:string ->
?bail:bool ->
?record_backtrace:bool ->
?ci:[ `Github_actions | `Unknown | `Disabled ] ->
'aThe various options taken by the tests runners run and run_with_args:
stdout(default toFmt.stdout). The formatter used to print on the standard output.stderr(default toFmt.stderr). The formatter used to print ont the standard error output.and_exit(defaulttrue). Once the tests have completed, exit with return code0if all tests passed, otherwise1.verbose(defaultfalse). Display the test std.out and std.err (rather than redirecting to a log file).compact(defaultfalse). Compact the output of the tests.tail_errors(default unlimited). Show only the last N lines of output of failed tests.quick_only(defaultfalse). Do not run the`Slowtests, unless--tagsselects them.show_errors(defaultfalse, ortruewhen a CI is detected). Display the test errors.json(defaultfalse). Print test results in a JSON-compatible format.filter. Filter tests according to~name, the name of the test, and~index, the number of the test case.log_dir(default"$PWD/_build/_tests/", or"$DUNE_SOURCEROOT/_build/_tests/"under dune). The directory in which to log the output of the tests. Each run also writes a JUnit XML report in itsjunitdirectory, where a failedcheckorfailis a<failure>and any other exception is an<error>.bail(defaultfalse). If true, stop running the tests after the first failure.record_backtrace(defaulttrue). Enable backtrace recording before beginning testing.ci(default auto-detected). Whether to enable specific logging for a CI system.
run n t runs the test suite t. n is the name of the tested library.
The optional argument and_exit controls what happens when the function ends. By default, and_exit is set, which makes the function exit with 0 if everything is fine or 1 if there is an issue. If and_exit is false, then the function raises Test_error on error.
The optional argument argv specifies command line arguments sent to alcotest like "--json", "--verbose", etc. Note that this array will be treated like a regular Sys.argv, so the array must have at least one element, and the first element will be treated as if it was the command name and thus ignored for the purposes of option processing. So ~argv:[||] is an error, ~argv:[| "--verbose" |] will have no effect, and ~argv:[| "ignored"; "--verbose" |] will successfully pass the verbose option.
val run_with_args :
(?argv:string array ->
string ->
'a Cmdliner.Term.t ->
'a test list ->
return)
with_optionsrun_with_args n a t Similar to run a t but take an extra argument a. Every test function will receive as argument the evaluation of the Cmdliner term a: this is useful to configure the test behaviors using the CLI.
Testable values
The following combinators represent types that can be used with the check functions below.
TESTABLE provides an abstract description for testable values.
testable pp eq is a new testable with the pretty-printer pp and equality eq.
string tests OCaml strings. When the output supports UTF-8, a valid UTF-8 string prints as is, apart from escaping ASCII as %S does.
slist t comp tests sorted lists of ts. The list are sorted using comp.
iarray t tests immutable arrays of ts. Available from OCaml 5.4.
result t e tests ts on success and es on failure.
triple a b c tests triples of as, bs and cs.
of_pp pp tests values which can be printed using pp and compared using Stdlib.compare
neg t is t's negation: it is true when t is false and it is false when t is true.
map f t lift a 'a testable to a 'b testable, converting 'b to 'a.
Assertion functions
Functions for asserting various properties within unit-tests. A failing assertion will cause the testcase to fail immediately.
The assertion functions optionally take information about the location at which they are called in the source code. This is used for giving more descriptive error messages in the case of failure.
check testable msg expected actual checks that two values are equal.
msg is printed if the check fails.
If check isn't in a tail-call position, Alcotest may guess the location of the check. Otherwise, use extra_info to report the location.
Check that two values are equal (labeled variant of check).
Simply fail.
Simply fail with a formatted message.
Check that an exception is raised.
match_raises msg exception_is_expected f Runs f (), and passes the raised exception to exception_is_expected. The check fails when no exception is raised, or exception_is_expected returns false.
Skip the current test case.
Versioned APIs
An alias of the above API that provides a stability guarantees over major version changes.
Unix-specific engine constructors
The Alcotest_engine package provides the most general form of the Alcotest API, parameterised over the thread implementation and the platform. This package provides the Unix platform implementation.