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
alcotest.engine
- Alcotest_engine
  - Formatters
  - Monad
    
    EXTENDED
    
    List
    
    Syntax
    
    Extend
    
    List
    
    M
    
    Syntax
    
    Identity
    
    S
  - Platform
    
    MAKER
    
    M
    
    S
  - Private
    
    Pp
    
    Make
    
    _
  - V1
    
    Cli
    
    MAKER
    
    M
    
    _
    
    M
    
    Make
    
    M
    
    _
    
    M
    
    S
    
    Core
    
    MAKER
    
    M
    
    _
    
    M
    
    Make
    
    M
    
    _
    
    M
    
    S
    
    Test
    
    Source_code_position
    
    TESTABLE
alcotest.stdlib_ext
- Alcotest_stdlib_ext
  - Cmdliner_syntax
  - Fun
  - Int
    
    Set
  - List
  - Option
  - Result
  - String
    
    Ascii
    
    Map
    
    Set
    
    Sub

Legend:
Library
Module
Module type
Parameter
Class
Class type

Parameters

module M : Alcotest_engine.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 stdout_isatty : unit -> bool

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

val stdout_columns : unit -> int option

stdout_columns () is the current width of stdout in columns, or None if no width can be determined (e.g. stdout is not a TTY).

val setup_std_outputs : 
  ?style_renderer:Fmt.style_renderer ->
  ?utf_8:bool ->
  Alcotest_engine.Formatters.stdout ->
  Alcotest_engine.Formatters.stderr ->
  unit

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

val log_trap_supported : bool

Whether or not the test runner should trap test logs. The following functions are used iff this is set to true.

val prepare_log_trap : root:string -> uuid:string -> name:string -> unit

prepare ~root ~uuid ~name is called before test suite execution.

root is the directory used for log capturing;
uuid is the unique test execution ID;
name is the suite name.

type file_descriptor

val file_exists : string -> bool

val open_write_only : string -> file_descriptor

val close : file_descriptor -> unit

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

with_redirect fd f is called for each test. On Unix, it deals with redirection of standard streams to the fd.

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

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