t/t6120-describe.sh

   1 #!/bin/sh
   2
   3 test_description='test describe'
   4
   5 #  o---o-----o----o----o-------o----x
   6 #       \   D,R   e           /
   7 #        \---o-------------o-'
   8 #         \  B            /
   9 #          `-o----o----o-'
  10 #                 A    c
  11 #
  12 # First parent of a merge commit is on the same line, second parent below.
  13
  14 GIT_TEST_DEFAULT_INITIAL_BRANCH_NAME=main
  15 export GIT_TEST_DEFAULT_INITIAL_BRANCH_NAME
  16
  17 . ./test-lib.sh
  18
  19 check_describe () {
  20         indir= &&
  21         while test $# != 0
  22         do
  23                 case "$1" in
  24                 -C)
  25                         indir="$2"
  26                         shift
  27                         ;;
  28                 *)
  29                         break
  30                         ;;
  31                 esac
  32                 shift
  33         done &&
  34         indir=${indir:+"$indir"/} &&
  35         expect="$1"
  36         shift
  37         describe_opts="$@"
  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
  43         '
  44 }
  45
  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 &&
  52
  53         git reset --hard second &&
  54         test_commit --annotate B side B &&
  55
  56         test_tick &&
  57         git merge -m Merged c &&
  58         merged=$(git rev-parse HEAD) &&
  59
  60         git reset --hard second &&
  61         test_commit --no-tag D another D &&
  62
  63         test_tick &&
  64         git tag -a -m R R &&
  65
  66         test_commit e another DD &&
  67         test_commit --no-tag "yet another" another DDD &&
  68
  69         test_tick &&
  70         git merge -m Merged $merged &&
  71
  72         test_commit --no-tag x file
  73 '
  74
  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^^^
  81
  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^^^
  88
  89 check_describe heads/main --all HEAD
  90 check_describe tags/c-6-gHASH --all HEAD^
  91 check_describe tags/e --all HEAD^^^
  92
  93 check_describe B-0-gHASH --long HEAD^^2^
  94 check_describe A-3-gHASH --long HEAD^^2
  95
  96 check_describe c-7-gHASH --tags
  97 check_describe e-3-gHASH --first-parent --tags
  98
  99 test_expect_success 'describe --contains defaults to HEAD without commit-ish' '
 100         echo "A^0" >expect &&
 101         git checkout A &&
 102         test_when_finished "git checkout -" &&
 103         git describe --contains >actual &&
 104         test_cmp expect actual
 105 '
 106
 107 check_describe tags/A --all A^0
 108
 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'
 115         EOF
 116         test_cmp expected err &&
 117         grep -E '^A-8-g[0-9a-f]+$' out
 118 "
 119
 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
 126 '
 127
 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]*$"
 131 '
 132
 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]*$"
 136 '
 137
 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
 141 '
 142
 143 test_expect_success 'pack tag refs' 'git pack-refs'
 144 check_describe A-8-gHASH HEAD
 145
 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
 150 '
 151
 152 check_describe "A-8-gHASH" --dirty
 153
 154 test_expect_success 'describe --dirty with --work-tree' '
 155         (
 156                 cd "$TEST_DIRECTORY" &&
 157                 git --git-dir "$TRASH_DIRECTORY/.git" --work-tree "$TRASH_DIRECTORY" describe --dirty >"$TRASH_DIRECTORY/out"
 158         ) &&
 159         grep -E "^A-8-g[0-9a-f]+$" out
 160 '
 161
 162 test_expect_success 'set-up dirty work tree' '
 163         echo >>file
 164 '
 165
 166 test_expect_success 'describe --dirty with --work-tree (dirty)' '
 167         git describe --dirty >expected &&
 168         (
 169                 cd "$TEST_DIRECTORY" &&
 170                 git --git-dir "$TRASH_DIRECTORY/.git" --work-tree "$TRASH_DIRECTORY" describe --dirty >"$TRASH_DIRECTORY/out"
 171         ) &&
 172         grep -E "^A-8-g[0-9a-f]+-dirty$" out &&
 173         test_cmp expected out
 174 '
 175
 176 test_expect_success 'describe --dirty=.mod with --work-tree (dirty)' '
 177         git describe --dirty=.mod >expected &&
 178         (
 179                 cd "$TEST_DIRECTORY" &&
 180                 git --git-dir "$TRASH_DIRECTORY/.git" --work-tree "$TRASH_DIRECTORY" describe --dirty=.mod >"$TRASH_DIRECTORY/out"
 181         ) &&
 182         grep -E "^A-8-g[0-9a-f]+.mod$" out &&
 183         test_cmp expected out
 184 '
 185
 186 test_expect_success 'describe --dirty HEAD' '
 187         test_must_fail git describe --dirty HEAD
 188 '
 189
 190 test_expect_success 'set-up matching pattern tests' '
 191         git tag -a -m test-annotated test-annotated &&
 192         echo >>file &&
 193         test_tick &&
 194         git commit -a -m "one more" &&
 195         git tag test1-lightweight &&
 196         echo >>file &&
 197         test_tick &&
 198         git commit -a -m "yet another" &&
 199         git tag test2-lightweight &&
 200         echo >>file &&
 201         test_tick &&
 202         git commit -a -m "even more"
 203
 204 '
 205
 206 check_describe "test-annotated-3-gHASH" --match="test-*"
 207
 208 check_describe "test1-lightweight-2-gHASH" --tags --match="test1-*"
 209
 210 check_describe "test2-lightweight-1-gHASH" --tags --match="test2-*"
 211
 212 check_describe "test2-lightweight-0-gHASH" --long --tags --match="test2-*" HEAD^
 213
 214 check_describe "test2-lightweight-0-gHASH" --long --tags --match="test1-*" --match="test2-*" HEAD^
 215
 216 check_describe "test2-lightweight-0-gHASH" --long --tags --match="test1-*" --no-match --match="test2-*" HEAD^
 217
 218 check_describe "test1-lightweight-2-gHASH" --long --tags --match="test1-*" --match="test3-*" HEAD
 219
 220 check_describe "test1-lightweight-2-gHASH" --long --tags --match="test3-*" --match="test1-*" HEAD
 221
 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
 228 '
 229
 230 check_describe "heads/branch_A-11-gHASH" --all --match="branch_*" --exclude="branch_C" HEAD
 231
 232 check_describe "remotes/origin/remote_branch_A-11-gHASH" --all --match="origin/remote_branch_*" --exclude="origin/remote_branch_C" HEAD
 233
 234 check_describe "original/original_branch_A-6-gHASH" --all test-annotated~1
 235
 236 test_expect_success '--match does not work for other types' '
 237         test_must_fail git describe --all --match="*original_branch_*" test-annotated~1
 238 '
 239
 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) &&
 242         case "$R" in
 243         *original_branch_A*) echo "fail: Found unknown reference $R with --exclude"
 244                 false;;
 245         *) echo ok: Found some known type;;
 246         esac
 247 '
 248
 249 test_expect_success 'name-rev with exact tags' '
 250         echo A >expect &&
 251         tag_object=$(git rev-parse refs/tags/A) &&
 252         git name-rev --tags --name-only $tag_object >actual &&
 253         test_cmp expect actual &&
 254
 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
 259 '
 260
 261 test_expect_success 'name-rev --all' '
 262         >expect.unsorted &&
 263         for rev in $(git rev-list --all)
 264         do
 265                 git name-rev $rev >>expect.unsorted
 266         done &&
 267         sort <expect.unsorted >expect &&
 268         git name-rev --all >actual.unsorted &&
 269         sort <actual.unsorted >actual &&
 270         test_cmp expect actual
 271 '
 272
 273 test_expect_success 'name-rev --stdin' '
 274         >expect.unsorted &&
 275         for rev in $(git rev-list --all)
 276         do
 277                 name=$(git name-rev --name-only $rev) &&
 278                 echo "$rev ($name)" >>expect.unsorted
 279         done &&
 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
 284 '
 285
 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 &&
 291
 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
 296 '
 297
 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
 304 '
 305
 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
 312 '
 313
 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
 319 '
 320
 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 &&
 329         test_cmp expect out
 330 '
 331
 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
 335 '
 336
 337 test_expect_success 'describe ignoring a broken submodule' '
 338         git describe --broken >out &&
 339         grep broken out
 340 '
 341
 342 test_expect_success 'describe with --work-tree ignoring a broken submodule' '
 343         (
 344                 cd "$TEST_DIRECTORY" &&
 345                 git --git-dir "$TRASH_DIRECTORY/.git" --work-tree "$TRASH_DIRECTORY" describe --broken >"$TRASH_DIRECTORY/out"
 346         ) &&
 347         test_when_finished "mv .git/modules/sub_moved .git/modules/sub1" &&
 348         grep broken out
 349 '
 350
 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
 358 '
 359
 360 test_expect_success 'describe a blob with its first introduction' '
 361         git commit --allow-empty -m "empty commit" &&
 362         git rm file &&
 363         git commit -m "delete blob" &&
 364         git revert HEAD &&
 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
 369 '
 370
 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
 377 '
 378
 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
 383 '
 384
 385 test_expect_success ULIMIT_STACK_SIZE 'name-rev works in a deep repo' '
 386         i=1 &&
 387         while test $i -lt 8000
 388         do
 389                 echo "commit refs/heads/main
 390 committer A U Thor <author@example.com> $((1000000000 + $i * 100)) +0200
 391 data <<EOF
 392 commit #$i
 393 EOF"
 394                 test $i = 1 && echo "from refs/heads/main^0"
 395                 i=$(($i + 1))
 396         done | git fast-import &&
 397         git checkout main &&
 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
 404 '
 405
 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
 413 '
 414
 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
 418
 419 test_expect_success 'describe complains about tree object' '
 420         test_must_fail git describe HEAD^{tree}
 421 '
 422
 423 test_expect_success 'describe complains about missing object' '
 424         test_must_fail git describe $ZERO_OID
 425 '
 426
 427 test_expect_success 'name-rev a rev shortly after epoch' '
 428         test_when_finished "git checkout main" &&
 429
 430         git checkout --orphan no-timestamp-underflow &&
 431         # Any date closer to epoch than the CUTOFF_DATE_SLOP constant
 432         # in builtin/name-rev.c.
 433         GIT_COMMITTER_DATE="@1234 +0000" \
 434         git commit -m "committer date shortly after epoch" &&
 435         old_commit_oid=$(git rev-parse HEAD) &&
 436
 437         echo "$old_commit_oid no-timestamp-underflow" >expect &&
 438         git name-rev $old_commit_oid >actual &&
 439         test_cmp expect actual
 440 '
 441
 442 # A--------------main
 443 #  \            /
 444 #   \----------M2
 445 #    \        /
 446 #     \---M1-C
 447 #      \ /
 448 #       B
 449 test_expect_success 'name-rev covers all conditions while looking at parents' '
 450         git init repo &&
 451         (
 452                 cd repo &&
 453
 454                 echo A >file &&
 455                 git add file &&
 456                 git commit -m A &&
 457                 A=$(git rev-parse HEAD) &&
 458
 459                 git checkout --detach &&
 460                 echo B >file &&
 461                 git commit -m B file &&
 462                 B=$(git rev-parse HEAD) &&
 463
 464                 git checkout $A &&
 465                 git merge --no-ff $B &&  # M1
 466
 467                 echo C >file &&
 468                 git commit -m C file &&
 469
 470                 git checkout $A &&
 471                 git merge --no-ff HEAD@{1} && # M2
 472
 473                 git checkout main &&
 474                 git merge --no-ff HEAD@{1} &&
 475
 476                 echo "$B main^2^2~1^2" >expect &&
 477                 git name-rev $B >actual &&
 478
 479                 test_cmp expect actual
 480         )
 481 '
 482
 483 #               B
 484 #               o
 485 #                \
 486 #  o-----o---o----x
 487 #        A
 488 #
 489 test_expect_success 'setup: describe commits with disjoint bases' '
 490         git init disjoint1 &&
 491         (
 492                 cd disjoint1 &&
 493
 494                 echo o >> file && git add file && git commit -m o &&
 495                 echo A >> file && git add file && git commit -m A &&
 496                 git tag A -a -m A &&
 497                 echo o >> file && git add file && git commit -m o &&
 498
 499                 git checkout --orphan branch && rm file &&
 500                 echo B > file2 && git add file2 && git commit -m B &&
 501                 git tag B -a -m B &&
 502                 git merge --no-ff --allow-unrelated-histories main -m x
 503         )
 504 '
 505
 506 check_describe -C disjoint1 "A-3-gHASH" HEAD
 507
 508 #           B
 509 #   o---o---o------------.
 510 #                         \
 511 #                  o---o---x
 512 #                  A
 513 #
 514 test_expect_success 'setup: describe commits with disjoint bases 2' '
 515         git init disjoint2 &&
 516         (
 517                 cd disjoint2 &&
 518
 519                 echo A >> file && git add file && GIT_COMMITTER_DATE="2020-01-01 18:00" git commit -m A &&
 520                 git tag A -a -m A &&
 521                 echo o >> file && git add file && GIT_COMMITTER_DATE="2020-01-01 18:01" git commit -m o &&
 522
 523                 git checkout --orphan branch &&
 524                 echo o >> file2 && git add file2 && GIT_COMMITTER_DATE="2020-01-01 15:00" git commit -m o &&
 525                 echo o >> file2 && git add file2 && GIT_COMMITTER_DATE="2020-01-01 15:01" git commit -m o &&
 526                 echo B >> file2 && git add file2 && GIT_COMMITTER_DATE="2020-01-01 15:02" git commit -m B &&
 527                 git tag B -a -m B &&
 528                 git merge --no-ff --allow-unrelated-histories main -m x
 529         )
 530 '
 531
 532 check_describe -C disjoint2 "B-3-gHASH" HEAD
 533
 534 test_done