mirror of
https://github.com/git/git.git
synced 2026-08-03 14:41:11 +00:00
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>
213 lines
5.5 KiB
Bash
Executable File
213 lines
5.5 KiB
Bash
Executable File
#!/bin/sh
|
|
|
|
test_description='diff function context'
|
|
|
|
. ./test-lib.sh
|
|
|
|
dir="$TEST_DIRECTORY/t4051"
|
|
|
|
commit_and_tag () {
|
|
tag=$1 &&
|
|
shift &&
|
|
git add "$@" &&
|
|
test_tick &&
|
|
git commit -m "$tag" &&
|
|
git tag "$tag"
|
|
}
|
|
|
|
first_context_line () {
|
|
awk '
|
|
found {print; exit}
|
|
/^@@/ {found = 1}
|
|
'
|
|
}
|
|
|
|
last_context_line () {
|
|
sed -ne \$p
|
|
}
|
|
|
|
check_diff () {
|
|
name=$1
|
|
desc=$2
|
|
options="-W $3"
|
|
|
|
test_expect_success "$desc" '
|
|
git diff $options "$name^" "$name" >"$name.diff"
|
|
'
|
|
|
|
test_expect_success ' diff applies' '
|
|
test_when_finished "git reset --hard" &&
|
|
git checkout --detach "$name^" &&
|
|
git apply --index "$name.diff" &&
|
|
git diff --exit-code "$name"
|
|
'
|
|
}
|
|
|
|
test_expect_success 'setup' '
|
|
cat "$dir/includes.c" "$dir/dummy.c" "$dir/dummy.c" "$dir/hello.c" \
|
|
"$dir/dummy.c" "$dir/dummy.c" >file.c &&
|
|
commit_and_tag initial file.c &&
|
|
|
|
grep -v "delete me from hello" <file.c >file.c.new &&
|
|
mv file.c.new file.c &&
|
|
commit_and_tag changed_hello file.c &&
|
|
|
|
grep -v "delete me from includes" <file.c >file.c.new &&
|
|
mv file.c.new file.c &&
|
|
commit_and_tag changed_includes file.c &&
|
|
|
|
cat "$dir/appended1.c" >>file.c &&
|
|
commit_and_tag appended file.c &&
|
|
|
|
cat "$dir/appended2.c" >>file.c &&
|
|
commit_and_tag extended file.c &&
|
|
|
|
grep -v "Begin of second part" <file.c >file.c.new &&
|
|
mv file.c.new file.c &&
|
|
commit_and_tag long_common_tail file.c &&
|
|
|
|
git checkout initial &&
|
|
cat "$dir/hello.c" "$dir/dummy.c" >file.c &&
|
|
commit_and_tag hello_dummy file.c &&
|
|
|
|
# overlap function context of 1st change and -u context of 2nd change
|
|
grep -v "delete me from hello" <"$dir/hello.c" >file.c &&
|
|
sed "2a\\
|
|
extra line" <"$dir/dummy.c" >>file.c &&
|
|
commit_and_tag changed_hello_dummy file.c &&
|
|
|
|
git checkout initial &&
|
|
grep -v "delete me from hello" <file.c >file.c.new &&
|
|
mv file.c.new file.c &&
|
|
cat "$dir/appended1.c" >>file.c &&
|
|
commit_and_tag changed_hello_appended file.c
|
|
'
|
|
|
|
check_diff changed_hello 'changed function'
|
|
|
|
test_expect_success ' context includes comment' '
|
|
test_grep "^ .*Hello comment" changed_hello.diff
|
|
'
|
|
|
|
test_expect_success ' context includes begin' '
|
|
test_grep "^ .*Begin of hello" changed_hello.diff
|
|
'
|
|
|
|
test_expect_success ' context includes end' '
|
|
test_grep "^ .*End of hello" changed_hello.diff
|
|
'
|
|
|
|
test_expect_success ' context does not include other functions' '
|
|
test $(grep -c "^[ +-].*Begin" changed_hello.diff) -le 1
|
|
'
|
|
|
|
test_expect_success ' context does not include preceding empty lines' '
|
|
test "$(first_context_line <changed_hello.diff)" != " "
|
|
'
|
|
|
|
test_expect_success ' context does not include trailing empty lines' '
|
|
test "$(last_context_line <changed_hello.diff)" != " "
|
|
'
|
|
|
|
check_diff changed_includes 'changed includes'
|
|
|
|
test_expect_success ' context includes begin' '
|
|
test_grep "^ .*Begin.h" changed_includes.diff
|
|
'
|
|
|
|
test_expect_success ' context includes end' '
|
|
test_grep "^ .*End.h" changed_includes.diff
|
|
'
|
|
|
|
test_expect_success ' context does not include other functions' '
|
|
test $(grep -c "^[ +-].*Begin" changed_includes.diff) -le 1
|
|
'
|
|
|
|
test_expect_success ' context does not include trailing empty lines' '
|
|
test "$(last_context_line <changed_includes.diff)" != " "
|
|
'
|
|
|
|
check_diff appended 'appended function'
|
|
|
|
test_expect_success ' context includes begin' '
|
|
test_grep "^[+].*Begin of first part" appended.diff
|
|
'
|
|
|
|
test_expect_success ' context includes end' '
|
|
test_grep "^[+].*End of first part" appended.diff
|
|
'
|
|
|
|
test_expect_success ' context does not include other functions' '
|
|
test $(grep -c "^[ +-].*Begin" appended.diff) -le 1
|
|
'
|
|
|
|
check_diff extended 'appended function part'
|
|
|
|
test_expect_success ' context includes begin' '
|
|
test_grep "^ .*Begin of first part" extended.diff
|
|
'
|
|
|
|
test_expect_success ' context includes end' '
|
|
test_grep "^[+].*End of second part" extended.diff
|
|
'
|
|
|
|
test_expect_success ' context does not include other functions' '
|
|
test $(grep -c "^[ +-].*Begin" extended.diff) -le 2
|
|
'
|
|
|
|
test_expect_success ' context does not include preceding empty lines' '
|
|
test "$(first_context_line <extended.diff)" != " "
|
|
'
|
|
|
|
check_diff long_common_tail 'change with long common tail and no context' -U0
|
|
|
|
test_expect_success ' context includes begin' '
|
|
test_grep "^ .*Begin of first part" long_common_tail.diff
|
|
'
|
|
|
|
test_expect_success ' context includes end' '
|
|
test_grep "^ .*End of second part" long_common_tail.diff
|
|
'
|
|
|
|
test_expect_success ' context does not include other functions' '
|
|
test $(grep -c "^[ +-].*Begin" long_common_tail.diff) -le 2
|
|
'
|
|
|
|
test_expect_success ' context does not include preceding empty lines' '
|
|
test "$(first_context_line <long_common_tail.diff)" != " "
|
|
'
|
|
|
|
check_diff changed_hello_appended 'changed function plus appended function'
|
|
|
|
test_expect_success ' context includes begin' '
|
|
test_grep "^ .*Begin of hello" changed_hello_appended.diff &&
|
|
test_grep "^[+].*Begin of first part" changed_hello_appended.diff
|
|
'
|
|
|
|
test_expect_success ' context includes end' '
|
|
test_grep "^ .*End of hello" changed_hello_appended.diff &&
|
|
test_grep "^[+].*End of first part" changed_hello_appended.diff
|
|
'
|
|
|
|
test_expect_success ' context does not include other functions' '
|
|
test $(grep -c "^[ +-].*Begin" changed_hello_appended.diff) -le 2
|
|
'
|
|
|
|
check_diff changed_hello_dummy 'changed two consecutive functions'
|
|
|
|
test_expect_success ' context includes begin' '
|
|
test_grep "^ .*Begin of hello" changed_hello_dummy.diff &&
|
|
test_grep "^ .*Begin of dummy" changed_hello_dummy.diff
|
|
'
|
|
|
|
test_expect_success ' context includes end' '
|
|
test_grep "^ .*End of hello" changed_hello_dummy.diff &&
|
|
test_grep "^ .*End of dummy" changed_hello_dummy.diff
|
|
'
|
|
|
|
test_expect_success ' overlapping hunks are merged' '
|
|
test $(grep -c "^@@" changed_hello_dummy.diff) -eq 1
|
|
'
|
|
|
|
test_done
|