mirror of
https://github.com/git/git.git
synced 2026-10-14 05:49:50 +02:00
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>
78 lines
2.5 KiB
Bash
78 lines
2.5 KiB
Bash
git_show_ref_exists=${git_show_ref_exists:-git show-ref --exists}
|
|
|
|
test_expect_success setup '
|
|
test_commit --annotate A &&
|
|
git checkout -b side &&
|
|
test_commit --annotate B &&
|
|
git checkout main &&
|
|
test_commit C &&
|
|
git branch B A^0
|
|
'
|
|
|
|
test_expect_success '--exists with existing reference' '
|
|
${git_show_ref_exists} refs/heads/$GIT_TEST_DEFAULT_INITIAL_BRANCH_NAME
|
|
'
|
|
|
|
test_expect_success '--exists with missing reference' '
|
|
test_expect_code 2 ${git_show_ref_exists} refs/heads/does-not-exist
|
|
'
|
|
|
|
test_expect_success '--exists does not use DWIM' '
|
|
test_expect_code 2 ${git_show_ref_exists} $GIT_TEST_DEFAULT_INITIAL_BRANCH_NAME 2>err &&
|
|
test_grep "reference does not exist" err
|
|
'
|
|
|
|
test_expect_success '--exists with HEAD' '
|
|
${git_show_ref_exists} HEAD
|
|
'
|
|
|
|
test_expect_success '--exists with bad reference name' '
|
|
test_when_finished "git update-ref -d refs/heads/bad...name" &&
|
|
new_oid=$(git rev-parse HEAD) &&
|
|
test-tool ref-store main update-ref msg refs/heads/bad...name $new_oid $ZERO_OID REF_SKIP_REFNAME_VERIFICATION &&
|
|
${git_show_ref_exists} refs/heads/bad...name
|
|
'
|
|
|
|
test_expect_success '--exists with arbitrary symref' '
|
|
test_when_finished "git symbolic-ref -d refs/symref" &&
|
|
git symbolic-ref refs/symref refs/heads/$GIT_TEST_DEFAULT_INITIAL_BRANCH_NAME &&
|
|
${git_show_ref_exists} refs/symref
|
|
'
|
|
|
|
test_expect_success '--exists with dangling symref' '
|
|
test_when_finished "git symbolic-ref -d refs/heads/dangling" &&
|
|
git symbolic-ref refs/heads/dangling refs/heads/does-not-exist &&
|
|
${git_show_ref_exists} refs/heads/dangling
|
|
'
|
|
|
|
test_expect_success '--exists with nonexistent object ID' '
|
|
test-tool ref-store main update-ref msg refs/heads/missing-oid $(test_oid 001) $ZERO_OID REF_SKIP_OID_VERIFICATION &&
|
|
${git_show_ref_exists} refs/heads/missing-oid
|
|
'
|
|
|
|
test_expect_success '--exists with non-commit object' '
|
|
tree_oid=$(git rev-parse HEAD^{tree}) &&
|
|
test-tool ref-store main update-ref msg refs/heads/tree ${tree_oid} $ZERO_OID REF_SKIP_OID_VERIFICATION &&
|
|
${git_show_ref_exists} refs/heads/tree
|
|
'
|
|
|
|
test_expect_success '--exists with directory fails with generic error' '
|
|
cat >expect <<-EOF &&
|
|
error: reference does not exist
|
|
EOF
|
|
test_expect_code 2 ${git_show_ref_exists} refs/heads 2>err &&
|
|
test_cmp expect err
|
|
'
|
|
|
|
test_expect_success '--exists with non-existent special ref' '
|
|
test_expect_code 2 ${git_show_ref_exists} FETCH_HEAD
|
|
'
|
|
|
|
test_expect_success '--exists with existing special ref' '
|
|
test_when_finished "rm .git/FETCH_HEAD" &&
|
|
git rev-parse HEAD >.git/FETCH_HEAD &&
|
|
${git_show_ref_exists} FETCH_HEAD
|
|
'
|
|
|
|
test_done
|