t/t4205-log-pretty-formats.sh

   1 #!/bin/sh
   2 #
   3 # Copyright (c) 2010, Will Palmer
   4 # Copyright (c) 2011, Alexey Shumkin (+ non-UTF-8 commit encoding tests)
   5 #
   6
   7 test_description='Test pretty formats'
   8 . ./test-lib.sh
   9
  10 # Tested non-UTF-8 encoding
  11 test_encoding="ISO8859-1"
  12
  13 sample_utf8_part=$(printf "f\303\244ng")
  14
  15 commit_msg () {
  16         # String "initial. initial" partly in German
  17         # (translated with Google Translate),
  18         # encoded in UTF-8, used as a commit log message below.
  19         msg="initial. an${sample_utf8_part}lich\n"
  20         if test -n "$1"
  21         then
  22                 printf "$msg" | iconv -f utf-8 -t "$1"
  23         else
  24                 printf "$msg"
  25         fi
  26 }
  27
  28 test_expect_success 'set up basic repos' '
  29         >foo &&
  30         >bar &&
  31         git add foo &&
  32         test_tick &&
  33         git config i18n.commitEncoding $test_encoding &&
  34         commit_msg $test_encoding | git commit -F - &&
  35         git add bar &&
  36         test_tick &&
  37         git commit -m "add bar" &&
  38         git config --unset i18n.commitEncoding
  39 '
  40
  41 test_expect_success 'alias builtin format' '
  42         git log --pretty=oneline >expected &&
  43         git config pretty.test-alias oneline &&
  44         git log --pretty=test-alias >actual &&
  45         test_cmp expected actual
  46 '
  47
  48 test_expect_success 'alias masking builtin format' '
  49         git log --pretty=oneline >expected &&
  50         git config pretty.oneline "%H" &&
  51         git log --pretty=oneline >actual &&
  52         test_cmp expected actual
  53 '
  54
  55 test_expect_success 'alias user-defined format' '
  56         git log --pretty="format:%h" >expected &&
  57         git config pretty.test-alias "format:%h" &&
  58         git log --pretty=test-alias >actual &&
  59         test_cmp expected actual
  60 '
  61
  62 test_expect_success 'alias user-defined tformat with %s (ISO8859-1 encoding)' '
  63         git config i18n.logOutputEncoding $test_encoding &&
  64         git log --oneline >expected-s &&
  65         git log --pretty="tformat:%h %s" >actual-s &&
  66         git config --unset i18n.logOutputEncoding &&
  67         test_cmp expected-s actual-s
  68 '
  69
  70 test_expect_success 'alias user-defined tformat with %s (utf-8 encoding)' '
  71         git log --oneline >expected-s &&
  72         git log --pretty="tformat:%h %s" >actual-s &&
  73         test_cmp expected-s actual-s
  74 '
  75
  76 test_expect_success 'alias user-defined tformat' '
  77         git log --pretty="tformat:%h" >expected &&
  78         git config pretty.test-alias "tformat:%h" &&
  79         git log --pretty=test-alias >actual &&
  80         test_cmp expected actual
  81 '
  82
  83 test_expect_success 'alias non-existent format' '
  84         git config pretty.test-alias format-that-will-never-exist &&
  85         test_must_fail git log --pretty=test-alias
  86 '
  87
  88 test_expect_success 'alias of an alias' '
  89         git log --pretty="tformat:%h" >expected &&
  90         git config pretty.test-foo "tformat:%h" &&
  91         git config pretty.test-bar test-foo &&
  92         git log --pretty=test-bar >actual && test_cmp expected actual
  93 '
  94
  95 test_expect_success 'alias masking an alias' '
  96         git log --pretty=format:"Two %H" >expected &&
  97         git config pretty.duplicate "format:One %H" &&
  98         git config --add pretty.duplicate "format:Two %H" &&
  99         git log --pretty=duplicate >actual &&
 100         test_cmp expected actual
 101 '
 102
 103 test_expect_success 'alias loop' '
 104         git config pretty.test-foo test-bar &&
 105         git config pretty.test-bar test-foo &&
 106         test_must_fail git log --pretty=test-foo
 107 '
 108
 109 test_expect_success 'NUL separation' '
 110         printf "add bar\0$(commit_msg)" >expected &&
 111         git log -z --pretty="format:%s" >actual &&
 112         test_cmp expected actual
 113 '
 114
 115 test_expect_success 'NUL termination' '
 116         printf "add bar\0$(commit_msg)\0" >expected &&
 117         git log -z --pretty="tformat:%s" >actual &&
 118         test_cmp expected actual
 119 '
 120
 121 test_expect_success 'NUL separation with --stat' '
 122         stat0_part=$(git diff --stat HEAD^ HEAD) &&
 123         stat1_part=$(git diff-tree --no-commit-id --stat --root HEAD^) &&
 124         printf "add bar\n$stat0_part\n\0$(commit_msg)\n$stat1_part\n" >expected &&
 125         git log -z --stat --pretty="format:%s" >actual &&
 126         test_cmp expected actual
 127 '
 128
 129 test_expect_failure 'NUL termination with --stat' '
 130         stat0_part=$(git diff --stat HEAD^ HEAD) &&
 131         stat1_part=$(git diff-tree --no-commit-id --stat --root HEAD^) &&
 132         printf "add bar\n$stat0_part\n\0$(commit_msg)\n$stat1_part\n0" >expected &&
 133         git log -z --stat --pretty="tformat:%s" >actual &&
 134         test_cmp expected actual
 135 '
 136
 137 for p in short medium full fuller email raw
 138 do
 139         test_expect_success "NUL termination with --reflog --pretty=$p" '
 140                 revs="$(git rev-list --reflog)" &&
 141                 for r in $revs
 142                 do
 143                         git show -s "$r" --pretty="$p" &&
 144                         printf "\0" || return 1
 145                 done >expect &&
 146                 {
 147                         git log -z --reflog --pretty="$p" &&
 148                         printf "\0"
 149                 } >actual &&
 150                 test_cmp expect actual
 151         '
 152 done
 153
 154 test_expect_success 'NUL termination with --reflog --pretty=oneline' '
 155         revs="$(git rev-list --reflog)" &&
 156         for r in $revs
 157         do
 158                 git show -s --pretty=oneline "$r" >raw &&
 159                 cat raw | lf_to_nul || return 1
 160         done >expect &&
 161         # the trailing NUL is already produced so we do not need to
 162         # output another one
 163         git log -z --pretty=oneline --reflog >actual &&
 164         test_cmp expect actual
 165 '
 166
 167 test_expect_success 'setup more commits' '
 168         test_commit "message one" one one message-one &&
 169         test_commit "message two" two two message-two &&
 170         head1=$(git rev-parse --verify --short HEAD~0) &&
 171         head2=$(git rev-parse --verify --short HEAD~1) &&
 172         head3=$(git rev-parse --verify --short HEAD~2) &&
 173         head4=$(git rev-parse --verify --short HEAD~3)
 174 '
 175
 176 test_expect_success 'left alignment formatting' '
 177         git log --pretty="tformat:%<(40)%s" >actual &&
 178         qz_to_tab_space <<-EOF >expected &&
 179         message two                            Z
 180         message one                            Z
 181         add bar                                Z
 182         $(commit_msg)                    Z
 183         EOF
 184         test_cmp expected actual
 185 '
 186
 187 test_expect_success 'left alignment formatting. i18n.logOutputEncoding' '
 188         git -c i18n.logOutputEncoding=$test_encoding log --pretty="tformat:%<(40)%s" >actual &&
 189         qz_to_tab_space <<-EOF | iconv -f utf-8 -t $test_encoding >expected &&
 190         message two                            Z
 191         message one                            Z
 192         add bar                                Z
 193         $(commit_msg)                    Z
 194         EOF
 195         test_cmp expected actual
 196 '
 197
 198 test_expect_success 'left alignment formatting at the nth column' '
 199         git log --pretty="tformat:%h %<|(40)%s" >actual &&
 200         qz_to_tab_space <<-EOF >expected &&
 201         $head1 message two                    Z
 202         $head2 message one                    Z
 203         $head3 add bar                        Z
 204         $head4 $(commit_msg)            Z
 205         EOF
 206         test_cmp expected actual
 207 '
 208
 209 test_expect_success 'left alignment formatting at the nth column' '
 210         COLUMNS=50 git log --pretty="tformat:%h %<|(-10)%s" >actual &&
 211         qz_to_tab_space <<-EOF >expected &&
 212         $head1 message two                    Z
 213         $head2 message one                    Z
 214         $head3 add bar                        Z
 215         $head4 $(commit_msg)            Z
 216         EOF
 217         test_cmp expected actual
 218 '
 219
 220 test_expect_success 'left alignment formatting at the nth column. i18n.logOutputEncoding' '
 221         git -c i18n.logOutputEncoding=$test_encoding log --pretty="tformat:%h %<|(40)%s" >actual &&
 222         qz_to_tab_space <<-EOF | iconv -f utf-8 -t $test_encoding >expected &&
 223         $head1 message two                    Z
 224         $head2 message one                    Z
 225         $head3 add bar                        Z
 226         $head4 $(commit_msg)            Z
 227         EOF
 228         test_cmp expected actual
 229 '
 230
 231 test_expect_success 'left alignment formatting with no padding' '
 232         git log --pretty="tformat:%<(1)%s" >actual &&
 233         cat <<-EOF >expected &&
 234         message two
 235         message one
 236         add bar
 237         $(commit_msg)
 238         EOF
 239         test_cmp expected actual
 240 '
 241
 242 test_expect_success 'left alignment formatting with no padding. i18n.logOutputEncoding' '
 243         git -c i18n.logOutputEncoding=$test_encoding log --pretty="tformat:%<(1)%s" >actual &&
 244         cat <<-EOF | iconv -f utf-8 -t $test_encoding >expected &&
 245         message two
 246         message one
 247         add bar
 248         $(commit_msg)
 249         EOF
 250         test_cmp expected actual
 251 '
 252
 253 test_expect_success 'left alignment formatting with trunc' '
 254         git log --pretty="tformat:%<(10,trunc)%s" >actual &&
 255         qz_to_tab_space <<-\EOF >expected &&
 256         message ..
 257         message ..
 258         add bar  Z
 259         initial...
 260         EOF
 261         test_cmp expected actual
 262 '
 263
 264 test_expect_success 'left alignment formatting with trunc. i18n.logOutputEncoding' '
 265         git -c i18n.logOutputEncoding=$test_encoding log --pretty="tformat:%<(10,trunc)%s" >actual &&
 266         qz_to_tab_space <<-\EOF | iconv -f utf-8 -t $test_encoding >expected &&
 267         message ..
 268         message ..
 269         add bar  Z
 270         initial...
 271         EOF
 272         test_cmp expected actual
 273 '
 274
 275 test_expect_success 'left alignment formatting with ltrunc' '
 276         git log --pretty="tformat:%<(10,ltrunc)%s" >actual &&
 277         qz_to_tab_space <<-EOF >expected &&
 278         ..sage two
 279         ..sage one
 280         add bar  Z
 281         ..${sample_utf8_part}lich
 282         EOF
 283         test_cmp expected actual
 284 '
 285
 286 test_expect_success 'left alignment formatting with ltrunc. i18n.logOutputEncoding' '
 287         git -c i18n.logOutputEncoding=$test_encoding log --pretty="tformat:%<(10,ltrunc)%s" >actual &&
 288         qz_to_tab_space <<-EOF | iconv -f utf-8 -t $test_encoding >expected &&
 289         ..sage two
 290         ..sage one
 291         add bar  Z
 292         ..${sample_utf8_part}lich
 293         EOF
 294         test_cmp expected actual
 295 '
 296
 297 test_expect_success 'left alignment formatting with mtrunc' '
 298         git log --pretty="tformat:%<(10,mtrunc)%s" >actual &&
 299         qz_to_tab_space <<-\EOF >expected &&
 300         mess.. two
 301         mess.. one
 302         add bar  Z
 303         init..lich
 304         EOF
 305         test_cmp expected actual
 306 '
 307
 308 test_expect_success 'left alignment formatting with mtrunc. i18n.logOutputEncoding' '
 309         git -c i18n.logOutputEncoding=$test_encoding log --pretty="tformat:%<(10,mtrunc)%s" >actual &&
 310         qz_to_tab_space <<-\EOF | iconv -f utf-8 -t $test_encoding >expected &&
 311         mess.. two
 312         mess.. one
 313         add bar  Z
 314         init..lich
 315         EOF
 316         test_cmp expected actual
 317 '
 318
 319 test_expect_success 'right alignment formatting' '
 320         git log --pretty="tformat:%>(40)%s" >actual &&
 321         qz_to_tab_space <<-EOF >expected &&
 322         Z                            message two
 323         Z                            message one
 324         Z                                add bar
 325         Z                    $(commit_msg)
 326         EOF
 327         test_cmp expected actual
 328 '
 329
 330 test_expect_success 'right alignment formatting. i18n.logOutputEncoding' '
 331         git -c i18n.logOutputEncoding=$test_encoding log --pretty="tformat:%>(40)%s" >actual &&
 332         qz_to_tab_space <<-EOF | iconv -f utf-8 -t $test_encoding >expected &&
 333         Z                            message two
 334         Z                            message one
 335         Z                                add bar
 336         Z                    $(commit_msg)
 337         EOF
 338         test_cmp expected actual
 339 '
 340
 341 test_expect_success 'right alignment formatting at the nth column' '
 342         git log --pretty="tformat:%h %>|(40)%s" >actual &&
 343         qz_to_tab_space <<-EOF >expected &&
 344         $head1                      message two
 345         $head2                      message one
 346         $head3                          add bar
 347         $head4              $(commit_msg)
 348         EOF
 349         test_cmp expected actual
 350 '
 351
 352 test_expect_success 'right alignment formatting at the nth column' '
 353         COLUMNS=50 git log --pretty="tformat:%h %>|(-10)%s" >actual &&
 354         qz_to_tab_space <<-EOF >expected &&
 355         $head1                      message two
 356         $head2                      message one
 357         $head3                          add bar
 358         $head4              $(commit_msg)
 359         EOF
 360         test_cmp expected actual
 361 '
 362
 363 test_expect_success 'right alignment formatting at the nth column. i18n.logOutputEncoding' '
 364         git -c i18n.logOutputEncoding=$test_encoding log --pretty="tformat:%h %>|(40)%s" >actual &&
 365         qz_to_tab_space <<-EOF | iconv -f utf-8 -t $test_encoding >expected &&
 366         $head1                      message two
 367         $head2                      message one
 368         $head3                          add bar
 369         $head4              $(commit_msg)
 370         EOF
 371         test_cmp expected actual
 372 '
 373
 374 # Note: Space between 'message' and 'two' should be in the same column
 375 # as in previous test.
 376 test_expect_success 'right alignment formatting at the nth column with --graph. i18n.logOutputEncoding' '
 377         git -c i18n.logOutputEncoding=$test_encoding log --graph --pretty="tformat:%h %>|(40)%s" >actual &&
 378         iconv -f utf-8 -t $test_encoding >expected <<-EOF &&
 379         * $head1                    message two
 380         * $head2                    message one
 381         * $head3                        add bar
 382         * $head4            $(commit_msg)
 383         EOF
 384         test_cmp expected actual
 385 '
 386
 387 test_expect_success 'right alignment formatting with no padding' '
 388         git log --pretty="tformat:%>(1)%s" >actual &&
 389         cat <<-EOF >expected &&
 390         message two
 391         message one
 392         add bar
 393         $(commit_msg)
 394         EOF
 395         test_cmp expected actual
 396 '
 397
 398 test_expect_success 'right alignment formatting with no padding and with --graph' '
 399         git log --graph --pretty="tformat:%>(1)%s" >actual &&
 400         cat <<-EOF >expected &&
 401         * message two
 402         * message one
 403         * add bar
 404         * $(commit_msg)
 405         EOF
 406         test_cmp expected actual
 407 '
 408
 409 test_expect_success 'right alignment formatting with no padding. i18n.logOutputEncoding' '
 410         git -c i18n.logOutputEncoding=$test_encoding log --pretty="tformat:%>(1)%s" >actual &&
 411         cat <<-EOF | iconv -f utf-8 -t $test_encoding >expected &&
 412         message two
 413         message one
 414         add bar
 415         $(commit_msg)
 416         EOF
 417         test_cmp expected actual
 418 '
 419
 420 test_expect_success 'center alignment formatting' '
 421         git log --pretty="tformat:%><(40)%s" >actual &&
 422         qz_to_tab_space <<-EOF >expected &&
 423         Z             message two              Z
 424         Z             message one              Z
 425         Z               add bar                Z
 426         Z         $(commit_msg)          Z
 427         EOF
 428         test_cmp expected actual
 429 '
 430
 431 test_expect_success 'center alignment formatting. i18n.logOutputEncoding' '
 432         git -c i18n.logOutputEncoding=$test_encoding log --pretty="tformat:%><(40)%s" >actual &&
 433         qz_to_tab_space <<-EOF | iconv -f utf-8 -t $test_encoding >expected &&
 434         Z             message two              Z
 435         Z             message one              Z
 436         Z               add bar                Z
 437         Z         $(commit_msg)          Z
 438         EOF
 439         test_cmp expected actual
 440 '
 441 test_expect_success 'center alignment formatting at the nth column' '
 442         git log --pretty="tformat:%h %><|(40)%s" >actual &&
 443         qz_to_tab_space <<-EOF >expected &&
 444         $head1           message two          Z
 445         $head2           message one          Z
 446         $head3             add bar            Z
 447         $head4       $(commit_msg)      Z
 448         EOF
 449         test_cmp expected actual
 450 '
 451
 452 test_expect_success 'center alignment formatting at the nth column' '
 453         COLUMNS=70 git log --pretty="tformat:%h %><|(-30)%s" >actual &&
 454         qz_to_tab_space <<-EOF >expected &&
 455         $head1           message two          Z
 456         $head2           message one          Z
 457         $head3             add bar            Z
 458         $head4       $(commit_msg)      Z
 459         EOF
 460         test_cmp expected actual
 461 '
 462
 463 test_expect_success 'center alignment formatting at the nth column. i18n.logOutputEncoding' '
 464         git -c i18n.logOutputEncoding=$test_encoding log --pretty="tformat:%h %><|(40)%s" >actual &&
 465         qz_to_tab_space <<-EOF | iconv -f utf-8 -t $test_encoding >expected &&
 466         $head1           message two          Z
 467         $head2           message one          Z
 468         $head3             add bar            Z
 469         $head4       $(commit_msg)      Z
 470         EOF
 471         test_cmp expected actual
 472 '
 473
 474 test_expect_success 'center alignment formatting with no padding' '
 475         git log --pretty="tformat:%><(1)%s" >actual &&
 476         cat <<-EOF >expected &&
 477         message two
 478         message one
 479         add bar
 480         $(commit_msg)
 481         EOF
 482         test_cmp expected actual
 483 '
 484
 485 # save HEAD's SHA-1 digest (with no abbreviations) to use it below
 486 # as far as the next test amends HEAD
 487 old_head1=$(git rev-parse --verify HEAD~0)
 488 test_expect_success 'center alignment formatting with no padding. i18n.logOutputEncoding' '
 489         git -c i18n.logOutputEncoding=$test_encoding log --pretty="tformat:%><(1)%s" >actual &&
 490         cat <<-EOF | iconv -f utf-8 -t $test_encoding >expected &&
 491         message two
 492         message one
 493         add bar
 494         $(commit_msg)
 495         EOF
 496         test_cmp expected actual
 497 '
 498
 499 test_expect_success 'left/right alignment formatting with stealing' '
 500         git commit --amend -m short --author "long long long <long@me.com>" &&
 501         git log --pretty="tformat:%<(10,trunc)%s%>>(10,ltrunc)% an" >actual &&
 502         cat <<-\EOF >expected &&
 503         short long  long long
 504         message ..   A U Thor
 505         add bar      A U Thor
 506         initial...   A U Thor
 507         EOF
 508         test_cmp expected actual
 509 '
 510 test_expect_success 'left/right alignment formatting with stealing. i18n.logOutputEncoding' '
 511         git -c i18n.logOutputEncoding=$test_encoding log --pretty="tformat:%<(10,trunc)%s%>>(10,ltrunc)% an" >actual &&
 512         cat <<-\EOF | iconv -f utf-8 -t $test_encoding >expected &&
 513         short long  long long
 514         message ..   A U Thor
 515         add bar      A U Thor
 516         initial...   A U Thor
 517         EOF
 518         test_cmp expected actual
 519 '
 520
 521 test_expect_success 'strbuf_utf8_replace() not producing NUL' '
 522         git log --color --pretty="tformat:%<(10,trunc)%s%>>(10,ltrunc)%C(auto)%d" |
 523                 test_decode_color |
 524                 nul_to_q >actual &&
 525         ! grep Q actual
 526 '
 527
 528 # --date=[XXX] and corresponding %a[X] %c[X] format equivalency
 529 test_expect_success '--date=iso-strict %ad%cd is the same as %aI%cI' '
 530         git log --format=%ad%n%cd --date=iso-strict >expected &&
 531         git log --format=%aI%n%cI >actual &&
 532         test_cmp expected actual
 533 '
 534
 535 test_expect_success '--date=short %ad%cd is the same as %as%cs' '
 536         git log --format=%ad%n%cd --date=short >expected &&
 537         git log --format=%as%n%cs >actual &&
 538         test_cmp expected actual
 539 '
 540
 541 test_expect_success '--date=human %ad%cd is the same as %ah%ch' '
 542         git log --format=%ad%n%cd --date=human >expected &&
 543         git log --format=%ah%n%ch >actual &&
 544         test_cmp expected actual
 545 '
 546
 547 # get new digests (with no abbreviations)
 548 test_expect_success 'set up log decoration tests' '
 549         head1=$(git rev-parse --verify HEAD~0) &&
 550         head2=$(git rev-parse --verify HEAD~1)
 551 '
 552
 553 test_expect_success 'log decoration properly follows tag chain' '
 554         git tag -a tag1 -m tag1 &&
 555         git tag -a tag2 -m tag2 tag1 &&
 556         git tag -d tag1 &&
 557         git commit --amend -m shorter &&
 558         git log --no-walk --tags --pretty="%H %d" --decorate=full >actual &&
 559         cat <<-EOF >expected &&
 560         $head2  (tag: refs/tags/message-one)
 561         $old_head1  (tag: refs/tags/message-two)
 562         $head1  (tag: refs/tags/tag2)
 563         EOF
 564         sort -k3 actual >actual1 &&
 565         test_cmp expected actual1
 566 '
 567
 568 test_expect_success 'clean log decoration' '
 569         git log --no-walk --tags --pretty="%H %D" --decorate=full >actual &&
 570         cat >expected <<-EOF &&
 571         $head2 tag: refs/tags/message-one
 572         $old_head1 tag: refs/tags/message-two
 573         $head1 tag: refs/tags/tag2
 574         EOF
 575         sort -k3 actual >actual1 &&
 576         test_cmp expected actual1
 577 '
 578
 579 cat >trailers <<EOF
 580 Signed-off-by: A U Thor <author@example.com>
 581 Acked-by: A U Thor <author@example.com>
 582 [ v2 updated patch description ]
 583 Signed-off-by: A U Thor
 584   <author@example.com>
 585 EOF
 586
 587 unfold () {
 588         perl -0pe 's/\n\s+/ /g'
 589 }
 590
 591 test_expect_success 'set up trailer tests' '
 592         echo "Some contents" >trailerfile &&
 593         git add trailerfile &&
 594         git commit -F - <<-EOF
 595         trailers: this commit message has trailers
 596
 597         This commit is a test commit with trailers at the end. We parse this
 598         message and display the trailers using %(trailers).
 599
 600         $(cat trailers)
 601         EOF
 602 '
 603
 604 test_expect_success 'pretty format %(trailers) shows trailers' '
 605         git log --no-walk --pretty="%(trailers)" >actual &&
 606         {
 607                 cat trailers &&
 608                 echo
 609         } >expect &&
 610         test_cmp expect actual
 611 '
 612
 613 test_expect_success 'pretty format %(trailers:) enables no options' '
 614         git log --no-walk --pretty="%(trailers:)" >actual &&
 615         # "expect" the same as the test above
 616         test_cmp expect actual
 617 '
 618
 619 test_expect_success '%(trailers:only) shows only "key: value" trailers' '
 620         git log --no-walk --pretty="%(trailers:only)" >actual &&
 621         {
 622                 grep -v patch.description <trailers &&
 623                 echo
 624         } >expect &&
 625         test_cmp expect actual
 626 '
 627
 628 test_expect_success '%(trailers:only=yes) shows only "key: value" trailers' '
 629         git log --no-walk --pretty=format:"%(trailers:only=yes)" >actual &&
 630         grep -v patch.description <trailers >expect &&
 631         test_cmp expect actual
 632 '
 633
 634 test_expect_success '%(trailers:only=no) shows all trailers' '
 635         git log --no-walk --pretty=format:"%(trailers:only=no)" >actual &&
 636         cat trailers >expect &&
 637         test_cmp expect actual
 638 '
 639
 640 test_expect_success '%(trailers:only=no,only=true) shows only "key: value" trailers' '
 641         git log --no-walk --pretty=format:"%(trailers:only=yes)" >actual &&
 642         grep -v patch.description <trailers >expect &&
 643         test_cmp expect actual
 644 '
 645
 646 test_expect_success '%(trailers:unfold) unfolds trailers' '
 647         git log --no-walk --pretty="%(trailers:unfold)" >actual &&
 648         {
 649                 unfold <trailers &&
 650                 echo
 651         } >expect &&
 652         test_cmp expect actual
 653 '
 654
 655 test_expect_success ':only and :unfold work together' '
 656         git log --no-walk --pretty="%(trailers:only,unfold)" >actual &&
 657         git log --no-walk --pretty="%(trailers:unfold,only)" >reverse &&
 658         test_cmp actual reverse &&
 659         {
 660                 grep -v patch.description <trailers | unfold &&
 661                 echo
 662         } >expect &&
 663         test_cmp expect actual
 664 '
 665
 666 test_expect_success 'pretty format %(trailers:key=foo) shows that trailer' '
 667         git log --no-walk --pretty="format:%(trailers:key=Acked-by)" >actual &&
 668         echo "Acked-by: A U Thor <author@example.com>" >expect &&
 669         test_cmp expect actual
 670 '
 671
 672 test_expect_success 'pretty format %(trailers:key=foo) is case insensitive' '
 673         git log --no-walk --pretty="format:%(trailers:key=AcKed-bY)" >actual &&
 674         echo "Acked-by: A U Thor <author@example.com>" >expect &&
 675         test_cmp expect actual
 676 '
 677
 678 test_expect_success 'pretty format %(trailers:key=foo:) trailing colon also works' '
 679         git log --no-walk --pretty="format:%(trailers:key=Acked-by:)" >actual &&
 680         echo "Acked-by: A U Thor <author@example.com>" >expect &&
 681         test_cmp expect actual
 682 '
 683
 684 test_expect_success 'pretty format %(trailers:key=foo) multiple keys' '
 685         git log --no-walk --pretty="format:%(trailers:key=Acked-by:,key=Signed-off-By)" >actual &&
 686         grep -v patch.description <trailers >expect &&
 687         test_cmp expect actual
 688 '
 689
 690 test_expect_success '%(trailers:key=nonexistent) becomes empty' '
 691         git log --no-walk --pretty="x%(trailers:key=Nacked-by)x" >actual &&
 692         echo "xx" >expect &&
 693         test_cmp expect actual
 694 '
 695
 696 test_expect_success '%(trailers:key=foo) handles multiple lines even if folded' '
 697         git log --no-walk --pretty="format:%(trailers:key=Signed-Off-by)" >actual &&
 698         grep -v patch.description <trailers | grep -v Acked-by >expect &&
 699         test_cmp expect actual
 700 '
 701
 702 test_expect_success '%(trailers:key=foo,unfold) properly unfolds' '
 703         git log --no-walk --pretty="format:%(trailers:key=Signed-Off-by,unfold)" >actual &&
 704         unfold <trailers | grep Signed-off-by >expect &&
 705         test_cmp expect actual
 706 '
 707
 708 test_expect_success 'pretty format %(trailers:key=foo,only=no) also includes nontrailer lines' '
 709         git log --no-walk --pretty="format:%(trailers:key=Acked-by,only=no)" >actual &&
 710         {
 711                 echo "Acked-by: A U Thor <author@example.com>" &&
 712                 grep patch.description <trailers
 713         } >expect &&
 714         test_cmp expect actual
 715 '
 716
 717 test_expect_success '%(trailers:key) without value is error' '
 718         git log --no-walk --pretty="tformat:%(trailers:key)" >actual &&
 719         echo "%(trailers:key)" >expect &&
 720         test_cmp expect actual
 721 '
 722
 723 test_expect_success '%(trailers:keyonly) shows only keys' '
 724         git log --no-walk --pretty="format:%(trailers:keyonly)" >actual &&
 725         test_write_lines \
 726                 "Signed-off-by" \
 727                 "Acked-by" \
 728                 "[ v2 updated patch description ]" \
 729                 "Signed-off-by" >expect &&
 730         test_cmp expect actual
 731 '
 732
 733 test_expect_success '%(trailers:key=foo,keyonly) shows only key' '
 734         git log --no-walk --pretty="format:%(trailers:key=Acked-by,keyonly)" >actual &&
 735         echo "Acked-by" >expect &&
 736         test_cmp expect actual
 737 '
 738
 739 test_expect_success '%(trailers:key=foo,valueonly) shows only value' '
 740         git log --no-walk --pretty="format:%(trailers:key=Acked-by,valueonly)" >actual &&
 741         echo "A U Thor <author@example.com>" >expect &&
 742         test_cmp expect actual
 743 '
 744
 745 test_expect_success '%(trailers:valueonly) shows only values' '
 746         git log --no-walk --pretty="format:%(trailers:valueonly)" >actual &&
 747         test_write_lines \
 748                 "A U Thor <author@example.com>" \
 749                 "A U Thor <author@example.com>" \
 750                 "[ v2 updated patch description ]" \
 751                 "A U Thor" \
 752                 "  <author@example.com>" >expect &&
 753         test_cmp expect actual
 754 '
 755
 756 test_expect_success '%(trailers:key=foo,keyonly,valueonly) shows nothing' '
 757         git log --no-walk --pretty="format:%(trailers:key=Acked-by,keyonly,valueonly)" >actual &&
 758         echo >expect &&
 759         test_cmp expect actual
 760 '
 761
 762 test_expect_success 'pretty format %(trailers:separator) changes separator' '
 763         git log --no-walk --pretty=format:"X%(trailers:separator=%x00)X" >actual &&
 764         (
 765                 printf "XSigned-off-by: A U Thor <author@example.com>\0" &&
 766                 printf "Acked-by: A U Thor <author@example.com>\0" &&
 767                 printf "[ v2 updated patch description ]\0" &&
 768                 printf "Signed-off-by: A U Thor\n  <author@example.com>X"
 769         ) >expect &&
 770         test_cmp expect actual
 771 '
 772
 773 test_expect_success 'pretty format %(trailers:separator=X,unfold) changes separator' '
 774         git log --no-walk --pretty=format:"X%(trailers:separator=%x00,unfold)X" >actual &&
 775         (
 776                 printf "XSigned-off-by: A U Thor <author@example.com>\0" &&
 777                 printf "Acked-by: A U Thor <author@example.com>\0" &&
 778                 printf "[ v2 updated patch description ]\0" &&
 779                 printf "Signed-off-by: A U Thor <author@example.com>X"
 780         ) >expect &&
 781         test_cmp expect actual
 782 '
 783
 784 test_expect_success 'pretty format %(trailers:key_value_separator) changes key-value separator' '
 785         git log --no-walk --pretty=format:"X%(trailers:key_value_separator=%x00)X" >actual &&
 786         (
 787                 printf "XSigned-off-by\0A U Thor <author@example.com>\n" &&
 788                 printf "Acked-by\0A U Thor <author@example.com>\n" &&
 789                 printf "[ v2 updated patch description ]\n" &&
 790                 printf "Signed-off-by\0A U Thor\n  <author@example.com>\nX"
 791         ) >expect &&
 792         test_cmp expect actual
 793 '
 794
 795 test_expect_success 'pretty format %(trailers:key_value_separator,unfold) changes key-value separator' '
 796         git log --no-walk --pretty=format:"X%(trailers:key_value_separator=%x00,unfold)X" >actual &&
 797         (
 798                 printf "XSigned-off-by\0A U Thor <author@example.com>\n" &&
 799                 printf "Acked-by\0A U Thor <author@example.com>\n" &&
 800                 printf "[ v2 updated patch description ]\n" &&
 801                 printf "Signed-off-by\0A U Thor <author@example.com>\nX"
 802         ) >expect &&
 803         test_cmp expect actual
 804 '
 805
 806 test_expect_success 'pretty format %(trailers:separator,key_value_separator) changes both separators' '
 807         git log --no-walk --pretty=format:"%(trailers:separator=%x00,key_value_separator=%x00%x00,unfold)" >actual &&
 808         (
 809                 printf "Signed-off-by\0\0A U Thor <author@example.com>\0" &&
 810                 printf "Acked-by\0\0A U Thor <author@example.com>\0" &&
 811                 printf "[ v2 updated patch description ]\0" &&
 812                 printf "Signed-off-by\0\0A U Thor <author@example.com>"
 813         ) >expect &&
 814         test_cmp expect actual
 815 '
 816
 817 test_expect_success 'pretty format %(trailers) combining separator/key/keyonly/valueonly' '
 818         git commit --allow-empty -F - <<-\EOF &&
 819         Important fix
 820
 821         The fix is explained here
 822
 823         Closes: #1234
 824         EOF
 825
 826         git commit --allow-empty -F - <<-\EOF &&
 827         Another fix
 828
 829         The fix is explained here
 830
 831         Closes: #567
 832         Closes: #890
 833         EOF
 834
 835         git commit --allow-empty -F - <<-\EOF &&
 836         Does not close any tickets
 837         EOF
 838
 839         git log --pretty="%s% (trailers:separator=%x2c%x20,key=Closes,valueonly)" HEAD~3.. >actual &&
 840         test_write_lines \
 841                 "Does not close any tickets" \
 842                 "Another fix #567, #890" \
 843                 "Important fix #1234" >expect &&
 844         test_cmp expect actual &&
 845
 846         git log --pretty="%s% (trailers:separator=%x2c%x20,key=Closes,keyonly)" HEAD~3.. >actual &&
 847         test_write_lines \
 848                 "Does not close any tickets" \
 849                 "Another fix Closes, Closes" \
 850                 "Important fix Closes" >expect &&
 851         test_cmp expect actual
 852 '
 853
 854 test_expect_success 'trailer parsing not fooled by --- line' '
 855         git commit --allow-empty -F - <<-\EOF &&
 856         this is the subject
 857
 858         This is the body. The message has a "---" line which would confuse a
 859         message+patch parser. But here we know we have only a commit message,
 860         so we get it right.
 861
 862         trailer: wrong
 863         ---
 864         This is more body.
 865
 866         trailer: right
 867         EOF
 868
 869         {
 870                 echo "trailer: right" &&
 871                 echo
 872         } >expect &&
 873         git log --no-walk --format="%(trailers)" >actual &&
 874         test_cmp expect actual
 875 '
 876
 877 test_expect_success 'set up %S tests' '
 878         git checkout --orphan source-a &&
 879         test_commit one &&
 880         test_commit two &&
 881         git checkout -b source-b HEAD^ &&
 882         test_commit three
 883 '
 884
 885 test_expect_success 'log --format=%S paints branch names' '
 886         cat >expect <<-\EOF &&
 887         source-b
 888         source-a
 889         source-b
 890         EOF
 891         git log --format=%S source-a source-b >actual &&
 892         test_cmp expect actual
 893 '
 894
 895 test_expect_success 'log --format=%S paints tag names' '
 896         git tag -m tagged source-tag &&
 897         cat >expect <<-\EOF &&
 898         source-tag
 899         source-a
 900         source-tag
 901         EOF
 902         git log --format=%S source-tag source-a >actual &&
 903         test_cmp expect actual
 904 '
 905
 906 test_expect_success 'log --format=%S paints symmetric ranges' '
 907         cat >expect <<-\EOF &&
 908         source-b
 909         source-a
 910         EOF
 911         git log --format=%S source-a...source-b >actual &&
 912         test_cmp expect actual
 913 '
 914
 915 test_expect_success '%S in git log --format works with other placeholders (part 1)' '
 916         git log --format="source-b %h" source-b >expect &&
 917         git log --format="%S %h" source-b >actual &&
 918         test_cmp expect actual
 919 '
 920
 921 test_expect_success '%S in git log --format works with other placeholders (part 2)' '
 922         git log --format="%h source-b" source-b >expect &&
 923         git log --format="%h %S" source-b >actual &&
 924         test_cmp expect actual
 925 '
 926
 927 test_expect_success 'log --pretty=reference' '
 928         git log --pretty="tformat:%h (%s, %as)" >expect &&
 929         git log --pretty=reference >actual &&
 930         test_cmp expect actual
 931 '
 932
 933 test_expect_success 'log --pretty=reference with log.date is overridden by short date' '
 934         git log --pretty="tformat:%h (%s, %as)" >expect &&
 935         test_config log.date rfc &&
 936         git log --pretty=reference >actual &&
 937         test_cmp expect actual
 938 '
 939
 940 test_expect_success 'log --pretty=reference with explicit date overrides short date' '
 941         git log --date=rfc --pretty="tformat:%h (%s, %ad)" >expect &&
 942         git log --date=rfc --pretty=reference >actual &&
 943         test_cmp expect actual
 944 '
 945
 946 test_expect_success 'log --pretty=reference is never unabbreviated' '
 947         git log --pretty="tformat:%h (%s, %as)" >expect &&
 948         git log --no-abbrev-commit --pretty=reference >actual &&
 949         test_cmp expect actual
 950 '
 951
 952 test_expect_success 'log --pretty=reference is never decorated' '
 953         git log --pretty="tformat:%h (%s, %as)" >expect &&
 954         git log --decorate=short --pretty=reference >actual &&
 955         test_cmp expect actual
 956 '
 957
 958 test_expect_success 'log --pretty=reference does not output reflog info' '
 959         git log --walk-reflogs --pretty="tformat:%h (%s, %as)" >expect &&
 960         git log --walk-reflogs --pretty=reference >actual &&
 961         test_cmp expect actual
 962 '
 963
 964 test_expect_success 'log --pretty=reference is colored appropriately' '
 965         git log --color=always --pretty="tformat:%C(auto)%h (%s, %as)" >expect &&
 966         git log --color=always --pretty=reference >actual &&
 967         test_cmp expect actual
 968 '
 969
 970 test_expect_success '%(describe) vs git describe' '
 971         git log --format="%H" | while read hash
 972         do
 973                 if desc=$(git describe $hash)
 974                 then
 975                         : >expect-contains-good
 976                 else
 977                         : >expect-contains-bad
 978                 fi &&
 979                 echo "$hash $desc" || return 1
 980         done >expect &&
 981         test_path_exists expect-contains-good &&
 982         test_path_exists expect-contains-bad &&
 983
 984         git log --format="%H %(describe)" >actual 2>err &&
 985         test_cmp expect actual &&
 986         test_must_be_empty err
 987 '
 988
 989 test_expect_success '%(describe:match=...) vs git describe --match ...' '
 990         test_when_finished "git tag -d tag-match" &&
 991         git tag -a -m tagged tag-match &&
 992         git describe --match "*-match" >expect &&
 993         git log -1 --format="%(describe:match=*-match)" >actual &&
 994         test_cmp expect actual
 995 '
 996
 997 test_expect_success '%(describe:exclude=...) vs git describe --exclude ...' '
 998         test_when_finished "git tag -d tag-exclude" &&
 999         git tag -a -m tagged tag-exclude &&
