t/t7504-commit-msg-hook.sh

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