package alcotest
Install
Dune Dependency
Authors
Maintainers
Sources
sha256=e2387136ca854df2b4152139dd4d4b3953a646e804948073dedfe0a232f08a15
sha512=ba38fe4a9061b001d274e5d41fb06c10c84120570fc00dc57dc5a06ba05176c2413295680d839f465ba91469ea99d7e172a324e26f005d6e8c4d98fca7657241
doc/alcotest.engine/Alcotest_engine/index.html
Module Alcotest_engine
Source
Alcotest_engine
provides a platform-independent test framework.
The main building blocks and combinators are defined here. These can be used to defined tests. The platform-specific runners for these tests are in alcotest
, alcotest-lwt
, alcotest-async
and alcotest-mirage
.
These modules are exposed for use internally by other Alcotest packages. They do not provide a stable interface.
Alcotest uses Format.std_formatter
and Format.err_formatter
formatters. However, in a parallel context (OCaml 5 and domains), using these values in parallel can lead to data-races, since these values are not domains-safe. As such, Alcotest offers a way to create your own formatter equivalent in behavior to Format.std_formatter
and Format.err_formatter
(i.e. they write well on 1
and 2
) but they can be used without risk even if another library (such as Logs
) uses Format.std_formatter
and/or Format.err_formatter
and is used in parallel.