3 test_description='test describe
6 .--------------o----o----o----x
8 o----o----o----o----o----. /
10 .------------o---o---o
18 R=$(git describe "$@" 2>err.actual)
21 test_expect_success "describe $*" '
24 $expect) echo happy ;;
25 *) echo "Oops - $R is not $expect";
31 test_expect_success setup '
34 echo one >file && git add file && git commit -m initial &&
35 one=$(git rev-parse HEAD) &&
37 git describe --always HEAD &&
40 echo two >file && git add file && git commit -m second &&
41 two=$(git rev-parse HEAD) &&
44 echo three >file && git add file && git commit -m third &&
47 echo A >file && git add file && git commit -m A &&
52 echo c >file && git add file && git commit -m c &&
56 git reset --hard $two &&
58 echo B >side && git add side && git commit -m B &&
63 git merge -m Merged c &&
64 merged=$(git rev-parse HEAD) &&
66 git reset --hard $two &&
68 echo D >another && git add another && git commit -m D &&
75 echo DD >another && git commit -a -m another &&
81 echo DDD >another && git commit -a -m "yet another" &&
84 git merge -m Merged $merged &&
87 echo X >file && echo X >side && git add file side &&
92 check_describe A-* HEAD
93 check_describe A-* HEAD^
94 check_describe R-* HEAD^^
95 check_describe A-* HEAD^^2
96 check_describe B HEAD^^2^
97 check_describe R-* HEAD^^^
99 check_describe c-* --tags HEAD
100 check_describe c-* --tags HEAD^
101 check_describe e-* --tags HEAD^^
102 check_describe c-* --tags HEAD^^2
103 check_describe B --tags HEAD^^2^
104 check_describe e --tags HEAD^^^
106 check_describe heads/master --all HEAD
107 check_describe tags/c-* --all HEAD^
108 check_describe tags/e --all HEAD^^^
110 check_describe B-0-* --long HEAD^^2^
111 check_describe A-3-* --long HEAD^^2
113 check_describe c-7-* --tags
114 check_describe e-3-* --first-parent --tags
116 test_expect_success 'describe --contains defaults to HEAD without commit-ish' '
117 echo "A^0" >expect &&
119 test_when_finished "git checkout -" &&
120 git describe --contains >actual &&
121 test_cmp expect actual
124 check_describe tags/A --all A^0
125 test_expect_success 'no warning was displayed for A' '
126 test_must_be_empty err.actual
129 test_expect_success 'rename tag A to Q locally' '
130 mv .git/refs/tags/A .git/refs/tags/Q
132 cat - >err.expect <<EOF
133 warning: tag 'A' is really 'Q' here
135 check_describe A-* HEAD
136 test_expect_success 'warning was displayed for Q' '
137 test_i18ncmp err.expect err.actual
139 test_expect_success 'rename tag Q back to A' '
140 mv .git/refs/tags/Q .git/refs/tags/A
143 test_expect_success 'pack tag refs' 'git pack-refs'
144 check_describe A-* 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-[1-9][0-9]?-g[0-9a-f]+$" out
152 check_describe "A-*[0-9a-f]" --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-[1-9][0-9]?-g[0-9a-f]+$" out
162 test_expect_success 'set-up dirty work tree' '
166 check_describe "A-*[0-9a-f]-dirty" --dirty
168 test_expect_success 'describe --dirty with --work-tree (dirty)' '
170 cd "$TEST_DIRECTORY" &&
171 git --git-dir "$TRASH_DIRECTORY/.git" --work-tree "$TRASH_DIRECTORY" describe --dirty >"$TRASH_DIRECTORY/out"
173 grep -E "^A-[1-9][0-9]?-g[0-9a-f]+-dirty$" out
176 check_describe "A-*[0-9a-f].mod" --dirty=.mod
178 test_expect_success 'describe --dirty=.mod with --work-tree (dirty)' '
180 cd "$TEST_DIRECTORY" &&
181 git --git-dir "$TRASH_DIRECTORY/.git" --work-tree "$TRASH_DIRECTORY" describe --dirty=.mod >"$TRASH_DIRECTORY/out"
183 grep -E "^A-[1-9][0-9]?-g[0-9a-f]+.mod$" 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-*" --match="test-*"
208 check_describe "test1-lightweight-*" --tags --match="test1-*"
210 check_describe "test2-lightweight-*" --tags --match="test2-*"
212 check_describe "test2-lightweight-*" --long --tags --match="test2-*" HEAD^
214 check_describe "test2-lightweight-*" --long --tags --match="test1-*" --match="test2-*" HEAD^
216 check_describe "test2-lightweight-*" --long --tags --match="test1-*" --no-match --match="test2-*" HEAD^
218 check_describe "test1-lightweight-*" --long --tags --match="test1-*" --match="test3-*" HEAD
220 check_describe "test1-lightweight-*" --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*" --all --match="branch_*" --exclude="branch_C" HEAD
232 check_describe "remotes/origin/remote_branch_A*" --all --match="origin/remote_branch_*" --exclude="origin/remote_branch_C" HEAD
234 check_describe "original/original_branch_A*" --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
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 --stdin' '
275 for rev in $(git rev-list --all)
277 name=$(git name-rev --name-only $rev) &&
278 echo "$rev ($name)" >>expect.unsorted
280 sort <expect.unsorted >expect &&
281 git rev-list --all | git name-rev --stdin >actual.unsorted &&
282 sort <actual.unsorted >actual &&
283 test_cmp expect actual
286 test_expect_success 'describe --contains with the exact tags' '
287 echo "A^0" >expect &&
288 tag_object=$(git rev-parse refs/tags/A) &&
289 git describe --contains $tag_object >actual &&
290 test_cmp expect actual &&
292 echo "A^0" >expect &&
293 tagged_commit=$(git rev-parse "refs/tags/A^0") &&
294 git describe --contains $tagged_commit >actual &&
295 test_cmp expect actual
298 test_expect_success 'describe --contains and --match' '
299 echo "A^0" >expect &&
300 tagged_commit=$(git rev-parse "refs/tags/A^0") &&
301 test_must_fail git describe --contains --match="B" $tagged_commit &&
302 git describe --contains --match="B" --match="A" $tagged_commit >actual &&
303 test_cmp expect actual
306 test_expect_success 'describe --exclude' '
307 echo "c~1" >expect &&
308 tagged_commit=$(git rev-parse "refs/tags/A^0") &&
309 test_must_fail git describe --contains --match="B" $tagged_commit &&
310 git describe --contains --match="?" --exclude="A" $tagged_commit >actual &&
311 test_cmp expect actual
314 test_expect_success 'describe --contains and --no-match' '
315 echo "A^0" >expect &&
316 tagged_commit=$(git rev-parse "refs/tags/A^0") &&
317 git describe --contains --match="B" --no-match $tagged_commit >actual &&
318 test_cmp expect actual
321 test_expect_success 'setup and absorb a submodule' '
322 test_create_repo sub1 &&
323 test_commit -C sub1 initial &&
324 git submodule add ./sub1 &&
325 git submodule absorbgitdirs &&
326 git commit -a -m "add submodule" &&
327 git describe --dirty >expect &&
328 git describe --broken >out &&
332 test_expect_success 'describe chokes on severely broken submodules' '
333 mv .git/modules/sub1/ .git/modules/sub_moved &&
334 test_must_fail git describe --dirty
337 test_expect_success 'describe ignoring a broken submodule' '
338 git describe --broken >out &&
342 test_expect_success 'describe with --work-tree ignoring a broken submodule' '
344 cd "$TEST_DIRECTORY" &&
345 git --git-dir "$TRASH_DIRECTORY/.git" --work-tree "$TRASH_DIRECTORY" describe --broken >"$TRASH_DIRECTORY/out"
347 test_when_finished "mv .git/modules/sub_moved .git/modules/sub1" &&
351 test_expect_success 'describe a blob at a directly tagged commit' '
352 echo "make it a unique blob" >file &&
353 git add file && git commit -m "content in file" &&
354 git tag -a -m "latest annotated tag" unique-file &&
355 git describe HEAD:file >actual &&
356 echo "unique-file:file" >expect &&
357 test_cmp expect actual
360 test_expect_success 'describe a blob with its first introduction' '
361 git commit --allow-empty -m "empty commit" &&
363 git commit -m "delete blob" &&
365 git commit --allow-empty -m "empty commit" &&
366 git describe HEAD:file >actual &&
367 echo "unique-file:file" >expect &&
368 test_cmp expect actual
371 test_expect_success 'describe directly tagged blob' '
372 git tag test-blob unique-file:file &&
373 git describe test-blob >actual &&
374 echo "unique-file:file" >expect &&
375 # suboptimal: we rather want to see "test-blob"
376 test_cmp expect actual
379 test_expect_success 'describe tag object' '
380 git tag test-blob-1 -a -m msg unique-file:file &&
381 test_must_fail git describe test-blob-1 2>actual &&
382 test_i18ngrep "fatal: test-blob-1 is neither a commit nor blob" actual
385 test_expect_failure ULIMIT_STACK_SIZE 'name-rev works in a deep repo' '
387 while test $i -lt 8000
389 echo "commit refs/heads/master
390 committer A U Thor <author@example.com> $((1000000000 + $i * 100)) +0200
394 test $i = 1 && echo "from refs/heads/master^0"
396 done | git fast-import &&
397 git checkout master &&
398 git tag far-far-away HEAD^ &&
399 echo "HEAD~4000 tags/far-far-away~3999" >expect &&
400 git name-rev HEAD~4000 >actual &&
401 test_cmp expect actual &&
402 run_with_limited_stack git name-rev HEAD~4000 >actual &&
403 test_cmp expect actual
406 test_expect_success ULIMIT_STACK_SIZE 'describe works in a deep repo' '
407 git tag -f far-far-away HEAD~7999 &&
408 echo "far-far-away" >expect &&
409 git describe --tags --abbrev=0 HEAD~4000 >actual &&
410 test_cmp expect actual &&
411 run_with_limited_stack git describe --tags --abbrev=0 HEAD~4000 >actual &&
412 test_cmp expect actual
415 check_describe tags/A --all A
416 check_describe tags/c --all c
417 check_describe heads/branch_A --all --match='branch_*' branch_A
419 test_expect_success 'describe complains about tree object' '
420 test_must_fail git describe HEAD^{tree}
423 test_expect_success 'describe complains about missing object' '
424 test_must_fail git describe $ZERO_OID