git/t/annotate-tests.sh
Jacob Keller 1a3119ed06 blame: allow --contents to work with non-HEAD commit
The --contents option can be used with git blame to blame the file as if
it had the contents from the specified file. This is akin to copying the
contents into the working tree and then running git blame. This option
has been supported since 1cfe77333f ("git-blame: no rev means start
from the working tree file.")

The --contents option always blames the file as if it was based on the
current HEAD commit. If you try to pass a revision while using
--contents, you get the following error:

  fatal: cannot use --contents with final commit object name

This is because the blame process generates a fake working tree commit
which always uses the HEAD object as its sole parent.

Enhance fake_working_tree_commit to take the object ID to use for the
parent instead of always using the HEAD object. Then, always generate a
fake commit when we have contents provided, even if we have a final
object. Remove the check to disallow --contents and a final revision.

Note that the behavior of generating a fake working commit is still
skipped when a revision is provided but --contents is not provided.
Generating such a commit in that case would combine the currently
checked out file contents with the provided revision, which breaks
normal blame behavior and produces unexpected results.

This enables use of --contents with an arbitrary revision, rather than
forcing the use of the local HEAD commit. This makes the --contents
option significantly more flexible, as it is no longer required to check
out the working tree to the desired commit before using --contents.

Reword the documentation so that its clear that --contents can be used
with <rev>.

Add tests for the --contents option to the annotate-tests.sh test
script.

Signed-off-by: Jacob Keller <jacob.keller@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2023-03-24 12:05:22 -07:00

662 lines
15 KiB
Bash

# This file isn't used as a test script directly, instead it is
# sourced from t8001-annotate.sh and t8002-blame.sh.
if test_have_prereq MINGW
then
sanitize_L () {
echo "$1" | sed 'sX\(^-L\|,\)\^\?/X&\\;*Xg'
}
else
sanitize_L () {
echo "$1"
}
fi
check_count () {
head= &&
file='file' &&
options= &&
while :
do
case "$1" in
-h) head="$2"; shift; shift ;;
-f) file="$2"; shift; shift ;;
-L*) options="$options $(sanitize_L "$1")"; shift ;;
-*) options="$options $1"; shift ;;
*) break ;;
esac
done &&
echo "$PROG $options $file $head" >&4 &&
$PROG $options $file $head >actual &&
perl -e '
my %expect = (@ARGV);
my %count = map { $_ => 0 } keys %expect;
while (<STDIN>) {
if (/^[0-9a-f]+\t\(([^\t]+)\t/) {
my $author = $1;
for ($author) { s/^\s*//; s/\s*$//; }
$count{$author}++;
}
}
my $bad = 0;
while (my ($author, $count) = each %count) {
my $ok;
my $value = 0;
$value = $expect{$author} if defined $expect{$author};
if ($value != $count) {
$bad = 1;
$ok = "bad";
}
else {
$ok = "good";
}
print STDERR "Author $author (expected $value, attributed $count) $ok\n";
}
exit($bad);
' "$@" <actual
}
get_progress_result () {
tr '\015' '\012' | tail -n 1
}
test_expect_success 'setup A lines' '
echo "1A quick brown fox jumps over the" >file &&
echo "lazy dog" >>file &&
git add file &&
GIT_AUTHOR_NAME="A" GIT_AUTHOR_EMAIL="A@test.git" \
git commit -a -m "Initial."
'
test_expect_success 'blame 1 author' '
check_count A 2
'
test_expect_success 'blame with --contents' '
check_count --contents=file A 2
'
test_expect_success 'blame with --contents changed' '
echo "1A quick brown fox jumps over the" >contents &&
echo "another lazy dog" >>contents &&
check_count --contents=contents A 1 "Not Committed Yet" 1
'
test_expect_success 'blame in a bare repo without starting commit' '
git clone --bare . bare.git &&
(
cd bare.git &&
check_count A 2
)
'
test_expect_success 'blame by tag objects' '
git tag -m "test tag" testTag &&
git tag -m "test tag #2" testTag2 testTag &&
check_count -h testTag A 2 &&
check_count -h testTag2 A 2
'
test_expect_success 'setup B lines' '
echo "2A quick brown fox jumps over the" >>file &&
echo "lazy dog" >>file &&
GIT_AUTHOR_NAME="B" GIT_AUTHOR_EMAIL="B@test.git" \
git commit -a -m "Second."
'
test_expect_success 'blame 2 authors' '
check_count A 2 B 2
'
test_expect_success 'blame with --contents and revision' '
check_count -h testTag --contents=file A 2 "Not Committed Yet" 2
'
test_expect_success 'setup B1 lines (branch1)' '
git checkout -b branch1 main &&
echo "3A slow green fox jumps into the" >>file &&
echo "well." >>file &&
GIT_AUTHOR_NAME="B1" GIT_AUTHOR_EMAIL="B1@test.git" \
git commit -a -m "Branch1-1"
'
test_expect_success 'blame 2 authors + 1 branch1 author' '
check_count A 2 B 2 B1 2
'
test_expect_success 'setup B2 lines (branch2)' '
git checkout -b branch2 main &&
sed -e "s/2A quick brown/4A quick brown lazy dog/" <file >file.new &&
mv file.new file &&
GIT_AUTHOR_NAME="B2" GIT_AUTHOR_EMAIL="B2@test.git" \
git commit -a -m "Branch2-1"
'
test_expect_success 'blame 2 authors + 1 branch2 author' '
check_count A 2 B 1 B2 1
'
test_expect_success 'merge branch1 & branch2' '
git merge branch1
'
test_expect_success 'blame 2 authors + 2 merged-in authors' '
check_count A 2 B 1 B1 2 B2 1
'
test_expect_success 'blame --first-parent blames merge for branch1' '
check_count --first-parent A 2 B 1 "A U Thor" 2 B2 1
'
test_expect_success 'blame ancestor' '
check_count -h main A 2 B 2
'
test_expect_success 'blame great-ancestor' '
check_count -h main^ A 2
'
test_expect_success 'setup evil merge' '
echo "evil merge." >>file &&
git commit -a --amend
'
test_expect_success 'blame evil merge' '
check_count A 2 B 1 B1 2 B2 1 "A U Thor" 1
'
test_expect_success 'blame huge graft' '
test_when_finished "git checkout branch2" &&
test_when_finished "rm -rf .git/info" &&
graft= &&
for i in 0 1 2
do
for j in 0 1 2 3 4 5 6 7 8 9
do
git checkout --orphan "$i$j" &&
printf "%s\n" "$i" "$j" >file &&
test_tick &&
GIT_AUTHOR_NAME=$i$j GIT_AUTHOR_EMAIL=$i$j@test.git \
git commit -a -m "$i$j" &&
commit=$(git rev-parse --verify HEAD) &&
graft="$graft$commit " || return 1
done
done &&
mkdir .git/info &&
printf "%s " $graft >.git/info/grafts &&
check_count -h 00 01 1 10 1
'
test_expect_success 'setup incomplete line' '
echo "incomplete" | tr -d "\\012" >>file &&
GIT_AUTHOR_NAME="C" GIT_AUTHOR_EMAIL="C@test.git" \
git commit -a -m "Incomplete"
'
test_expect_success 'blame incomplete line' '
check_count A 2 B 1 B1 2 B2 1 "A U Thor" 1 C 1
'
test_expect_success 'setup edits' '
mv file file.orig &&
{
cat file.orig &&
echo
} | sed -e "s/^3A/99/" -e "/^1A/d" -e "/^incomplete/d" >file &&
echo "incomplete" | tr -d "\\012" >>file &&
GIT_AUTHOR_NAME="D" GIT_AUTHOR_EMAIL="D@test.git" \
git commit -a -m "edit"
'
test_expect_success 'blame edits' '
check_count A 1 B 1 B1 1 B2 1 "A U Thor" 1 C 1 D 1
'
test_expect_success 'setup obfuscated email' '
echo "No robots allowed" >file.new &&
cat file >>file.new &&
mv file.new file &&
GIT_AUTHOR_NAME="E" GIT_AUTHOR_EMAIL="E at test dot git" \
git commit -a -m "norobots"
'
test_expect_success 'blame obfuscated email' '
check_count A 1 B 1 B1 1 B2 1 "A U Thor" 1 C 1 D 1 E 1
'
test_expect_success 'blame -L 1 (all)' '
check_count -L1 A 1 B 1 B1 1 B2 1 "A U Thor" 1 C 1 D 1 E 1
'
test_expect_success 'blame -L , (all)' '
check_count -L, A 1 B 1 B1 1 B2 1 "A U Thor" 1 C 1 D 1 E 1
'
test_expect_success 'blame -L X (X to end)' '
check_count -L5 B1 1 C 1 D 1 "A U Thor" 1
'
test_expect_success 'blame -L X, (X to end)' '
check_count -L5, B1 1 C 1 D 1 "A U Thor" 1
'
test_expect_success 'blame -L ,Y (up to Y)' '
check_count -L,3 A 1 B2 1 E 1
'
test_expect_success 'blame -L X,X' '
check_count -L3,3 B2 1
'
test_expect_success 'blame -L X,Y' '
check_count -L3,6 B 1 B1 1 B2 1 D 1
'
test_expect_success 'blame -L Y,X (undocumented)' '
check_count -L6,3 B 1 B1 1 B2 1 D 1
'
test_expect_success 'blame -L -X' '
test_must_fail $PROG -L-1 file
'
test_expect_success 'blame -L 0' '
test_must_fail $PROG -L0 file
'
test_expect_success 'blame -L ,0' '
test_must_fail $PROG -L,0 file
'
test_expect_success 'blame -L ,+0' '
test_must_fail $PROG -L,+0 file
'
test_expect_success 'blame -L X,+0' '
test_must_fail $PROG -L1,+0 file
'
test_expect_success 'blame -L X,+1' '
check_count -L3,+1 B2 1
'
test_expect_success 'blame -L X,+N' '
check_count -L3,+4 B 1 B1 1 B2 1 D 1
'
test_expect_success 'blame -L ,-0' '
test_must_fail $PROG -L,-0 file
'
test_expect_success 'blame -L X,-0' '
test_must_fail $PROG -L1,-0 file
'
test_expect_success 'blame -L X,-1' '
check_count -L3,-1 B2 1
'
test_expect_success 'blame -L X,-N' '
check_count -L6,-4 B 1 B1 1 B2 1 D 1
'
test_expect_success 'blame -L /RE/ (RE to end)' '
check_count -L/evil/ C 1 "A U Thor" 1
'
test_expect_success 'blame -L /RE/,/RE2/' '
check_count -L/robot/,/green/ A 1 B 1 B2 1 D 1 E 1
'
test_expect_success 'blame -L X,/RE/' '
check_count -L5,/evil/ B1 1 D 1 "A U Thor" 1
'
test_expect_success 'blame -L /RE/,Y' '
check_count -L/99/,7 B1 1 D 1 "A U Thor" 1
'
test_expect_success 'blame -L /RE/,+N' '
check_count -L/99/,+3 B1 1 D 1 "A U Thor" 1
'
test_expect_success 'blame -L /RE/,-N' '
check_count -L/99/,-3 B 1 B2 1 D 1
'
# 'file' ends with an incomplete line, so 'wc' reports one fewer lines than
# git-blame sees, hence the last line is actually $(wc...)+1.
test_expect_success 'blame -L X (X == nlines)' '
n=$(expr $(wc -l <file) + 1) &&
check_count -L$n C 1
'
test_expect_success 'blame -L X (X == nlines + 1)' '
n=$(expr $(wc -l <file) + 2) &&
test_must_fail $PROG -L$n file
'
test_expect_success 'blame -L X (X > nlines)' '
test_must_fail $PROG -L12345 file
'
test_expect_success 'blame -L ,Y (Y == nlines)' '
n=$(expr $(wc -l <file) + 1) &&
check_count -L,$n A 1 B 1 B1 1 B2 1 "A U Thor" 1 C 1 D 1 E 1
'
test_expect_success 'blame -L ,Y (Y == nlines + 1)' '
n=$(expr $(wc -l <file) + 2) &&
check_count -L,$n A 1 B 1 B1 1 B2 1 "A U Thor" 1 C 1 D 1 E 1
'
test_expect_success 'blame -L ,Y (Y > nlines)' '
check_count -L,12345 A 1 B 1 B1 1 B2 1 "A U Thor" 1 C 1 D 1 E 1
'
test_expect_success 'blame -L multiple (disjoint)' '
check_count -L2,3 -L6,7 A 1 B1 1 B2 1 "A U Thor" 1
'
test_expect_success 'blame -L multiple (disjoint: unordered)' '
check_count -L6,7 -L2,3 A 1 B1 1 B2 1 "A U Thor" 1
'
test_expect_success 'blame -L multiple (adjacent)' '
check_count -L2,3 -L4,5 A 1 B 1 B2 1 D 1
'
test_expect_success 'blame -L multiple (adjacent: unordered)' '
check_count -L4,5 -L2,3 A 1 B 1 B2 1 D 1
'
test_expect_success 'blame -L multiple (overlapping)' '
check_count -L2,4 -L3,5 A 1 B 1 B2 1 D 1
'
test_expect_success 'blame -L multiple (overlapping: unordered)' '
check_count -L3,5 -L2,4 A 1 B 1 B2 1 D 1
'
test_expect_success 'blame -L multiple (superset/subset)' '
check_count -L2,8 -L3,5 A 1 B 1 B1 1 B2 1 C 1 D 1 "A U Thor" 1
'
test_expect_success 'blame -L multiple (superset/subset: unordered)' '
check_count -L3,5 -L2,8 A 1 B 1 B1 1 B2 1 C 1 D 1 "A U Thor" 1
'
test_expect_success 'blame -L /RE/ (relative)' '
check_count -L3,3 -L/fox/ B1 1 B2 1 C 1 D 1 "A U Thor" 1
'
test_expect_success 'blame -L /RE/ (relative: no preceding range)' '
check_count -L/dog/ A 1 B 1 B1 1 B2 1 C 1 D 1 "A U Thor" 1
'
test_expect_success 'blame -L /RE/ (relative: adjacent)' '
check_count -L1,1 -L/dog/,+1 A 1 E 1
'
test_expect_success 'blame -L /RE/ (relative: not found)' '
test_must_fail $PROG -L4,4 -L/dog/ file
'
test_expect_success 'blame -L /RE/ (relative: end-of-file)' '
test_must_fail $PROG -L, -L/$/ file
'
test_expect_success 'blame -L ^/RE/ (absolute)' '
check_count -L3,3 -L^/dog/,+2 A 1 B2 1
'
test_expect_success 'blame -L ^/RE/ (absolute: no preceding range)' '
check_count -L^/dog/,+2 A 1 B2 1
'
test_expect_success 'blame -L ^/RE/ (absolute: not found)' '
test_must_fail $PROG -L4,4 -L^/tambourine/ file
'
test_expect_success 'blame -L ^/RE/ (absolute: end-of-file)' '
n=$(expr $(wc -l <file) + 1) &&
check_count -L$n -L^/$/,+2 A 1 C 1 E 1
'
test_expect_success 'setup -L :regex' '
tr Q "\\t" >hello.c <<-\EOF &&
int main(int argc, const char *argv[])
{
Qputs("hello");
}
EOF
git add hello.c &&
GIT_AUTHOR_NAME="F" GIT_AUTHOR_EMAIL="F@test.git" \
git commit -m "hello" &&
mv hello.c hello.orig &&
sed -e "/}/ {x; s/$/Qputs(\"goodbye\");/; G;}" <hello.orig |
tr Q "\\t" >hello.c &&
GIT_AUTHOR_NAME="G" GIT_AUTHOR_EMAIL="G@test.git" \
git commit -a -m "goodbye" &&
mv hello.c hello.orig &&
echo "#include <stdio.h>" >hello.c &&
cat hello.orig >>hello.c &&
tr Q "\\t" >>hello.c <<-\EOF &&
void mail()
{
Qputs("mail");
}
EOF
GIT_AUTHOR_NAME="H" GIT_AUTHOR_EMAIL="H@test.git" \
git commit -a -m "mail"
'
test_expect_success 'blame -L :literal' '
check_count -f hello.c -L:main F 4 G 1
'
test_expect_success 'blame -L :regex' '
check_count -f hello.c "-L:m[a-z][a-z]l" H 4
'
test_expect_success 'blame -L :nomatch' '
test_must_fail $PROG -L:nomatch hello.c
'
test_expect_success 'blame -L :RE (relative)' '
check_count -f hello.c -L3,3 -L:ma.. F 1 H 4
'
test_expect_success 'blame -L :RE (relative: no preceding range)' '
check_count -f hello.c -L:ma.. F 4 G 1
'
test_expect_success 'blame -L :RE (relative: not found)' '
test_must_fail $PROG -L3,3 -L:tambourine hello.c
'
test_expect_success 'blame -L :RE (relative: end-of-file)' '
test_must_fail $PROG -L, -L:main hello.c
'
test_expect_success 'blame -L ^:RE (absolute)' '
check_count -f hello.c -L3,3 -L^:ma.. F 4 G 1
'
test_expect_success 'blame -L ^:RE (absolute: no preceding range)' '
check_count -f hello.c -L^:ma.. F 4 G 1
'
test_expect_success 'blame -L ^:RE (absolute: not found)' '
test_must_fail $PROG -L4,4 -L^:tambourine hello.c
'
test_expect_success 'blame -L ^:RE (absolute: end-of-file)' '
n=$(printf "%d" $(wc -l <hello.c)) &&
check_count -f hello.c -L$n -L^:ma.. F 4 G 1 H 1
'
test_expect_success 'blame -L :funcname with userdiff driver' '
cat >file.template <<-\EOF &&
DO NOT MATCH THIS LINE
function RIGHT(a, b) result(c)
AS THE DEFAULT DRIVER WOULD
integer, intent(in) :: ChangeMe
EOF
fortran_file=file.f03 &&
test_when_finished "rm .gitattributes" &&
echo "$fortran_file diff=fortran" >.gitattributes &&
test_commit --author "A <A@test.git>" \
"add" "$fortran_file" \
"$(cat file.template)" &&
test_commit --author "B <B@test.git>" \
"change" "$fortran_file" \
"$(cat file.template | sed -e s/ChangeMe/IWasChanged/)" &&
check_count -f "$fortran_file" -L:RIGHT A 3 B 1
'
test_expect_success 'setup incremental' '
(
GIT_AUTHOR_NAME=I &&
export GIT_AUTHOR_NAME &&
GIT_AUTHOR_EMAIL=I@test.git &&
export GIT_AUTHOR_EMAIL &&
>incremental &&
git add incremental &&
git commit -m "step 0" &&
printf "partial" >>incremental &&
git commit -a -m "step 0.5" &&
echo >>incremental &&
git commit -a -m "step 1"
)
'
test_expect_success 'blame empty' '
check_count -h HEAD^^ -f incremental
'
test_expect_success 'blame -L 0 empty' '
test_must_fail $PROG -L0 incremental HEAD^^
'
test_expect_success 'blame -L 1 empty' '
test_must_fail $PROG -L1 incremental HEAD^^
'
test_expect_success 'blame -L 2 empty' '
test_must_fail $PROG -L2 incremental HEAD^^
'
test_expect_success 'blame half' '
check_count -h HEAD^ -f incremental I 1
'
test_expect_success 'blame -L 0 half' '
test_must_fail $PROG -L0 incremental HEAD^
'
test_expect_success 'blame -L 1 half' '
check_count -h HEAD^ -f incremental -L1 I 1
'
test_expect_success 'blame -L 2 half' '
test_must_fail $PROG -L2 incremental HEAD^
'
test_expect_success 'blame -L 3 half' '
test_must_fail $PROG -L3 incremental HEAD^
'
test_expect_success 'blame full' '
check_count -f incremental I 1
'
test_expect_success 'blame -L 0 full' '
test_must_fail $PROG -L0 incremental
'
test_expect_success 'blame -L 1 full' '
check_count -f incremental -L1 I 1
'
test_expect_success 'blame -L 2 full' '
test_must_fail $PROG -L2 incremental
'
test_expect_success 'blame -L 3 full' '
test_must_fail $PROG -L3 incremental
'
test_expect_success 'blame -L' '
test_must_fail $PROG -L file
'
test_expect_success 'blame -L X,+' '
test_must_fail $PROG -L1,+ file
'
test_expect_success 'blame -L X,-' '
test_must_fail $PROG -L1,- file
'
test_expect_success 'blame -L X (non-numeric X)' '
test_must_fail $PROG -LX file
'
test_expect_success 'blame -L X,Y (non-numeric Y)' '
test_must_fail $PROG -L1,Y file
'
test_expect_success 'blame -L X,+N (non-numeric N)' '
test_must_fail $PROG -L1,+N file
'
test_expect_success 'blame -L X,-N (non-numeric N)' '
test_must_fail $PROG -L1,-N file
'
test_expect_success 'blame -L ,^/RE/' '
test_must_fail $PROG -L1,^/99/ file
'
test_expect_success 'blame progress on a full file' '
cat >expect <<-\EOF &&
Blaming lines: 100% (10/10), done.
EOF
GIT_PROGRESS_DELAY=0 \
git blame --progress hello.c 2>stderr &&
get_progress_result <stderr >actual &&
test_cmp expect actual
'
test_expect_success 'blame progress on a single range' '
cat >expect <<-\EOF &&
Blaming lines: 100% (4/4), done.
EOF
GIT_PROGRESS_DELAY=0 \
git blame --progress -L 3,6 hello.c 2>stderr &&
get_progress_result <stderr >actual &&
test_cmp expect actual
'
test_expect_success 'blame progress on multiple ranges' '
cat >expect <<-\EOF &&
Blaming lines: 100% (7/7), done.
EOF
GIT_PROGRESS_DELAY=0 \
git blame --progress -L 3,6 -L 8,10 hello.c 2>stderr &&
get_progress_result <stderr >actual &&
test_cmp expect actual
'