Skip to contentSkip to conversation

test-lib: set GIT_CEILING_DIRECTORIES to protect the surrounding repository

PATCH Superseded SZEDER Gábor 3 participants 6 messages Aug 28, 2021 – Sep 1, 2021

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 test-lib: set GIT_CEILING_DIRECTORIES to protect the surrounding repository

Every once in a while a test somehow manages to escape from its trash directory and modifies the surrounding repository, whether because of a bug in git itself, a bug in a test [1], or e.g. when trying to run tests with a shell that is, in general, unable to run our tests [2].

Set GIT_CEILING_DIRECTORIES="$GIT_BUILD_DIR" as an additional safety measure to protect the surrounding repository at least from modifications by git commands executed in the tests (though it won't save us from regular shell commands, e.g. 'cd .. && rm -f ...').

[1] e.g. https://public-inbox.org/git/[email protected]
[2] $ git symbolic-ref HEAD
refs/heads/master
$ ksh ./t2011-checkout-invalid-head.sh
[... a lot of "not ok" ...]
$ git symbolic-ref HEAD
refs/heads/other

(In short: 'ksh' doesn't support the 'local' builtin command, which is used by 'test_oid', causing it to return with error whenever called, leaving ZERO_OID set to empty, so when 'checkout main from invalid HEAD' runs 'echo $ZERO_OID >.git/HEAD' writes a corrupt (not invalid) HEAD, and subsequent git commands don't recognize the repository in the trash directory anymore, but operate on the surrounding repo.)

---
 t/test-lib.sh | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)
t/test-lib.sh +2 -1
index abcfbed6d6..a1e0182c2f 100644
@@ -1343,7 +1343,8 @@ fi
 GIT_TEMPLATE_DIR="$GIT_BUILD_DIR"/templates/blt
 GIT_CONFIG_NOSYSTEM=1
 GIT_ATTR_NOSYSTEM=1
-export PATH GIT_EXEC_PATH GIT_TEMPLATE_DIR GIT_CONFIG_NOSYSTEM GIT_ATTR_NOSYSTEM
+GIT_CEILING_DIRECTORIES="$GIT_BUILD_DIR"
+export PATH GIT_EXEC_PATH GIT_TEMPLATE_DIR GIT_CONFIG_NOSYSTEM GIT_ATTR_NOSYSTEM GIT_CEILING_DIRECTORIES
 
 if test -z "$GIT_TEST_CMP"
 then
Signature · 1 line
2.33.0.358.g803110d36e
#1 lore raw

t/test-lib.sh fi · line 1346

Quoted 10 lines · SZEDER Gábor
t/test-lib.sh +1 -1
index abcfbed6d6..a1e0182c2f 100644
@@ -1343,7 +1343,8 @@ fi
 GIT_TEMPLATE_DIR="$GIT_BUILD_DIR"/templates/blt
 GIT_CONFIG_NOSYSTEM=1
 GIT_ATTR_NOSYSTEM=1
-export PATH GIT_EXEC_PATH GIT_TEMPLATE_DIR GIT_CONFIG_NOSYSTEM GIT_ATTR_NOSYSTEM
+GIT_CEILING_DIRECTORIES="$GIT_BUILD_DIR"

this wouldn't work as expected with --root and would be IMHO safer anyway if using instead

GIT_CEILING_DIRECTORIES="$TRASH_DIRECTORY/.."

Carlo

#2 lore raw
Quoted 15 lines · Carlo Arenas

t/test-lib.sh fi · line 1346

Quoted 10 lines · SZEDER Gábor
t/test-lib.sh +1 -1
index abcfbed6d6..a1e0182c2f 100644
@@ -1343,7 +1343,8 @@ fi
 GIT_TEMPLATE_DIR="$GIT_BUILD_DIR"/templates/blt
 GIT_CONFIG_NOSYSTEM=1
 GIT_ATTR_NOSYSTEM=1
-export PATH GIT_EXEC_PATH GIT_TEMPLATE_DIR GIT_CONFIG_NOSYSTEM GIT_ATTR_NOSYSTEM
+GIT_CEILING_DIRECTORIES="$GIT_BUILD_DIR"

this wouldn't work as expected with --root and would be IMHO safer anyway if using instead

Quoted 1 line

GIT_CEILING_DIRECTORIES="$TRASH_DIRECTORY/.."

Thanks, I completely forgot about '--root'.

#3 lore raw

PATCH v2 1/1 test-lib: set GIT_CEILING_DIRECTORIES to protect the surrounding repository

In reply to SZEDER Gábor

Every once in a while a test somehow manages to escape from its trash directory and modifies the surrounding repository, whether because of a bug in git itself, a bug in a test [1], or e.g. when trying to run tests with a shell that is, in general, unable to run our tests [2].

