package alcotest

  1. Overview
  2. Docs
On This Page
  1. Display
package alcotest
Legend:
Library
Module
Module type
Parameter
Class
Class type

A lightweight and colourful test framework, based on OUnit.

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

Speed level for a test.

type test_case = string * speed_level * (unit -> unit)

A test case is a documentation string, a speed level as well as an anyonymous function.

type test = string * test_case list

A test has a name and contains a list of test cases

type result = {
  1. success : int;
  2. failures : int;
  3. time : float;
}

The type for result values.

val result : OUnit.test -> result

Run the tests, return a result.

exception Test_error

The exception return by run in case of errors.

val run : ?and_exit:bool -> string -> test list -> unit

run 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 then the function raises Test_error on error.

Display

val line : Pervasives.out_channel -> ?color:[ `Blue | `Yellow ] -> char -> unit

Draw a line on the given channel