alcotest
  1. Overview
  2. Docs

Parameters

module X : sig ... end

Signature

type event = [
  1. | `Result of Alcotest_engine__.Model.Test_name.t * [ `Ok | `Exn of Alcotest_engine__.Model.Test_name.t * string * unit Fmt.t | `Error of Alcotest_engine__.Model.Test_name.t * unit Fmt.t | `Skip | `Todo of string ]
  2. | `Start of Alcotest_engine__.Model.Test_name.t
]
type result = {
  1. success : int;
  2. failures : int;
  3. time : float;
  4. errors : unit Fmt.t list;
}
val info : ?available_width:int -> max_label:int -> doc_of_test_name:(Alcotest_engine__.Model.Test_name.t -> string) -> Alcotest_engine__.Model.Test_name.t Fmt.t
val rresult_error : [ `Ok | `Exn of Alcotest_engine__.Model.Test_name.t * string * unit Fmt.t | `Error of Alcotest_engine__.Model.Test_name.t * unit Fmt.t | `Skip | `Todo of string ] Fmt.t
val event_line : margins:int -> max_label:int -> doc_of_test_name:(Alcotest_engine__.Model.Test_name.t -> string) -> [ `Result of Alcotest_engine__.Model.Test_name.t * [< Alcotest_engine__.Model.Run_result.t ] | `Start of Alcotest_engine__.Model.Test_name.t ] Fmt.t
val event : isatty:bool -> compact:bool -> max_label:int -> doc_of_test_name:(Alcotest_engine__.Model.Test_name.t -> string) -> selector_on_failure:bool -> tests_so_far:int -> event Fmt.t
val suite_results : log_dir:(Format.formatter -> unit) -> < verbose : bool ; show_errors : bool ; json : bool ; compact : bool.. > -> result Fmt.t
val quoted : 'a Fmt.t -> 'a Fmt.t

Wraps a formatter with `GNU-style quotation marks'.

val with_surrounding_box : 'a Fmt.t -> 'a Fmt.t

Wraps a formatter with a Unicode box with width given by X.stdout_columns. Uses box-drawing characters from code page 437.

val horizontal_rule : _ Fmt.t

Horizontal rule of length X.stdout_columns. Uses box-drawing characters from code page 437.

val user_error : string -> _

Raise a user error, then fail.