Skip to content

Commit

Permalink
tests: add a proper readme
Browse files Browse the repository at this point in the history
  • Loading branch information
rjbou committed Aug 29, 2024
1 parent b14aea0 commit a60d566
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions tests/readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Opam test suite

There is 3 different kind of tests
* CRAM test in `reftests`. It is used to check opam behaviour. See
`reftests/readme.md` for more details.
* Bench tests in `bench`, using
[current-bench](https://github.com/ocurrent/current-bench). It is used to
bench some specific operations.
* OCaml tests in `lib`. For the moment it is used to check some type
manipulation and patch code.

There is also other tests:
* [`opam-rt`](https://github.com/ocaml-opam/opam-rt): historical test suite. it
is a mix of opam cli calls and library usage. It is meant to be removed once
all test has been ported to `reftests` and `lib`
* [`opam-crowbar`](https://github.com/ocaml/opam/blob/master/src/crowbar/opam-crowbar.opam):
some fuzz testing of some opam library main types.

0 comments on commit a60d566

Please # to comment.