Merge branch 'js/pre-merge-commit-hook'
authorJunio C Hamano <gitster@pobox.com>
Wed, 18 Sep 2019 18:50:08 +0000 (11:50 -0700)
committerJunio C Hamano <gitster@pobox.com>
Wed, 18 Sep 2019 18:50:08 +0000 (11:50 -0700)
A new "pre-merge-commit" hook has been introduced.

* js/pre-merge-commit-hook:
merge: --no-verify to bypass pre-merge-commit hook
git-merge: honor pre-merge-commit hook
merge: do no-verify like commit
t7503: verify proper hook execution

Documentation/git-merge.txt
Documentation/githooks.txt
Documentation/merge-options.txt
builtin/merge.c
t/t7503-pre-commit-and-pre-merge-commit-hooks.sh [new file with mode: 0755]
t/t7503-pre-commit-hook.sh [deleted file]
templates/hooks--pre-merge-commit.sample [new file with mode: 0755]
index 01fd52dc7063802226bf4f7205a2a1aab697bc67..092529c619e29cfa1c0959358d4671ff1cba1144 100644 (file)
@@ -10,7 +10,7 @@ SYNOPSIS
 --------
 [verse]
 'git merge' [-n] [--stat] [--no-commit] [--squash] [--[no-]edit]
-       [-s <strategy>] [-X <strategy-option>] [-S[<keyid>]]
+       [--no-verify] [-s <strategy>] [-X <strategy-option>] [-S[<keyid>]]
        [--[no-]allow-unrelated-histories]
        [--[no-]rerere-autoupdate] [-m <msg>] [-F <file>] [<commit>...]
 'git merge' (--continue | --abort | --quit)
index 82cd573776cec696774c467979c6da10f23554c3..57d6e2b98da7a093eff4ac0987824e34f6858677 100644 (file)
@@ -103,6 +103,28 @@ The default 'pre-commit' hook, when enabled--and with the
 `hooks.allownonascii` config option unset or set to false--prevents
 the use of non-ASCII filenames.
 
+pre-merge-commit
+~~~~~~~~~~~~~~~~
+
+This hook is invoked by linkgit:git-merge[1], and can be bypassed
+with the `--no-verify` option.  It takes no parameters, and is
+invoked after the merge has been carried out successfully and before
+obtaining the proposed commit log message to
+make a commit.  Exiting with a non-zero status from this script
+causes the `git merge` command to abort before creating a commit.
+
+The default 'pre-merge-commit' hook, when enabled, runs the
+'pre-commit' hook, if the latter is enabled.
+
+This hook is invoked with the environment variable
+`GIT_EDITOR=:` if the command will not bring up an editor
+to modify the commit message.
+
+If the merge cannot be carried out automatically, the conflicts
+need to be resolved and the result committed separately (see
+linkgit:git-merge[1]). At that point, this hook will not be executed,
+but the 'pre-commit' hook will, if it is enabled.
+
 prepare-commit-msg
 ~~~~~~~~~~~~~~~~~~
 
index 79a00d2a4abd6f7191f2639185e199fa85f6289b..d6a9f4b96faaf2814b41a2ff79a49c9d4d899795 100644 (file)
@@ -105,6 +105,10 @@ option can be used to override --squash.
 +
 With --squash, --commit is not allowed, and will fail.
 
+--no-verify::
+       This option bypasses the pre-merge and commit-msg hooks.
+       See also linkgit:githooks[5].
+
 -s <strategy>::
 --strategy=<strategy>::
        Use the given merge strategy; can be supplied more than
index e2ccbc44e204173b09f5ad4b704a31a9e8643bb6..c9746e37b86fa15963ae862ad1aaea5ece92562b 100644 (file)
@@ -81,7 +81,7 @@ static int show_progress = -1;
 static int default_to_upstream = 1;
 static int signoff;
 static const char *sign_commit;
-static int verify_msg = 1;
+static int no_verify;
 
 static struct strategy all_strategy[] = {
        { "recursive",  DEFAULT_TWOHEAD | NO_TRIVIAL },
@@ -287,7 +287,7 @@ static struct option builtin_merge_options[] = {
          N_("GPG sign commit"), PARSE_OPT_OPTARG, NULL, (intptr_t) "" },
        OPT_BOOL(0, "overwrite-ignore", &overwrite_ignore, N_("update ignored files (default)")),
        OPT_BOOL(0, "signoff", &signoff, N_("add Signed-off-by:")),
-       OPT_BOOL(0, "verify", &verify_msg, N_("verify commit-msg hook")),
+       OPT_BOOL(0, "no-verify", &no_verify, N_("bypass pre-merge-commit and commit-msg hooks")),
        OPT_END()
 };
 
