From: Jiang Xin <zhiyou.jx@xxxxxxxxxxxxxxx>
The "proc-receive" may update one or more references, and will send its
result one by one in pkt-line format. Each line of the result has four
fields and one optional message field, as "<old-oid> <new-oid> <ref>
<status> [<message>]". See the following example:
# OK, run this command successfully.
PKT-LINE(old-oid new-oid ref ok)
# NO, I reject it.
PKT-LINE(old-oid new-oid ref ng reason)
# OK, but use an alternate reference.
PKT-LINE(old-oid new-oid ref ok ref:alt-ref)
# It will fallthrough to receive-pack to execute.
PKT-LINE(old-oid new-oid ref ft)
The first three fields have the same foramt as a command.
The forth field has a two-letter status code. Available status code:
* ok: The command runs successfully. If the optional message has a
prefix "ref:", the hook has created/updated an alternate reference
instead.
* ng: Fail to run the command. Error message is in the optional message
field.
* ft: Will fallthrough to receive-pack to execute.
Signed-off-by: Jiang Xin <zhiyou.jx@xxxxxxxxxxxxxxx>
---
builtin/receive-pack.c | 21 +++++++--
t/t5411-proc-receive-hook.sh | 90 +++++++++++++++++++++++++++++++++---
transport.c | 27 +++++++----
3 files changed, 119 insertions(+), 19 deletions(-)
diff --git a/builtin/receive-pack.c b/builtin/receive-pack.c
index fef97e6985..c791f562d0 100644
--- a/builtin/receive-pack.c
+++ b/builtin/receive-pack.c
@@ -326,6 +326,7 @@ static void write_head_info(void)
struct command {
struct command *next;
const char *error_string;
+ const char *extra_string;
unsigned int skip_update:1,
did_not_exist:1,
run_proc_receive:1;
@@ -883,7 +884,12 @@ static int read_proc_receive_result(struct packet_reader *reader,
else
cmd->error_string = "failed";
code = 1;
- } else if (strcmp("ok", status)) {
+ } else if (!strcmp("ok", status)) {
+ cmd->extra_string = xstrdup_or_null(msg);
+ } else if (!strcmp("ft", status)) {
+ /* Reset "run_proc_receive" field, and continue to run in "receive-pack" */
+ cmd->run_proc_receive = 0;
+ } else {
die("protocol error: proc-receive has bad status '%s' for '%s'",
status, reader->line);
}
@@ -2190,12 +2196,17 @@ static void report(struct command *commands, const char *unpack_status)
packet_buf_write(&buf, "unpack %s\n",
unpack_status ? unpack_status : "ok");
for (cmd = commands; cmd; cmd = cmd->next) {
- if (!cmd->error_string)
- packet_buf_write(&buf, "ok %s\n",
- cmd->ref_name);
- else
+ if (!cmd->error_string) {
+ if (!cmd->extra_string)
+ packet_buf_write(&buf, "ok %s\n",
+ cmd->ref_name);
+ else
+ packet_buf_write(&buf, "ok %s%c%s\n",
+ cmd->ref_name, ' ', cmd->extra_string);
+ } else {
packet_buf_write(&buf, "ng %s %s\n",
cmd->ref_name, cmd->error_string);
+ }
}
packet_buf_flush(&buf);
diff --git a/t/t5411-proc-receive-hook.sh b/t/t5411-proc-receive-hook.sh
index f9681bed34..917988ab57 100755
--- a/t/t5411-proc-receive-hook.sh
+++ b/t/t5411-proc-receive-hook.sh
@@ -691,9 +691,9 @@ test_expect_success "setup proc-receive hook" '
printf >&2 "# proc-receive hook\n"
test-tool proc-receive -v \
- -r "$ZERO_OID $A refs/for/next/topic ok" \
+ -r "$ZERO_OID $A refs/for/next/topic ok ref:refs/pull/123/head" \
-r "$ZERO_OID $A refs/review/a/b/c/topic ok" \
- -r "$ZERO_OID $A refs/for/master/topic ok"
+ -r "$ZERO_OID $A refs/for/master/topic ok ref:refs/pull/124/head"
EOF
chmod a+x upstream/hooks/proc-receive
'
@@ -716,17 +716,17 @@ test_expect_success "report update of all special refs" '
remote: proc-receive< <ZERO-OID> <COMMIT-A> refs/for/next/topic
remote: proc-receive< <ZERO-OID> <COMMIT-A> refs/review/a/b/c/topic
remote: proc-receive< <ZERO-OID> <COMMIT-A> refs/for/master/topic
- remote: proc-receive> <ZERO-OID> <COMMIT-A> refs/for/next/topic ok
+ remote: proc-receive> <ZERO-OID> <COMMIT-A> refs/for/next/topic ok ref:refs/pull/123/head
remote: proc-receive> <ZERO-OID> <COMMIT-A> refs/review/a/b/c/topic ok
- remote: proc-receive> <ZERO-OID> <COMMIT-A> refs/for/master/topic ok
+ remote: proc-receive> <ZERO-OID> <COMMIT-A> refs/for/master/topic ok ref:refs/pull/124/head
remote: # post-receive hook
remote: post-receive< <ZERO-OID> <COMMIT-A> refs/for/next/topic
remote: post-receive< <ZERO-OID> <COMMIT-A> refs/review/a/b/c/topic
remote: post-receive< <ZERO-OID> <COMMIT-A> refs/for/master/topic
To ../upstream
- * [new reference] HEAD -> refs/for/next/topic
+ * [new reference] HEAD -> refs/pull/123/head
* [new reference] HEAD -> refs/review/a/b/c/topic
- * [new reference] HEAD -> refs/for/master/topic
+ * [new reference] HEAD -> refs/pull/124/head
EOF
test_cmp expect actual &&
(
@@ -873,4 +873,82 @@ test_expect_success "report mixed refs update (special ref first)" '
test_cmp expect actual
'
+test_expect_success "config receive.procReceiveRefs for all ref/" '
+ (
+ cd upstream &&
+ git config --add receive.procReceiveRefs refs/
+ )
+'
+
+test_expect_success "setup proc-receive hook" '
+ cat >upstream/hooks/proc-receive <<-EOF &&
+ #!/bin/sh
+
+ printf >&2 "# proc-receive hook\n"
+
+ test-tool proc-receive -v \
+ -r "$A $ZERO_OID refs/heads/yyy ft" \
+ -r "$B $A refs/heads/zzz ft" \
+ -r "$A $B refs/for/master/topic ok ref:refs/pull/123/head" \
+ -r "$A $B refs/heads/master ft" \
+ -r "$B $A refs/for/next/topic ok ref:refs/pull/124/head"
+ EOF
+ chmod a+x upstream/hooks/proc-receive
+'
+
+test_expect_success "report test: fallthrough" '
+ (
+ cd workbench &&
+ git push -f origin \
+ :refs/heads/yyy \
+ $A:refs/heads/zzz \
+ HEAD:refs/for/master/topic \
+ HEAD:refs/for/next/topic \
+ $B:refs/heads/master
+ ) >out 2>&1 &&
+ format_git_output <out >actual &&
+ cat >expect <<-EOF &&
+ remote: # pre-receive hook
+ remote: pre-receive< <COMMIT-A> <COMMIT-B> refs/heads/master
+ remote: pre-receive< <COMMIT-A> <ZERO-OID> refs/heads/yyy
+ remote: pre-receive< <COMMIT-B> <COMMIT-A> refs/heads/zzz
+ remote: pre-receive< <ZERO-OID> <COMMIT-A> refs/for/master/topic
+ remote: pre-receive< <ZERO-OID> <COMMIT-A> refs/for/next/topic
+ remote: # proc-receive hook
+ remote: proc-receive< <COMMIT-A> <COMMIT-B> refs/heads/master
+ remote: proc-receive< <COMMIT-A> <ZERO-OID> refs/heads/yyy
+ remote: proc-receive< <COMMIT-B> <COMMIT-A> refs/heads/zzz
+ remote: proc-receive< <ZERO-OID> <COMMIT-A> refs/for/master/topic
+ remote: proc-receive< <ZERO-OID> <COMMIT-A> refs/for/next/topic
+ remote: proc-receive> <COMMIT-A> <ZERO-OID> refs/heads/yyy ft
+ remote: proc-receive> <COMMIT-B> <COMMIT-A> refs/heads/zzz ft
+ remote: proc-receive> <COMMIT-A> <COMMIT-B> refs/for/master/topic ok ref:refs/pull/123/head
+ remote: proc-receive> <COMMIT-A> <COMMIT-B> refs/heads/master ft
+ remote: proc-receive> <COMMIT-B> <COMMIT-A> refs/for/next/topic ok ref:refs/pull/124/head
+ remote: # post-receive hook
+ remote: post-receive< <COMMIT-A> <ZERO-OID> refs/heads/yyy
+ remote: post-receive< <COMMIT-B> <COMMIT-A> refs/heads/zzz
+ remote: post-receive< <COMMIT-A> <COMMIT-B> refs/for/master/topic
+ remote: post-receive< <COMMIT-A> <COMMIT-B> refs/heads/master
+ remote: post-receive< <COMMIT-B> <COMMIT-A> refs/for/next/topic
+ To ../upstream
+ 1029397..ce858e6 <COMMIT-B> -> master
+ - [deleted] yyy
+ + ce858e6...1029397 <COMMIT-A> -> zzz (forced update)
+ * [new reference] HEAD -> refs/pull/123/head
+ * [new reference] HEAD -> refs/pull/124/head
+ EOF
+ test_cmp expect actual &&
+ (
+ cd upstream &&
+ git show-ref
+ ) >out &&
+ format_git_output <out >actual &&
+ cat >expect <<-EOF &&
+ <COMMIT-B> refs/heads/master
+ <COMMIT-A> refs/heads/zzz
+ EOF
+ test_cmp expect actual
+'
+
test_done
diff --git a/transport.c b/transport.c
index b5b7bb841e..d51af11d48 100644
--- a/transport.c
+++ b/transport.c
@@ -463,11 +463,16 @@ static void print_ref_status(char flag, const char *summary,
struct ref *to, struct ref *from, const char *msg,
int porcelain, int summary_width)
{
+ char *to_name = to->name;
+
+ if (to->remote_status && !strncmp("ref:", to->remote_status, 4))
+ to_name = to->remote_status + 4;
+
if (porcelain) {
if (from)
- fprintf(stdout, "%c\t%s:%s\t", flag, from->name, to->name);
+ fprintf(stdout, "%c\t%s:%s\t", flag, from->name, to_name);
else
- fprintf(stdout, "%c\t:%s\t", flag, to->name);
+ fprintf(stdout, "%c\t:%s\t", flag, to_name);
if (msg)
fprintf(stdout, "%s (%s)\n", summary, msg);
else
@@ -481,9 +486,9 @@ static void print_ref_status(char flag, const char *summary,
fprintf(stderr, " %s%c %-*s%s ", red, flag, summary_width,
summary, reset);
if (from)
- fprintf(stderr, "%s -> %s", prettify_refname(from->name), prettify_refname(to->name));
+ fprintf(stderr, "%s -> %s", prettify_refname(from->name), prettify_refname(to_name));
else
- fputs(prettify_refname(to->name), stderr);
+ fputs(prettify_refname(to_name), stderr);
if (msg) {
fputs(" (", stderr);
fputs(msg, stderr);
@@ -498,13 +503,19 @@ static void print_ok_ref_status(struct ref *ref, int porcelain, int summary_widt
if (ref->deletion)
print_ref_status('-', "[deleted]", ref, NULL, NULL,
porcelain, summary_width);
- else if (is_null_oid(&ref->old_oid))
+ else if (is_null_oid(&ref->old_oid)) {
+ char *refname;
+
+ if (ref->remote_status && !strncmp(ref->remote_status, "ref:", 4))
+ refname = ref->remote_status + 4;
+ else
+ refname = ref->name;
print_ref_status('*',
- (starts_with(ref->name, "refs/tags/") ? "[new tag]" :
- (starts_with(ref->name, "refs/heads/") ? "[new branch]" :
+ (starts_with(refname, "refs/tags/") ? "[new tag]" :
+ (starts_with(refname, "refs/heads/") ? "[new branch]" :
"[new reference]")),
ref, ref->peer_ref, NULL, porcelain, summary_width);
- else {
+ } else {
struct strbuf quickref = STRBUF_INIT;
char type;
const char *msg;
--
2.26.0.rc1.33.g4914ba4bcf
