From 285a5086ca5439f0c3c0cb0d49d1d2f2c5ca677b Mon Sep 17 00:00:00 2001 From: Michael Vetter Date: Fri, 6 Mar 2026 09:53:49 +0100 Subject: [PATCH] docs: Add note about sanitizers overhead --- CONTRIBUTING.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d6e892c4..b21029f9 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -174,6 +174,11 @@ When adding a new test file: ### Running functional tests Functional tests use [stabber](https://github.com/profanity-im/stabber) to simulate an XMPP server. +**Performance Note:** It is highly recommended to run functional tests **without** sanitizers (**ASan** and **UBSan**). These sanitizers add significant overhead that can cause functional tests to time out or take an excessively long time to complete. + +* **Meson:** Ensure `-Db_sanitize=none` is set in your build configuration. You can check your current configuration with `meson configure build_run | grep b_sanitize`. +* **Autotools:** Ensure your `CFLAGS` does not contain `-fsanitize=address` or `-fsanitize=undefined`. + To run functional tests, you need the same dependencies as unit tests (`cmocka`) plus `stabber` and `libutil`. Functional tests will be automatically enabled if these dependencies are detected during configuration.