On This Page
Legend:
Library
Module
Module type
Parameter
Class
Class type
Library
Module
Module type
Parameter
Class
Class type
package alcotest
A lightweight and colourful test framework.
type test_case = string * speed_level * (unit -> unit)A test case is an UTF-8 encoded documentation string, a speed level and a function to execute.
type test = string * test_case listA test is an US-ASCII encoded name and a list of test cases.
The exception return by run in case of errors.
val run : ?and_exit:bool -> string -> test list -> unitrun n t runs the test suite t. n is 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.
Assert functions
module type TESTABLE = sig ... endval bool : bool testablebool tests booleans.
val int : int testableint tests integers.
val char : char testablechar tests characters.
val string : string testablestring tests OCaml strings.
slist t comp tests sorted lists of ts. The list are sorted using comp.
val result : 'a testable -> 'e testable -> ('a, 'e) Result.result testableresult t e tests ts on success and es on failure.
val of_pp : (Format.formatter -> 'a -> unit) -> 'a testableof_pp pp tests values which can be printed using pp and compared using Pervasives.compare
val pass : 'a testablepass tests values of any type and always succeeds.
val check : 'a testable -> string -> 'a -> 'a -> unitCheck that two values are equal.
Display
val line : Pervasives.out_channel -> ?color:[ `Blue | `Yellow ] -> char -> unit@
On This Page