From bd12ec8ca48c3d4e1b92b6055bda4bba986acf64 Mon Sep 17 00:00:00 2001 From: Michal Domonkos Date: Mon, 27 Jan 2025 16:12:35 +0100 Subject: [PATCH] Add note on ASAN/UBSAN affecting test performance This came up while submitting #3540. (backported from commit ad336706822519f5403504b68569ee6ee0324620) --- tests/README.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/tests/README.md b/tests/README.md index 330887620e..87dcf8028d 100644 --- a/tests/README.md +++ b/tests/README.md @@ -159,6 +159,15 @@ as well as the existing tests. Below are the specifics of RPM's test-suite: ### Tips & Tricks +* If you've configured your CMake build with the `ENABLE_ASAN` and/or + `ENABLE_UBSAN` options enabled (OFF by default), the test-suite will run + significantly slower, increasing the total execution time by as much as 2 + minutes on modern hardware. If this is an issue, consider setting up a + separate CMake build on the side without these options enabled and use that + for running the test-suite iteratively. Before submitting a PR, though, + please verify that the test-suite still passes with those options enabled + (the easiest way is to run `make ci`). + * Sometimes, you may need to specify a literal square bracket, such as in RPM commands using `--qf` format strings. Do that by wrapping the whole script (or expected output) in double square brackets, for example: