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

[PATCH] t0000: fix test if run with TEST_OUTPUT_DIRECTORY

From
Patrick Steinhardt <ps@pks.im>
Date
Jul 20, 2021, 06:32 UTC
Message-ID
<44006e7b0bdda50dc51153cc2efb6ae954d4eecb.1626762728.git.ps@pks.im>
In-Reply-To
<60f5d923848d3_145c71208cc@natae.notmuch>

Testcases in t0000 are quite special given that they many of them run nested testcases to verify that testing functionality itself works as expected. These nested testcases are realized by writing a new ad-hoc test script which again sources test-lib.sh, where the new script is created in a nested subdirectory located beneath the current trash directory. We then execute the new test script with the nested subdirectory as current working directory and explicitly re-export TEST_OUTPUT_DIRECTORY to point to that directory.

While this works as expected in the general case, it falls apart when the developer has TEST_OUTPUT_DIRECTORY explicitly defined either via the environment or via config.mak. In that case, test-lib.sh will clobber the value that we've just carefully set up to instead contain what the developer has defined. As a result, the TEST_OUTPUT_DIRECTORY continues to point at the root output directory, not at the nested one.

This issue causes breakage in the 'test_atexit is run' test case: the nested test case writes files into "../../", which is assumed to be the parent's trash directory. But because TEST_OUTPUT_DIRECTORY already points to to the root output directory, we instead end up writing those files outside of the output directory. The parent test case will then try to check whether those files still exist in its own trash directory, which thus must fail now.

Fix the issue by adding a new TEST_OUTPUT_DIRECTORY_OVERRIDE variable. If set, then we'll always override the TEST_OUTPUT_DIRECTORY with its value after sourcing GIT-BUILD-OPTIONS.

Signed-off-by: Patrick Steinhardt <ps@pks.im>
---
 t/t0000-basic.sh | 7 +++++--
 t/test-lib.sh    | 9 +++++++++
 2 files changed, 14 insertions(+), 2 deletions(-)
diff --git a/t/t0000-basic.sh b/t/t0000-basic.sh
index 2c6e34b947..09d2202748 100755
--- a/t/t0000-basic.sh
+++ b/t/t0000-basic.sh
@@ -89,8 +89,11 @@ _run_sub_test_lib_test_common () {
 		EOF
 		cat >>"$name.sh" &&
 		export TEST_DIRECTORY &&
-		TEST_OUTPUT_DIRECTORY=$(pwd) &&
-		export TEST_OUTPUT_DIRECTORY &&
+		# The child test re-sources GIT-BUILD-OPTIONS and may thus
+		# override the test output directory. We thus pass it as an
+		# explicit override to the child.
+		TEST_OUTPUT_DIRECTORY_OVERRIDE=$(pwd) &&
+		export TEST_OUTPUT_DIRECTORY_OVERRIDE &&
 		sane_unset GIT_TEST_FAIL_PREREQS &&
 		if test -z "$neg"
 		then
diff --git a/t/test-lib.sh b/t/test-lib.sh
index 9e26860544..da13190970 100644
--- a/t/test-lib.sh
+++ b/t/test-lib.sh
@@ -57,6 +57,15 @@ fi
 . "$GIT_BUILD_DIR"/GIT-BUILD-OPTIONS
 export PERL_PATH SHELL_PATH
 
+# In t0000, we need to override test directories of nested testcases. In case
+# the developer has TEST_OUTPUT_DIRECTORY part of his build options, then we'd
+# reset this value to instead contain what the developer has specified. We thus
+# have this knob to allow overriding the directory.
+if test -n "${TEST_OUTPUT_DIRECTORY_OVERRIDE}"
+then
+	TEST_OUTPUT_DIRECTORY="${TEST_OUTPUT_DIRECTORY_OVERRIDE}"
+fi
+
 # Disallow the use of abbreviated options in the test suite by default
 if test -z "${GIT_TEST_DISALLOW_ABBREVIATED_OPTIONS}"
 then
-- 
2.32.0
Previous: Felipe ContrerasNext: Jeff King
Message 40 of 43 in “What's cooking in git.git (Jul 2021, #03; Tue, 13)”
  1. Junio C HamanoJul 14, 2021
  2. Eric SunshineJul 14, 2021
  3. Junio C HamanoJul 14, 2021
  4. Eric SunshineJul 14, 2021
  5. Junio C HamanoJul 14, 2021
  6. Han-Wen NienhuysJul 14, 2021
  7. Ævar Arnfjörð BjarmasonJul 14, 2021
  8. Ævar Arnfjörð BjarmasonJul 14, 2021
  9. Junio C HamanoJul 14, 2021
  10. Derrick StoleeJul 14, 2021
  11. Ævar Arnfjörð BjarmasonJul 14, 2021
  12. CodingGuidelines: recommend gender-neutral descriptionJunio C Hamano, Jul 15, 2021
  13. Eric SunshineJul 15, 2021
  14. Taylor BlauJul 15, 2021
  15. Junio C HamanoJul 15, 2021
  16. Felipe ContrerasJul 16, 2021
  17. Derrick StoleeJul 15, 2021
  18. Johannes SchindelinJul 16, 2021
  19. Felipe ContrerasJul 16, 2021
  20. CodingGuidelines: recommend gender-neutral descriptionJunio C Hamano, Jul 16, 2021
  21. Derrick StoleeJul 16, 2021
  22. Ævar Arnfjörð BjarmasonJul 16, 2021
  23. Junio C HamanoJul 16, 2021
  24. Felipe ContrerasJul 16, 2021
  25. Bagas SanjayaAug 12, 2021
  26. Taylor BlauJul 14, 2021
  27. Patrick SteinhardtJul 19, 2021
  28. Felipe ContrerasJul 19, 2021
  29. Jeff KingJul 19, 2021
  30. Felipe ContrerasJul 19, 2021
  31. Patrick SteinhardtJul 19, 2021
  32. Felipe ContrerasJul 19, 2021
  33. Jeff KingJul 19, 2021
  34. Patrick SteinhardtJul 19, 2021
  35. Jeff KingJul 19, 2021
  36. Junio C HamanoJul 19, 2021
  37. Felipe ContrerasJul 19, 2021
  38. Patrick SteinhardtJul 20, 2021
  39. Felipe ContrerasJul 20, 2021
  40. t0000: fix test if run with TEST_OUTPUT_DIRECTORYPatrick Steinhardt, Jul 20, 2021
  41. Jeff KingJul 20, 2021
  42. Junio C HamanoJul 20, 2021
  43. Felipe ContrerasJul 20, 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.