package ppx_test

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Test registration
Module opened in the test code
Higher level API
Middle level APIs
Lower level APIs

package ppx_test

ppx_test
- Ppx_test
  - Location
  - Longident
  - Test
    
    Error
    
    Name
    
    Report
    
    Result
    
    TestTool
ppx_test.runtime
- Ppx_test_runtime

Legend:
Library
Module
Module type
Parameter
Class
Class type

type t

The test type

Test registration

val test_unit : Location.t -> Longident.t -> (unit -> unit) -> unit

Add a test of type unit -> unit. This is called when let %TEST_UNIT ppx phrase is called.

val test : Location.t -> Longident.t -> (unit -> bool) -> unit

Add a test of type unit -> bool. This is called when let %TEST ppx phrase is called.

val test_fail : Location.t -> Longident.t -> (unit -> unit) -> unit

Add a test of type unit -> unit. It must fail by raising an exception. This is called when let %TEST_FAIL ppx phrase is called.

Module opened in the test code

module TestTool : sig ... end

Higher level API

val collect : unit -> unit

Run tests added by test, test_unit and add. Then it prints the report to stderr and exit. The exit status is 0 if there is no error, otherwise, 1.

This is for standalone test executables: it parses command line options using arg_specs to select tests to perform. All the tests are executed by default.

For application programs with integrated test interface, use run_tests instead.

Middle level APIs

module Name : sig ... end

Name of tests

module Error : sig ... end

Test error descriptions

module Result : sig ... end

Test result

module Report : sig ... end

Report for the test run

val run_tests : bool -> Report.t

Run tests added by test, test_unit and add. It returns a report.

This is for application programs with integrated tests.

The boolean is to set the default value to perform each test or not. For test selections, applications must use arg_specs at its command line option parsing.

val arg_specs : (string * Arg.spec * string) list

Command line switches for testing options. Useful when integrating the tests into main applications instead of building independent test executables.

Lower level APIs

val add : t -> unit

val fun_ : (unit -> bool) -> t

val label : string -> t -> t

val ident : Longident.t -> t -> t

val list : t list -> t