package tezt

You can search for identifiers within the package.

in-package search v0.2.0

tezt
- CHANGES
- README
- Library tezt
  - Tezt
    
    Background
    
    Base
    
    Check
    
    Cli
    
    Diff
    
    JSON
    
    Log
    
    Process
    
    Process_hooks
    
    Regression
    
    Runner
    
    Shell
    
    Sys
    
    Temp
    
    Test
    
    SCHEDULER
    
    String_tree
- Library tezt.core
  - Tezt_core
    
    Background
    
    Base
    
    String_map
    
    String_set
    
    Check
    
    EQUALABLE
    
    COMPARABLE
    
    Cli
    
    Options
    
    Logs
    
    Reports
    
    Commands
    
    Selecting_tests
    
    Diff
    
    Log
    
    Color
    
    FG
    
    BG
    
    Style
    
    Process_hooks
    
    Regression
    
    TSL
    
    TSL_AST
    
    TSL_lexer
    
    TSL_parser
    
    Test
    
    SCHEDULER
    
    String_tree
    
    Version
- Library tezt.json
  - JSON
- Library tezt.scheduler
  - Scheduler
    
    Message
    
    Timer
- Sources
  - tezt
    
    echo.ml
    
    main.ml
    
    process.ml
    
    process_common.ml
    
    runner.ml
    
    temp.ml
    
    tezt.ml
    
    tezt__.ml
  - tezt.core
    
    TSL.ml
    
    TSL_AST.ml
    
    TSL_lexer.ml
    
    TSL_parser.ml
    
    background.ml
    
    base.ml
    
    check.ml
    
    cli.ml
    
    diff.ml
    
    log.ml
    
    process_hooks.ml
    
    regression.ml
    
    test.ml
    
    tezt_core.ml
    
    version.ml
  - tezt.json
    
    JSON.ml
  - tezt.scheduler
    
    scheduler.ml

Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module `Runner.Sys`Source

Extension to Stdlib.Sys that can also execute on remote runners.

Most functions from this module just call their Stdlib.Sys equivalent when runner is not specified. When runner is specified, they instead use SSH to execute a shell command remotely with a similar effect.

Sourcetype error

Errors that can occur when executing a Sys command on a remote runner.

Sourceexception Remote_error of error

Exception raised when failing to execute a Sys command remotely.

This is not raised when running a command without a runner. Instead, Sys_error is raised.

Sourceval show_error : error -> string

Convert an error to an error message.

Sourceval file_exists : ?runner:t -> string -> bool

Check if a file exists on the system.

For the local version, see Sys.file_exists.

Sourceval mkdir : ?runner:t -> ?perms:int -> string -> unit

Create a new directory.

For the local version, see Unix.mkdir.

Sourceval is_directory : ?runner:t -> string -> bool

Check if a file exists and is a directory.

For the local version, see Sys.is_directory.

Sourceval readdir : ?runner:t -> string -> string array

Return the contents of a directory.

For the local version, see Sys.readdir.

Sourceval remove : ?runner:t -> string -> unit

Remove a file.

For the local version, see Sys.remove.

Sourceval rm_rf : t -> string -> unit

Remove recursively with rm -rf.

Only implemented for remote runners.

Sourceval rmdir : ?runner:t -> string -> unit

Remove a directory.

For the local version, see Unix.rmdir.

Sourceval mkfifo : ?runner:t -> ?perms:int -> string -> unit

Create a named pipe.

For the local version, see Unix.mkfifo.

package tezt

Module Runner.SysSource

Module `Runner.Sys`Source