package tezt
Install
Dune Dependency
Authors
Maintainers
Sources
md5=88c2d9d3da75ff554599bc34cbf5acbe
sha512=e60294514ecc4a989ce663ebb306e56f654dcfaffb7dbe5e3f05f5a13c9c2ff64dadde4a77b0d9a8567a76a6a7a2b25e0940ccd2a956ffcb85ff9300bfebe3bc
doc/tezt.core/Tezt_core/Log/index.html
Module Tezt_core.LogSource
Tezt logs.
Quote or escape a string using shell syntax.
Quote or escape a command with arguments using shell syntax.
Colors
Logging
val log :
level:Cli.Logs.level ->
?color:Color.t ->
?prefix:string ->
('a, Format.formatter, unit, unit) format4 ->
'aLog a message if the log level requested on the command-line allows it.
See the documentation of Cli for a description of each log level and when to use them.
In tests, you should mostly use function info.
val debug :
?color:Color.t ->
?prefix:string ->
('a, Format.formatter, unit, unit) format4 ->
'aSame as log ~level:Debug.
val info :
?color:Color.t ->
?prefix:string ->
('a, Format.formatter, unit, unit) format4 ->
'aSame as log ~level:Info.
val report :
?color:Color.t ->
?prefix:string ->
('a, Format.formatter, unit, unit) format4 ->
'aSame as log ~level:Report.
Same as log ~level:Warn ~color:red ~prefix:"warn".
Same as log ~level:Error ~color:red ~prefix:"error".
Whether a test succeeded, failed or was aborted by the user.
Failed comes with the error message, which is a string version of the exception that was raised (usually with Test.fail). This message is unused by the Log module itself.
val test_result :
test_index:int ->
test_count:int ->
failure_count:int ->
iteration:int ->
test_result ->
string ->
unitLog the result of a test.
test_index is the index of the test, starting from 1. test_count is the total number of tests. failure_count is the total number of failures so far.
iteration is the index of the iteration count to display in --loop mode.
The string argument is the name of the test.
Log a command which will be run.
Log it with level Debug, and print it unconditionally with no timestamp if Cli.options.commands is true.
Set the worker id to print if --log-worker-ids is set.
Close the current log file, if any, and open another one.
By default, logs are output to Cli.Logs.file, if it is specified (with --log-file). One can use set_file to change this. This is in particular done automatically when using -j: each child process calls set_file to write to its own file.
Flush current log file, if any.