1000         git describe --exclude "*-exclude" >expect &&
1001         git log -1 --format="%(describe:exclude=*-exclude)" >actual &&
1002         test_cmp expect actual
1003 '
1004
1005 test_expect_success '%(describe:tags) vs git describe --tags' '
1006         test_when_finished "git tag -d tagname" &&
1007         git tag tagname &&
1008         git describe --tags >expect &&
1009         git log -1 --format="%(describe:tags)" >actual &&
1010         test_cmp expect actual
1011 '
1012
1013 test_expect_success '%(describe:abbrev=...) vs git describe --abbrev=...' '
1014         test_when_finished "git tag -d tagname" &&
1015         git tag -a -m tagged tagname &&
1016         git describe --abbrev=15 >expect &&
1017         git log -1 --format="%(describe:abbrev=15)" >actual &&
1018         test_cmp expect actual
1019 '
1020
1021 test_expect_success 'log --pretty with space stealing' '
1022         printf mm0 >expect &&
1023         git log -1 --pretty="format:mm%>>|(1)%x30" >actual &&
1024         test_cmp expect actual
1025 '
1026
1027 test_expect_success 'log --pretty with invalid padding format' '
1028         printf "%s%%<(20" "$(git rev-parse HEAD)" >expect &&
1029         git log -1 --pretty="format:%H%<(20" >actual &&
1030         test_cmp expect actual
1031 '
1032
1033 test_expect_success 'log --pretty with magical wrapping directives' '
1034         commit_id=$(git commit-tree HEAD^{tree} -m "describe me") &&
1035         git tag describe-me $commit_id &&
1036         printf "\n(tag:\ndescribe-me)%%+w(2)" >expect &&
1037         git log -1 --pretty="format:%w(1)%+d%+w(2)" $commit_id >actual &&
1038         test_cmp expect actual
1039 '
1040
1041 test_expect_success SIZE_T_IS_64BIT 'log --pretty with overflowing wrapping directive' '
1042         printf "%%w(2147483649,1,1)0" >expect &&
1043         git log -1 --pretty="format:%w(2147483649,1,1)%x30" >actual &&
1044         test_cmp expect actual &&
1045         printf "%%w(1,2147483649,1)0" >expect &&
1046         git log -1 --pretty="format:%w(1,2147483649,1)%x30" >actual &&
1047         test_cmp expect actual &&
1048         printf "%%w(1,1,2147483649)0" >expect &&
1049         git log -1 --pretty="format:%w(1,1,2147483649)%x30" >actual &&
1050         test_cmp expect actual
1051 '
1052
1053 test_expect_success SIZE_T_IS_64BIT 'log --pretty with overflowing padding directive' '
1054         printf "%%<(2147483649)0" >expect &&
1055         git log -1 --pretty="format:%<(2147483649)%x30" >actual &&
1056         test_cmp expect actual
1057 '
1058
1059 test_expect_success 'log --pretty with padding and preceding control chars' '
1060         printf "\20\20   0" >expect &&
1061         git log -1 --pretty="format:%x10%x10%>|(4)%x30" >actual &&
1062         test_cmp expect actual
1063 '
1064
1065 test_expect_success 'log --pretty truncation with control chars' '
1066         test_commit "$(printf "\20\20\20\20xxxx")" file contents commit-with-control-chars &&
1067         printf "\20\20\20\20x.." >expect &&
1068         git log -1 --pretty="format:%<(3,trunc)%s" commit-with-control-chars >actual &&
1069         test_cmp expect actual
1070 '
1071
1072 test_expect_success EXPENSIVE,SIZE_T_IS_64BIT 'log --pretty with huge commit message' '
1073         # We only assert that this command does not crash. This needs to be
1074         # executed with the address sanitizer to demonstrate failure.
1075         git log -1 --pretty="format:%>(2147483646)%x41%41%>(2147483646)%x41" >/dev/null
1076 '
1077
1078 test_expect_success EXPENSIVE,SIZE_T_IS_64BIT 'set up huge commit' '
1079         test-tool genzeros 2147483649 | tr "\000" "1" >expect &&
1080         huge_commit=$(git commit-tree -F expect HEAD^{tree})
1081 '
1082
1083 test_expect_success EXPENSIVE,SIZE_T_IS_64BIT 'log --pretty with huge commit message' '
1084         git log -1 --format="%B%<(1)%x30" $huge_commit >actual &&
1085         echo 0 >>expect &&
1086         test_cmp expect actual
1087 '
1088
1089 test_expect_success EXPENSIVE,SIZE_T_IS_64BIT 'log --pretty with huge commit message does not cause allocation failure' '
1090         test_must_fail git log -1 --format="%<(1)%B" $huge_commit 2>error &&
1091         cat >expect <<-EOF &&
1092         fatal: number too large to represent as int on this platform: 2147483649
1093         EOF
1094         test_cmp expect error
1095 '
1096
1097 # pretty-formats note wide char limitations, and add tests
1098 test_expect_failure 'wide and decomposed characters column counting' '
1099
1100 # from t/lib-unicode-nfc-nfd.sh hex values converted to octal
1101         utf8_nfc=$(printf "\303\251") && # e acute combined.
1102         utf8_nfd=$(printf "\145\314\201") && # e with a combining acute (i.e. decomposed)
1103         utf8_emoji=$(printf "\360\237\221\250") &&
1104
1105 # replacement character when requesting a wide char fits in a single display colum.
1106 # "half wide" alternative could be a plain ASCII dot `.`
1107         utf8_vert_ell=$(printf "\342\213\256") &&
1108
1109 # use ${xxx} here!
1110         nfc10="${utf8_nfc}${utf8_nfc}${utf8_nfc}${utf8_nfc}${utf8_nfc}${utf8_nfc}${utf8_nfc}${utf8_nfc}${utf8_nfc}${utf8_nfc}" &&
1111         nfd10="${utf8_nfd}${utf8_nfd}${utf8_nfd}${utf8_nfd}${utf8_nfd}${utf8_nfd}${utf8_nfd}${utf8_nfd}${utf8_nfd}${utf8_nfd}" &&
1112         emoji5="${utf8_emoji}${utf8_emoji}${utf8_emoji}${utf8_emoji}${utf8_emoji}" &&
1113 # emoji5 uses 10 display columns
1114
1115         test_commit "abcdefghij" &&
1116         test_commit --no-tag "${nfc10}" &&
1117         test_commit --no-tag "${nfd10}" &&
1118         test_commit --no-tag "${emoji5}" &&
1119         printf "${utf8_emoji}..${utf8_emoji}${utf8_vert_ell}\n${utf8_nfd}..${utf8_nfd}${utf8_nfd}\n${utf8_nfc}..${utf8_nfc}${utf8_nfc}\na..ij\n" >expected &&
1120         git log --format="%<(5,mtrunc)%s" -4 >actual &&
1121         test_cmp expected actual
1122 '
1123
1124 test_done