t1450: fix quoting of NUL byte when corrupting pack
PATCH 1/1 t1450: fix quoting of NUL byte when corrupting pack
We use
printf '\0'
to generate a NUL byte which we then dd into the packfile to ensure that we modify the first byte of the first object, thereby (probabilistically) invalidating the checksum. Except the single quotes we're using are interpreted to match with the ones we enclose the whole test in. So we actually execute
printf \0
and end up injecting the ASCII code for "0", 0x30, instead.
The comment right above this printf invocation says that "at least one of [the type bits] is not zero, so setting the first byte to 0 is sufficient". Substituting "0x30" for "0" in that comment won't do: we'd need to reason about which bits go where and just what the packfile looks like that we're modifying in this test.
Let's avoid all of that by actually executing
printf "\0"
to generate a NUL byte, as intended.
---
If my reading is correct, when we substitute 0x30, the type will be 3 (blob) and the size will be zero. So there might actually exist formally valid packfiles where this byte that we're modifying is already zero. What matters in the end is whether we might be using such a packfile in this exact test and from what I can tell, no, we won't be doing that.
t/t1450-fsck.sh | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
t/t1450-fsck.sh +1 -1
@@ -714,7 +714,7 @@ test_expect_success 'fsck fails on corrupt packfile' ' # at least one of which is not zero, so setting the first byte to 0 is # sufficient.) chmod a+w .git/objects/pack/pack-$pack.pack && - printf '\0' | dd of=.git/objects/pack/pack-$pack.pack bs=1 conv=notrunc seek=12 && + printf "\0" | dd of=.git/objects/pack/pack-$pack.pack bs=1 conv=notrunc seek=12 && test_when_finished "rm -f .git/objects/pack/pack-$pack.*" && remove_object $hsh &&
Signature · 1 line
2.28.0.81.ge8ab941b67
Quoted 20 lines · Martin Ågren
We use
printf '\0'
to generate a NUL byte which we then
ddinto the packfile to ensure that we modify the first byte of the first object, thereby (probabilistically) invalidating the checksum. Except the single quotes we're using are interpreted to match with the ones we enclose the whole test in. So we actually executeprintf \0
and end up injecting the ASCII code for "0",
0x30, instead.The comment right above this
printfinvocation says that "at least one of [the type bits] is not zero, so setting the first byte to 0 is sufficient". Substituting "0x30" for "0" in that comment won't do: we'd need to reason about which bits go where and just what the packfile looks like that we're modifying in this test.
Quoted 5 lines
Let's avoid all of that by actually executing
printf "\0"
to generate a NUL byte, as intended.
Thanks. Very well explained.
I wonder if it is an easy way to find similar problems without too much hand-parsing of the test scripts. Inside a modern test_expect_* that begins and ends the test body with a single quote, any line that has a single quote that is not quoted could be suspect, but that would probably give us too many false positive.
Quoted 25 lines
Signed-off-by Martin Ågren <[email protected]>---
If my reading is correct, when we substitute0x30, the type will be 3 (blob) and the size will be zero. So there might actually exist formally valid packfiles where this byte that we're modifying is already zero. What matters in the end is whether we might be using such a packfile in this exact test and from what I can tell, no, we won't be doing that.t/t1450-fsck.sh | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)t/t1450-fsck.sh +1
-1@@ -714,7 +714,7 @@ test_expect_success 'fsck fails on corrupt packfile' ' # at least one of which is not zero, so setting the first byte to 0 is # sufficient.) chmod a+w .git/objects/pack/pack-$pack.pack && - printf '\0' | dd of=.git/objects/pack/pack-$pack.pack bs=1 conv=notrunc seek=12 && + printf "\0" | dd of=.git/objects/pack/pack-$pack.pack bs=1 conv=notrunc seek=12 && test_when_finished "rm -f .git/objects/pack/pack-$pack.*" && remove_object $hsh &&
Quoted 6 lines · Junio C Hamano
I wonder if it is an easy way to find similar problems without too much hand-parsing of the test scripts. Inside a modern test_expect_* that begins and ends the test body with a single quote, any line that has a single quote that is not quoted could be suspect, but that would probably give us too many false positive.
I did some very crude hand-parsing and identified a few spots that looked needlessly complicated and where I could change or drop the quoting so that the code we see is the code we also execute. Patch below.
Some of those sites made me go "what is actually going on here?" which would be an argument for simplifying them. Others are more "maybe we should avoid those quote marks, but the test is obviously correct anyway".
So I didn't spot any other bugs (like the 0x30/NUL thing in my original patch), which is good, but also makes me not very motivated to invest in more advanced parsing.
Martin
-- >8 --
Subject: [PATCH] t: don't spuriously close & open quotes
If we write something like
test_expect_success 'sed a little' '
sed -e 's/hi/lo/' in >out
'
the human readers do not see what the shell eventually sees:
sed -e s/hi/lo/ in >out
In this example, this makes no real difference. But this can be confusing and can make the reader wonder whether we actually rely on that whole "close the quote, do some stuff, then start quoting again" and what is actually going on. It could potentially also be a bug in the test.
Change several such single quotes to use double quotes instead or, in a few cases, drop them altogether. These were identified using some crude grepping. We're not fixing any test bugs here, but we're hopefully making these tests slightly easier to grok and to maintain.
(There are legitimate use cases for closing a quote and opening a new one, e.g., both '\'' and '"'"' can be used to produce a literal single quote. I'm not touching any of those here.)
In t9401, tuck the redirecting ">" to the filename while we're touching those lines.
--- t/t1400-update-ref.sh | 2 +- t/t3501-revert-cherry-pick.sh | 4 ++-- t/t3507-cherry-pick-conflict.sh | 4 ++-- t/t4005-diff-rename-2.sh | 4 ++-- t/t4034-diff-words.sh | 2 +- t/t4104-apply-boundary.sh | 24 ++++++++++++------------ t/t4150-am.sh | 8 ++++---- t/t4200-rerere.sh | 2 +- t/t5302-pack-index.sh | 2 +- t/t5510-fetch.sh | 4 ++-- t/t5553-set-upstream.sh | 6 +++--- t/t6026-merge-attr.sh | 4 ++-- t/t7001-mv.sh | 2 +- t/t7600-merge.sh | 6 +++--- t/t9001-send-email.sh | 10 +++++----- t/t9100-git-svn-basic.sh | 2 +- t/t9401-git-cvsserver-crlf.sh | 8 ++++---- t/t9402-git-cvsserver-refs.sh | 2 +- 18 files changed, 48 insertions(+), 48 deletions(-)
t/t1400-update-ref.sh +1 -1
@@ -324,7 +324,7 @@ test_expect_success "create $m (logged by config)" ' test_expect_success "update $m (logged by config)" ' test_config core.logAllRefUpdates true && GIT_COMMITTER_DATE="2005-05-26 23:33" \ - git update-ref HEAD'" $B $A "'-m "Switch" && + git update-ref HEAD $B $A -m "Switch" && test $B = $(git show-ref -s --verify $m) ' test_expect_success "set $m (logged by config)" '
t/t3501-revert-cherry-pick.sh +2 -2
@@ -47,7 +47,7 @@ test_expect_success 'cherry-pick --nonsense' ' git diff --exit-code HEAD && test_must_fail git cherry-pick --nonsense 2>msg && git diff --exit-code HEAD "$pos" && - test_i18ngrep '[Uu]sage:' msg + test_i18ngrep "[Uu]sage:" msg ' test_expect_success 'revert --nonsense' '
@@ -56,7 +56,7 @@ test_expect_success 'revert --nonsense' ' git diff --exit-code HEAD && test_must_fail git revert --nonsense 2>msg && git diff --exit-code HEAD "$pos" && - test_i18ngrep '[Uu]sage:' msg + test_i18ngrep "[Uu]sage:" msg ' test_expect_success 'cherry-pick after renaming branch' '
t/t3507-cherry-pick-conflict.sh +2 -2
@@ -512,7 +512,7 @@ test_expect_success 'commit after failed cherry-pick adds -s at the right place' Signed-off-by: C O Mitter <[email protected]> # Conflicts: EOF - grep -e "^# Conflicts:" -e '^Signed-off-by' .git/COMMIT_EDITMSG >actual && + grep -e "^# Conflicts:" -e "^Signed-off-by" .git/COMMIT_EDITMSG >actual && test_cmp expect actual && cat <<-\EOF >expected &&
@@ -541,7 +541,7 @@ test_expect_success 'commit --amend -s places the sign-off at the right place' ' Signed-off-by: C O Mitter <[email protected]> Conflicts: EOF - grep -e "^Conflicts:" -e '^Signed-off-by' .git/COMMIT_EDITMSG >actual && + grep -e "^Conflicts:" -e "^Signed-off-by" .git/COMMIT_EDITMSG >actual && test_cmp expect actual '
t/t4005-diff-rename-2.sh +2 -2
@@ -14,8 +14,8 @@ test_expect_success 'setup reference tree' ' git update-index --add COPYING rezrov && tree=$(git write-tree) && echo $tree && - sed -e 's/HOWEVER/However/' <COPYING >COPYING.1 && - sed -e 's/GPL/G.P.L/g' <COPYING >COPYING.2 && + sed -e "s/HOWEVER/However/" <COPYING >COPYING.1 && + sed -e "s/GPL/G.P.L/g" <COPYING >COPYING.2 && origoid=$(git hash-object COPYING) && oid1=$(git hash-object COPYING.1) && oid2=$(git hash-object COPYING.2)
t/t4034-diff-words.sh +1 -1
@@ -102,7 +102,7 @@ test_expect_success 'word diff with runs of whitespace' ' ' test_expect_success '--word-diff=porcelain' ' - sed 's/#.*$//' >expect <<-EOF && + sed "s/#.*$//" >expect <<-EOF && diff --git a/pre b/post index $pre..$post 100644 --- a/pre
t/t4104-apply-boundary.sh +12 -12
@@ -11,7 +11,7 @@ test_description='git apply boundary tests L="c d e f g h i j k l m n o p q r s t u v w x" test_expect_success setup ' - for i in b '"$L"' y + for i in b $L y do echo $i done >victim &&
@@ -19,7 +19,7 @@ test_expect_success setup ' git update-index --add victim && # add to the head - for i in a b '"$L"' y + for i in a b $L y do echo $i done >victim &&
@@ -28,7 +28,7 @@ test_expect_success setup ' git diff --unified=0 >add-a-patch.without && # insert at line two - for i in b a '"$L"' y + for i in b a $L y do echo $i done >victim &&
@@ -37,7 +37,7 @@ test_expect_success setup ' git diff --unified=0 >insert-a-patch.without && # modify at the head - for i in a '"$L"' y + for i in a $L y do echo $i done >victim &&
@@ -46,7 +46,7 @@ test_expect_success setup ' git diff --unified=0 >mod-a-patch.without && # remove from the head - for i in '"$L"' y + for i in $L y do echo $i done >victim &&
@@ -55,7 +55,7 @@ test_expect_success setup ' git diff --unified=0 >del-a-patch.without && # add to the tail - for i in b '"$L"' y z + for i in b $L y z do echo $i done >victim &&
@@ -64,7 +64,7 @@ test_expect_success setup ' git diff --unified=0 >add-z-patch.without && # modify at the tail - for i in b '"$L"' z + for i in b $L z do echo $i done >victim &&
@@ -73,7 +73,7 @@ test_expect_success setup ' git diff --unified=0 >mod-z-patch.without && # remove from the tail - for i in b '"$L"' + for i in b $L do echo $i done >victim &&
@@ -95,8 +95,8 @@ do test_expect_success "apply $kind-patch $with context" ' cat original >victim && git update-index victim && - git apply --index '"$u$kind-patch.$with"' && - test_cmp '"$kind"'-expect victim + git apply --index $u$kind-patch.$with && + test_cmp $kind-expect victim ' done done
@@ -110,8 +110,8 @@ do test_expect_success "apply non-git $kind-patch without context" ' cat original >victim && git update-index victim && - git apply --unidiff-zero --index '"$kind-ng.without"' && - test_cmp '"$kind"'-expect victim + git apply --unidiff-zero --index $kind-ng.without && + test_cmp $kind-expect victim ' done
t/t4150-am.sh +4 -4
@@ -989,7 +989,7 @@ test_expect_success 'am -s unexpected trailer block' ' Signed-off-by: J C H <[email protected]> EOF git commit -F msg && - git cat-file commit HEAD | sed -e '1,/^$/d' >original && + git cat-file commit HEAD | sed -e "1,/^$/d" >original && git format-patch --stdout -1 >patch && git reset --hard HEAD^ &&
@@ -998,7 +998,7 @@ test_expect_success 'am -s unexpected trailer block' ' cat original && echo "Signed-off-by: $GIT_COMMITTER_NAME <$GIT_COMMITTER_EMAIL>" ) >expect && - git cat-file commit HEAD | sed -e '1,/^$/d' >actual && + git cat-file commit HEAD | sed -e "1,/^$/d" >actual && test_cmp expect actual && cat >msg <<-\EOF &&
@@ -1009,7 +1009,7 @@ test_expect_success 'am -s unexpected trailer block' ' EOF git reset HEAD^ && git commit -F msg file && - git cat-file commit HEAD | sed -e '1,/^$/d' >original && + git cat-file commit HEAD | sed -e "1,/^$/d" >original && git format-patch --stdout -1 >patch && git reset --hard HEAD^ &&
@@ -1020,7 +1020,7 @@ test_expect_success 'am -s unexpected trailer block' ' echo && echo "Signed-off-by: $GIT_COMMITTER_NAME <$GIT_COMMITTER_EMAIL>" ) >expect && - git cat-file commit HEAD | sed -e '1,/^$/d' >actual && + git cat-file commit HEAD | sed -e "1,/^$/d" >actual && test_cmp expect actual '
t/t4200-rerere.sh +1 -1
@@ -364,7 +364,7 @@ test_expect_success 'set up an unresolved merge' ' git reset --hard && git checkout version2 && fifth=$(git rev-parse fifth) && - echo "$fifth branch 'fifth' of ." | + echo "$fifth branch fifth of ." | git fmt-merge-msg >msg && ancestor=$(git merge-base version2 fifth) && test_must_fail git merge-recursive "$ancestor" -- HEAD fifth &&
t/t5302-pack-index.sh +1 -1
@@ -15,7 +15,7 @@ test_expect_success 'setup' ' i=1 && while test $i -le 100 do - iii=$(printf '%03i' $i) + iii=$(printf "%03i" $i) test-tool genrandom "bar" 200 > wide_delta_$iii && test-tool genrandom "baz $iii" 50 >> wide_delta_$iii && test-tool genrandom "foo"$i 100 > deep_delta_$iii &&
t/t5510-fetch.sh +2 -2
@@ -213,7 +213,7 @@ test_expect_success 'fetch tags when there is no tags' ' test_expect_success 'fetch following tags' ' cd "$D" && - git tag -a -m 'annotated' anno HEAD && + git tag -a -m "annotated" anno HEAD && git tag light HEAD && mkdir four &&
@@ -331,7 +331,7 @@ test_expect_success 'bundle does not prerequisite objects' ' test_expect_success 'bundle should be able to create a full history' ' cd "$D" && - git tag -a -m '1.0' v1.0 master && + git tag -a -m "1.0" v1.0 master && git bundle create bundle4 v1.0 '
t/t5553-set-upstream.sh +3 -3
@@ -81,7 +81,7 @@ test_expect_success 'fetch --set-upstream http://nosuchdomain.example.com fails test_expect_success 'fetch --set-upstream with valid URL sets upstream to URL' ' clear_config other other2 && - url="file://'"$PWD"'" && + url="file://$PWD" && git fetch --set-upstream "$url" && check_config master "$url" HEAD && check_config_missing other &&
@@ -158,7 +158,7 @@ test_expect_success 'pull --set-upstream upstream with more than one branch does test_expect_success 'pull --set-upstream with valid URL sets upstream to URL' ' clear_config master other other2 && git checkout master && - url="file://'"$PWD"'" && + url="file://$PWD" && git pull --set-upstream "$url" && check_config master "$url" HEAD && check_config_missing other &&
@@ -168,7 +168,7 @@ test_expect_success 'pull --set-upstream with valid URL sets upstream to URL' ' test_expect_success 'pull --set-upstream with valid URL and branch sets branch' ' clear_config master other other2 && git checkout master && - url="file://'"$PWD"'" && + url="file://$PWD" && git pull --set-upstream "$url" master && check_config master "$url" refs/heads/master && check_config_missing other &&
t/t6026-merge-attr.sh +2 -2
@@ -122,7 +122,7 @@ test_expect_success 'custom merge backend' ' o=$(git unpack-file master^:text) && a=$(git unpack-file side^:text) && b=$(git unpack-file master:text) && - sh -c "./custom-merge $o $a $b 0 'text'" && + sh -c "./custom-merge $o $a $b 0 text" && sed -e 1,3d $a >check-2 && cmp check-1 check-2 && rm -f $o $a $b
@@ -149,7 +149,7 @@ test_expect_success 'custom merge backend' ' o=$(git unpack-file master^:text) && a=$(git unpack-file anchor:text) && b=$(git unpack-file master:text) && - sh -c "./custom-merge $o $a $b 0 'text'" && + sh -c "./custom-merge $o $a $b 0 text" && sed -e 1,3d $a >check-2 && cmp check-1 check-2 && sed -e 1,3d -e 4q $a >check-3 &&
t/t7001-mv.sh +1 -1
@@ -177,7 +177,7 @@ test_expect_success "Sergey Vlasov's test case" ' date >ab.c && date >ab/d && git add ab.c ab && - git commit -m 'initial' && + git commit -m "initial" && git mv ab a '
t/t7600-merge.sh +3 -3
@@ -246,7 +246,7 @@ test_expect_success 'merge --squash c3 with c7' ' # file EOF git cat-file commit HEAD >raw && - sed -e '1,/^$/d' raw >actual && + sed -e "1,/^$/d" raw >actual && test_cmp expect actual '
@@ -268,7 +268,7 @@ test_expect_success 'merge c3 with c7 with commit.cleanup = scissors' ' # file EOF git cat-file commit HEAD >raw && - sed -e '1,/^$/d' raw >actual && + sed -e "1,/^$/d" raw >actual && test_i18ncmp expect actual '
@@ -292,7 +292,7 @@ test_expect_success 'merge c3 with c7 with --squash commit.cleanup = scissors' ' # file EOF git cat-file commit HEAD >raw && - sed -e '1,/^$/d' raw >actual && + sed -e "1,/^$/d" raw >actual && test_i18ncmp expect actual '
t/t9001-send-email.sh +5 -5
@@ -1551,7 +1551,7 @@ test_expect_success $PREREQ '8-bit and sendemail.transferencoding=quoted-printab --smtp-server="$(pwd)/fake.sendmail" \ email-using-8bit \ 2>errors >out && - sed '1,/^$/d' msgtxt1 >actual && + sed "1,/^$/d" msgtxt1 >actual && test_cmp expected actual '
@@ -1568,7 +1568,7 @@ test_expect_success $PREREQ '8-bit and sendemail.transferencoding=base64' ' --smtp-server="$(pwd)/fake.sendmail" \ email-using-8bit \ 2>errors >out && - sed '1,/^$/d' msgtxt1 >actual && + sed "1,/^$/d" msgtxt1 >actual && test_cmp expected actual '
@@ -1594,7 +1594,7 @@ test_expect_success $PREREQ 'convert from quoted-printable to base64' ' --smtp-server="$(pwd)/fake.sendmail" \ email-using-qp \ 2>errors >out && - sed '1,/^$/d' msgtxt1 >actual && + sed "1,/^$/d" msgtxt1 >actual && test_cmp expected actual '
@@ -1624,7 +1624,7 @@ test_expect_success $PREREQ 'CRLF and sendemail.transferencoding=quoted-printabl --smtp-server="$(pwd)/fake.sendmail" \ email-using-crlf \ 2>errors >out && - sed '1,/^$/d' msgtxt1 >actual && + sed "1,/^$/d" msgtxt1 >actual && test_cmp expected actual '
@@ -1641,7 +1641,7 @@ test_expect_success $PREREQ 'CRLF and sendemail.transferencoding=base64' ' --smtp-server="$(pwd)/fake.sendmail" \ email-using-crlf \ 2>errors >out && - sed '1,/^$/d' msgtxt1 >actual && + sed "1,/^$/d" msgtxt1 >actual && test_cmp expected actual '
t/t9100-git-svn-basic.sh +1 -1
@@ -69,7 +69,7 @@ test_expect_success "$name" " mv dir/new_file dir/file && git update-index --remove dir/file && git update-index --add dir/file/file && - git commit -m '$name' && + git commit -m "$name" && test_must_fail git svn set-tree --find-copies-harder --rmdir \ remotes/git-svn..mybranch "
t/t9401-git-cvsserver-crlf.sh +4 -4
@@ -167,10 +167,10 @@ test_expect_success 'adding files' ' test_expect_success 'updating' ' git pull gitcvs.git && - echo 'hi' > subdir/newfile.bin && - echo 'junk' > subdir/file.h && - echo 'hi' > subdir/newfile.c && - echo 'hello' >> binfile.bin && + echo "hi" >subdir/newfile.bin && + echo "junk" >subdir/file.h && + echo "hi" >subdir/newfile.c && + echo "hello" >>binfile.bin && git add subdir/newfile.bin subdir/file.h subdir/newfile.c binfile.bin && git commit -q -m "Add and change some files" && git push gitcvs.git >/dev/null &&
t/t9402-git-cvsserver-refs.sh +1 -1
@@ -178,7 +178,7 @@ test_expect_success 'setup v1.2 on b1' ' mkdir cdir && echo "cdir/cfile" >cdir/cfile && git add -A cdir adir t3 t2 && - git commit -q -m 'v1.2' && + git commit -q -m "v1.2" && git tag v1.2 && git push --tags gitcvs.git b1:b1 '
Signature · 1 line
2.28.0.81.ge8ab941b67
t/t7001-mv.sh test_expect_success "Sergey Vlasov's test case" ' · line 180
Quoted 11 lines · Martin Ågren
Subject: [PATCH] t: don't spuriously close & open quotes
[...]Signed-off-by Martin Ågren <[email protected]>---
t/t7001-mv.sh +1
-1@@ -177,7 +177,7 @@ test_expect_success "Sergey Vlasov's test case" ' git add ab.c ab && - git commit -m 'initial' && + git commit -m "initial" && git mv ab a '
This was discovered[1] independently a couple weeks ago; glad to see it was picked up by your grep'ing, as well.
[1]: https://lore.kernel.org/git/CAPig+cQpUu2UO-+jWn1nTaDykWnxwuEitzVB7PnW2SS_b7V8Hg@mail.gmail.com/
v2 cover t: don't spuriously close and reopen quotes
In reply to Martin ÅgrenThis is an updated version of the patch I posted inline in [1]. I've tweaked the end result a bit and pulled out the modifications to t4104 to their own patch. t4104 is also where most of the interdiff is spent.
I've updated the commit message of the main patch based on the discussion in the earlier thread.
[1] https://lore.kernel.org/git/[email protected]/
Martin Ågren (2):
t: don't spuriously close and reopen quotes
t4104: modernize and simplify quoting
t/t1400-update-ref.sh | 2 +- t/t3501-revert-cherry-pick.sh | 4 +-- t/t3507-cherry-pick-conflict.sh | 4 +-- t/t4005-diff-rename-2.sh | 4 +-- t/t4034-diff-words.sh | 2 +- t/t4104-apply-boundary.sh | 57 +++++++++------------------------ t/t4150-am.sh | 8 ++--- t/t4200-rerere.sh | 2 +- t/t5302-pack-index.sh | 2 +- t/t5510-fetch.sh | 4 +-- t/t5553-set-upstream.sh | 6 ++-- t/t6026-merge-attr.sh | 4 +-- t/t7001-mv.sh | 2 +- t/t7600-merge.sh | 6 ++-- t/t9001-send-email.sh | 10 +++--- t/t9100-git-svn-basic.sh | 6 ++-- t/t9401-git-cvsserver-crlf.sh | 8 ++--- t/t9402-git-cvsserver-refs.sh | 2 +- 18 files changed, 53 insertions(+), 80 deletions(-)
Interdiff against v1:
t/t4104-apply-boundary.sh +15 -42
@@ -3,80 +3,55 @@ # Copyright (c) 2005 Junio C Hamano # -test_description='git apply boundary tests +test_description='git apply boundary tests' -' . ./test-lib.sh L="c d e f g h i j k l m n o p q r s t u v w x" test_expect_success setup ' - for i in b $L y - do - echo $i - done >victim && + test_write_lines b $L y >victim && cat victim >original && git update-index --add victim && # add to the head - for i in a b $L y - do - echo $i - done >victim && + test_write_lines a b $L y >victim && cat victim >add-a-expect && git diff victim >add-a-patch.with && git diff --unified=0 >add-a-patch.without && # insert at line two - for i in b a $L y - do - echo $i - done >victim && + test_write_lines b a $L y >victim && cat victim >insert-a-expect && git diff victim >insert-a-patch.with && git diff --unified=0 >insert-a-patch.without && # modify at the head - for i in a $L y - do - echo $i - done >victim && + test_write_lines a $L y >victim && cat victim >mod-a-expect && git diff victim >mod-a-patch.with && git diff --unified=0 >mod-a-patch.without && # remove from the head - for i in $L y - do - echo $i - done >victim && + test_write_lines $L y >victim && cat victim >del-a-expect && git diff victim >del-a-patch.with && git diff --unified=0 >del-a-patch.without && # add to the tail - for i in b $L y z - do - echo $i - done >victim && + test_write_lines b $L y z >victim && cat victim >add-z-expect && git diff victim >add-z-patch.with && git diff --unified=0 >add-z-patch.without && # modify at the tail - for i in b $L z - do - echo $i - done >victim && + test_write_lines b $L z >victim && cat victim >mod-z-expect && git diff victim >mod-z-patch.with && git diff --unified=0 >mod-z-patch.without && # remove from the tail - for i in b $L - do - echo $i - done >victim && + test_write_lines b $L >victim && cat victim >del-z-expect && git diff victim >del-z-patch.with && git diff --unified=0 >del-z-patch.without
@@ -88,15 +63,15 @@ for with in with without do case "$with" in with) u= ;; - without) u='--unidiff-zero ' ;; + without) u=--unidiff-zero ;; esac for kind in add-a add-z insert-a mod-a mod-z del-a del-z do test_expect_success "apply $kind-patch $with context" ' cat original >victim && git update-index victim && - git apply --index $u$kind-patch.$with && - test_cmp $kind-expect victim + git apply --index $u "$kind-patch.$with" && + test_cmp "$kind-expect" victim ' done done
@@ -110,13 +85,12 @@ do test_expect_success "apply non-git $kind-patch without context" ' cat original >victim && git update-index victim && - git apply --unidiff-zero --index $kind-ng.without && - test_cmp $kind-expect victim + git apply --unidiff-zero --index "$kind-ng.without" && + test_cmp "$kind-expect" victim ' done test_expect_success 'two lines' ' - >file && git add file && echo aaa >file &&
@@ -125,11 +99,10 @@ test_expect_success 'two lines' ' echo bbb >file && git add file && test_must_fail git apply --check patch - ' test_expect_success 'apply patch with 3 context lines matching at end' ' - { echo a; echo b; echo c; echo d; } >file && + test_write_lines a b c d >file && git add file && echo e >>file && git diff >patch &&
t/t9100-git-svn-basic.sh +2 -2
@@ -63,7 +63,7 @@ test_expect_success "$name" ' name='detect node change from file to directory #1' -test_expect_success "$name" " +test_expect_success "$name" ' mkdir dir/new_file && mv dir/file dir/new_file/file && mv dir/new_file dir/file &&
@@ -72,7 +72,7 @@ test_expect_success "$name" " git commit -m "$name" && test_must_fail git svn set-tree --find-copies-harder --rmdir \ remotes/git-svn..mybranch -" +' name='detect node change from directory to file #1'
Signature · 1 line
2.28.0.199.g4234a9100e
PATCH v2 1/2 t: don't spuriously close and reopen quotes
In the test scripts, the recommended style is, e.g.:
test_expect_success 'name' '
do-something somehow &&
do-some-more testing
'When using this style, any single quote in the multi-line test section is actually closing the lone single quotes that surround it.
It can be a non-issue in practice:
test_expect_success 'sed a little' '
sed -e 's/hi/lo/' in >out # "ok": no whitespace in s/hi/lo/
'
Or it can be a bug in the test, e.g., because variable interpolation happens before the test even begins executing:
v=abc
test_expect_success 'variable interpolation' '
v=def &&
echo '"$v"' # abc
'Change several such in-test single quotes to use double quotes instead or, in a few cases, drop them altogether. These were identified using some crude grepping. We're not fixing any test bugs here, but we're hopefully making these tests slightly easier to grok and to maintain.
There are legitimate use cases for closing a quote and opening a new one, e.g., both '\'' and '"'"' can be used to produce a literal single quote. I'm not touching any of those here.
In t9401, tuck the redirecting ">" to the filename while we're touching those lines.
--- t/t1400-update-ref.sh | 2 +- t/t3501-revert-cherry-pick.sh | 4 ++-- t/t3507-cherry-pick-conflict.sh | 4 ++-- t/t4005-diff-rename-2.sh | 4 ++-- t/t4034-diff-words.sh | 2 +- t/t4150-am.sh | 8 ++++---- t/t4200-rerere.sh | 2 +- t/t5302-pack-index.sh | 2 +- t/t5510-fetch.sh | 4 ++-- t/t5553-set-upstream.sh | 6 +++--- t/t6026-merge-attr.sh | 4 ++-- t/t7001-mv.sh | 2 +- t/t7600-merge.sh | 6 +++--- t/t9001-send-email.sh | 10 +++++----- t/t9100-git-svn-basic.sh | 6 +++--- t/t9401-git-cvsserver-crlf.sh | 8 ++++---- t/t9402-git-cvsserver-refs.sh | 2 +- 17 files changed, 38 insertions(+), 38 deletions(-)
t/t1400-update-ref.sh +1 -1
@@ -324,7 +324,7 @@ test_expect_success "create $m (logged by config)" ' test_expect_success "update $m (logged by config)" ' test_config core.logAllRefUpdates true && GIT_COMMITTER_DATE="2005-05-26 23:33" \ - git update-ref HEAD'" $B $A "'-m "Switch" && + git update-ref HEAD $B $A -m "Switch" && test $B = $(git show-ref -s --verify $m) ' test_expect_success "set $m (logged by config)" '
t/t3501-revert-cherry-pick.sh +2 -2
@@ -47,7 +47,7 @@ test_expect_success 'cherry-pick --nonsense' ' git diff --exit-code HEAD && test_must_fail git cherry-pick --nonsense 2>msg && git diff --exit-code HEAD "$pos" && - test_i18ngrep '[Uu]sage:' msg + test_i18ngrep "[Uu]sage:" msg ' test_expect_success 'revert --nonsense' '
@@ -56,7 +56,7 @@ test_expect_success 'revert --nonsense' ' git diff --exit-code HEAD && test_must_fail git revert --nonsense 2>msg && git diff --exit-code HEAD "$pos" && - test_i18ngrep '[Uu]sage:' msg + test_i18ngrep "[Uu]sage:" msg ' test_expect_success 'cherry-pick after renaming branch' '
t/t3507-cherry-pick-conflict.sh +2 -2
@@ -512,7 +512,7 @@ test_expect_success 'commit after failed cherry-pick adds -s at the right place' Signed-off-by: C O Mitter <[email protected]> # Conflicts: EOF - grep -e "^# Conflicts:" -e '^Signed-off-by' .git/COMMIT_EDITMSG >actual && + grep -e "^# Conflicts:" -e "^Signed-off-by" .git/COMMIT_EDITMSG >actual && test_cmp expect actual && cat <<-\EOF >expected &&
@@ -541,7 +541,7 @@ test_expect_success 'commit --amend -s places the sign-off at the right place' ' Signed-off-by: C O Mitter <[email protected]> Conflicts: EOF - grep -e "^Conflicts:" -e '^Signed-off-by' .git/COMMIT_EDITMSG >actual && + grep -e "^Conflicts:" -e "^Signed-off-by" .git/COMMIT_EDITMSG >actual && test_cmp expect actual '
t/t4005-diff-rename-2.sh +2 -2
@@ -14,8 +14,8 @@ test_expect_success 'setup reference tree' ' git update-index --add COPYING rezrov && tree=$(git write-tree) && echo $tree && - sed -e 's/HOWEVER/However/' <COPYING >COPYING.1 && - sed -e 's/GPL/G.P.L/g' <COPYING >COPYING.2 && + sed -e "s/HOWEVER/However/" <COPYING >COPYING.1 && + sed -e "s/GPL/G.P.L/g" <COPYING >COPYING.2 && origoid=$(git hash-object COPYING) && oid1=$(git hash-object COPYING.1) && oid2=$(git hash-object COPYING.2)
t/t4034-diff-words.sh +1 -1
@@ -102,7 +102,7 @@ test_expect_success 'word diff with runs of whitespace' ' ' test_expect_success '--word-diff=porcelain' ' - sed 's/#.*$//' >expect <<-EOF && + sed "s/#.*$//" >expect <<-EOF && diff --git a/pre b/post index $pre..$post 100644 --- a/pre
t/t4150-am.sh +4 -4
@@ -989,7 +989,7 @@ test_expect_success 'am -s unexpected trailer block' ' Signed-off-by: J C H <[email protected]> EOF git commit -F msg && - git cat-file commit HEAD | sed -e '1,/^$/d' >original && + git cat-file commit HEAD | sed -e "1,/^$/d" >original && git format-patch --stdout -1 >patch && git reset --hard HEAD^ &&
@@ -998,7 +998,7 @@ test_expect_success 'am -s unexpected trailer block' ' cat original && echo "Signed-off-by: $GIT_COMMITTER_NAME <$GIT_COMMITTER_EMAIL>" ) >expect && - git cat-file commit HEAD | sed -e '1,/^$/d' >actual && + git cat-file commit HEAD | sed -e "1,/^$/d" >actual && test_cmp expect actual && cat >msg <<-\EOF &&
@@ -1009,7 +1009,7 @@ test_expect_success 'am -s unexpected trailer block' ' EOF git reset HEAD^ && git commit -F msg file && - git cat-file commit HEAD | sed -e '1,/^$/d' >original && + git cat-file commit HEAD | sed -e "1,/^$/d" >original && git format-patch --stdout -1 >patch && git reset --hard HEAD^ &&
@@ -1020,7 +1020,7 @@ test_expect_success 'am -s unexpected trailer block' ' echo && echo "Signed-off-by: $GIT_COMMITTER_NAME <$GIT_COMMITTER_EMAIL>" ) >expect && - git cat-file commit HEAD | sed -e '1,/^$/d' >actual && + git cat-file commit HEAD | sed -e "1,/^$/d" >actual && test_cmp expect actual '
t/t4200-rerere.sh +1 -1
@@ -364,7 +364,7 @@ test_expect_success 'set up an unresolved merge' ' git reset --hard && git checkout version2 && fifth=$(git rev-parse fifth) && - echo "$fifth branch 'fifth' of ." | + echo "$fifth branch fifth of ." | git fmt-merge-msg >msg && ancestor=$(git merge-base version2 fifth) && test_must_fail git merge-recursive "$ancestor" -- HEAD fifth &&
t/t5302-pack-index.sh +1 -1
@@ -15,7 +15,7 @@ test_expect_success 'setup' ' i=1 && while test $i -le 100 do - iii=$(printf '%03i' $i) + iii=$(printf "%03i" $i) test-tool genrandom "bar" 200 > wide_delta_$iii && test-tool genrandom "baz $iii" 50 >> wide_delta_$iii && test-tool genrandom "foo"$i 100 > deep_delta_$iii &&
t/t5510-fetch.sh +2 -2
@@ -213,7 +213,7 @@ test_expect_success 'fetch tags when there is no tags' ' test_expect_success 'fetch following tags' ' cd "$D" && - git tag -a -m 'annotated' anno HEAD && + git tag -a -m "annotated" anno HEAD && git tag light HEAD && mkdir four &&
@@ -331,7 +331,7 @@ test_expect_success 'bundle does not prerequisite objects' ' test_expect_success 'bundle should be able to create a full history' ' cd "$D" && - git tag -a -m '1.0' v1.0 master && + git tag -a -m "1.0" v1.0 master && git bundle create bundle4 v1.0 '
t/t5553-set-upstream.sh +3 -3
@@ -81,7 +81,7 @@ test_expect_success 'fetch --set-upstream http://nosuchdomain.example.com fails test_expect_success 'fetch --set-upstream with valid URL sets upstream to URL' ' clear_config other other2 && - url="file://'"$PWD"'" && + url="file://$PWD" && git fetch --set-upstream "$url" && check_config master "$url" HEAD && check_config_missing other &&
@@ -158,7 +158,7 @@ test_expect_success 'pull --set-upstream upstream with more than one branch does test_expect_success 'pull --set-upstream with valid URL sets upstream to URL' ' clear_config master other other2 && git checkout master && - url="file://'"$PWD"'" && + url="file://$PWD" && git pull --set-upstream "$url" && check_config master "$url" HEAD && check_config_missing other &&
@@ -168,7 +168,7 @@ test_expect_success 'pull --set-upstream with valid URL sets upstream to URL' ' test_expect_success 'pull --set-upstream with valid URL and branch sets branch' ' clear_config master other other2 && git checkout master && - url="file://'"$PWD"'" && + url="file://$PWD" && git pull --set-upstream "$url" master && check_config master "$url" refs/heads/master && check_config_missing other &&
t/t6026-merge-attr.sh +2 -2
@@ -122,7 +122,7 @@ test_expect_success 'custom merge backend' ' o=$(git unpack-file master^:text) && a=$(git unpack-file side^:text) && b=$(git unpack-file master:text) && - sh -c "./custom-merge $o $a $b 0 'text'" && + sh -c "./custom-merge $o $a $b 0 text" && sed -e 1,3d $a >check-2 && cmp check-1 check-2 && rm -f $o $a $b
@@ -149,7 +149,7 @@ test_expect_success 'custom merge backend' ' o=$(git unpack-file master^:text) && a=$(git unpack-file anchor:text) && b=$(git unpack-file master:text) && - sh -c "./custom-merge $o $a $b 0 'text'" && + sh -c "./custom-merge $o $a $b 0 text" && sed -e 1,3d $a >check-2 && cmp check-1 check-2 && sed -e 1,3d -e 4q $a >check-3 &&
t/t7001-mv.sh +1 -1
@@ -177,7 +177,7 @@ test_expect_success "Sergey Vlasov's test case" ' date >ab.c && date >ab/d && git add ab.c ab && - git commit -m 'initial' && + git commit -m "initial" && git mv ab a '
t/t7600-merge.sh +3 -3
@@ -246,7 +246,7 @@ test_expect_success 'merge --squash c3 with c7' ' # file EOF git cat-file commit HEAD >raw && - sed -e '1,/^$/d' raw >actual && + sed -e "1,/^$/d" raw >actual && test_cmp expect actual '
@@ -268,7 +268,7 @@ test_expect_success 'merge c3 with c7 with commit.cleanup = scissors' ' # file EOF git cat-file commit HEAD >raw && - sed -e '1,/^$/d' raw >actual && + sed -e "1,/^$/d" raw >actual && test_i18ncmp expect actual '
@@ -292,7 +292,7 @@ test_expect_success 'merge c3 with c7 with --squash commit.cleanup = scissors' ' # file EOF git cat-file commit HEAD >raw && - sed -e '1,/^$/d' raw >actual && + sed -e "1,/^$/d" raw >actual && test_i18ncmp expect actual '
t/t9001-send-email.sh +5 -5
@@ -1551,7 +1551,7 @@ test_expect_success $PREREQ '8-bit and sendemail.transferencoding=quoted-printab --smtp-server="$(pwd)/fake.sendmail" \ email-using-8bit \ 2>errors >out && - sed '1,/^$/d' msgtxt1 >actual && + sed "1,/^$/d" msgtxt1 >actual && test_cmp expected actual '
@@ -1568,7 +1568,7 @@ test_expect_success $PREREQ '8-bit and sendemail.transferencoding=base64' ' --smtp-server="$(pwd)/fake.sendmail" \ email-using-8bit \ 2>errors >out && - sed '1,/^$/d' msgtxt1 >actual && + sed "1,/^$/d" msgtxt1 >actual && test_cmp expected actual '
@@ -1594,7 +1594,7 @@ test_expect_success $PREREQ 'convert from quoted-printable to base64' ' --smtp-server="$(pwd)/fake.sendmail" \ email-using-qp \ 2>errors >out && - sed '1,/^$/d' msgtxt1 >actual && + sed "1,/^$/d" msgtxt1 >actual && test_cmp expected actual '
@@ -1624,7 +1624,7 @@ test_expect_success $PREREQ 'CRLF and sendemail.transferencoding=quoted-printabl --smtp-server="$(pwd)/fake.sendmail" \ email-using-crlf \ 2>errors >out && - sed '1,/^$/d' msgtxt1 >actual && + sed "1,/^$/d" msgtxt1 >actual && test_cmp expected actual '
@@ -1641,7 +1641,7 @@ test_expect_success $PREREQ 'CRLF and sendemail.transferencoding=base64' ' --smtp-server="$(pwd)/fake.sendmail" \ email-using-crlf \ 2>errors >out && - sed '1,/^$/d' msgtxt1 >actual && + sed "1,/^$/d" msgtxt1 >actual && test_cmp expected actual '
t/t9100-git-svn-basic.sh +3 -3
@@ -63,16 +63,16 @@ test_expect_success "$name" ' name='detect node change from file to directory #1' -test_expect_success "$name" " +test_expect_success "$name" ' mkdir dir/new_file && mv dir/file dir/new_file/file && mv dir/new_file dir/file && git update-index --remove dir/file && git update-index --add dir/file/file && - git commit -m '$name' && + git commit -m "$name" && test_must_fail git svn set-tree --find-copies-harder --rmdir \ remotes/git-svn..mybranch -" +' name='detect node change from directory to file #1'
t/t9401-git-cvsserver-crlf.sh +4 -4
@@ -167,10 +167,10 @@ test_expect_success 'adding files' ' test_expect_success 'updating' ' git pull gitcvs.git && - echo 'hi' > subdir/newfile.bin && - echo 'junk' > subdir/file.h && - echo 'hi' > subdir/newfile.c && - echo 'hello' >> binfile.bin && + echo "hi" >subdir/newfile.bin && + echo "junk" >subdir/file.h && + echo "hi" >subdir/newfile.c && + echo "hello" >>binfile.bin && git add subdir/newfile.bin subdir/file.h subdir/newfile.c binfile.bin && git commit -q -m "Add and change some files" && git push gitcvs.git >/dev/null &&
t/t9402-git-cvsserver-refs.sh +1 -1
@@ -178,7 +178,7 @@ test_expect_success 'setup v1.2 on b1' ' mkdir cdir && echo "cdir/cfile" >cdir/cfile && git add -A cdir adir t3 t2 && - git commit -q -m 'v1.2' && + git commit -q -m "v1.2" && git tag v1.2 && git push --tags gitcvs.git b1:b1 '
Signature · 1 line
2.28.0.199.g4234a9100e
Re: [PATCH v2 1/2] t: don't spuriously close and reopen quotes
t/t4200-rerere.sh test_expect_success 'set up an unresolved merge' ' · line 366
Quoted 6 lines · Martin Ågren
t/t4200-rerere.sh +1
-1@@ -364,7 +364,7 @@ test_expect_success 'set up an unresolved merge' ' fifth=$(git rev-parse fifth) && - echo "$fifth branch 'fifth' of ." | + echo "$fifth branch fifth of ." | git fmt-merge-msg >msg &&
This one is a bit weird. It really seems as if the intent was to quote the word "fifth" in the merge message, so dropping the quotes altogether seems wrong. However, the file 'msg' is never even consulted in this test (or any other test), so is this just "dead code" (including the leading 'fifth=' assignment which also is otherwise unused outside the 'echo')?
t/t5510-fetch.sh test_expect_success 'fetch tags when there is no tags' ' · line 215
Quoted 6 lines
t/t5510-fetch.sh +1
-1@@ -213,7 +213,7 @@ test_expect_success 'fetch tags when there is no tags' ' test_expect_success 'fetch following tags' ' cd "$D" && - git tag -a -m 'annotated' anno HEAD && + git tag -a -m "annotated" anno HEAD &&
There are a fair number of these quoted single-token arguments containing no special characters which don't actually need to be quoted at all, so an alternative would be simply to drop the quotes altogether, making the commands less syntactically noisy. However, that might be outside the intended scope of this change.
Re: [PATCH v2 1/2] t: don't spuriously close and reopen quotes
Hi Eric,
Thanks for having a look.
Quoted 15 lines · Eric Sunshine
t/t4200-rerere.sh test_expect_success 'set up an unresolved merge' ' · line 366
Quoted 6 lines · Martin Ågren
t/t4200-rerere.sh +1
-1@@ -364,7 +364,7 @@ test_expect_success 'set up an unresolved merge' ' fifth=$(git rev-parse fifth) && - echo "$fifth branch 'fifth' of ." | + echo "$fifth branch fifth of ." | git fmt-merge-msg >msg &&This one is a bit weird. It really seems as if the intent was to quote the word "fifth" in the merge message, so dropping the quotes altogether seems wrong. However, the file 'msg' is never even consulted in this test (or any other test), so is this just "dead code" (including the leading 'fifth=' assignment which also is otherwise unused outside the 'echo')?
Huh, good catch. The tests showed up in v2 of the patch [1] and there's not enough context in the archives to tell whether something was partly removed from an earlier "v1.5" or partly added but not all the way.
We expect to fail the merge -- and we do, and not because of this msg thing -- and then we look around a little, but we don't resolve the merge and make a commit. And from what I can tell, there wouldn't be much point in making a commit. So I should be able to safely drop this "dead code" entirely.
[1] https://lore.kernel.org/git/20100805112837.GL13779@burratino/>
Quoted 4 lines
Quoted 4 lines
t/t5510-fetch.sh +0
-0@@ -213,7 +213,7 @@ test_expect_success 'fetch tags when there is no tags' ' test_expect_success 'fetch following tags' ' cd "$D" &&
Quoted 8 lines
t/t5510-fetch.sh test_expect_success 'fetch tags when there is no tags' ' · line 216
Quoted 2 lines
t/t5510-fetch.sh +1
-1- git tag -a -m 'annotated' anno HEAD && + git tag -a -m "annotated" anno HEAD &&There are a fair number of these quoted single-token arguments containing no special characters which don't actually need to be quoted at all, so an alternative would be simply to drop the quotes altogether, making the commands less syntactically noisy. However, that might be outside the intended scope of this change.
FWIW, I find something like git foo -m "message" a lot more intuitive/reasonable than, e.g., git foo "HEAD" to signal that here's a message that could in principle have whitespace, even if this one doesn't. For all of these, I tried to follow the surrounding style. For example in t9401, where we do echo "hi". We certainly don't need the quotes there, but t9401 is very consistent on this and I didn't want to muddy that unnecessarily.
If we say that "don't use quotes if you don't need to" is a reasonable thing to strive for, I can drop these in a reroll. I think I'll be injecting a patch anyway for the "msg" you pointed out in t4200, so I can certainly tweak this patch to be a bit more aggressive in dropping unnecessary quotes.
Thanks
Martin
Re: [PATCH v2 1/2] t: don't spuriously close and reopen quotes
Quoted 12 lines · Martin Ågren
Quoted 10 lines · Eric Sunshine
t/t4200-rerere.sh test_expect_success 'set up an unresolved merge' ' · line 367
Quoted 2 lines · Martin Ågren
t/t4200-rerere.sh +1
-1- echo "$fifth branch 'fifth' of ." | + echo "$fifth branch fifth of ." |This one is a bit weird. It really seems as if the intent was to quote the word "fifth" in the merge message, so dropping the quotes altogether seems wrong. However, the file 'msg' is never even consulted in this test (or any other test), so is this just "dead code" (including the leading 'fifth=' assignment which also is otherwise unused outside the 'echo')?
Quoted 2 lines
Huh, good catch. [...] So I should be able to safely drop this "dead code" entirely.
That could be done atop this series if there is no other reason to re-roll.
Quoted 9 lines
Quoted 8 lines
t/t5510-fetch.sh test_expect_success 'fetch tags when there is no tags' ' · line 216
Quoted 2 lines
t/t5510-fetch.sh +1
-1- git tag -a -m 'annotated' anno HEAD && + git tag -a -m "annotated" anno HEAD &&There are a fair number of these quoted single-token arguments containing no special characters which don't actually need to be quoted at all, so an alternative would be simply to drop the quotes altogether, making the commands less syntactically noisy. However, that might be outside the intended scope of this change.
Quoted 5 lines
If we say that "don't use quotes if you don't need to" is a reasonable thing to strive for, I can drop these in a reroll. I think I'll be injecting a patch anyway for the "msg" you pointed out in t4200, so I can certainly tweak this patch to be a bit more aggressive in dropping unnecessary quotes.
No need. Matching the local convention makes sense, and I don't insist upon such a change at all. Mine was a non-actionable observation, and it's entirely subjective anyhow.
I don't feel strongly about whether the series should be re-rolled. It's true that dropping that dead code (mentioned above) would make more sense coming before the patch which fixes up the quoting, but it wouldn't bother me if the dead-code removal was done as a follow-on patch.
Re: [PATCH v2 1/2] t: don't spuriously close and reopen quotes
Quoted 5 lines · Eric Sunshine
I don't feel strongly about whether the series should be re-rolled. It's true that dropping that dead code (mentioned above) would make more sense coming before the patch which fixes up the quoting, but it wouldn't bother me if the dead-code removal was done as a follow-on patch.
Yeah, I agree that a preparatory clean-up followed by the main change would logically make more sense, but if it is swapped it is not the end of the world ;-)
Thanks, both.
PATCH v2 2/2 t4104: modernize and simplify quoting
In reply to Martin ÅgrenDrop whitespace in the value of $test_description and in a test body and use test_write_lines.
Stop defining $u with a trailing space just so that we can tuck it in like git foo $u$more... and get minimal whitespace in the command:git foo $u $more... is more readable at the "cost" of an empty $u yielding git foo something....
Finally, avoid using single quotes within the test scripts to repeatedly close and reopen the quotes that wrap the test scripts (see the previous commit). This "unnecessary" quoting does mean that the verbose test output shows the interpolated values, i.e., the shell code we're running. But the downside is that the source of the script does *not* show the shell code we're eventually executing, leaving the reader to reason about what we really do and whether there are any quoting issues. (There aren't.)
Where we run through loops to generate several "identical but different" tests, the test message contains the interpolated variables we're looping on, meaning one can always identify exactly which instance has failed, even if the verbose test output shows the exact same test body several times.
--- t/t4104-apply-boundary.sh | 57 +++++++++++---------------------------- 1 file changed, 15 insertions(+), 42 deletions(-)
t/t4104-apply-boundary.sh +15 -42
@@ -3,80 +3,55 @@ # Copyright (c) 2005 Junio C Hamano # -test_description='git apply boundary tests +test_description='git apply boundary tests' -' . ./test-lib.sh L="c d e f g h i j k l m n o p q r s t u v w x" test_expect_success setup ' - for i in b '"$L"' y - do - echo $i - done >victim && + test_write_lines b $L y >victim && cat victim >original && git update-index --add victim && # add to the head - for i in a b '"$L"' y - do - echo $i - done >victim && + test_write_lines a b $L y >victim && cat victim >add-a-expect && git diff victim >add-a-patch.with && git diff --unified=0 >add-a-patch.without && # insert at line two - for i in b a '"$L"' y - do - echo $i - done >victim && + test_write_lines b a $L y >victim && cat victim >insert-a-expect && git diff victim >insert-a-patch.with && git diff --unified=0 >insert-a-patch.without && # modify at the head - for i in a '"$L"' y - do - echo $i - done >victim && + test_write_lines a $L y >victim && cat victim >mod-a-expect && git diff victim >mod-a-patch.with && git diff --unified=0 >mod-a-patch.without && # remove from the head - for i in '"$L"' y - do - echo $i - done >victim && + test_write_lines $L y >victim && cat victim >del-a-expect && git diff victim >del-a-patch.with && git diff --unified=0 >del-a-patch.without && # add to the tail - for i in b '"$L"' y z - do - echo $i - done >victim && + test_write_lines b $L y z >victim && cat victim >add-z-expect && git diff victim >add-z-patch.with && git diff --unified=0 >add-z-patch.without && # modify at the tail - for i in b '"$L"' z - do - echo $i - done >victim && + test_write_lines b $L z >victim && cat victim >mod-z-expect && git diff victim >mod-z-patch.with && git diff --unified=0 >mod-z-patch.without && # remove from the tail - for i in b '"$L"' - do - echo $i - done >victim && + test_write_lines b $L >victim && cat victim >del-z-expect && git diff victim >del-z-patch.with && git diff --unified=0 >del-z-patch.without
@@ -88,15 +63,15 @@ for with in with without do case "$with" in with) u= ;; - without) u='--unidiff-zero ' ;; + without) u=--unidiff-zero ;; esac for kind in add-a add-z insert-a mod-a mod-z del-a del-z do test_expect_success "apply $kind-patch $with context" ' cat original >victim && git update-index victim && - git apply --index '"$u$kind-patch.$with"' && - test_cmp '"$kind"'-expect victim + git apply --index $u "$kind-patch.$with" && + test_cmp "$kind-expect" victim ' done done
@@ -110,13 +85,12 @@ do test_expect_success "apply non-git $kind-patch without context" ' cat original >victim && git update-index victim && - git apply --unidiff-zero --index '"$kind-ng.without"' && - test_cmp '"$kind"'-expect victim + git apply --unidiff-zero --index "$kind-ng.without" && + test_cmp "$kind-expect" victim ' done test_expect_success 'two lines' ' - >file && git add file && echo aaa >file &&
@@ -125,11 +99,10 @@ test_expect_success 'two lines' ' echo bbb >file && git add file && test_must_fail git apply --check patch - ' test_expect_success 'apply patch with 3 context lines matching at end' ' - { echo a; echo b; echo c; echo d; } >file && + test_write_lines a b c d >file && git add file && echo e >>file && git diff >patch &&
Signature · 1 line
2.28.0.199.g4234a9100e
Quoted 3 lines · Martin Ågren
printf '\0'
to generate a NUL byte
[but]
t/t1450-fsck.sh test_expect_success 'fsck fails on corrupt packfile' ' · line 717
Quoted 4 lines
end up injecting the ASCII code for "0",
0x30, instead.t/t1450-fsck.sh +1
-1- printf '\0' | dd of=.git/objects/pack/pack-$pack.pack bs=1 conv=notrunc seek=12 && + printf "\0" | dd of=.git/objects/pack/pack-$pack.pack bs=1 conv=notrunc seek=12 &&
In sh/bash, this should make no difference, and that's what I get here. Am I missing something?
$ printf '\0' | hexdump 0000000 0000 0000001 $ printf "\0" | hexdump 0000000 0000 0000001
Chris
Oh, wait, I am indeed missing something -- the script itself is all in single quotes, so the single quotes on the line in question are wrong. Never mind!
Chris
Quoted 4 lines · Chris Torek
Oh, wait, I am indeed missing something -- the script itself is all in single quotes, so the single quotes on the line in question are wrong. Never mind!
No worries! Thanks for having a look at the patch. Is there anything that could be done to make this clearer in the commit message? (I find it quite awkward to discuss quoting: will the reader understand which quoting is part of my own formatting of the message vs which is part of the quoting issue I want to get across!?)
Martin
Quoted 5 lines · Martin Ågren
No worries! Thanks for having a look at the patch. Is there anything that could be done to make this clearer in the commit message? (I find it quite awkward to discuss quoting: will the reader understand which quoting is part of my own formatting of the message vs which is part of the quoting issue I want to get across!?)
This is indeed a problem...
Perhaps something along these lines (generic boilerplate for any single-quote fixes, that should be adjusted for the actual fix):
In the test scripts, the recommended style is, e.g.:
test_expect_success 'name' '
multi-line test
goes here
'
When using this style, any single quote in the multi-line test section is actually closing the lone single quotes that surround it. To avoid confusion, minimize and/or eliminate the use of single quotes here.
Chris
Quoted 20 lines · Chris Torek
Quoted 5 lines · Martin Ågren
No worries! Thanks for having a look at the patch. Is there anything that could be done to make this clearer in the commit message? (I find it quite awkward to discuss quoting: will the reader understand which quoting is part of my own formatting of the message vs which is part of the quoting issue I want to get across!?)
This is indeed a problem...
Perhaps something along these lines (generic boilerplate for any single-quote fixes, that should be adjusted for the actual fix):
In the test scripts, the recommended style is, e.g.:
test_expect_success'name' '
multi-line test
goes here
'
Quoted 4 lines
When using this style, any single quote in the multi-line test section is actually closing the lone single quotes that surround it. To avoid confusion, minimize and/or eliminate the use of single quotes here.
Another thing that falls into the same class and probably be a good addition to the above "tip" is how $variables are interpolated, i.e.
test_expect_success 'test name' ' test-that-references $variable && another-test-that-references "$variable" '
are 99% of the time the right way to refer to variable that is assigned outside the test itself (e.g. the whole four lines shown above may be in a loop, "for variable in a b c; ... ;done").
test_expect_success 'test name' ' test-that-references '$variable' && another-test-that-references '"$variable"' '
is most likely a wrong way to write for the first one (i.e. what if the value in $variable has $IFS whitespace) and "not wrong per-se but unnecessary" for the second one.
Same applies to $(command) substitution, but it is more important. "Step out of the quote, evaluate and step back into the quote" pattern would mean the command is evaluated while formulating the body of the test, not while running the test, which often is not what the author intended.
Thanks.