Michael Montalbo
47f79f6198
Replace bare grep with test_grep in test assertions across the
suite, including sourced test helpers (lib-*.sh, *-tests.sh).
test_grep prints the contents of the file being searched on
failure, making debugging easier than a bare grep which fails
silently.
Only assertion-style greps are converted: grep used as a filter
in pipelines, command substitutions, conditionals, or with
redirected I/O is left as-is with a "# lint-ok" annotation.
Existing '! test_grep' calls are rewritten to 'test_grep !' so
that the diagnostic output is preserved on failure.
test_grep requires the file it reads to exist, so '! grep'
assertions that inspect a file whose presence is conditional need
care. In t5537 the '.git/shallow' file is still present after the
repack (the client remains shallow), so the assertion is
converted like any other. In t1400 the '.git/packed-refs' file
exists only with the files backend, so its check is guarded with a
REFFILES prerequisite; the backend-agnostic 'git show-ref' check
that follows still runs under every backend. In t7450 'git~2' is
the NTFS 8.3 short name of a '..git' file and only exists
when 8.3 short-name generation is enabled, so its check is guarded
with a 'test -f' on the path and uses test_grep inside the guard,
the same shape as t1400 (a plain test_grep would BUG when the
short name is absent).
The conversion was generated using a grep-assertion linter
(greplint.pl, added in the following commit) to identify bare
grep calls at command position. To reproduce, from the t/
directory:
# Step 1: annotate the two data-filter greps (grep produces
# data, not a verdict) so the linter skips them.
sed -i '/grep -vf before commits\.raw/s/$/ # lint-ok: data filter/' \
t5326-multi-pack-bitmaps.sh
sed -i '/grep -E "^\[0-9a-f\].*|| :/s/$/ # lint-ok: data filter/' \
t5702-protocol-v2.sh
# Step 1b: two '! grep' assertions need more than a mechanical
# conversion; handle them by hand before the linter-driven steps
# below so it leaves them alone.
#
# t1400: '.git/packed-refs' is absent under reftable, so guard the
# check with REFFILES (a plain test_grep would BUG on the missing
# file):
#
# git update-ref -d HEAD $B &&
# - ! grep "$m" .git/packed-refs &&
# + if test_have_prereq REFFILES
# + then
# + test_grep ! "$m" .git/packed-refs
# + fi &&
# test_must_fail git show-ref --verify -q $m
#
# t7450: git~2 is an NTFS 8.3 short name that exists only when
# short-name generation is enabled, so guard the check on its
# presence with 'test -f' and note in a comment why the path can
# be absent (a plain test_grep would BUG when it is):
#
# - ! grep gitdir squatting-clone/d/a/git~2
# + if test -f squatting-clone/d/a/git~2
# + then
# + test_grep ! gitdir squatting-clone/d/a/git~2
# + fi
# Step 2: reorder pre-existing '! test_grep' to 'test_grep !'
# (must come before steps 3-4 so greplint does not see them)
sed -i 's/! test_grep/test_grep !/' t0031-lockfile-pid.sh
sed -i 's/! test_grep/test_grep !/' t5300-pack-object.sh
sed -i 's/! test_grep/test_grep !/' t5319-multi-pack-index.sh
# Step 3: convert '! grep' -> 'test_grep !'
perl greplint.pl *.sh 2>&1 | cut -d: -f1,2 |
while IFS=: read f l; do
sed -i "${l}s/! *grep/test_grep !/" "$f"
done
# Step 4: convert remaining 'grep' -> 'test_grep'
perl greplint.pl *.sh 2>&1 | cut -d: -f1,2 |
while IFS=: read f l; do
sed -i "${l}s/grep/test_grep/" "$f"
done
To verify, run: make -C t test-greplint
Signed-off-by: Michael Montalbo <mmontalbo@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
134 lines
3.4 KiB
Bash
Executable File
134 lines
3.4 KiB
Bash
Executable File
#!/bin/sh
|
|
|
|
test_description='Test the dir-iterator functionality'
|
|
|
|
. ./test-lib.sh
|
|
|
|
test_expect_success 'setup' '
|
|
mkdir -p dir &&
|
|
mkdir -p dir/a/b/c/ &&
|
|
>dir/b &&
|
|
>dir/c &&
|
|
mkdir -p dir/d/e/d/ &&
|
|
>dir/a/b/c/d &&
|
|
>dir/a/e &&
|
|
>dir/d/e/d/a &&
|
|
|
|
mkdir -p dir2/a/b/c/ &&
|
|
>dir2/a/b/c/d
|
|
'
|
|
|
|
test_expect_success 'dir-iterator should iterate through all files' '
|
|
cat >expected-iteration-sorted-output <<-EOF &&
|
|
[d] (a) [a] ./dir/a
|
|
[d] (a/b) [b] ./dir/a/b
|
|
[d] (a/b/c) [c] ./dir/a/b/c
|
|
[d] (d) [d] ./dir/d
|
|
[d] (d/e) [e] ./dir/d/e
|
|
[d] (d/e/d) [d] ./dir/d/e/d
|
|
[f] (a/b/c/d) [d] ./dir/a/b/c/d
|
|
[f] (a/e) [e] ./dir/a/e
|
|
[f] (b) [b] ./dir/b
|
|
[f] (c) [c] ./dir/c
|
|
[f] (d/e/d/a) [a] ./dir/d/e/d/a
|
|
EOF
|
|
|
|
test-tool dir-iterator ./dir >out &&
|
|
sort out >./actual-iteration-sorted-output &&
|
|
|
|
test_cmp expected-iteration-sorted-output actual-iteration-sorted-output
|
|
'
|
|
|
|
test_expect_success 'dir-iterator should list files in the correct order' '
|
|
cat >expected-pre-order-output <<-EOF &&
|
|
[d] (a) [a] ./dir2/a
|
|
[d] (a/b) [b] ./dir2/a/b
|
|
[d] (a/b/c) [c] ./dir2/a/b/c
|
|
[f] (a/b/c/d) [d] ./dir2/a/b/c/d
|
|
EOF
|
|
|
|
test-tool dir-iterator ./dir2 >actual-pre-order-output &&
|
|
|
|
test_cmp expected-pre-order-output actual-pre-order-output
|
|
'
|
|
|
|
test_expect_success 'begin should fail upon inexistent paths' '
|
|
test_must_fail test-tool dir-iterator ./inexistent-path \
|
|
>actual-inexistent-path-output &&
|
|
echo "dir_iterator_begin failure: ENOENT" >expected-inexistent-path-output &&
|
|
test_cmp expected-inexistent-path-output actual-inexistent-path-output
|
|
'
|
|
|
|
test_expect_success 'begin should fail upon non directory paths' '
|
|
test_must_fail test-tool dir-iterator ./dir/b >actual-non-dir-output &&
|
|
echo "dir_iterator_begin failure: ENOTDIR" >expected-non-dir-output &&
|
|
test_cmp expected-non-dir-output actual-non-dir-output
|
|
'
|
|
|
|
test_expect_success POSIXPERM,SANITY 'advance should not fail on errors by default' '
|
|
cat >expected-no-permissions-output <<-EOF &&
|
|
[d] (a) [a] ./dir3/a
|
|
EOF
|
|
|
|
mkdir -p dir3/a &&
|
|
>dir3/a/b &&
|
|
chmod 0 dir3/a &&
|
|
|
|
test-tool dir-iterator ./dir3 >actual-no-permissions-output &&
|
|
test_cmp expected-no-permissions-output actual-no-permissions-output &&
|
|
chmod 755 dir3/a &&
|
|
rm -rf dir3
|
|
'
|
|
|
|
test_expect_success POSIXPERM,SANITY 'advance should fail on errors, w/ pedantic flag' '
|
|
cat >expected-no-permissions-pedantic-output <<-EOF &&
|
|
[d] (a) [a] ./dir3/a
|
|
dir_iterator_advance failure
|
|
EOF
|
|
|
|
mkdir -p dir3/a &&
|
|
>dir3/a/b &&
|
|
chmod 0 dir3/a &&
|
|
|
|
test_must_fail test-tool dir-iterator --pedantic ./dir3 \
|
|
>actual-no-permissions-pedantic-output &&
|
|
test_cmp expected-no-permissions-pedantic-output \
|
|
actual-no-permissions-pedantic-output &&
|
|
chmod 755 dir3/a &&
|
|
rm -rf dir3
|
|
'
|
|
|
|
test_expect_success SYMLINKS 'setup dirs with symlinks' '
|
|
mkdir -p dir4/a &&
|
|
mkdir -p dir4/b/c &&
|
|
>dir4/a/d &&
|
|
ln -s d dir4/a/e &&
|
|
ln -s ../b dir4/a/f &&
|
|
|
|
ln -s dir4 dir5
|
|
'
|
|
|
|
test_expect_success SYMLINKS 'dir-iterator should not follow symlinks by default' '
|
|
cat >expected-no-follow-sorted-output <<-EOF &&
|
|
[d] (a) [a] ./dir4/a
|
|
[d] (b) [b] ./dir4/b
|
|
[d] (b/c) [c] ./dir4/b/c
|
|
[f] (a/d) [d] ./dir4/a/d
|
|
[s] (a/e) [e] ./dir4/a/e
|
|
[s] (a/f) [f] ./dir4/a/f
|
|
EOF
|
|
|
|
test-tool dir-iterator ./dir4 >out &&
|
|
sort out >actual-no-follow-sorted-output &&
|
|
|
|
test_cmp expected-no-follow-sorted-output actual-no-follow-sorted-output
|
|
'
|
|
|
|
test_expect_success SYMLINKS 'dir-iterator does not resolve top-level symlinks' '
|
|
test_must_fail test-tool dir-iterator ./dir5 >out &&
|
|
|
|
test_grep "ENOTDIR" out
|
|
'
|
|
|
|
test_done
|