git/list[1] front-page[2] threads[3] people[4] search[5] about
 

[PATCH v2] test: fix for TEST_OUTPUT_DIRECTORY

From
Felipe Contreras <felipe.contreras@gmail.com>
Date
Jun 15, 2021, 18:31 UTC
Message-ID
<20210615183157.104999-1-felipe.contreras@gmail.com>

The test_atexit unit test relies on the specific location of the generated files.

When TEST_OUTPUT_DIRECTORY is unset, _run_sub_test_lib_test_common sets it to pwd, which is two levels under the pwd of the parent unit test, and the parent can find the generated files just fine.

But when TEST_OUTPUT_DIRECTORY is set, it's stored in GIT-BUILD-OPTIONS, and even though _run_sub_test_lib_test_common correctly overrides it, when the child script is run it sources GIT-BUILD-OPTIONS and TEST_OUTPUT_DIRECTORY is overridden.

Effectively both the parent and child scripts output to the same directory.

  make TEST_OUTPUT_DIRECTORY=/tmp/foobar GIT-BUILD-OPTIONS &&
  make -C t t0000-basic.sh

We could try to specify --root, as 6883047071 (t0000: set TEST_OUTPUT_DIRECTORY for sub-tests, 2013-12-28) suggested, but then the results of subtests would leak out because TEST_RESULTS_DIR would not be changed from the parent.

Instead, let's revert part of 2d14e13c56 (test output: respect $TEST_OUTPUT_DIRECTORY, 2013-04-29) by removing TEST_OUTPUT_DIRECTORY from GIT-BUILD-OPTIONS.

It's unclear how much value t/valgrind/analyze.sh provides today, but users of that script that use TEST_OUTPUT_DIRECTORY as well can simply call the script with that variable in the environment.

It doesn't make much sense to break t0000-basic.sh for users of TEST_OUTPUT_DIRECTORY, just to provide a little convenience for the users of t/valgrind/analyze.sh.

Presumably this was broken since 900721e15c (test-lib: introduce 'test_atexit', 2019-03-13).

Cc: John Keeping <john@keeping.me.uk>
Cc: Johannes Schindelin <Johannes.Schindelin@gmx.de>
Helped-by: Jeff King <peff@peff.net>
Signed-off-by: Felipe Contreras <felipe.contreras@gmail.com>
---

Since v1 I completely changed the approach and instead of using --root which leaks test results, I remove TEST_OUTPUT_DIRECTORY from GIT-BUILD-OPTIONS.

Apparently only people who would care are the users of t/valgrind/analyze.sh which now would need to specify that variable themselves.

Marginal convenience for the users of an obscure script is not a good reason to break t0000-basic.sh.

Range-diff against v1: 1: 04047359b9 < -: ---------- test: fix for TEST_OUTPUT_DIRECTORY -: ---------- > 1: d8430aee08 test: fix for TEST_OUTPUT_DIRECTORY

 Makefile              | 3 ---
 t/valgrind/analyze.sh | 3 ---
 2 files changed, 6 deletions(-)
diff --git a/Makefile b/Makefile
index c3565fc0f8..2e25489569 100644
--- a/Makefile
+++ b/Makefile
@@ -2790,9 +2790,6 @@ GIT-BUILD-OPTIONS: FORCE
 	@echo PAGER_ENV=\''$(subst ','\'',$(subst ','\'',$(PAGER_ENV)))'\' >>$@+
 	@echo DC_SHA1=\''$(subst ','\'',$(subst ','\'',$(DC_SHA1)))'\' >>$@+
 	@echo X=\'$(X)\' >>$@+
-ifdef TEST_OUTPUT_DIRECTORY
-	@echo TEST_OUTPUT_DIRECTORY=\''$(subst ','\'',$(subst ','\'',$(TEST_OUTPUT_DIRECTORY)))'\' >>$@+
-endif
 ifdef GIT_TEST_OPTS
 	@echo GIT_TEST_OPTS=\''$(subst ','\'',$(subst ','\'',$(GIT_TEST_OPTS)))'\' >>$@+
 endif
diff --git a/t/valgrind/analyze.sh b/t/valgrind/analyze.sh
index 2ffc80f721..378d0a8daa 100755
--- a/t/valgrind/analyze.sh
+++ b/t/valgrind/analyze.sh
@@ -1,8 +1,5 @@
 #!/bin/sh
 
-# Get TEST_OUTPUT_DIRECTORY from GIT-BUILD-OPTIONS if it's there...
-. "$(dirname "$0")/../../GIT-BUILD-OPTIONS"
-# ... otherwise set it to the default value.
 : ${TEST_OUTPUT_DIRECTORY=$(dirname "$0")/..}
 
 output=
-- 
2.32.0
Next: Ævar Arnfjörð Bjarmason
Message 1 of 2 in “test: fix for TEST_OUTPUT_DIRECTORY”
  1. test: fix for TEST_OUTPUT_DIRECTORYFelipe Contreras, Jun 15, 2021
  2. Ævar Arnfjörð BjarmasonJun 15, 2021

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.