package tezt
Install
Dune Dependency
Authors
Maintainers
Sources
md5=81f699e653ce9fd71e11d3704638c98d
sha512=30fd97f8b2c5e1282d89c1c5dee3530d4e10e8c3a95abd281e8ecb8b2ee3c367eacb8e663ef445af2fdb0aa2d697d39d6284950b1bda35761c6a3b59e3f264b6
Description
Published: 05 Jun 2023
README
Tezt
Tezt (pronounced "tezty", as in "tasty" with a "z") is a test framework for OCaml. It is well suited for writing and executing unit, integration and regression tests. It integrates well with continuous integration (CI).
API Documentation
The API documentation contains an introduction to Tezt as well as documentation for all modules. It is generated from lib/tezt.ml
.
Getting Started
Install
Install with opam:
opam install tezt
Write a Test
Create a file such as test/main.ml
:
(* [Tezt] and its submodule [Base] are designed to be opened.
[Tezt] is the main module of the library and it only contains submodules,
such as [Test] which is used below.
[Tezt.Base] contains values such as [unit] which is used below. *)
open Tezt
open Tezt.Base
(* Register as many tests as you want like this. *)
let () =
Test.register
(* [~__FILE__] contains the name of the file in which the test is defined.
It allows to select tests to run based on their filename. *)
~__FILE__
(* Titles uniquely identify tests so that they can be individually selected. *)
~title: "demo"
(* Tags are another way to group tests together to select them. *)
~tags: [ "math"; "addition" ]
@@ fun () ->
(* Here is the actual test. *)
if 1 + 1 <> 2 then Test.fail "expected 1 + 1 = 2, got %d" (1 + 1);
(* Here is another way to write the same test. *)
Check.((1 + 1 = 2) int) ~error_msg: "expected 1 + 1 = %R, got %L";
Log.info "Math is safe today.";
(* [unit] is [Lwt.return ()]. *)
unit
(* Call the main function of Tezt so that it actually runs your tests. *)
let () = Test.run ()
Then create a test/dune
file:
(test (name main) (libraries tezt))
You can now run your test with dune runtest
. However dune runtest
is limited because you cannot pass command-line arguments. Usually, you would instead run something like:
dune exec test/main.exe -- -i
This should show you:
[09:04:06.395] Math is safe today.
[09:04:06.395] [SUCCESS] (1/1) demo
The -i
flag is a short-hand for --info
and sets the log level so that you can see the result of the call to Log.info
.
To see the list of command-line options, in particular how to select tests from the command-line, how to run them in parallel and how to produce reports, run:
dune exec test/main.exe -- --help
Dependencies (6)
Dev Dependencies (4)
-
ocamlformat
with-test & = "0.21.0"
-
js_of_ocaml-lwt
with-test
-
js_of_ocaml
with-test
-
conf-npm
with-test
Used by (55)
-
bam
< "0.2"
-
bls12-381
>= "18.0" & < "19.0"
-
dedukti
>= "2.7"
- diff
-
octez-alcotezt
< "19.0"
- octez-bls12-381-polynomial
-
octez-l2-libs
< "19.0"
-
octez-libs
< "19.0"
- octez-mec
- octez-polynomial
-
octez-proto-libs
< "19.0"
-
octez-protocol-017-PtNairob-libs
< "19.0"
-
octez-protocol-018-Proxford-libs
< "19.0"
-
octez-protocol-alpha-libs
< "19.0"
-
octez-shell-libs
< "19.0"
- octez-smart-rollup-wasm-benchmark-lib
- SourceCode_ASCII
-
tezos-baking-016-PtMumbai
>= "17.1"
- tezos-baking-017-PtNairob
-
tezos-baking-alpha
>= "17.1"
-
tezos-base
>= "17.1"
-
tezos-clic
>= "17.1"
-
tezos-client-016-PtMumbai
>= "17.1"
- tezos-client-017-PtNairob
-
tezos-client-alpha
>= "17.1"
-
tezos-client-base
>= "17.1"
-
tezos-client-base-unix
>= "17.1"
-
tezos-context
>= "17.1"
-
tezos-crypto
>= "17.1"
-
tezos-crypto-dal
>= "17.1"
-
tezos-error-monad
>= "17.1"
-
tezos-hacl
>= "17.1"
-
tezos-layer2-store
>= "17.1"
-
tezos-lwt-result-stdlib
>= "17.1"
-
tezos-mockup
>= "17.1"
-
tezos-p2p
>= "17.1"
-
tezos-protocol-environment
>= "17.1"
-
tezos-proxy
>= "17.1"
-
tezos-proxy-server-config
>= "17.1" & < "19.0"
-
tezos-requester
>= "17.1"
-
tezos-rpc-http-server
>= "17.1"
-
tezos-sapling
>= "17.1"
-
tezos-scoru-wasm-helpers
< "17.1"
-
tezos-shell
>= "17.1"
-
tezos-shell-services
>= "17.1"
-
tezos-signer-backends
>= "17.1"
-
tezos-stdlib
>= "17.1"
-
tezos-stdlib-unix
>= "17.1"
-
tezos-store
>= "17.1"
-
tezos-version
>= "17.1"
-
tezos-webassembly-interpreter
>= "17.1"
-
tezos-workers
>= "17.1"
- tezt-performance-regression
-
tezt-tezos
< "19.0"
- universo
Conflicts (2)
-
js_of_ocaml-lwt
< "4.0.0"
-
js_of_ocaml
< "4.0.0"