tezt 3.1.0 · OCaml Package

Command-line interface.

When this module is loaded, it parses command line options unconditionally as a side-effect.

type log_level =

| Quiet
| Error
| Warn
| Report
| Info
| Debug

Log levels for standard output.

The list below is sorted from the most quiet level to the most verbose level.

Absolutely no log has log level Quiet. In other words, setting log level Quiet inhibits all logs.

Error logs are about errors which imply that the current test failed. This includes messages given to Test.fail and uncaught exceptions.

Warn logs are about errors that do not cause the current test to fail. This includes failure to clean up temporary files, for instance.

Report logs are informational messages that report the result of the current test. They tell the user whether the test was successful or not. They may also include information about how to re-run the test.

Info logs are informational messages that summarize what the test is doing. They tell the user that a particular milestone was reached. In tests, it is a good idea to log Info messages at significant checkpoints.

Debug logs give more details about exactly what is happening. They include external process outputs, exit codes, and signals which are sent.

Additionally, some flags such as --commands and --list cause some information to be printed unconditionally, even with --quiet. Such kind of output is not considered to be log messages.

type temporary_file_mode =

| Delete
| Delete_if_successful
| Keep

What to do with temporary files after the test is finished.

type loop_mode =

| Infinite
| Count of int

How many times to loop.

type on_unknown_regression_files_mode =

| Warn
| Ignore
| Fail
| Delete

type options = {

mutable color : bool;
mutable log_level : log_level;
mutable log_file : out_channel option;
mutable log_filename : string option;
mutable log_buffer_size : int;
mutable log_worker_id : bool;
mutable commands : bool;
mutable temporary_file_mode : temporary_file_mode;
mutable keep_going : bool;
mutable files_to_run : string list;
mutable files_not_to_run : string list;
mutable tests_to_run : string list;
mutable tests_not_to_run : string list;
mutable patterns_to_run : Base.rex list;
mutable patterns_not_to_run : Base.rex list;
mutable tags_to_run : string list;
mutable tags_not_to_run : string list;
mutable list : [ `Ascii_art | `Tsv ] option;
mutable global_timeout : float option;
mutable test_timeout : float option;
mutable retry : int;
mutable reset_regressions : bool;
mutable on_unknown_regression_files_mode : on_unknown_regression_files_mode;
mutable loop_mode : loop_mode;
mutable time : bool;
mutable record : string option;
mutable from_records : string list;
mutable resume_file : string option;
mutable resume : bool;
mutable job : (int * int) option;
mutable job_count : int;
mutable suggest_jobs : bool;
mutable junit : string option;
mutable skip : int;
mutable only : int option;
mutable test_args : string Base.String_map.t;
mutable seed : int option;

}

Command-line options.

log_file is Some channel where channel is open on filename if --log-file filename was specified on the command line. channel is automatically replaced by another channel if init is called again with --log-file. channel is automatically closed either when replaced by another one or at exit.

val options : options

Values for command-line options.

val set_log_file : string -> unit

val get : ?default:'a -> (string -> 'a option) -> string -> 'a

Get the value for a parameter specified with --test-arg.

Usage: get parse parameter

If --test-arg parameter=value was specified on the command-line, this calls parse on value. If parse returns None, this fails. If parse returns Some x, this returns x.

If no value for parameter was specified on the command-line, this returns default if default was specified. Else, this fails.

It is recommended to make it so that specifying parameters with --test-arg is not mandatory for everyday use. This means it is recommended to always give default values, and that those default values should be suitable for typical test runs. For parameters that can take a small number of values, it is usually better to register multiple tests, one for each possible value, and to use tags to select from the command-line.

raises Failure
if parse returns None or if parameter was not specified on the command-line using --test-arg and no default value was provided.

val get_opt : (string -> 'a option) -> string -> 'a option

Same as get parse parameter but return None if parameter is absent.

val get_bool : ?default:bool -> string -> bool

Same as get bool_of_string_opt.

val get_bool_opt : string -> bool option

Same as get_opt bool_of_string_opt.

val get_int : ?default:int -> string -> int

Same as get int_of_string_opt.

val get_int_opt : string -> int option

Same as get_opt int_of_string_opt.

val get_float : ?default:float -> string -> float

Same as get float_of_string_opt.

val get_float_opt : string -> float option

Same as get_opt float_of_string_opt.

val get_string : ?default:string -> string -> string

Same as get (fun x -> Some x).

val get_string_opt : string -> string option

Same as get_opt (fun x -> Some x).

package tezt