From: "Rubén Justo" <rjusto@gmail.com>
To: Git List <git@vger.kernel.org>, Jeff King <peff@peff.net>
Subject: [PATCH] test-lib: GIT_TEST_SANITIZE_LEAK_LOG enabled by default
Date: Wed, 10 Jul 2024 02:51:58 +0200 [thread overview]
Message-ID: <598149bf-6541-4c9e-8c94-a108e3ee7fd7@gmail.com> (raw)
As we describe in t/README, it can happen that:
Some tests run "git" (or "test-tool" etc.) without properly checking
the exit code, or git will invoke itself and fail to ferry the
abort() exit code to the original caller.
Therefore, GIT_TEST_SANITIZE_LEAK_LOG must be set to true to capture all
memory leaks triggered by the tests when SANITIZE=leak.
Set it to true by default, and stop worrying about someone checking for
leaks who isn't aware of this option and might be missing some leaks.
Signed-off-by: Rubén Justo <rjusto@gmail.com>
---
ci/lib.sh | 1 -
t/README | 4 ++--
t/test-lib.sh | 2 +-
3 files changed, 3 insertions(+), 4 deletions(-)
diff --git a/ci/lib.sh b/ci/lib.sh
index ff66ad356b..fe52954828 100755
--- a/ci/lib.sh
+++ b/ci/lib.sh
@@ -374,7 +374,6 @@ linux-musl)
linux-leaks|linux-reftable-leaks)
export SANITIZE=leak
export GIT_TEST_PASSING_SANITIZE_LEAK=true
- export GIT_TEST_SANITIZE_LEAK_LOG=true
;;
linux-asan-ubsan)
export SANITIZE=address,undefined
diff --git a/t/README b/t/README
index d9e0e07506..1c97bc3331 100644
--- a/t/README
+++ b/t/README
@@ -382,10 +382,10 @@ mapping between "TEST_PASSES_SANITIZE_LEAK=true"
and those tests that
pass under "SANITIZE=leak". This is especially useful when testing a
series that fixes various memory leaks with "git rebase -x".
-GIT_TEST_SANITIZE_LEAK_LOG=true will log memory leaks to
+GIT_TEST_SANITIZE_LEAK_LOG=<boolean> controls logging of memory leaks to
"test-results/$TEST_NAME.leak/trace.*" files. The logs include a
"dedup_token" (see +"ASAN_OPTIONS=help=1 ./git") and other options to
-make logs +machine-readable.
+make logs +machine-readable. Defaults to "true" when SANITIZE=leak.
With GIT_TEST_SANITIZE_LEAK_LOG=true we'll look at the leak logs
before exiting and exit on failure if the logs showed that we had a
diff --git a/t/test-lib.sh b/t/test-lib.sh
index 7ed6d3fc47..1dd2ea4e07 100644
--- a/t/test-lib.sh
+++ b/t/test-lib.sh
@@ -1578,7 +1578,7 @@ then
test_done
fi
- if test_bool_env GIT_TEST_SANITIZE_LEAK_LOG false
+ if test_bool_env GIT_TEST_SANITIZE_LEAK_LOG true
then
if ! mkdir -p "$TEST_RESULTS_SAN_DIR"
then
--
2.45.1
next reply other threads:[~2024-07-10 0:52 UTC|newest]
Thread overview: 10+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-07-10 0:51 Rubén Justo [this message]
2024-07-10 1:12 ` [PATCH] test-lib: GIT_TEST_SANITIZE_LEAK_LOG enabled by default Jeff King
2024-07-22 7:52 ` Patrick Steinhardt
2024-07-10 2:30 ` [PATCH v2] " Rubén Justo
2024-07-10 3:58 ` Junio C Hamano
2024-07-10 4:46 ` Rubén Justo
2024-07-10 7:16 ` Jeff King
2024-07-11 14:03 ` Rubén Justo
2024-07-11 14:10 ` [PATCH v3] " Rubén Justo
2024-07-17 7:02 ` Jeff King
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=598149bf-6541-4c9e-8c94-a108e3ee7fd7@gmail.com \
--to=rjusto@gmail.com \
--cc=git@vger.kernel.org \
--cc=peff@peff.net \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).