@matheusbsbs / matheus-bagliano / commits / 05ef58ec1f
Fork 0

Teach receive-pack to run pre-receive/post-receive hooks

Bill Lear pointed out that it is easy to send out notifications of changes with the update hook, but successful execution of the update hook does not necessarily mean that the ref was actually updated. Lock contention on the ref or being unable to append to the reflog may prevent the ref from being changed. Sending out notifications prior to the ref actually changing is very misleading. To help this situation I am introducing two new hooks to the receive-pack flow: pre-receive and post-receive. These new hooks are invoked only once per receive-pack execution and are passed three arguments per ref (refname, old-sha1, new-sha1). The new post-receive hook is ideal for sending out notifications, as it has the complete list of all refnames that were successfully updated as well as the old and new SHA-1 values. This allows more interesting notifications to be sent. Multiple ref updates could be easily summarized into one email, for example. The new pre-receive hook is ideal for logging update attempts, as it is run only once for the entire receive-pack operation. It can also be used to verify multiple updates happen at once, e.g. an update to the `maint` head must also be accompained by a new annotated tag. Lots of documentation improvements for receive-pack are included in this change, as we want to make sure the new hooks are clearly explained. Signed-off-by: Shawn O. Pearce <spearce@spearce.org> Signed-off-by: Junio C Hamano <junkio@cox.net>

Shawn O. Pearce committed Mar 7, 2007 at 16:52 UTC 05ef58ec1f2fb69d6e7ae7fca84163f75bd95050
3 files changed +191 -62
Documentation/git-receive-pack.txt
+107 -42
@@ -25,61 +25,126 @@ The command allows for creation and fast forwarding of sha1 refs
25 local end receive-pack runs, but to the user who is sitting at
26 the send-pack end, it is updating the remote. Confused?)
27
28 -Before each ref is updated, if $GIT_DIR/hooks/update file exists
29 -and executable, it is called with three parameters:
28 +There are other real-world examples of using update and
29 +post-update hooks found in the Documentation/howto directory.
30
31 - $GIT_DIR/hooks/update refname sha1-old sha1-new
31 +git-receive-pack honours the receive.denyNonFastForwards config
32 +option, which tells it if updates to a ref should be denied if they
33 +are not fast-forwards.
34 +
35 +OPTIONS
36 +-------
37 +<directory>::
38 + The repository to sync into.
39 +
40 +pre-receive Hook
41 +----------------
42 +Before any ref is updated, if $GIT_DIR/hooks/pre-receive file exists
43 +and is executable, it will be invoked once, with three parameters
44 +per ref to be updated:
45 +
46 + $GIT_DIR/hooks/pre-receive (refname sha1-old sha1-new)+
47 +
48 +The refname parameter is relative to $GIT_DIR; e.g. for the master
49 +head this is "refs/heads/master". The two sha1 arguments after
50 +each refname are the object names for the refname before and after
51 +the update. Refs to be created will have sha1-old equal to 0{40},
52 +while refs to be deleted will have sha1-new equal to 0{40}, otherwise
53 +sha1-old and sha1-new should be valid objects in the repository.
54 +
55 +This hook is called before any refname is updated and before any
56 +fast-forward checks are performed.
57 +
58 +If the pre-receive hook exits with a non-zero exit status no updates
59 +will be performed, and the update, post-receive and post-update
60 +hooks will not be invoked either. This can be useful to quickly
61 +bail out if the update is not to be supported.
62
33 -The refname parameter is relative to $GIT_DIR; e.g. for the
34 -master head this is "refs/heads/master". Two sha1 are the
35 -object names for the refname before and after the update. Note
36 -that the hook is called before the refname is updated, so either
37 -sha1-old is 0{40} (meaning there is no such ref yet), or it
38 -should match what is recorded in refname.
63 +update Hook
64 +-----------
65 +Before each ref is updated, if $GIT_DIR/hooks/update file exists
66 +and is executable, it is invoked once per ref, with three parameters:
67
40 -The hook should exit with non-zero status if it wants to
41 -disallow updating the named ref. Otherwise it should exit with
42 -zero.
68 + $GIT_DIR/hooks/update refname sha1-old sha1-new
69
44 -Using this hook, it is easy to generate mails on updates to
45 -the local repository. This example script sends a mail with
46 -the commits pushed to the repository:
70 +The refname parameter is relative to $GIT_DIR; e.g. for the master
71 +head this is "refs/heads/master". The two sha1 arguments are
72 +the object names for the refname before and after the update.
73 +Note that the hook is called before the refname is updated,
74 +so either sha1-old is 0{40} (meaning there is no such ref yet),
75 +or it should match what is recorded in refname.
76 +
77 +The hook should exit with non-zero status if it wants to disallow
78 +updating the named ref. Otherwise it should exit with zero.
79 +
80 +Successful execution (a zero exit status) of this hook does not
81 +ensure the ref will actully be updated, it is only a prerequisite.
82 +As such it is not a good idea to send notices (e.g. email) from
83 +this hook. Consider using the post-receive hook instead.
84 +
85 +post-receive Hook
86 +-----------------
87 +After all refs were updated (or attempted to be updated), if any
88 +ref update was successful, and if $GIT_DIR/hooks/post-receive
89 +file exists and is executable, it will be invoke once with three
90 +parameters for each successfully updated ref:
91 +
92 + $GIT_DIR/hooks/post-receive (refname sha1-old sha1-new)+
93 +
94 +The refname parameter is relative to $GIT_DIR; e.g. for the master
95 +head this is "refs/heads/master". The two sha1 arguments after
96 +each refname are the object names for the refname before and after
97 +the update. Refs that were created will have sha1-old equal to
98 +0{40}, while refs that were deleted will have sha1-new equal to
99 +0{40}, otherwise sha1-old and sha1-new should be valid objects in
100 +the repository.
101 +
102 +Using this hook, it is easy to generate mails describing the updates
103 +to the repository. This example script sends one mail message per
104 +ref listing the commits pushed to the repository:
105
106 #!/bin/sh
107 # mail out commit update information.
50 - if expr "$2" : '0*$' >/dev/null
51 - then
52 - echo "Created a new ref, with the following commits:"
53 - git-rev-list --pretty "$2"
54 - else
55 - echo "New commits:"
56 - git-rev-list --pretty "$3" "^$2"
57 - fi |
58 - mail -s "Changes to ref $1" commit-list@mydomain
108 + while test $# -gt 0
109 + do
110 + if expr "$2" : '0*$' >/dev/null
111 + then
112 + echo "Created a new ref, with the following commits:"
113 + git-rev-list --pretty "$2"
114 + else
115 + echo "New commits:"
116 + git-rev-list --pretty "$3" "^$2"
117 + fi |
118 + mail -s "Changes to ref $1" commit-list@mydomain
119 + shift; shift; shift; # discard this ref's args
120 + done
121 exit 0
122
61 -Another hook $GIT_DIR/hooks/post-update, if exists and
62 -executable, is called with the list of refs that have been
63 -updated. This can be used to implement repository wide cleanup
64 -task if needed. The exit code from this hook invocation is
65 -ignored; the only thing left for git-receive-pack to do at that
66 -point is to exit itself anyway. This hook can be used, for
67 -example, to run "git-update-server-info" if the repository is
68 -packed and is served via a dumb transport.
123 +The exit code from this hook invocation is ignored, however a
124 +non-zero exit code will generate an error message.
125
70 - #!/bin/sh
71 - exec git-update-server-info
126 +Note that it is possible for refname to not have sha1-new when this
127 +hook runs. This can easily occur if another user modifies the ref
128 +after it was updated by receive-pack, but before the hook was able
129 +to evaluate it. It is recommended that hooks rely on sha1-new
130 +rather than the current value of refname.
131
73 -There are other real-world examples of using update and
74 -post-update hooks found in the Documentation/howto directory.
132 +post-update Hook
133 +----------------
134 +After all other processing, if at least one ref was updated, and
135 +if $GIT_DIR/hooks/post-update file exists and is executable, then
136 +post-update will called with the list of refs that have been updated.
137 +This can be used to implement any repository wide cleanup tasks.
138
76 -git-receive-pack honours the receive.denyNonFastforwards flag, which
77 -tells it if updates to a ref should be denied if they are not fast-forwards.
139 +The exit code from this hook invocation is ignored; the only thing
140 +left for git-receive-pack to do at that point is to exit itself
141 +anyway.
142
79 -OPTIONS
80 --------
81 -<directory>::
82 - The repository to sync into.
143 +This hook can be used, for example, to run "git-update-server-info"
144 +if the repository is packed and is served via a dumb transport.
145 +
146 + #!/bin/sh
147 + exec git-update-server-info
148
149
150 SEE ALSO
receive-pack.c
+11
@@ -68,6 +68,8 @@ struct command {
68 static struct command *commands;
69
70 static const char update_hook[] = "hooks/update";
71 +static const char pre_receive_hook[] = "hooks/pre-receive";
72 +static const char post_receive_hook[] = "hooks/post-receive";
73
74 static int run_hook(const char *hook_name,
75 struct command *first_cmd,
@@ -236,6 +238,14 @@ static void execute_commands(const char *unpacker_error)
238 return;
239 }
240
241 + if (run_hook(pre_receive_hook, commands, 0)) {
242 + while (cmd) {
243 + cmd->error_string = "pre-receive hook declined";
244 + cmd = cmd->next;
245 + }
246 + return;
247 + }
248 +
249 while (cmd) {
250 cmd->error_string = update(cmd);
251 cmd = cmd->next;
@@ -483,6 +493,7 @@ int main(int argc, char **argv)
493 unlink(pack_lockfile);
494 if (report_status)
495 report(unpack_status);
496 + run_hook(post_receive_hook, commands, 0);
497 run_update_post_hook(commands);
498 }
499 return 0;
t/t5401-update-hooks.sh
+73 -20
@@ -11,47 +11,91 @@ test_expect_success setup '
11 git-update-index --add a &&
12 tree0=$(git-write-tree) &&
13 commit0=$(echo setup | git-commit-tree $tree0) &&
14 - git-update-ref HEAD $commit0 &&
15 - git-clone ./. victim &&
14 echo We hope it works. >a &&
15 git-update-index a &&
16 tree1=$(git-write-tree) &&
17 commit1=$(echo modify | git-commit-tree $tree1 -p $commit0) &&
20 - git-update-ref HEAD $commit1
18 + git-update-ref refs/heads/master $commit0 &&
19 + git-update-ref refs/heads/tofail $commit1 &&
20 + git-clone ./. victim &&
21 + GIT_DIR=victim/.git git-update-ref refs/heads/tofail $commit1 &&
22 + git-update-ref refs/heads/master $commit1 &&
23 + git-update-ref refs/heads/tofail $commit0
24 '
25
26 +cat >victim/.git/hooks/pre-receive <<'EOF'
27 +#!/bin/sh
28 +echo "$@" >>$GIT_DIR/pre-receive.args
29 +read x; printf "$x" >$GIT_DIR/pre-receive.stdin
30 +echo STDOUT pre-receive
31 +echo STDERR pre-receive >&2
32 +EOF
33 +chmod u+x victim/.git/hooks/pre-receive
34 +
35 cat >victim/.git/hooks/update <<'EOF'
36 #!/bin/sh
25 -echo "$@" >$GIT_DIR/update.args
37 +echo "$@" >>$GIT_DIR/update.args
38 read x; printf "$x" >$GIT_DIR/update.stdin
27 -echo STDOUT update
28 -echo STDERR update >&2
39 +echo STDOUT update $1
40 +echo STDERR update $1 >&2
41 +test "$1" = refs/heads/master || exit
42 EOF
43 chmod u+x victim/.git/hooks/update
44
45 +cat >victim/.git/hooks/post-receive <<'EOF'
46 +#!/bin/sh
47 +echo "$@" >>$GIT_DIR/post-receive.args
48 +read x; printf "$x" >$GIT_DIR/post-receive.stdin
49 +echo STDOUT post-receive
50 +echo STDERR post-receive >&2
51 +EOF
52 +chmod u+x victim/.git/hooks/post-receive
53 +
54 cat >victim/.git/hooks/post-update <<'EOF'
55 #!/bin/sh
34 -echo "$@" >$GIT_DIR/post-update.args
56 +echo "$@" >>$GIT_DIR/post-update.args
57 read x; printf "$x" >$GIT_DIR/post-update.stdin
58 echo STDOUT post-update
59 echo STDERR post-update >&2
60 EOF
61 chmod u+x victim/.git/hooks/post-update
62
41 -test_expect_success push '
42 - git-send-pack ./victim/.git/ master >send.out 2>send.err
63 +test_expect_failure push '
64 + git-send-pack --force ./victim/.git master tofail >send.out 2>send.err
65 +'
66 +
67 +test_expect_success 'updated as expected' '
68 + test $(GIT_DIR=victim/.git git-rev-parse master) = $commit1 &&
69 + test $(GIT_DIR=victim/.git git-rev-parse tofail) = $commit1
70 '
71
72 test_expect_success 'hooks ran' '
73 + test -f victim/.git/pre-receive.args &&
74 + test -f victim/.git/pre-receive.stdin &&
75 test -f victim/.git/update.args &&
76 test -f victim/.git/update.stdin &&
77 + test -f victim/.git/post-receive.args &&
78 + test -f victim/.git/post-receive.stdin &&
79 test -f victim/.git/post-update.args &&
80 test -f victim/.git/post-update.stdin
81 '
82
83 +test_expect_success 'pre-receive hook arguments' '
84 + echo \
85 + refs/heads/master $commit0 $commit1 \
86 + refs/heads/tofail $commit1 $commit0 \
87 + | diff - victim/.git/pre-receive.args
88 +'
89 +
90 test_expect_success 'update hook arguments' '
91 + (echo refs/heads/master $commit0 $commit1;
92 + echo refs/heads/tofail $commit1 $commit0
93 + ) | diff - victim/.git/update.args
94 +'
95 +
96 +test_expect_success 'post-receive hook arguments' '
97 echo refs/heads/master $commit0 $commit1 |
54 - diff -u - victim/.git/update.args
98 + diff - victim/.git/post-receive.args
99 '
100
101 test_expect_success 'post-update hook arguments' '
@@ -59,23 +103,32 @@ test_expect_success 'post-update hook arguments' '
103 diff -u - victim/.git/post-update.args
104 '
105
62 -test_expect_failure 'update hook stdin is /dev/null' '
63 - test -s victim/.git/update.stdin
64 -'
65 -
66 -test_expect_failure 'post-update hook stdin is /dev/null' '
67 - test -s victim/.git/post-update.stdin
106 +test_expect_success 'all hook stdin is /dev/null' '
107 + ! test -s victim/.git/pre-receive.stdin &&
108 + ! test -s victim/.git/update.stdin &&
109 + ! test -s victim/.git/post-receive.stdin &&
110 + ! test -s victim/.git/post-update.stdin
111 '
112
113 test_expect_failure 'send-pack produced no output' '
114 test -s send.out
115 '
116
117 +cat <<EOF >expect
118 +STDOUT pre-receive
119 +STDERR pre-receive
120 +STDOUT update refs/heads/master
121 +STDERR update refs/heads/master
122 +STDOUT update refs/heads/tofail
123 +STDERR update refs/heads/tofail
124 +STDOUT post-receive
125 +STDERR post-receive
126 +STDOUT post-update
127 +STDERR post-update
128 +EOF
129 test_expect_success 'send-pack stderr contains hook messages' '
75 - grep "STDOUT update" send.err &&
76 - grep "STDERR update" send.err &&
77 - grep "STDOUT post-update" send.err &&
78 - grep "STDERR post-update" send.err
130 + egrep ^STD send.err >actual &&
131 + diff - actual <expect
132 '
133
134 test_done