zstd/tests/regression
W. Felix Handte 1bc8019e10 Update results.csv 2022-05-11 10:27:35 -07:00
..
.gitignore fixed minor compression difference in btlazy2 2021-12-29 18:51:03 -08:00
Makefile [build] Add support for ASM files in Make + CMake 2021-09-17 14:13:53 -07:00
README.md [regression] Add README explaining the test 2020-10-30 13:55:52 -07:00
config.c Use new paramSwitch enum for LCM, row matchfinder, and block splitter 2021-09-21 14:22:02 -04:00
config.h [copyright][license] Switch to yearless copyright and some cleanup in the linux-kernel files 2021-03-30 10:30:43 -07:00
data.c [copyright][license] Switch to yearless copyright and some cleanup in the linux-kernel files 2021-03-30 10:30:43 -07:00
data.h [copyright][license] Switch to yearless copyright and some cleanup in the linux-kernel files 2021-03-30 10:30:43 -07:00
levels.h Use new paramSwitch enum for LCM, row matchfinder, and block splitter 2021-09-21 14:22:02 -04:00
method.c [copyright][license] Switch to yearless copyright and some cleanup in the linux-kernel files 2021-03-30 10:30:43 -07:00
method.h [copyright][license] Switch to yearless copyright and some cleanup in the linux-kernel files 2021-03-30 10:30:43 -07:00
result.c [copyright][license] Switch to yearless copyright and some cleanup in the linux-kernel files 2021-03-30 10:30:43 -07:00
result.h [copyright][license] Switch to yearless copyright and some cleanup in the linux-kernel files 2021-03-30 10:30:43 -07:00
results.csv Update results.csv 2022-05-11 10:27:35 -07:00
test.c [copyright][license] Switch to yearless copyright and some cleanup in the linux-kernel files 2021-03-30 10:30:43 -07:00

README.md

Regression tests

The regression tests run zstd in many scenarios and ensures that the size of the compressed results doesn't change. This helps us ensure that we don't accidentally regress zstd's compression ratio.

These tests get run every night by CircleCI. If the job fails you can read the diff printed by the job to ensure the change isn't a regression. If all is well you can download the results.csv artifact and commit the new results. Or you can rebuild it yourself following the instructions below.

Rebuilding results.csv

From the root of the zstd repo run:

# Build the zstd binary
make clean
make -j zstd

# Build the regression test binary
cd tests/regression
make clean
make -j test

# Run the regression test
./test --cache data-cache --zstd ../../zstd --output results.csv

# Check results.csv to ensure the new results are okay
git diff

# Then submit the PR