3 test_description
='test describe'
5 # o---o-----o----o----o-------o----x
7 # \---o-------------o-'
12 # First parent of a merge commit is on the same line, second parent below.
14 GIT_TEST_DEFAULT_INITIAL_BRANCH_NAME
=main
15 export GIT_TEST_DEFAULT_INITIAL_BRANCH_NAME
34 indir
=${indir:+"$indir"/} &&
38 test_expect_success
"describe $describe_opts" '
39 git ${indir:+ -C "$indir"} describe $describe_opts >raw &&
40 sed -e "s/-g[0-9a-f]*\$/-gHASH/" <raw >actual &&
41 echo "$expect" >expect &&
42 test_cmp expect actual
46 test_expect_success setup
'
47 test_commit initial file one &&
48 test_commit second file two &&
49 test_commit third file three &&
50 test_commit --annotate A file A &&
51 test_commit c file c &&
53 git reset --hard second &&
54 test_commit --annotate B side B &&
57 git merge -m Merged c &&
58 merged=$(git rev-parse HEAD) &&
60 git reset --hard second &&
61 test_commit --no-tag D another D &&
66 test_commit e another DD &&
67 test_commit --no-tag "yet another" another DDD &&
70 git merge -m Merged $merged &&
72 test_commit --no-tag x file
75 check_describe A-8-gHASH HEAD
76 check_describe A-7-gHASH HEAD^
77 check_describe R-2-gHASH HEAD^^
78 check_describe A-3-gHASH HEAD^^
2
79 check_describe B HEAD^^
2^
80 check_describe R-1-gHASH HEAD^^^
82 check_describe c-7-gHASH
--tags HEAD
83 check_describe c-6-gHASH
--tags HEAD^
84 check_describe e-1-gHASH
--tags HEAD^^
85 check_describe c-2-gHASH
--tags HEAD^^
2
86 check_describe B
--tags HEAD^^
2^
87 check_describe e
--tags HEAD^^^
89 check_describe
heads
/main
--all HEAD
90 check_describe tags
/c-6-gHASH
--all HEAD^
91 check_describe tags
/e
--all HEAD^^^
93 check_describe B-0-gHASH
--long HEAD^^
2^
94 check_describe A-3-gHASH
--long HEAD^^
2
96 check_describe c-7-gHASH
--tags
97 check_describe e-3-gHASH
--first-parent --tags
99 test_expect_success
'describe --contains defaults to HEAD without commit-ish' '
100 echo "A^0" >expect &&
102 test_when_finished "git checkout -" &&
103 git describe --contains >actual &&
104 test_cmp expect actual
107 check_describe tags
/A
--all A^
0
109 test_expect_success
'renaming tag A to Q locally produces a warning' "
110 git update-ref refs/tags/Q $(git rev-parse refs/tags/A) &&
111 git update-ref -d refs/tags/A &&
112 git describe HEAD 2>err >out &&
113 cat >expected <<-\EOF &&
114 warning: tag 'Q' is externally known as 'A'
116 test_cmp expected err &&
117 grep -E '^A-8-g[0-9a-f]+$' out
120 test_expect_success
'misnamed annotated tag forces long output' '
121 description=$(git describe --no-long Q^0) &&
122 expr "$description" : "A-0-g[0-9a-f]*$" &&
123 git rev-parse --verify "$description" >actual &&
124 git rev-parse --verify Q^0 >expect &&
125 test_cmp expect actual
128 test_expect_success
'abbrev=0 will not break misplaced tag (1)' '
129 description=$(git describe --abbrev=0 Q^0) &&
130 expr "$description" : "A-0-g[0-9a-f]*$"
133 test_expect_success
'abbrev=0 will not break misplaced tag (2)' '
134 description=$(git describe --abbrev=0 c^0) &&
135 expr "$description" : "A-1-g[0-9a-f]*$"
138 test_expect_success
'rename tag Q back to A' '
139 git update-ref refs/tags/A $(git rev-parse refs/tags/Q) &&
140 git update-ref -d refs/tags/Q
143 test_expect_success
'pack tag refs' 'git pack-refs'
144 check_describe A-8-gHASH HEAD
146 test_expect_success
'describe works from outside repo using --git-dir' '
147 git clone --bare "$TRASH_DIRECTORY" "$TRASH_DIRECTORY/bare" &&
148 git --git-dir "$TRASH_DIRECTORY/bare" describe >out &&
149 grep -E "^A-8-g[0-9a-f]+$" out
152 check_describe
"A-8-gHASH" --dirty
154 test_expect_success
'describe --dirty with --work-tree' '
156 cd "$TEST_DIRECTORY" &&
157 git --git-dir "$TRASH_DIRECTORY/.git" --work-tree "$TRASH_DIRECTORY" describe --dirty >"$TRASH_DIRECTORY/out"
159 grep -E "^A-8-g[0-9a-f]+$" out
162 test_expect_success
'set-up dirty work tree' '
166 test_expect_success
'describe --dirty with --work-tree (dirty)' '
167 git describe --dirty >expected &&
169 cd "$TEST_DIRECTORY" &&
170 git --git-dir "$TRASH_DIRECTORY/.git" --work-tree "$TRASH_DIRECTORY" describe --dirty >"$TRASH_DIRECTORY/out"
172 grep -E "^A-8-g[0-9a-f]+-dirty$" out &&
173 test_cmp expected out
176 test_expect_success
'describe --dirty=.mod with --work-tree (dirty)' '
177 git describe --dirty=.mod >expected &&
179 cd "$TEST_DIRECTORY" &&
180 git --git-dir "$TRASH_DIRECTORY/.git" --work-tree "$TRASH_DIRECTORY" describe --dirty=.mod >"$TRASH_DIRECTORY/out"
182 grep -E "^A-8-g[0-9a-f]+.mod$" out &&
183 test_cmp expected out
186 test_expect_success
'describe --dirty HEAD' '
187 test_must_fail git describe --dirty HEAD
190 test_expect_success
'set-up matching pattern tests' '
191 git tag -a -m test-annotated test-annotated &&
194 git commit -a -m "one more" &&
195 git tag test1-lightweight &&
198 git commit -a -m "yet another" &&
199 git tag test2-lightweight &&
202 git commit -a -m "even more"
206 check_describe
"test-annotated-3-gHASH" --match="test-*"
208 check_describe
"test1-lightweight-2-gHASH" --tags --match="test1-*"
210 check_describe
"test2-lightweight-1-gHASH" --tags --match="test2-*"
212 check_describe
"test2-lightweight-0-gHASH" --long --tags --match="test2-*" HEAD^
214 check_describe
"test2-lightweight-0-gHASH" --long --tags --match="test1-*" --match="test2-*" HEAD^
216 check_describe
"test2-lightweight-0-gHASH" --long --tags --match="test1-*" --no-match --match="test2-*" HEAD^
218 check_describe
"test1-lightweight-2-gHASH" --long --tags --match="test1-*" --match="test3-*" HEAD
220 check_describe
"test1-lightweight-2-gHASH" --long --tags --match="test3-*" --match="test1-*" HEAD
222 test_expect_success
'set-up branches' '
223 git branch branch_A A &&
224 git branch branch_C c &&
225 git update-ref refs/remotes/origin/remote_branch_A "A^{commit}" &&
226 git update-ref refs/remotes/origin/remote_branch_C "c^{commit}" &&
227 git update-ref refs/original/original_branch_A test-annotated~2
230 check_describe
"heads/branch_A-11-gHASH" --all --match="branch_*" --exclude="branch_C" HEAD
232 check_describe
"remotes/origin/remote_branch_A-11-gHASH" --all --match="origin/remote_branch_*" --exclude="origin/remote_branch_C" HEAD
234 check_describe
"original/original_branch_A-6-gHASH" --all test-annotated~
1
236 test_expect_success
'--match does not work for other types' '
237 test_must_fail git describe --all --match="*original_branch_*" test-annotated~1
240 test_expect_success
'--exclude does not work for other types' '
241 R=$(git describe --all --exclude="any_pattern_even_not_matching" test-annotated~1) &&
243 *original_branch_A*) echo "fail: Found unknown reference $R with --exclude"
245 *) echo ok: Found some known type;;
249 test_expect_success
'name-rev with exact tags' '
251 tag_object=$(git rev-parse refs/tags/A) &&
252 git name-rev --tags --name-only $tag_object >actual &&
253 test_cmp expect actual &&
255 echo "A^0" >expect &&
256 tagged_commit=$(git rev-parse "refs/tags/A^0") &&
257 git name-rev --tags --name-only $tagged_commit >actual &&
258 test_cmp expect actual
261 test_expect_success
'name-rev --all' '
263 for rev in $(git rev-list --all)
265 git name-rev $rev >>expect.unsorted || return 1
267 sort <expect.unsorted >expect &&
268 git name-rev --all >actual.unsorted &&
269 sort <actual.unsorted >actual &&
270 test_cmp expect actual
273 test_expect_success
'name-rev --annotate-stdin' '
275 for rev in $(git rev-list --all)
277 name=$(git name-rev --name-only $rev) &&
278 echo "$rev ($name)" >>expect.unsorted || return 1
280 sort <expect.unsorted >expect &&
281 git rev-list --all | git name-rev --annotate-stdin >actual.unsorted &&
282 sort <actual.unsorted >actual &&
283 test_cmp expect actual
286 test_expect_success
'name-rev --stdin deprecated' "
287 git rev-list --all | git name-rev --stdin 2>actual &&
288 grep -E 'warning: --stdin is deprecated' actual
291 test_expect_success
'describe --contains with the exact tags' '
292 echo "A^0" >expect &&
293 tag_object=$(git rev-parse refs/tags/A) &&
294 git describe --contains $tag_object >actual &&
295 test_cmp expect actual &&
297 echo "A^0" >expect &&
298 tagged_commit=$(git rev-parse "refs/tags/A^0") &&
299 git describe --contains $tagged_commit >actual &&
300 test_cmp expect actual
303 test_expect_success
'describe --contains and --match' '
304 echo "A^0" >expect &&
305 tagged_commit=$(git rev-parse "refs/tags/A^0") &&
306 test_must_fail git describe --contains --match="B" $tagged_commit &&
307 git describe --contains --match="B" --match="A" $tagged_commit >actual &&
308 test_cmp expect actual
311 test_expect_success
'describe --exclude' '
312 echo "c~1" >expect &&
313 tagged_commit=$(git rev-parse "refs/tags/A^0") &&
314 test_must_fail git describe --contains --match="B" $tagged_commit &&
315 git describe --contains --match="?" --exclude="A" $tagged_commit >actual &&
316 test_cmp expect actual
319 test_expect_success
'describe --contains and --no-match' '
320 echo "A^0" >expect &&
321 tagged_commit=$(git rev-parse "refs/tags/A^0") &&
322 git describe --contains --match="B" --no-match $tagged_commit >actual &&
323 test_cmp expect actual
326 test_expect_success
'setup and absorb a submodule' '
327 test_create_repo sub1 &&
328 test_commit -C sub1 initial &&
329 git submodule add ./sub1 &&
330 git submodule absorbgitdirs &&
331 git commit -a -m "add submodule" &&
332 git describe --dirty >expect &&
333 git describe --broken >out &&
337 test_expect_success
'describe chokes on severely broken submodules' '
338 mv .git/modules/sub1/ .git/modules/sub_moved &&
339 test_must_fail git describe --dirty
342 test_expect_success
'describe ignoring a broken submodule' '
343 git describe --broken >out &&
347 test_expect_success
'describe with --work-tree ignoring a broken submodule' '
349 cd "$TEST_DIRECTORY" &&
350 git --git-dir "$TRASH_DIRECTORY/.git" --work-tree "$TRASH_DIRECTORY" describe --broken >"$TRASH_DIRECTORY/out"
352 test_when_finished "mv .git/modules/sub_moved .git/modules/sub1" &&
356 test_expect_success
'describe a blob at a directly tagged commit' '
357 echo "make it a unique blob" >file &&
358 git add file && git commit -m "content in file" &&
359 git tag -a -m "latest annotated tag" unique-file &&
360 git describe HEAD:file >actual &&
361 echo "unique-file:file" >expect &&
362 test_cmp expect actual
365 test_expect_success
'describe a blob with its first introduction' '
366 git commit --allow-empty -m "empty commit" &&
368 git commit -m "delete blob" &&
370 git commit --allow-empty -m "empty commit" &&
371 git describe HEAD:file >actual &&
372 echo "unique-file:file" >expect &&
373 test_cmp expect actual
376 test_expect_success
'describe directly tagged blob' '
377 git tag test-blob unique-file:file &&
378 git describe test-blob >actual &&
379 echo "unique-file:file" >expect &&
380 # suboptimal: we rather want to see "test-blob"
381 test_cmp expect actual
384 test_expect_success
'describe tag object' '
385 git tag test-blob-1 -a -m msg unique-file:file &&
386 test_must_fail git describe test-blob-1 2>actual &&
387 test_i18ngrep "fatal: test-blob-1 is neither a commit nor blob" actual
390 test_expect_success ULIMIT_STACK_SIZE
'name-rev works in a deep repo' '
392 while test $i -lt 8000
394 echo "commit refs/heads/main
395 committer A U Thor <author@example.com> $((1000000000 + $i * 100)) +0200
401 echo "from refs/heads/main^0"
403 i=$(($i + 1)) || return 1
404 done | git fast-import &&
406 git tag far-far-away HEAD^ &&
407 echo "HEAD~4000 tags/far-far-away~3999" >expect &&
408 git name-rev HEAD~4000 >actual &&
409 test_cmp expect actual &&
410 run_with_limited_stack git name-rev HEAD~4000 >actual &&
411 test_cmp expect actual
414 test_expect_success ULIMIT_STACK_SIZE
'describe works in a deep repo' '
415 git tag -f far-far-away HEAD~7999 &&
416 echo "far-far-away" >expect &&
417 git describe --tags --abbrev=0 HEAD~4000 >actual &&
418 test_cmp expect actual &&
419 run_with_limited_stack git describe --tags --abbrev=0 HEAD~4000 >actual &&
420 test_cmp expect actual
423 check_describe tags
/A
--all A
424 check_describe tags
/c
--all c
425 check_describe
heads
/branch_A
--all --match='branch_*' branch_A
427 test_expect_success
'describe complains about tree object' '
428 test_must_fail git describe HEAD^{tree}
431 test_expect_success
'describe complains about missing object' '
432 test_must_fail git describe $ZERO_OID
435 test_expect_success
'name-rev a rev shortly after epoch' '
436 test_when_finished "git checkout main" &&
438 git checkout --orphan no-timestamp-underflow &&
439 # Any date closer to epoch than the CUTOFF_DATE_SLOP constant
440 # in builtin/name-rev.c.
441 GIT_COMMITTER_DATE="@1234 +0000" \
442 git commit -m "committer date shortly after epoch" &&
443 old_commit_oid=$(git rev-parse HEAD) &&
445 echo "$old_commit_oid no-timestamp-underflow" >expect &&
446 git name-rev $old_commit_oid >actual &&
447 test_cmp expect actual
450 # A--------------main
457 test_expect_success
'name-rev covers all conditions while looking at parents' '
465 A=$(git rev-parse HEAD) &&
467 git checkout --detach &&
469 git commit -m B file &&
470 B=$(git rev-parse HEAD) &&
473 git merge --no-ff $B && # M1
476 git commit -m C file &&
479 git merge --no-ff HEAD@{1} && # M2
482 git merge --no-ff HEAD@{1} &&
484 echo "$B main^2^2~1^2" >expect &&
485 git name-rev $B >actual &&
487 test_cmp expect actual
493 # Where C has a non-monotonically increasing commit timestamp w.r.t. other
495 test_expect_success
'non-monotonic commit dates setup' '
496 UNIX_EPOCH_ZERO="@0 +0000" &&
497 git init non-monotonic &&
498 test_commit -C non-monotonic A &&
499 test_commit -C non-monotonic --no-tag B &&
500 test_commit -C non-monotonic --no-tag --date "$UNIX_EPOCH_ZERO" C &&
501 test_commit -C non-monotonic D &&
502 test_commit -C non-monotonic E
505 test_expect_success
'name-rev with commitGraph handles non-monotonic timestamps' '
506 test_config -C non-monotonic core.commitGraph true &&
510 git commit-graph write --reachable &&
512 echo "main~3 tags/D~2" >expect &&
513 git name-rev --tags main~3 >actual &&
515 test_cmp expect actual
519 test_expect_success
'name-rev --all works with non-monotonic timestamps' '
520 test_config -C non-monotonic core.commitGraph false &&
524 rm -rf .git/info/commit-graph* &&
534 git log --pretty=%H >revs &&
536 paste -d" " revs tags | sort >expect &&
538 git name-rev --tags --all | sort >actual &&
539 test_cmp expect actual
543 test_expect_success
'name-rev --annotate-stdin works with non-monotonic timestamps' '
544 test_config -C non-monotonic core.commitGraph false &&
548 rm -rf .git/info/commit-graph* &&
550 cat >expect <<-\EOF &&
558 git log --pretty=%H >revs &&
559 git name-rev --tags --annotate-stdin --name-only <revs >actual &&
560 test_cmp expect actual
564 test_expect_success
'name-rev --all works with commitGraph' '
565 test_config -C non-monotonic core.commitGraph true &&
569 git commit-graph write --reachable &&
579 git log --pretty=%H >revs &&
581 paste -d" " revs tags | sort >expect &&
583 git name-rev --tags --all | sort >actual &&
584 test_cmp expect actual
588 test_expect_success
'name-rev --annotate-stdin works with commitGraph' '
589 test_config -C non-monotonic core.commitGraph true &&
593 git commit-graph write --reachable &&
595 cat >expect <<-\EOF &&
603 git log --pretty=%H >revs &&
604 git name-rev --tags --annotate-stdin --name-only <revs >actual &&
605 test_cmp expect actual
615 test_expect_success
'setup: describe commits with disjoint bases' '
616 git init disjoint1 &&
620 echo o >> file && git add file && git commit -m o &&
621 echo A >> file && git add file && git commit -m A &&
623 echo o >> file && git add file && git commit -m o &&
625 git checkout --orphan branch && rm file &&
626 echo B > file2 && git add file2 && git commit -m B &&
628 git merge --no-ff --allow-unrelated-histories main -m x
632 check_describe
-C disjoint1
"A-3-gHASH" HEAD
635 # o---o---o------------.
640 test_expect_success
'setup: describe commits with disjoint bases 2' '
641 git init disjoint2 &&
645 echo A >> file && git add file && GIT_COMMITTER_DATE="2020-01-01 18:00" git commit -m A &&
647 echo o >> file && git add file && GIT_COMMITTER_DATE="2020-01-01 18:01" git commit -m o &&
649 git checkout --orphan branch &&
650 echo o >> file2 && git add file2 && GIT_COMMITTER_DATE="2020-01-01 15:00" git commit -m o &&
651 echo o >> file2 && git add file2 && GIT_COMMITTER_DATE="2020-01-01 15:01" git commit -m o &&
652 echo B >> file2 && git add file2 && GIT_COMMITTER_DATE="2020-01-01 15:02" git commit -m B &&
654 git merge --no-ff --allow-unrelated-histories main -m x
658 check_describe
-C disjoint2
"B-3-gHASH" HEAD
660 test_expect_success
'setup misleading taggerdates' '
661 GIT_COMMITTER_DATE="2006-12-12 12:31" git tag -a -m "another tag" newer-tag-older-commit unique-file~1
664 check_describe newer-tag-older-commit~
1 --contains unique-file~
2