t0017: clarify dubious test set-up

1ff750b1 (tests: make GIT_TEST_GETTEXT_POISON a boolean, 2019-06-21) added this test, in which "test-tool -C" is fed a name of a directory that does not exist, and expects that it dies because of a failure to read the configuration file(s), because the configuration setting is screwed up to contain mutual inclusion loop, before it notices that the directory to chdir into does not exist and dies. It is of dubious value to etch the current order of events, i.e., the configuration needs to be read that early (for initializing trace2 subsystem) before we even notice the lack of the directory and have a chance to fail, into stone. Indeed, if you completely compile out trace2 subsystem so that it does not even attempt to read the configuration that early, we would die with a different error message (i.e. "unable to chdir to 'cycle'") and this test will fail. At least give a bogus argument to "test-tool -C" a name that is clearly bogus to make sure we can more easily see what is going on with plenty of comments. We may want to remove this test altogether, instead, though. Signed-off-by: Junio C Hamano <gitster@pobox.com>

Junio C Hamano committed May 15, 2024 at 12:32 UTC 22f13e04146596f439bf6713f5872eec017f5438
1 file changed +8 -1
t/t0017-env-helper.sh
+8 -1
@@ -91,9 +91,16 @@ test_expect_success 'test-tool env-helper reads config thanks to trace2' '
91 git config -l 2>err &&
92 grep "exceeded maximum include depth" err &&
93
94 + # This validates that the assumption that we attempt to
95 + # read the configuration and fail very early in the start-up
96 + # sequence (due to trace2 subsystem), even before we notice
97 + # that the directory named with "test-tool -C" does not exist
98 + # and die. It is a dubious thing to test, though.
99 test_must_fail \
100 env HOME="$(pwd)/home" GIT_TEST_ENV_HELPER=true \
96 - test-tool -C cycle env-helper --type=bool --default=0 --exit-code GIT_TEST_ENV_HELPER 2>err &&
101 + test-tool -C no-such-directory \
102 + env-helper --type=bool --default=0 \
103 + --exit-code GIT_TEST_ENV_HELPER 2>err &&
104 grep "exceeded maximum include depth" err
105 '
106