Set GIT_CEILING_DIRECTORIES="$TRASH_DIRECTORY/.." as an additional safety measure to protect the surrounding repository at least from modifications by git commands executed in the tests (assuming that handling of ceiling directories during repository discovery is not broken, and, of course, it won't save us from regular shell commands, e.g. 'cd .. && rm -f ...').

[1] e.g. https://public-inbox.org/git/[email protected]
[2] $ git symbolic-ref HEAD
refs/heads/master
$ ksh ./t2011-checkout-invalid-head.sh
[... a lot of "not ok" ...]
$ git symbolic-ref HEAD
refs/heads/other

(In short: 'ksh' doesn't support the 'local' builtin command, which is used by 'test_oid', causing it to return with error whenever it's called, leaving ZERO_OID set to empty, so when the test 'checkout main from invalid HEAD' runs 'echo $ZERO_OID >.git/HEAD' it writes a corrupt (not invalid) HEAD, and subsequent git commands don't recognize the repository in the trash directory anymore, but operate on the surrounding repo.)

---
Changes since v1:
- Set "$TRASH_DIRECTORY/.." instead of $GIT_BUILD_DIR.
- Minor commit message tweaks.

 t/test-lib.sh | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)
t/test-lib.sh +2 -1
index abcfbed6d6..fc1e521519 100644
@@ -1343,7 +1343,8 @@ fi
 GIT_TEMPLATE_DIR="$GIT_BUILD_DIR"/templates/blt
 GIT_CONFIG_NOSYSTEM=1
 GIT_ATTR_NOSYSTEM=1
-export PATH GIT_EXEC_PATH GIT_TEMPLATE_DIR GIT_CONFIG_NOSYSTEM GIT_ATTR_NOSYSTEM
+GIT_CEILING_DIRECTORIES="$TRASH_DIRECTORY/.."
+export PATH GIT_EXEC_PATH GIT_TEMPLATE_DIR GIT_CONFIG_NOSYSTEM GIT_ATTR_NOSYSTEM GIT_CEILING_DIRECTORIES
 
 if test -z "$GIT_TEST_CMP"
 then
Signature · 1 line
2.33.0.361.g6f8e582daa
#4 lore raw
Quoted 42 lines · SZEDER Gábor

Every once in a while a test somehow manages to escape from its trash directory and modifies the surrounding repository, whether because of a bug in git itself, a bug in a test [1], or e.g. when trying to run tests with a shell that is, in general, unable to run our tests [2].

Set GIT_CEILING_DIRECTORIES="$TRASH_DIRECTORY/.." as an additional safety measure to protect the surrounding repository at least from modifications by git commands executed in the tests (assuming that handling of ceiling directories during repository discovery is not broken, and, of course, it won't save us from regular shell commands, e.g. 'cd .. && rm -f ...').

[1] e.g. https://public-inbox.org/git/[email protected]
[2] $ git symbolic-ref HEAD
refs/heads/master
$ ksh ./t2011-checkout-invalid-head.sh
[... a lot of "not ok" ...]
$ git symbolic-ref HEAD
refs/heads/other

(In short: 'ksh' doesn't support the 'local' builtin command, which is used by 'test_oid', causing it to return with error whenever it's called, leaving ZERO_OID set to empty, so when the test 'checkout main from invalid HEAD' runs 'echo $ZERO_OID >.git/HEAD' it writes a corrupt (not invalid) HEAD, and subsequent git commands don't recognize the repository in the trash directory anymore, but operate on the surrounding repo.)

---
Changes since v1:
- Set "$TRASH_DIRECTORY/.." instead of $GIT_BUILD_DIR.
- Minor commit message tweaks.

 t/test-lib.sh | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)
t/test-lib.sh +0 -0
index abcfbed6d6..fc1e521519 100644

t/test-lib.sh fi · line 1350

Quoted 9 lines
t/test-lib.sh +2 -1
@@ -1343,7 +1343,8 @@ fi
 GIT_TEMPLATE_DIR="$GIT_BUILD_DIR"/templates/blt
 GIT_CONFIG_NOSYSTEM=1
 GIT_ATTR_NOSYSTEM=1
-export PATH GIT_EXEC_PATH GIT_TEMPLATE_DIR GIT_CONFIG_NOSYSTEM GIT_ATTR_NOSYSTEM
+GIT_CEILING_DIRECTORIES="$TRASH_DIRECTORY/.."
+export PATH GIT_EXEC_PATH GIT_TEMPLATE_DIR GIT_CONFIG_NOSYSTEM GIT_ATTR_NOSYSTEM GIT_CEILING_DIRECTORIES
 
 if test -z "$GIT_TEST_CMP"
 then

For what it's worth I'm very happy with this, and have been running this in my own daily build of git, I've occasionally ran into e.g. needing to manually clean up my own git.git's config file because some test escaped its trash directory.

#5 lore raw
Quoted 15 lines · Ævar Arnfjörð Bjarmason
Quoted 11 lines · SZEDER Gábor

Every once in a while a test somehow manages to escape from its trash directory and modifies the surrounding repository, whether because of a bug in git itself, a bug in a test [1], or e.g. when trying to run tests with a shell that is, in general, unable to run our tests [2].

Set GIT_CEILING_DIRECTORIES="$TRASH_DIRECTORY/.." as an additional safety measure to protect the surrounding repository at least from modifications by git commands executed in the tests (assuming that handling of ceiling directories during repository discovery is not broken, and, of course, it won't save us from regular shell commands, e.g. 'cd .. && rm -f ...').

Quoted 4 lines

For what it's worth I'm very happy with this, and have been running this in my own daily build of git, I've occasionally ran into e.g. needing to manually clean up my own git.git's config file because some test escaped its trash directory.

Thanks, that's a good point.

After a test escapes from its trash directory I routinely check the content of the work tree and look for stray refs, but it never occured to me that I should look at the config, too. And indeed, at the bottom of .git/config there are two config variables that I don't remember setting (actually don't even know what they do).