From c8ba567c231342200bf60e3bf8b5c8e6878ca076 Mon Sep 17 00:00:00 2001 From: Nick Tobey Date: Mon, 4 Dec 2023 11:59:09 -0800 Subject: [PATCH] Add comments to BATS test. --- integration-tests/bats/performance.bats | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/integration-tests/bats/performance.bats b/integration-tests/bats/performance.bats index d08c81ebe4..a3b397b432 100644 --- a/integration-tests/bats/performance.bats +++ b/integration-tests/bats/performance.bats @@ -1,6 +1,12 @@ #!/usr/bin/env bats load $BATS_TEST_DIRNAME/helper/common.bash +# This BATS test attempts to detect performance regressions when using standard workflows on large datasets. +# Please note that this is a rough approach that is not designed to detect all performance issues, merely an extra +# safeguard against bugs that cause large (order-of-magnitude+) regressions. + +# BATS_TEST_TIMEOUT is measured in seconds and is chosen to be high enough that all tests in this suite pass +# when running on GitHub's CI, but low enough that an order-of magnitude regression will cause them to fail. BATS_TEST_TIMEOUT=50 # This function was used to create the dolt repo used for this test. It is not run during testing.