package alcotest

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Parameters
Signature

package alcotest

alcotest
- Alcotest
  - Cli
    
    Make
    
    M
  - Core
    
    Make
    
    M
  - Unix
    
    M
alcotest.engine
- Alcotest_engine
  - Cli
    
    MAKER
    
    M
    
    P
    
    M
    
    Make
    
    M
    
    P
    
    M
    
    S
  - Core
    
    MAKER
    
    M
    
    P
    
    M
    
    Make
    
    M
    
    P
    
    M
    
    S
  - Monad
    
    EXTENDED
    
    Infix
    
    List
    
    Extend
    
    Infix
    
    List
    
    M
    
    Identity
    
    S
  - Platform
    
    MAKER
    
    M
    
    S
  - Private
    
    Pp
    
    Utils
    
    List
    
    Result
    
    String
    
    Ascii
    
    Map
    
    Set
    
    Sub
  - Test
    
    TESTABLE

Legend:
Library
Module
Module type
Parameter
Class
Class type

Parameters

module M : Monad.S

Signature

val time : unit -> float

time () returns the current timestamp, used to measure the duration of a testrun.

val getcwd : unit -> string

getcwd () returns the current working directory.

val prepare : base:string -> dir:string -> name:string -> unit

prepare ~base ~dir ~name is called before test suite execution. base is the parent of the log directory, dir the log directory (including unique testrun ID), and name is the test name. On Unix, this function creates the log directory dir for the test output, and sets up the symlink latest to the latest result.

val stdout_isatty : unit -> bool

Return true if standard output refers to a terminal or console window, false otherwise.

val with_redirect : string -> (unit -> 'a M.t) -> 'a M.t

with_redirect output_file f is called for each test. On Unix, it it deals with redirection of standard streams to the output_file. The implementation of with_redirect has to make sure to call f in order to run the test case.

val setup_std_outputs : 
  ?style_renderer:Fmt.style_renderer ->
  ?utf_8:bool ->
  unit ->
  unit

setup_std_outputs ~style_renderer ~utf_8 () is called at startup of alcotest and sets up the standard streams for colored output.

val home_directory : unit -> (string, [ `Msg of string ]) Stdlib.result

home_directory () is the current user's HOME directory, if it exists.