@@ -816,6 +816,18 @@ static void write_merge_heads(struct commit_list *);
 static void prepare_to_commit(struct commit_list *remoteheads)
 {
        struct strbuf msg = STRBUF_INIT;
+       const char *index_file = get_index_file();
+
+       if (!no_verify && run_commit_hook(0 < option_edit, index_file, "pre-merge-commit", NULL))
+               abort_commit(remoteheads, NULL);
+       /*
+        * Re-read the index as pre-merge-commit hook could have updated it,
+        * and write it out as a tree.  We must do this before we invoke
+        * the editor and after we invoke run_status above.
+        */
+       if (find_hook("pre-merge-commit"))
+               discard_cache();
+       read_cache_from(index_file);
        strbuf_addbuf(&msg, &merge_msg);
        if (squash)
                BUG("the control must not reach here under --squash");
@@ -842,7 +854,7 @@ static void prepare_to_commit(struct commit_list *remoteheads)
                        abort_commit(remoteheads, NULL);
        }
 
-       if (verify_msg && run_commit_hook(0 < option_edit, get_index_file(),
+       if (!no_verify && run_commit_hook(0 < option_edit, get_index_file(),
                                          "commit-msg",
                                          git_path_merge_msg(the_repository), NULL))
                abort_commit(remoteheads, NULL);
diff --git a/t/t7503-pre-commit-and-pre-merge-commit-hooks.sh b/t/t7503-pre-commit-and-pre-merge-commit-hooks.sh
new file mode 100755 (executable)
index 0000000..b348545
--- /dev/null
@@ -0,0 +1,281 @@
+#!/bin/sh
+
+test_description='pre-commit and pre-merge-commit hooks'
+
+. ./test-lib.sh
+
+HOOKDIR="$(git rev-parse --git-dir)/hooks"
+PRECOMMIT="$HOOKDIR/pre-commit"
+PREMERGE="$HOOKDIR/pre-merge-commit"
+
+# Prepare sample scripts that write their $0 to actual_hooks
+test_expect_success 'sample script setup' '
+       mkdir -p "$HOOKDIR" &&
+       write_script "$HOOKDIR/success.sample" <<-\EOF &&
+       echo $0 >>actual_hooks
+       exit 0
+       EOF
+       write_script "$HOOKDIR/fail.sample" <<-\EOF &&
+       echo $0 >>actual_hooks
+       exit 1
+       EOF
+       write_script "$HOOKDIR/non-exec.sample" <<-\EOF &&
+       echo $0 >>actual_hooks
+       exit 1
+       EOF
+       chmod -x "$HOOKDIR/non-exec.sample" &&
+       write_script "$HOOKDIR/require-prefix.sample" <<-\EOF &&
+       echo $0 >>actual_hooks
+       test $GIT_PREFIX = "success/"
+       EOF
+       write_script "$HOOKDIR/check-author.sample" <<-\EOF
+       echo $0 >>actual_hooks
+       test "$GIT_AUTHOR_NAME" = "New Author" &&
+       test "$GIT_AUTHOR_EMAIL" = "newauthor@example.com"
+       EOF
+'
+
+test_expect_success 'root commit' '
+       echo "root" >file &&
+       git add file &&
+       git commit -m "zeroth" &&
+       git checkout -b side &&
+       echo "foo" >foo &&
+       git add foo &&
+       git commit -m "make it non-ff" &&
+       git branch side-orig side &&
+       git checkout master
+'
+
+test_expect_success 'setup conflicting branches' '
+       test_when_finished "git checkout master" &&
+       git checkout -b conflicting-a master &&
+       echo a >conflicting &&
+       git add conflicting &&
+       git commit -m conflicting-a &&
+       git checkout -b conflicting-b master &&
+       echo b >conflicting &&
+       git add conflicting &&
+       git commit -m conflicting-b
+'
+
+test_expect_success 'with no hook' '
+       test_when_finished "rm -f actual_hooks" &&
+       echo "foo" >file &&
+       git add file &&
+       git commit -m "first" &&
+       test_path_is_missing actual_hooks
+'
+
+test_expect_success 'with no hook (merge)' '
+       test_when_finished "rm -f actual_hooks" &&
+       git branch -f side side-orig &&
+       git checkout side &&
+       git merge -m "merge master" master &&
+       git checkout master &&
+       test_path_is_missing actual_hooks
+'
+
+test_expect_success '--no-verify with no hook' '
+       test_when_finished "rm -f actual_hooks" &&
+       echo "bar" >file &&
+       git add file &&
+       git commit --no-verify -m "bar" &&
+       test_path_is_missing actual_hooks
+'
+
+test_expect_success '--no-verify with no hook (merge)' '
+       test_when_finished "rm -f actual_hooks" &&
+       git branch -f side side-orig &&
+       git checkout side &&
+       git merge --no-verify -m "merge master" master &&
+       git checkout master &&
+       test_path_is_missing actual_hooks
+'
+
+test_expect_success 'with succeeding hook' '
+       test_when_finished "rm -f \"$PRECOMMIT\" expected_hooks actual_hooks" &&
+       cp "$HOOKDIR/success.sample" "$PRECOMMIT" &&
+       echo "$PRECOMMIT" >expected_hooks &&
+       echo "more" >>file &&
+       git add file &&
+       git commit -m "more" &&
+       test_cmp expected_hooks actual_hooks
+'
+
+test_expect_success 'with succeeding hook (merge)' '
+       test_when_finished "rm -f \"$PREMERGE\" expected_hooks actual_hooks" &&
+       cp "$HOOKDIR/success.sample" "$PREMERGE" &&
+       echo "$PREMERGE" >expected_hooks &&
+       git checkout side &&
+       git merge -m "merge master" master &&
+       git checkout master &&
+       test_cmp expected_hooks actual_hooks
+'
+
+test_expect_success 'automatic merge fails; both hooks are available' '
+       test_when_finished "rm -f \"$PREMERGE\" \"$PRECOMMIT\"" &&
+       test_when_finished "rm -f expected_hooks actual_hooks" &&
+       test_when_finished "git checkout master" &&
+       cp "$HOOKDIR/success.sample" "$PREMERGE" &&
+       cp "$HOOKDIR/success.sample" "$PRECOMMIT" &&
+
+       git checkout conflicting-a &&
+       test_must_fail git merge -m "merge conflicting-b" conflicting-b &&
+       test_path_is_missing actual_hooks &&
+
+       echo "$PRECOMMIT" >expected_hooks &&
+       echo a+b >conflicting &&
+       git add conflicting &&
+       git commit -m "resolve conflict" &&
+       test_cmp expected_hooks actual_hooks
+'
+
+test_expect_success '--no-verify with succeeding hook' '
+       test_when_finished "rm -f \"$PRECOMMIT\" actual_hooks" &&
+       cp "$HOOKDIR/success.sample" "$PRECOMMIT" &&
+       echo "even more" >>file &&
+       git add file &&
+       git commit --no-verify -m "even more" &&
+       test_path_is_missing actual_hooks
+'
+
+test_expect_success '--no-verify with succeeding hook (merge)' '
+       test_when_finished "rm -f \"$PREMERGE\" actual_hooks" &&
+       cp "$HOOKDIR/success.sample" "$PREMERGE" &&
+       git branch -f side side-orig &&
+       git checkout side &&
+       git merge --no-verify -m "merge master" master &&
+       git checkout master &&
+       test_path_is_missing actual_hooks
+'
+
+test_expect_success 'with failing hook' '
+       test_when_finished "rm -f \"$PRECOMMIT\" expected_hooks actual_hooks" &&
+       cp "$HOOKDIR/fail.sample" "$PRECOMMIT" &&
+       echo "$PRECOMMIT" >expected_hooks &&
+       echo "another" >>file &&
+       git add file &&
+       test_must_fail git commit -m "another" &&
+       test_cmp expected_hooks actual_hooks
+'
+
+test_expect_success '--no-verify with failing hook' '
+       test_when_finished "rm -f \"$PRECOMMIT\" actual_hooks" &&
+       cp "$HOOKDIR/fail.sample" "$PRECOMMIT" &&
+       echo "stuff" >>file &&
+       git add file &&
+       git commit --no-verify -m "stuff" &&
+       test_path_is_missing actual_hooks
+'
+
+test_expect_success 'with failing hook (merge)' '
+       test_when_finished "rm -f \"$PREMERGE\" expected_hooks actual_hooks" &&
+       cp "$HOOKDIR/fail.sample" "$PREMERGE" &&
+       echo "$PREMERGE" >expected_hooks &&
+       git checkout side &&
+       test_must_fail git merge -m "merge master" master &&
+       git checkout master &&
+       test_cmp expected_hooks actual_hooks
+'
+
+test_expect_success '--no-verify with failing hook (merge)' '
+       test_when_finished "rm -f \"$PREMERGE\" actual_hooks" &&
+       cp "$HOOKDIR/fail.sample" "$PREMERGE" &&
+       git branch -f side side-orig &&
+       git checkout side &&
+       git merge --no-verify -m "merge master" master &&
+       git checkout master &&
+       test_path_is_missing actual_hooks
+'
+
+test_expect_success POSIXPERM 'with non-executable hook' '
+       test_when_finished "rm -f \"$PRECOMMIT\" actual_hooks" &&
+       cp "$HOOKDIR/non-exec.sample" "$PRECOMMIT" &&
+       echo "content" >>file &&
+       git add file &&
+       git commit -m "content" &&
+       test_path_is_missing actual_hooks
+'
+
+test_expect_success POSIXPERM '--no-verify with non-executable hook' '
+       test_when_finished "rm -f \"$PRECOMMIT\" actual_hooks" &&
+       cp "$HOOKDIR/non-exec.sample" "$PRECOMMIT" &&
+       echo "more content" >>file &&
+       git add file &&
+       git commit --no-verify -m "more content" &&
+       test_path_is_missing actual_hooks
+'
+
+test_expect_success POSIXPERM 'with non-executable hook (merge)' '
+       test_when_finished "rm -f \"$PREMERGE\" actual_hooks" &&
+       cp "$HOOKDIR/non-exec.sample" "$PREMERGE" &&
+       git branch -f side side-orig &&
+       git checkout side &&
+       git merge -m "merge master" master &&
+       git checkout master &&
+       test_path_is_missing actual_hooks
+'
+
+test_expect_success POSIXPERM '--no-verify with non-executable hook (merge)' '
+       test_when_finished "rm -f \"$PREMERGE\" actual_hooks" &&
+       cp "$HOOKDIR/non-exec.sample" "$PREMERGE" &&
+       git branch -f side side-orig &&
+       git checkout side &&
+       git merge --no-verify -m "merge master" master &&
+       git checkout master &&
+       test_path_is_missing actual_hooks
+'
+
+test_expect_success 'with hook requiring GIT_PREFIX' '
+       test_when_finished "rm -rf \"$PRECOMMIT\" expected_hooks actual_hooks success" &&
+       cp "$HOOKDIR/require-prefix.sample" "$PRECOMMIT" &&
+       echo "$PRECOMMIT" >expected_hooks &&
+       echo "more content" >>file &&
+       git add file &&
+       mkdir success &&
+       (
+               cd success &&
+               git commit -m "hook requires GIT_PREFIX = success/"
+       ) &&
+       test_cmp expected_hooks actual_hooks
+'
+
+test_expect_success 'with failing hook requiring GIT_PREFIX' '
+       test_when_finished "rm -rf \"$PRECOMMIT\" expected_hooks actual_hooks fail" &&
+       cp "$HOOKDIR/require-prefix.sample" "$PRECOMMIT" &&
+       echo "$PRECOMMIT" >expected_hooks &&
+       echo "more content" >>file &&
+       git add file &&
+       mkdir fail &&
+       (
+               cd fail &&
+               test_must_fail git commit -m "hook must fail"
+       ) &&
+       git checkout -- file &&
+       test_cmp expected_hooks actual_hooks
+'
+
+test_expect_success 'check the author in hook' '
+       test_when_finished "rm -f \"$PRECOMMIT\" expected_hooks actual_hooks" &&
+       cp "$HOOKDIR/check-author.sample" "$PRECOMMIT" &&
+       cat >expected_hooks <<-EOF &&
+       $PRECOMMIT
+       $PRECOMMIT
+       $PRECOMMIT
+       EOF
+       test_must_fail git commit --allow-empty -m "by a.u.thor" &&
+       (
+               GIT_AUTHOR_NAME="New Author" &&
+               GIT_AUTHOR_EMAIL="newauthor@example.com" &&
+               export GIT_AUTHOR_NAME GIT_AUTHOR_EMAIL &&
+               git commit --allow-empty -m "by new.author via env" &&
+               git show -s
+       ) &&
+       git commit --author="New Author <newauthor@example.com>" \
+               --allow-empty -m "by new.author via command line" &&
+       git show -s &&
+       test_cmp expected_hooks actual_hooks
+'
+
+test_done
diff --git a/t/t7503-pre-commit-hook.sh b/t/t7503-pre-commit-hook.sh
deleted file mode 100755 (executable)
index 984889b..0000000
+++ /dev/null
@@ -1,139 +0,0 @@
-#!/bin/sh
-
-test_description='pre-commit hook'
-
-. ./test-lib.sh
-
-test_expect_success 'with no hook' '
-
-       echo "foo" > file &&
-       git add file &&
-       git commit -m "first"
-
-'
-
-test_expect_success '--no-verify with no hook' '
-
-       echo "bar" > file &&
-       git add file &&
-       git commit --no-verify -m "bar"
-
-'
-
-# now install hook that always succeeds
-HOOKDIR="$(git rev-parse --git-dir)/hooks"
-HOOK="$HOOKDIR/pre-commit"
-mkdir -p "$HOOKDIR"
-cat > "$HOOK" <<EOF
-#!/bin/sh
-exit 0
-EOF
-chmod +x "$HOOK"
-
-test_expect_success 'with succeeding hook' '
-
-       echo "more" >> file &&
-       git add file &&
-       git commit -m "more"
-
-'
-
-test_expect_success '--no-verify with succeeding hook' '
-
-       echo "even more" >> file &&
-       git add file &&
-       git commit --no-verify -m "even more"
-
-'
-
-# now a hook that fails
-cat > "$HOOK" <<EOF
-#!/bin/sh
-exit 1
-EOF
-
-test_expect_success 'with failing hook' '
-
-       echo "another" >> file &&
-       git add file &&
-       test_must_fail git commit -m "another"
-
-'
-
-test_expect_success '--no-verify with failing hook' '
-
-       echo "stuff" >> file &&
-       git add file &&
-       git commit --no-verify -m "stuff"
-
-'
-
-chmod -x "$HOOK"
-test_expect_success POSIXPERM 'with non-executable hook' '
-
-       echo "content" >> file &&
-       git add file &&
-       git commit -m "content"
-
-'
-
-test_expect_success POSIXPERM '--no-verify with non-executable hook' '
-
-       echo "more content" >> file &&
-       git add file &&
-       git commit --no-verify -m "more content"
-
-'
-chmod +x "$HOOK"
-
-# a hook that checks $GIT_PREFIX and succeeds inside the
-# success/ subdirectory only
-cat > "$HOOK" <<EOF
-#!/bin/sh
-test \$GIT_PREFIX = success/
-EOF
-
-test_expect_success 'with hook requiring GIT_PREFIX' '
-
-       echo "more content" >> file &&
-       git add file &&
-       mkdir success &&
-       (
-               cd success &&
-               git commit -m "hook requires GIT_PREFIX = success/"
-       ) &&
-       rmdir success
-'
-
-test_expect_success 'with failing hook requiring GIT_PREFIX' '
-
-       echo "more content" >> file &&
-       git add file &&
-       mkdir fail &&
-       (
-               cd fail &&
-               test_must_fail git commit -m "hook must fail"
-       ) &&
-       rmdir fail &&
-       git checkout -- file
-'
-
-test_expect_success 'check the author in hook' '
-       write_script "$HOOK" <<-\EOF &&
-       test "$GIT_AUTHOR_NAME" = "New Author" &&
-       test "$GIT_AUTHOR_EMAIL" = "newauthor@example.com"
-       EOF
-       test_must_fail git commit --allow-empty -m "by a.u.thor" &&
-       (
-               GIT_AUTHOR_NAME="New Author" &&
-               GIT_AUTHOR_EMAIL="newauthor@example.com" &&
-               export GIT_AUTHOR_NAME GIT_AUTHOR_EMAIL &&
-               git commit --allow-empty -m "by new.author via env" &&
-               git show -s
-       ) &&
-       git commit --author="New Author <newauthor@example.com>" \
-               --allow-empty -m "by new.author via command line" &&
-       git show -s
-'
-
-test_done
diff --git a/templates/hooks--pre-merge-commit.sample b/templates/hooks--pre-merge-commit.sample
new file mode 100755 (executable)
index 0000000..399eab1
--- /dev/null
@@ -0,0 +1,13 @@
+#!/bin/sh
+#
+# An example hook script to verify what is about to be committed.
+# Called by "git merge" with no arguments.  The hook should
+# exit with non-zero status after issuing an appropriate message to
+# stderr if it wants to stop the merge commit.
+#
+# To enable this hook, rename this file to "pre-merge-commit".
+
+. git-sh-setup
+test -x "$GIT_DIR/hooks/pre-commit" &&
+        exec "$GIT_DIR/hooks/pre-commit"
+: