mirror of
https://github.com/git/git
synced 2024-08-24 18:26:02 +00:00
![Junio C Hamano](/assets/img/avatar_default.png)
The pre-receive and post-receive hooks were designed to be an improvement over old style update and post-update hooks, which take the update information on their command line and are limited by the command line length limit. The same information is fed from the standard input to pre/post-receive hooks instead to lift this limitation. It has been mandatory for these new style hooks to consume the update information fully from the standard input stream. Otherwise, they would risk killing the receive-pack process via SIGPIPE. If a hook does not want to look at all the information, it is easy to send its standard input to /dev/null (perhaps a niche use of hook might need to know only the fact that a push was made, without having to know what objects have been pushed to update which refs), and this has already been done by existing hooks that are written carefully. However, because there is no good way to consistently fail hooks that do not consume the input fully (a small push may result in a short update record that may fit within the pipe buffer, to which the receive-pack process may manage to write before the hook has a chance to exit without reading anything, which will not result in a death-by-SIGPIPE of receive-pack), it can lead to a hard to diagnose "once in a blue moon" phantom failure. Lift this "hooks must consume their input fully" mandate. A mandate that is not enforced strictly is not helping us to catch mistakes in hooks. If a hook has a good reason to decide the outcome of its operation without reading the information we feed it, let it do so as it pleases. Signed-off-by: Junio C Hamano <gitster@pobox.com>
152 lines
4.1 KiB
Bash
Executable file
152 lines
4.1 KiB
Bash
Executable file
#!/bin/sh
|
|
#
|
|
# Copyright (c) 2006 Shawn O. Pearce
|
|
#
|
|
|
|
test_description='Test the update hook infrastructure.'
|
|
. ./test-lib.sh
|
|
|
|
test_expect_success setup '
|
|
echo This is a test. >a &&
|
|
git update-index --add a &&
|
|
tree0=$(git write-tree) &&
|
|
commit0=$(echo setup | git commit-tree $tree0) &&
|
|
echo We hope it works. >a &&
|
|
git update-index a &&
|
|
tree1=$(git write-tree) &&
|
|
commit1=$(echo modify | git commit-tree $tree1 -p $commit0) &&
|
|
git update-ref refs/heads/master $commit0 &&
|
|
git update-ref refs/heads/tofail $commit1 &&
|
|
git clone --bare ./. victim.git &&
|
|
GIT_DIR=victim.git git update-ref refs/heads/tofail $commit1 &&
|
|
git update-ref refs/heads/master $commit1 &&
|
|
git update-ref refs/heads/tofail $commit0
|
|
'
|
|
|
|
cat >victim.git/hooks/pre-receive <<'EOF'
|
|
#!/bin/sh
|
|
printf %s "$@" >>$GIT_DIR/pre-receive.args
|
|
cat - >$GIT_DIR/pre-receive.stdin
|
|
echo STDOUT pre-receive
|
|
echo STDERR pre-receive >&2
|
|
EOF
|
|
chmod u+x victim.git/hooks/pre-receive
|
|
|
|
cat >victim.git/hooks/update <<'EOF'
|
|
#!/bin/sh
|
|
echo "$@" >>$GIT_DIR/update.args
|
|
read x; printf %s "$x" >$GIT_DIR/update.stdin
|
|
echo STDOUT update $1
|
|
echo STDERR update $1 >&2
|
|
test "$1" = refs/heads/master || exit
|
|
EOF
|
|
chmod u+x victim.git/hooks/update
|
|
|
|
cat >victim.git/hooks/post-receive <<'EOF'
|
|
#!/bin/sh
|
|
printf %s "$@" >>$GIT_DIR/post-receive.args
|
|
cat - >$GIT_DIR/post-receive.stdin
|
|
echo STDOUT post-receive
|
|
echo STDERR post-receive >&2
|
|
EOF
|
|
chmod u+x victim.git/hooks/post-receive
|
|
|
|
cat >victim.git/hooks/post-update <<'EOF'
|
|
#!/bin/sh
|
|
echo "$@" >>$GIT_DIR/post-update.args
|
|
read x; printf %s "$x" >$GIT_DIR/post-update.stdin
|
|
echo STDOUT post-update
|
|
echo STDERR post-update >&2
|
|
EOF
|
|
chmod u+x victim.git/hooks/post-update
|
|
|
|
test_expect_success push '
|
|
test_must_fail git send-pack --force ./victim.git \
|
|
master tofail >send.out 2>send.err
|
|
'
|
|
|
|
test_expect_success 'updated as expected' '
|
|
test $(GIT_DIR=victim.git git rev-parse master) = $commit1 &&
|
|
test $(GIT_DIR=victim.git git rev-parse tofail) = $commit1
|
|
'
|
|
|
|
test_expect_success 'hooks ran' '
|
|
test -f victim.git/pre-receive.args &&
|
|
test -f victim.git/pre-receive.stdin &&
|
|
test -f victim.git/update.args &&
|
|
test -f victim.git/update.stdin &&
|
|
test -f victim.git/post-receive.args &&
|
|
test -f victim.git/post-receive.stdin &&
|
|
test -f victim.git/post-update.args &&
|
|
test -f victim.git/post-update.stdin
|
|
'
|
|
|
|
test_expect_success 'pre-receive hook input' '
|
|
(echo $commit0 $commit1 refs/heads/master;
|
|
echo $commit1 $commit0 refs/heads/tofail
|
|
) | test_cmp - victim.git/pre-receive.stdin
|
|
'
|
|
|
|
test_expect_success 'update hook arguments' '
|
|
(echo refs/heads/master $commit0 $commit1;
|
|
echo refs/heads/tofail $commit1 $commit0
|
|
) | test_cmp - victim.git/update.args
|
|
'
|
|
|
|
test_expect_success 'post-receive hook input' '
|
|
echo $commit0 $commit1 refs/heads/master |
|
|
test_cmp - victim.git/post-receive.stdin
|
|
'
|
|
|
|
test_expect_success 'post-update hook arguments' '
|
|
echo refs/heads/master |
|
|
test_cmp - victim.git/post-update.args
|
|
'
|
|
|
|
test_expect_success 'all hook stdin is /dev/null' '
|
|
! test -s victim.git/update.stdin &&
|
|
! test -s victim.git/post-update.stdin
|
|
'
|
|
|
|
test_expect_success 'all *-receive hook args are empty' '
|
|
! test -s victim.git/pre-receive.args &&
|
|
! test -s victim.git/post-receive.args
|
|
'
|
|
|
|
test_expect_success 'send-pack produced no output' '
|
|
! test -s send.out
|
|
'
|
|
|
|
cat <<EOF >expect
|
|
remote: STDOUT pre-receive
|
|
remote: STDERR pre-receive
|
|
remote: STDOUT update refs/heads/master
|
|
remote: STDERR update refs/heads/master
|
|
remote: STDOUT update refs/heads/tofail
|
|
remote: STDERR update refs/heads/tofail
|
|
remote: error: hook declined to update refs/heads/tofail
|
|
remote: STDOUT post-receive
|
|
remote: STDERR post-receive
|
|
remote: STDOUT post-update
|
|
remote: STDERR post-update
|
|
EOF
|
|
test_expect_success 'send-pack stderr contains hook messages' '
|
|
grep ^remote: send.err | sed "s/ *\$//" >actual &&
|
|
test_cmp expect actual
|
|
'
|
|
|
|
test_expect_success 'pre-receive hook that forgets to read its input' '
|
|
write_script victim.git/hooks/pre-receive <<-\EOF &&
|
|
exit 0
|
|
EOF
|
|
rm -f victim.git/hooks/update victim.git/hooks/post-update &&
|
|
|
|
for v in $(test_seq 100 999)
|
|
do
|
|
git branch branch_$v master || return
|
|
done &&
|
|
git push ./victim.git "+refs/heads/*:refs/heads/*"
|
|
'
|
|
|
|
test_done
|