package alcotest

  1. Overview
  2. Docs
Alcotest is a lightweight and colourful test framework

Install 

dune-project
 Dependency

github.com Readme Changelog ISC License Edit opam file Versions (6)

Authors

  1. T
    Thomas Gazagnaire

Maintainers

  1. T
    thomas@gazagnaire.org

Sources

alcotest-1.9.1.tbz
sha256=1e29c3b41d4329062105b723dfda3aff86b8cef5e7c7500d0e491fc5fd78e482
sha512=c49d402fa636dcf11f81917610dd1d2eca8606c8919aede4db23710d071f6046a8f93c78de9fbfee26637a53ca67f71fad500bfa2478b7f0f059608a492dd0a5

doc/alcotest.engine/Alcotest_engine/index.html

Module Alcotest_engineSource

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.

Sourcemodule V1 : sig ... end

Version 1 of the user-facing Alcotest API.

Sourcemodule Monad : sig ... end

Monad signatures for use with V1.Core and V1.Cli.

Sourcemodule Platform : sig ... end

Defines platform-dependent functions.

Sourcemodule Private : sig ... end

These modules are exposed for use internally by other Alcotest packages. They do not provide a stable interface.

Sourcemodule Formatters : sig ... end

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.