package tezt
Install
Dune Dependency
Authors
Maintainers
Sources
md5=362773eb411d8a62fd3c6ec25c5a1f0e
sha512=c56c705b28f4399223576563f4ca0168c818adc57d9f0710cd1eaa5185fc26cf321de5f6f3ede7125ce5f5922c5e0456d3044c23acc6fa12b466fe23ca9d48a7
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.log_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.