package octez-libs

You can search for identifiers within the package.

in-package search v0.2.0

Package contains no libraries

include module type of Tezt.Regression

Regression test helpers (run tests, capture output, etc).

val 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.

val hooks : Tezt_core.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.

val register : 
  __FILE__:string ->
  title:string ->
  tags:string list ->
  ?uses:Uses.t list ->
  ?uses_node:bool ->
  ?uses_client:bool ->
  ?uses_admin_client:bool ->
  ?file:string ->
  (unit -> unit Lwt.t) ->
  unit

Wrapper over Tezt.Regression.register that checks test dependencies (?uses).