From a446fa33dcd29f582a2292766d9b1c7ea79a9143 Mon Sep 17 00:00:00 2001 From: Nick Terrell Date: Fri, 30 Oct 2020 13:55:52 -0700 Subject: [PATCH] [regression] Add README explaining the test --- tests/regression/README.md | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) create mode 100644 tests/regression/README.md diff --git a/tests/regression/README.md b/tests/regression/README.md new file mode 100644 index 000000000..bb36b1ddd --- /dev/null +++ b/tests/regression/README.md @@ -0,0 +1,28 @@ +# 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 +``` -- 2.47.2