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-js-1.5.0.tbz
sha256=54281907e02d78995df246dc2e10ed182828294ad2059347a1e3a13354848f6c
sha512=1aea91de40795ec4f6603d510107e4b663c1a94bd223f162ad231316d8595e9e098cabbe28a46bdcb588942f3d103d8377373d533bcc7413ba3868a577469b45

doc/alcotest.engine/Alcotest_engine/V1/Core/Make/index.html

Module Core.MakeSource

Functor for building a tester that sequences tests of type ('a -> unit M.t) within a given concurrency monad M.t. The run and run_with_args functions must be scheduled in a global event loop. Intended for use by the Alcotest_lwt and Alcotest_async backends.

Parameters

module P : Platform.MAKER
module M : Monad.S

Signature

Sourcetype return = unit M.t

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 = Async_kernel.Deferred.t respectively.

Sourcetype speed_level = [
  1. | `Quick
  2. | `Slow
]

Speed level of a test. Tests marked as `Quick are always run. Tests marked as `Slow are skipped when the `-q` flag is passed.

Sourcetype 'a test_case = string * speed_level * ('a -> return)

A test case is a UTF-8 encoded documentation string, a speed level and a function to execute. Typically, the testing function calls the helper functions provided below (such as check and fail).

Sourceexception Test_error

The exception return by run in case of errors.

Sourceval test_case : string -> speed_level -> ('a -> return) -> 'a test_case

test_case n s f is the test case n running at speed s using the function f.

Sourcetype 'a test = string * 'a test_case list

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.

Sourcetype 'a with_options = ?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 -> 'a

The various options taken by the tests runners run and run_with_args:

  • and_exit (default true). Once the tests have completed, exit with return code 0 if all tests passed, otherwise 1.
  • verbose (default false). Display the test std.out and std.err (rather than redirecting to a log file).
  • compact (default false). Compact the output of the tests.
  • tail_errors (default unlimited). Show only the last N lines of output of failed tests.
  • quick_only (default false). Don't run tests with the `Slow speed level.
  • show_errors (default false). Display the test errors.
  • json (default false). Print test results in a JSON-compatible format.
  • log_dir (default "$PWD/_build/_tests/"). The directory in which to log the output of the tests (if verbose is not set).
  • bail (default false). If true, stop running the tests after the first failure.
  • record_backtrace (defualt true). Enable backtrace recording before beginning testing.
Sourceval run : (string -> unit test list -> return) with_options
Sourceval run_with_args : (string -> 'a -> 'a test list -> return) with_options
Sourceval list_tests : 'a test list -> return

Print all of the test cases in a human-readable form

Sourceval run' : Alcotest_engine__.Config.User.t -> string -> unit test list -> return

Variant of run that consumes a config value.

Sourceval run_with_args' : Alcotest_engine__.Config.User.t -> string -> 'a -> 'a test list -> return

Variant of run_with_args that consumes a config value.