t / t7502-commit.shon commit t7502: perform commits using alternate editor in a subshell (24e099f)
   1#!/bin/sh
   2
   3test_description='git commit porcelain-ish'
   4
   5. ./test-lib.sh
   6
   7commit_msg_is () {
   8        expect=commit_msg_is.expect
   9        actual=commit_msg_is.actual
  10
  11        printf "%s" "$(git log --pretty=format:%s%b -1)" >$actual &&
  12        printf "%s" "$1" >$expect &&
  13        test_i18ncmp $expect $actual
  14}
  15
  16# Arguments: [<prefix] [<commit message>] [<commit options>]
  17check_summary_oneline() {
  18        test_tick &&
  19        git commit ${3+"$3"} -m "$2" | head -1 > act &&
  20
  21        # branch name
  22        SUMMARY_PREFIX="$(git name-rev --name-only HEAD)" &&
  23
  24        # append the "special" prefix, like "root-commit", "detached HEAD"
  25        if test -n "$1"
  26        then
  27                SUMMARY_PREFIX="$SUMMARY_PREFIX ($1)"
  28        fi
  29
  30        # abbrev SHA-1
  31        SUMMARY_POSTFIX="$(git log -1 --pretty='format:%h')"
  32        echo "[$SUMMARY_PREFIX $SUMMARY_POSTFIX] $2" >exp &&
  33
  34        test_i18ncmp exp act
  35}
  36
  37test_expect_success 'output summary format' '
  38
  39        echo new >file1 &&
  40        git add file1 &&
  41        check_summary_oneline "root-commit" "initial" &&
  42
  43        echo change >>file1 &&
  44        git add file1
  45'
  46
  47test_expect_success 'output summary format: root-commit' '
  48        check_summary_oneline "" "a change"
  49'
  50
  51test_expect_success 'output summary format for commit with an empty diff' '
  52
  53        check_summary_oneline "" "empty" "--allow-empty"
  54'
  55
  56test_expect_success 'output summary format for merges' '
  57
  58        git checkout -b recursive-base &&
  59        test_commit base file1 &&
  60
  61        git checkout -b recursive-a recursive-base &&
  62        test_commit commit-a file1 &&
  63
  64        git checkout -b recursive-b recursive-base &&
  65        test_commit commit-b file1 &&
  66
  67        # conflict
  68        git checkout recursive-a &&
  69        test_must_fail git merge recursive-b &&
  70        # resolve the conflict
  71        echo commit-a > file1 &&
  72        git add file1 &&
  73        check_summary_oneline "" "Merge"
  74'
  75
  76output_tests_cleanup() {
  77        # this is needed for "do not fire editor in the presence of conflicts"
  78        git checkout master &&
  79
  80        # this is needed for the "partial removal" test to pass
  81        git rm file1 &&
  82        git commit -m "cleanup"
  83}
  84
  85test_expect_success 'the basics' '
  86
  87        output_tests_cleanup &&
  88
  89        echo doing partial >"commit is" &&
  90        mkdir not &&
  91        echo very much encouraged but we should >not/forbid &&
  92        git add "commit is" not &&
  93        echo update added "commit is" file >"commit is" &&
  94        echo also update another >not/forbid &&
  95        test_tick &&
  96        git commit -a -m "initial with -a" &&
  97
  98        git cat-file blob HEAD:"commit is" >current.1 &&
  99        git cat-file blob HEAD:not/forbid >current.2 &&
 100
 101        cmp current.1 "commit is" &&
 102        cmp current.2 not/forbid
 103
 104'
 105
 106test_expect_success 'partial' '
 107
 108        echo another >"commit is" &&
 109        echo another >not/forbid &&
 110        test_tick &&
 111        git commit -m "partial commit to handle a file" "commit is" &&
 112
 113        changed=$(git diff-tree --name-only HEAD^ HEAD) &&
 114        test "$changed" = "commit is"
 115
 116'
 117
 118test_expect_success 'partial modification in a subdirectory' '
 119
 120        test_tick &&
 121        git commit -m "partial commit to subdirectory" not &&
 122
 123        changed=$(git diff-tree -r --name-only HEAD^ HEAD) &&
 124        test "$changed" = "not/forbid"
 125
 126'
 127
 128test_expect_success 'partial removal' '
 129
 130        git rm not/forbid &&
 131        git commit -m "partial commit to remove not/forbid" not &&
 132
 133        changed=$(git diff-tree -r --name-only HEAD^ HEAD) &&
 134        test "$changed" = "not/forbid" &&
 135        remain=$(git ls-tree -r --name-only HEAD) &&
 136        test "$remain" = "commit is"
 137
 138'
 139
 140test_expect_success 'sign off' '
 141
 142        >positive &&
 143        git add positive &&
 144        git commit -s -m "thank you" &&
 145        actual=$(git cat-file commit HEAD | sed -ne "s/Signed-off-by: //p") &&
 146        expected=$(git var GIT_COMMITTER_IDENT | sed -e "s/>.*/>/") &&
 147        test "z$actual" = "z$expected"
 148
 149'
 150
 151test_expect_success 'multiple -m' '
 152
 153        >negative &&
 154        git add negative &&
 155        git commit -m "one" -m "two" -m "three" &&
 156        actual=$(git cat-file commit HEAD | sed -e "1,/^\$/d") &&
 157        expected=$(echo one; echo; echo two; echo; echo three) &&
 158        test "z$actual" = "z$expected"
 159
 160'
 161
 162test_expect_success 'verbose' '
 163
 164        echo minus >negative &&
 165        git add negative &&
 166        git status -v | sed -ne "/^diff --git /p" >actual &&
 167        echo "diff --git a/negative b/negative" >expect &&
 168        test_cmp expect actual
 169
 170'
 171
 172test_expect_success 'verbose respects diff config' '
 173
 174        git config color.diff always &&
 175        git status -v >actual &&
 176        grep "\[1mdiff --git" actual &&
 177        git config --unset color.diff
 178'
 179
 180test_expect_success 'cleanup commit messages (verbatim option,-t)' '
 181
 182        echo >>negative &&
 183        { echo;echo "# text";echo; } >expect &&
 184        git commit --cleanup=verbatim -t expect -a &&
 185        git cat-file -p HEAD |sed -e "1,/^\$/d" |head -n 3 >actual &&
 186        test_cmp expect actual
 187
 188'
 189
 190test_expect_success 'cleanup commit messages (verbatim option,-F)' '
 191
 192        echo >>negative &&
 193        git commit --cleanup=verbatim -F expect -a &&
 194        git cat-file -p HEAD |sed -e "1,/^\$/d">actual &&
 195        test_cmp expect actual
 196
 197'
 198
 199test_expect_success 'cleanup commit messages (verbatim option,-m)' '
 200
 201        echo >>negative &&
 202        git commit --cleanup=verbatim -m "$(cat expect)" -a &&
 203        git cat-file -p HEAD |sed -e "1,/^\$/d">actual &&
 204        test_cmp expect actual
 205
 206'
 207
 208test_expect_success 'cleanup commit messages (whitespace option,-F)' '
 209
 210        echo >>negative &&
 211        { echo;echo "# text";echo; } >text &&
 212        echo "# text" >expect &&
 213        git commit --cleanup=whitespace -F text -a &&
 214        git cat-file -p HEAD |sed -e "1,/^\$/d">actual &&
 215        test_cmp expect actual
 216
 217'
 218
 219test_expect_success 'cleanup commit messages (strip option,-F)' '
 220
 221        echo >>negative &&
 222        { echo;echo "# text";echo sample;echo; } >text &&
 223        echo sample >expect &&
 224        git commit --cleanup=strip -F text -a &&
 225        git cat-file -p HEAD |sed -e "1,/^\$/d">actual &&
 226        test_cmp expect actual
 227
 228'
 229
 230test_expect_success 'cleanup commit messages (strip option,-F,-e)' '
 231
 232        echo >>negative &&
 233        { echo;echo sample;echo; } >text &&
 234        git commit -e -F text -a &&
 235        head -n 4 .git/COMMIT_EDITMSG >actual
 236'
 237
 238echo "sample
 239
 240# Please enter the commit message for your changes. Lines starting
 241# with '#' will be ignored, and an empty message aborts the commit." >expect
 242
 243test_expect_success 'cleanup commit messages (strip option,-F,-e): output' '
 244        test_i18ncmp expect actual
 245'
 246
 247test_expect_success 'cleanup commit message (fail on invalid cleanup mode option)' '
 248        test_must_fail git commit --cleanup=non-existent
 249'
 250
 251test_expect_success 'cleanup commit message (fail on invalid cleanup mode configuration)' '
 252        test_must_fail git -c commit.cleanup=non-existent commit
 253'
 254
 255test_expect_success 'cleanup commit message (no config and no option uses default)' '
 256        echo content >>file &&
 257        git add file &&
 258        (
 259          test_set_editor "$TEST_DIRECTORY"/t7500/add-content-and-comment &&
 260          git commit --no-status
 261        ) &&
 262        commit_msg_is "commit message"
 263'
 264
 265test_expect_success 'cleanup commit message (option overrides default)' '
 266        echo content >>file &&
 267        git add file &&
 268        (
 269          test_set_editor "$TEST_DIRECTORY"/t7500/add-content-and-comment &&
 270          git commit --cleanup=whitespace --no-status
 271        ) &&
 272        commit_msg_is "commit message # comment"
 273'
 274
 275test_expect_success 'cleanup commit message (config overrides default)' '
 276        echo content >>file &&
 277        git add file &&
 278        (
 279          test_set_editor "$TEST_DIRECTORY"/t7500/add-content-and-comment &&
 280          git -c commit.cleanup=whitespace commit --no-status
 281        ) &&
 282        commit_msg_is "commit message # comment"
 283'
 284
 285test_expect_success 'cleanup commit message (option overrides config)' '
 286        echo content >>file &&
 287        git add file &&
 288        (
 289          test_set_editor "$TEST_DIRECTORY"/t7500/add-content-and-comment &&
 290          git -c commit.cleanup=whitespace commit --cleanup=default
 291        ) &&
 292        commit_msg_is "commit message"
 293'
 294
 295test_expect_success 'cleanup commit message (default, -m)' '
 296        echo content >>file &&
 297        git add file &&
 298        git commit -m "message #comment " &&
 299        commit_msg_is "message #comment"
 300'
 301
 302test_expect_success 'cleanup commit message (whitespace option, -m)' '
 303        echo content >>file &&
 304        git add file &&
 305        git commit --cleanup=whitespace --no-status -m "message #comment " &&
 306        commit_msg_is "message #comment"
 307'
 308
 309test_expect_success 'cleanup commit message (whitespace config, -m)' '
 310        echo content >>file &&
 311        git add file &&
 312        git -c commit.cleanup=whitespace commit --no-status -m "message #comment " &&
 313        commit_msg_is "message #comment"
 314'
 315
 316test_expect_success 'message shows author when it is not equal to committer' '
 317        echo >>negative &&
 318        git commit -e -m "sample" -a &&
 319        test_i18ngrep \
 320          "^# Author: *A U Thor <author@example.com>\$" \
 321          .git/COMMIT_EDITMSG
 322'
 323
 324test_expect_success AUTOIDENT 'message shows committer when it is automatic' '
 325
 326        echo >>negative &&
 327        (
 328                sane_unset GIT_COMMITTER_EMAIL &&
 329                sane_unset GIT_COMMITTER_NAME &&
 330                git commit -e -m "sample" -a
 331        ) &&
 332        # the ident is calculated from the system, so we cannot
 333        # check the actual value, only that it is there
 334        test_i18ngrep "^# Committer: " .git/COMMIT_EDITMSG
 335'
 336
 337write_script .git/FAKE_EDITOR <<EOF
 338echo editor started > "$(pwd)/.git/result"
 339exit 0
 340EOF
 341
 342test_expect_success !AUTOIDENT 'do not fire editor when committer is bogus' '
 343        >.git/result
 344        >expect &&
 345
 346        echo >>negative &&
 347        (
 348                sane_unset GIT_COMMITTER_EMAIL &&
 349                sane_unset GIT_COMMITTER_NAME &&
 350                GIT_EDITOR="\"$(pwd)/.git/FAKE_EDITOR\"" &&
 351                export GIT_EDITOR &&
 352                test_must_fail git commit -e -m sample -a
 353        ) &&
 354        test_cmp expect .git/result
 355'
 356
 357test_expect_success 'do not fire editor in the presence of conflicts' '
 358
 359        git clean -f &&
 360        echo f >g &&
 361        git add g &&
 362        git commit -m "add g" &&
 363        git branch second &&
 364        echo master >g &&
 365        echo g >h &&
 366        git add g h &&
 367        git commit -m "modify g and add h" &&
 368        git checkout second &&
 369        echo second >g &&
 370        git add g &&
 371        git commit -m second &&
 372        # Must fail due to conflict
 373        test_must_fail git cherry-pick -n master &&
 374        echo "editor not started" >.git/result &&
 375        (
 376                GIT_EDITOR="\"$(pwd)/.git/FAKE_EDITOR\"" &&
 377                export GIT_EDITOR &&
 378                test_must_fail git commit
 379        ) &&
 380        test "$(cat .git/result)" = "editor not started"
 381'
 382
 383write_script .git/FAKE_EDITOR <<EOF
 384# kill -TERM command added below.
 385EOF
 386
 387test_expect_success EXECKEEPSPID 'a SIGTERM should break locks' '
 388        echo >>negative &&
 389        ! "$SHELL_PATH" -c '\''
 390          echo kill -TERM $$ >> .git/FAKE_EDITOR
 391          GIT_EDITOR=.git/FAKE_EDITOR
 392          export GIT_EDITOR
 393          exec git commit -a'\'' &&
 394        test ! -f .git/index.lock
 395'
 396
 397rm -f .git/MERGE_MSG .git/COMMIT_EDITMSG
 398git reset -q --hard
 399
 400test_expect_success 'Hand committing of a redundant merge removes dups' '
 401
 402        git rev-parse second master >expect &&
 403        test_must_fail git merge second master &&
 404        git checkout master g &&
 405        EDITOR=: git commit -a &&
 406        git cat-file commit HEAD | sed -n -e "s/^parent //p" -e "/^$/q" >actual &&
 407        test_cmp expect actual
 408
 409'
 410
 411test_expect_success 'A single-liner subject with a token plus colon is not a footer' '
 412
 413        git reset --hard &&
 414        git commit -s -m "hello: kitty" --allow-empty &&
 415        git cat-file commit HEAD | sed -e "1,/^$/d" >actual &&
 416        test_line_count = 3 actual
 417
 418'
 419
 420write_script .git/FAKE_EDITOR <<\EOF
 421mv "$1" "$1.orig"
 422(
 423        echo message
 424        cat "$1.orig"
 425) >"$1"
 426EOF
 427
 428echo '## Custom template' >template
 429
 430clear_config () {
 431        (
 432                git config --unset-all "$1"
 433                case $? in
 434                0|5)    exit 0 ;;
 435                *)      exit 1 ;;
 436                esac
 437        )
 438}
 439
 440try_commit () {
 441        git reset --hard &&
 442        echo >>negative &&
 443        GIT_EDITOR=.git/FAKE_EDITOR git commit -a $* $use_template &&
 444        case "$use_template" in
 445        '')
 446                test_i18ngrep ! "^## Custom template" .git/COMMIT_EDITMSG ;;
 447        *)
 448                test_i18ngrep "^## Custom template" .git/COMMIT_EDITMSG ;;
 449        esac
 450}
 451
 452try_commit_status_combo () {
 453
 454        test_expect_success 'commit' '
 455                clear_config commit.status &&
 456                try_commit "" &&
 457                test_i18ngrep "^# Changes to be committed:" .git/COMMIT_EDITMSG
 458        '
 459
 460        test_expect_success 'commit' '
 461                clear_config commit.status &&
 462                try_commit "" &&
 463                test_i18ngrep "^# Changes to be committed:" .git/COMMIT_EDITMSG
 464        '
 465
 466        test_expect_success 'commit --status' '
 467                clear_config commit.status &&
 468                try_commit --status &&
 469                test_i18ngrep "^# Changes to be committed:" .git/COMMIT_EDITMSG
 470        '
 471
 472        test_expect_success 'commit --no-status' '
 473                clear_config commit.status &&
 474                try_commit --no-status &&
 475                test_i18ngrep ! "^# Changes to be committed:" .git/COMMIT_EDITMSG
 476        '
 477
 478        test_expect_success 'commit with commit.status = yes' '
 479                clear_config commit.status &&
 480                git config commit.status yes &&
 481                try_commit "" &&
 482                test_i18ngrep "^# Changes to be committed:" .git/COMMIT_EDITMSG
 483        '
 484
 485        test_expect_success 'commit with commit.status = no' '
 486                clear_config commit.status &&
 487                git config commit.status no &&
 488                try_commit "" &&
 489                test_i18ngrep ! "^# Changes to be committed:" .git/COMMIT_EDITMSG
 490        '
 491
 492        test_expect_success 'commit --status with commit.status = yes' '
 493                clear_config commit.status &&
 494                git config commit.status yes &&
 495                try_commit --status &&
 496                test_i18ngrep "^# Changes to be committed:" .git/COMMIT_EDITMSG
 497        '
 498
 499        test_expect_success 'commit --no-status with commit.status = yes' '
 500                clear_config commit.status &&
 501                git config commit.status yes &&
 502                try_commit --no-status &&
 503                test_i18ngrep ! "^# Changes to be committed:" .git/COMMIT_EDITMSG
 504        '
 505
 506        test_expect_success 'commit --status with commit.status = no' '
 507                clear_config commit.status &&
 508                git config commit.status no &&
 509                try_commit --status &&
 510                test_i18ngrep "^# Changes to be committed:" .git/COMMIT_EDITMSG
 511        '
 512
 513        test_expect_success 'commit --no-status with commit.status = no' '
 514                clear_config commit.status &&
 515                git config commit.status no &&
 516                try_commit --no-status &&
 517                test_i18ngrep ! "^# Changes to be committed:" .git/COMMIT_EDITMSG
 518        '
 519
 520}
 521
 522try_commit_status_combo
 523
 524use_template="-t template"
 525
 526try_commit_status_combo
 527
 528test_done