xref: /freebsd/sys/contrib/zstd/TESTING.md (revision d34048812292b714a0bf99967270d18fe3097c62)
1Testing
2=======
3
4Zstandard CI testing is split up into three sections:
5short, medium, and long tests.
6
7Short Tests
8-----------
9Short tests run on CircleCI for new commits on every branch and pull request.
10They consist of the following tests:
11- Compilation on all supported targets (x86, x86_64, ARM, AArch64, PowerPC, and PowerPC64)
12- Compilation on various versions of gcc, clang, and g++
13- `tests/playTests.sh` on x86_64, without the tests on long data (CLI tests)
14- Small tests (`tests/legacy.c`, `tests/longmatch.c`, `tests/symbols.c`) on x64_64
15
16Medium Tests
17------------
18Medium tests run on every commit and pull request to `dev` branch, on TravisCI.
19They consist of the following tests:
20- The following tests run with UBsan and Asan on x86_64 and x86, as well as with
21  Msan on x86_64
22  - `tests/playTests.sh --test-long-data`
23  - Fuzzer tests: `tests/fuzzer.c`, `tests/zstreamtest.c`, and `tests/decodecorpus.c`
24- `tests/zstreamtest.c` under Tsan (streaming mode, including multithreaded mode)
25- Valgrind Test (`make -C tests valgrindTest`) (testing CLI and fuzzer under valgrind)
26- Fuzzer tests (see above) on ARM, AArch64, PowerPC, and PowerPC64
27
28Long Tests
29----------
30Long tests run on all commits to `master` branch,
31and once a day on the current version of `dev` branch,
32on TravisCI.
33They consist of the following tests:
34- Entire test suite (including fuzzers and some other specialized tests) on:
35  - x86_64 and x86 with UBsan and Asan
36  - x86_64 with Msan
37  - ARM, AArch64, PowerPC, and PowerPC64
38- Streaming mode fuzzer with Tsan (for the `zstdmt` testing)
39- ZlibWrapper tests, including under valgrind
40- Versions test (ensuring `zstd` can decode files from all previous versions)
41- `pzstd` with asan and tsan, as well as in 32-bits mode
42- Testing `zstd` with legacy mode off
43- Testing `zbuff` (old streaming API)
44- Entire test suite and make install on macOS
45