package tezt
Install
dune-project
Dependency
Authors
Maintainers
Sources
md5=15abf8d74a268d18dd42e539f894fbe8
sha512=fb30fc561a1e77f037a4ce7eb022345ef0620fa1ac3e16bd83b7f867ef3d0c0ff676255a967d3122e7ef25b22f4b0dc01fba9fe90fe1b486e68b268ba1e9a9c9
doc/tezt.core/Tezt_core/Regression/index.html
Module Tezt_core.RegressionSource
Run Tezt regression tests and capture their output.
NOTE: consider using dune cram when it becomes available: https://dune.readthedocs.io/en/stable/tests.html#cram-tests
val register :
__FILE__:string ->
title:string ->
tags:string list ->
?file:string ->
(unit -> unit Lwt.t) ->
unitRegister a regression test.
This function is a wrapper around Test.register. It adds the "regression" tag to the tags list provided by the argument.
Output which is captured (with capture) is recorded in a file named <ROOT>/<DIR>/expected/<BASE>/<FILE>.out where:
<ROOT>is the root directory of the project, read from environment variableDUNE_SOURCEROOTif available, elsePWDif available, else usingSys.getcwd;<DIR>isFilename.dirname __FILE__;<BASE>isFilename.basename __FILE__;<FILE>is~file, which defaults to a sanitized and possibly truncated version of~title.
Capture some output of a regression test.
Call this to record a string into the expected output file of the current test. A newline character \n will be added after it if eol is true (which is the default).
This function only records its argument when called while a regression test is running, i.e. from the body of Regression.register. If you call it outside of Regression.register, it has no effect. So you can define a function that captures and use it with or without regression testing.
A typical use is to define custom process hooks that substitute non-deterministic parts of the output with deterministic ones. See also hooks.