package tezt

You can search for identifiers within the package.

in-package search v0.2.0

Test framework for unit tests, integration tests, and regression tests

Install

Dune Dependency

gitlab.com Readme Changelog Edit opam file Versions (7)

Authors

T

Tezos devteam

Maintainers

C

contact@tezos.com

Sources

tezt-4.2.0.tar.bz2

md5=7878acd788ae59f1a07d0392644f0fff

sha512=b9e8ce2576b0bc65870409380edf17b88656a985ceb9a438a84f479b51d6b30740acf7b035eccf7d122bf5227611bf15e888e607dcdbb1576b4383f12314dd49

doc/tezt.core/Tezt_core/Regression/index.html

Module `Tezt_core.Regression`Source

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

Source

val register : 
  __FILE__:string ->
  title:string ->
  tags:string list ->
  ?file:string ->
  (unit -> unit Lwt.t) ->
  unit

Register 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 variable DUNE_SOURCEROOT if available, else PWD if available, else using Sys.getcwd;
<DIR> is Filename.dirname __FILE__;
<BASE> is Filename.basename __FILE__;
<FILE> is ~file, which defaults to a sanitized and possibly truncated version of ~title.

Sourceval capture : ?eol:bool -> string -> unit

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.

Sourceval hooks : Process_hooks.t

Hooks that enable regression testing when attached to a process ran from a registered regression test function.

The hooks will capture the spawned command, its arguments and the output of its execution.