t/t7504-commit-msg-hook.sh

   1 #!/bin/sh
   2
   3 test_description='commit-msg hook'
   4
   5 . ./test-lib.sh
   6
   7 test_expect_success 'with no hook' '
   8
   9         echo "foo" > file &&
  10         git add file &&
  11         git commit -m "first"
  12
  13 '
  14
  15 # set up fake editor for interactive editing
  16 cat > fake-editor <<'EOF'
  17 #!/bin/sh
  18 cp FAKE_MSG "$1"
  19 exit 0
  20 EOF
  21 chmod +x fake-editor
  22
  23 ## Not using test_set_editor here so we can easily ensure the editor variable
  24 ## is only set for the editor tests
  25 FAKE_EDITOR="$(pwd)/fake-editor"
  26 export FAKE_EDITOR
  27
  28 test_expect_success 'with no hook (editor)' '
  29
  30         echo "more foo" >> file &&
  31         git add file &&
  32         echo "more foo" > FAKE_MSG &&
  33         GIT_EDITOR="\"\$FAKE_EDITOR\"" git commit
  34
  35 '
  36
  37 test_expect_success '--no-verify with no hook' '
  38
  39         echo "bar" > file &&
  40         git add file &&
  41         git commit --no-verify -m "bar"
  42
  43 '
  44
  45 test_expect_success '--no-verify with no hook (editor)' '
  46
  47         echo "more bar" > file &&
  48         git add file &&
  49         echo "more bar" > FAKE_MSG &&
  50         GIT_EDITOR="\"\$FAKE_EDITOR\"" git commit --no-verify
  51
  52 '
  53
  54 # now install hook that always succeeds
  55 HOOKDIR="$(git rev-parse --git-dir)/hooks"
  56 HOOK="$HOOKDIR/commit-msg"
  57 mkdir -p "$HOOKDIR"
  58 cat > "$HOOK" <<EOF
  59 #!/bin/sh
  60 exit 0
  61 EOF
  62 chmod +x "$HOOK"
  63
  64 test_expect_success 'with succeeding hook' '
  65
  66         echo "more" >> file &&
  67         git add file &&
  68         git commit -m "more"
  69
  70 '
  71
  72 test_expect_success 'with succeeding hook (editor)' '
  73
  74         echo "more more" >> file &&
  75         git add file &&
  76         echo "more more" > FAKE_MSG &&
  77         GIT_EDITOR="\"\$FAKE_EDITOR\"" git commit
  78
  79 '
  80
  81 test_expect_success '--no-verify with succeeding hook' '
  82
  83         echo "even more" >> file &&
  84         git add file &&
  85         git commit --no-verify -m "even more"
  86
  87 '
  88
  89 test_expect_success '--no-verify with succeeding hook (editor)' '
  90
  91         echo "even more more" >> file &&
  92         git add file &&
  93         echo "even more more" > FAKE_MSG &&
  94         GIT_EDITOR="\"\$FAKE_EDITOR\"" git commit --no-verify
  95
  96 '
  97
  98 # now a hook that fails
  99 cat > "$HOOK" <<EOF
 100 #!/bin/sh
 101 exit 1
 102 EOF
 103
 104 commit_msg_is () {
 105         test "$(git log --pretty=format:%s%b -1)" = "$1"
 106 }
 107
 108 test_expect_success 'with failing hook' '
 109
 110         echo "another" >> file &&
 111         git add file &&
 112         test_must_fail git commit -m "another"
 113
 114 '
 115
 116 test_expect_success 'with failing hook (editor)' '
 117
 118         echo "more another" >> file &&
 119         git add file &&
 120         echo "more another" > FAKE_MSG &&
 121         ! (GIT_EDITOR="\"\$FAKE_EDITOR\"" git commit)
 122
 123 '
 124
 125 test_expect_success '--no-verify with failing hook' '
 126
 127         echo "stuff" >> file &&
 128         git add file &&
 129         git commit --no-verify -m "stuff"
 130
 131 '
 132
 133 test_expect_success '--no-verify with failing hook (editor)' '
 134
 135         echo "more stuff" >> file &&
 136         git add file &&
 137         echo "more stuff" > FAKE_MSG &&
 138         GIT_EDITOR="\"\$FAKE_EDITOR\"" git commit --no-verify
 139
 140 '
 141
 142 test_expect_success 'merge fails with failing hook' '
 143
 144         test_when_finished "git branch -D newbranch" &&
 145         test_when_finished "git checkout -f master" &&
 146         git checkout --orphan newbranch &&
 147         : >file2 &&
 148         git add file2 &&
 149         git commit --no-verify file2 -m in-side-branch &&
 150         test_must_fail git merge --allow-unrelated-histories master &&
 151         commit_msg_is "in-side-branch" # HEAD before merge
 152
 153 '
 154
 155 test_expect_success 'merge bypasses failing hook with --no-verify' '
 156
 157         test_when_finished "git branch -D newbranch" &&
 158         test_when_finished "git checkout -f master" &&
 159         git checkout --orphan newbranch &&
 160         git rm -f file &&
 161         : >file2 &&
 162         git add file2 &&
 163         git commit --no-verify file2 -m in-side-branch &&
 164         git merge --no-verify --allow-unrelated-histories master &&
 165         commit_msg_is "Merge branch '\''master'\'' into newbranch"
 166 '
 167
 168
 169 chmod -x "$HOOK"
 170 test_expect_success POSIXPERM 'with non-executable hook' '
 171
 172         echo "content" >file &&
 173         git add file &&
 174         git commit -m "content"
 175
 176 '
 177
 178 test_expect_success POSIXPERM 'with non-executable hook (editor)' '
 179
 180         echo "content again" >> file &&
 181         git add file &&
 182         echo "content again" > FAKE_MSG &&
 183         GIT_EDITOR="\"\$FAKE_EDITOR\"" git commit -m "content again"
 184
 185 '
 186
 187 test_expect_success POSIXPERM '--no-verify with non-executable hook' '
 188
 189         echo "more content" >> file &&
 190         git add file &&
 191         git commit --no-verify -m "more content"
 192
 193 '
 194
 195 test_expect_success POSIXPERM '--no-verify with non-executable hook (editor)' '
 196
 197         echo "even more content" >> file &&
 198         git add file &&
 199         echo "even more content" > FAKE_MSG &&
 200         GIT_EDITOR="\"\$FAKE_EDITOR\"" git commit --no-verify
 201
 202 '
 203
 204 # now a hook that edits the commit message
 205 cat > "$HOOK" <<'EOF'
 206 #!/bin/sh
 207 echo "new message" > "$1"
 208 exit 0
 209 EOF
 210 chmod +x "$HOOK"
 211
 212 test_expect_success 'hook edits commit message' '
 213
 214         echo "additional" >> file &&
 215         git add file &&
 216         git commit -m "additional" &&
 217         commit_msg_is "new message"
 218
 219 '
 220
 221 test_expect_success 'hook edits commit message (editor)' '
 222
 223         echo "additional content" >> file &&
 224         git add file &&
 225         echo "additional content" > FAKE_MSG &&
 226         GIT_EDITOR="\"\$FAKE_EDITOR\"" git commit &&
 227         commit_msg_is "new message"
 228
 229 '
 230
 231 test_expect_success "hook doesn't edit commit message" '
 232
 233         echo "plus" >> file &&
 234         git add file &&
 235         git commit --no-verify -m "plus" &&
 236         commit_msg_is "plus"
 237
 238 '
 239
 240 test_expect_success "hook doesn't edit commit message (editor)" '
 241
 242         echo "more plus" >> file &&
 243         git add file &&
 244         echo "more plus" > FAKE_MSG &&
 245         GIT_EDITOR="\"\$FAKE_EDITOR\"" git commit --no-verify &&
 246         commit_msg_is "more plus"
 247 '
 248
 249 test_expect_success 'hook called in git-merge picks up commit message' '
 250         test_when_finished "git branch -D newbranch" &&
 251         test_when_finished "git checkout -f master" &&
 252         git checkout --orphan newbranch &&
 253         git rm -f file &&
 254         : >file2 &&
 255         git add file2 &&
 256         git commit --no-verify file2 -m in-side-branch &&
 257         git merge --allow-unrelated-histories master &&
 258         commit_msg_is "new message"
 259 '
 260
 261 test_expect_failure 'merge --continue remembers --no-verify' '
 262         test_when_finished "git branch -D newbranch" &&
 263         test_when_finished "git checkout -f master" &&
 264         git checkout master &&
 265         echo a >file2 &&
 266         git add file2 &&
 267         git commit --no-verify -m "add file2 to master" &&
 268         git checkout -b newbranch master^ &&
 269         echo b >file2 &&
 270         git add file2 &&
 271         git commit --no-verify file2 -m in-side-branch &&
 272         git merge --no-verify -m not-rewritten-by-hook master &&
 273         # resolve conflict:
 274         echo c >file2 &&
 275         git add file2 &&
 276         git merge --continue &&
 277         commit_msg_is not-rewritten-by-hook
 278 '
 279
 280 # set up fake editor to replace `pick` by `reword`
 281 cat > reword-editor <<'EOF'
 282 #!/bin/sh
 283 mv "$1" "$1".bup &&
 284 sed 's/^pick/reword/' <"$1".bup >"$1"
 285 EOF
 286 chmod +x reword-editor
 287 REWORD_EDITOR="$(pwd)/reword-editor"
 288 export REWORD_EDITOR
 289
 290 test_expect_success 'hook is called for reword during `rebase -i`' '
 291
 292         GIT_SEQUENCE_EDITOR="\"$REWORD_EDITOR\"" git rebase -i HEAD^ &&
 293         commit_msg_is "new message"
 294
 295 '
 296
 297
 298 test_done