git/t/t7503-pre-commit-and-pre-merge-commit-hooks.sh

284 lines
7.2 KiB
Bash
Raw Normal View History

#!/bin/sh
test_description='pre-commit and pre-merge-commit hooks'
GIT_TEST_DEFAULT_INITIAL_BRANCH_NAME=main
tests: mark tests relying on the current default for `init.defaultBranch` In addition to the manual adjustment to let the `linux-gcc` CI job run the test suite with `master` and then with `main`, this patch makes sure that GIT_TEST_DEFAULT_INITIAL_BRANCH_NAME is set in all test scripts that currently rely on the initial branch name being `master by default. To determine which test scripts to mark up, the first step was to force-set the default branch name to `master` in - all test scripts that contain the keyword `master`, - t4211, which expects `t/t4211/history.export` with a hard-coded ref to initialize the default branch, - t5560 because it sources `t/t556x_common` which uses `master`, - t8002 and t8012 because both source `t/annotate-tests.sh` which also uses `master`) This trick was performed by this command: $ sed -i '/^ *\. \.\/\(test-lib\|lib-\(bash\|cvs\|git-svn\)\|gitweb-lib\)\.sh$/i\ GIT_TEST_DEFAULT_INITIAL_BRANCH_NAME=master\ export GIT_TEST_DEFAULT_INITIAL_BRANCH_NAME\ ' $(git grep -l master t/t[0-9]*.sh) \ t/t4211*.sh t/t5560*.sh t/t8002*.sh t/t8012*.sh After that, careful, manual inspection revealed that some of the test scripts containing the needle `master` do not actually rely on a specific default branch name: either they mention `master` only in a comment, or they initialize that branch specificially, or they do not actually refer to the current default branch. Therefore, the aforementioned modification was undone in those test scripts thusly: $ git checkout HEAD -- \ t/t0027-auto-crlf.sh t/t0060-path-utils.sh \ t/t1011-read-tree-sparse-checkout.sh \ t/t1305-config-include.sh t/t1309-early-config.sh \ t/t1402-check-ref-format.sh t/t1450-fsck.sh \ t/t2024-checkout-dwim.sh \ t/t2106-update-index-assume-unchanged.sh \ t/t3040-subprojects-basic.sh t/t3301-notes.sh \ t/t3308-notes-merge.sh t/t3423-rebase-reword.sh \ t/t3436-rebase-more-options.sh \ t/t4015-diff-whitespace.sh t/t4257-am-interactive.sh \ t/t5323-pack-redundant.sh t/t5401-update-hooks.sh \ t/t5511-refspec.sh t/t5526-fetch-submodules.sh \ t/t5529-push-errors.sh t/t5530-upload-pack-error.sh \ t/t5548-push-porcelain.sh \ t/t5552-skipping-fetch-negotiator.sh \ t/t5572-pull-submodule.sh t/t5608-clone-2gb.sh \ t/t5614-clone-submodules-shallow.sh \ t/t7508-status.sh t/t7606-merge-custom.sh \ t/t9302-fast-import-unpack-limit.sh We excluded one set of test scripts in these commands, though: the range of `git p4` tests. The reason? `git p4` stores the (foreign) remote branch in the branch called `p4/master`, which is obviously not the default branch. Manual analysis revealed that only five of these tests actually require a specific default branch name to pass; They were modified thusly: $ sed -i '/^ *\. \.\/lib-git-p4\.sh$/i\ GIT_TEST_DEFAULT_INITIAL_BRANCH_NAME=master\ export GIT_TEST_DEFAULT_INITIAL_BRANCH_NAME\ ' t/t980[0167]*.sh t/t9811*.sh Signed-off-by: Johannes Schindelin <johannes.schindelin@gmx.de> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2020-11-18 23:44:19 +00:00
export GIT_TEST_DEFAULT_INITIAL_BRANCH_NAME
TEST_PASSES_SANITIZE_LEAK=true
. ./test-lib.sh
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 main
'
test_expect_success 'setup conflicting branches' '
test_when_finished "git checkout main" &&
git checkout -b conflicting-a main &&
echo a >conflicting &&
git add conflicting &&
git commit -m conflicting-a &&
git checkout -b conflicting-b main &&
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 main" main &&
git checkout main &&
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 main" main &&
git checkout main &&
test_path_is_missing actual_hooks
'
setup_success_hook () {
test_when_finished "rm -f actual_hooks expected_hooks" &&
echo "$1" >expected_hooks &&
test_hook "$1" <<-EOF
echo $1 >>actual_hooks
EOF
}
test_expect_success 'with succeeding hook' '
setup_success_hook "pre-commit" &&
echo "more" >>file &&
git add file &&
git commit -m "more" &&
test_cmp expected_hooks actual_hooks
'
test_expect_success 'with succeeding hook (merge)' '
setup_success_hook "pre-merge-commit" &&
git checkout side &&
git merge -m "merge main" main &&
git checkout main &&
test_cmp expected_hooks actual_hooks
'
test_expect_success 'automatic merge fails; both hooks are available' '
setup_success_hook "pre-commit" &&
setup_success_hook "pre-merge-commit" &&
git checkout conflicting-a &&
test_must_fail git merge -m "merge conflicting-b" conflicting-b &&
test_path_is_missing actual_hooks &&
echo "pre-commit" >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' '
setup_success_hook "pre-commit" &&
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)' '
setup_success_hook "pre-merge-commit" &&
git branch -f side side-orig &&
git checkout side &&
git merge --no-verify -m "merge main" main &&
git checkout main &&
test_path_is_missing actual_hooks
'
setup_failing_hook () {
test_when_finished "rm -f actual_hooks" &&
test_hook "$1" <<-EOF
echo $1-failing-hook >>actual_hooks
exit 1
EOF
}
Sane use of test_expect_failure Originally, test_expect_failure was designed to be the opposite of test_expect_success, but this was a bad decision. Most tests run a series of commands that leads to the single command that needs to be tested, like this: test_expect_{success,failure} 'test title' ' setup1 && setup2 && setup3 && what is to be tested ' And expecting a failure exit from the whole sequence misses the point of writing tests. Your setup$N that are supposed to succeed may have failed without even reaching what you are trying to test. The only valid use of test_expect_failure is to check a trivial single command that is expected to fail, which is a minority in tests of Porcelain-ish commands. This large-ish patch rewrites all uses of test_expect_failure to use test_expect_success and rewrites the condition of what is tested, like this: test_expect_success 'test title' ' setup1 && setup2 && setup3 && ! this command should fail ' test_expect_failure is redefined to serve as a reminder that that test *should* succeed but due to a known breakage in git it currently does not pass. So if git-foo command should create a file 'bar' but you discovered a bug that it doesn't, you can write a test like this: test_expect_failure 'git-foo should create bar' ' rm -f bar && git foo && test -f bar ' This construct acts similar to test_expect_success, but instead of reporting "ok/FAIL" like test_expect_success does, the outcome is reported as "FIXED/still broken". Signed-off-by: Junio C Hamano <gitster@pobox.com>
2008-02-01 09:50:53 +00:00
test_expect_success 'with failing hook' '
setup_failing_hook "pre-commit" &&
test_when_finished "rm -f expected_hooks" &&
echo "pre-commit-failing-hook" >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' '
setup_failing_hook "pre-commit" &&
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)' '
setup_failing_hook "pre-merge-commit" &&
echo "pre-merge-commit-failing-hook" >expected_hooks &&
git checkout side &&
test_must_fail git merge -m "merge main" main &&
git checkout main &&
test_cmp expected_hooks actual_hooks
'
test_expect_success '--no-verify with failing hook (merge)' '
setup_failing_hook "pre-merge-commit" &&
git branch -f side side-orig &&
git checkout side &&
git merge --no-verify -m "merge main" main &&
git checkout main &&
test_path_is_missing actual_hooks
'
setup_non_exec_hook () {
test_when_finished "rm -f actual_hooks" &&
test_hook "$1" <<-\EOF &&
echo non-exec >>actual_hooks
exit 1
EOF
test_hook --disable "$1"
}
test_expect_success POSIXPERM 'with non-executable hook' '
setup_non_exec_hook "pre-commit" &&
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' '
setup_non_exec_hook "pre-commit" &&
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)' '
setup_non_exec_hook "pre-merge" &&
git branch -f side side-orig &&
git checkout side &&
git merge -m "merge main" main &&
git checkout main &&
test_path_is_missing actual_hooks
'
test_expect_success POSIXPERM '--no-verify with non-executable hook (merge)' '
setup_non_exec_hook "pre-merge" &&
git branch -f side side-orig &&
git checkout side &&
git merge --no-verify -m "merge main" main &&
git checkout main &&
test_path_is_missing actual_hooks
'
setup_require_prefix_hook () {
test_when_finished "rm -f expected_hooks" &&
echo require-prefix >expected_hooks &&
test_hook pre-commit <<-\EOF
echo require-prefix >>actual_hooks
test $GIT_PREFIX = "success/"
EOF
}
test_expect_success 'with hook requiring GIT_PREFIX' '
test_when_finished "rm -rf actual_hooks success" &&
setup_require_prefix_hook &&
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 actual_hooks fail" &&
setup_require_prefix_hook &&
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
'
setup_require_author_hook () {
test_when_finished "rm -f expected_hooks actual_hooks" &&
echo check-author >expected_hooks &&
test_hook pre-commit <<-\EOF
echo check-author >>actual_hooks
test "$GIT_AUTHOR_NAME" = "New Author" &&
test "$GIT_AUTHOR_EMAIL" = "newauthor@example.com"
EOF
}
test_expect_success 'check the author in hook' '
setup_require_author_hook &&
cat >expected_hooks <<-EOF &&
check-author
check-author
check-author
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