am: Allow passing --no-verify flag
PATCH v4 1/1 am: Allow passing --no-verify flag
From: Thierry Reding <[email protected]>
The git-am --no-verify flag is analogous to the same flag passed to git-commit. It bypasses the pre-applypatch and applypatch-msg hooks if they are enabled.
---
Changes in v4:
- check that scripts haven't run and that commits have been applied
Changes in v3:
- move tests to existing t/t4150-am
Changes in v2:
- add test to verify that the new option works
Documentation/git-am.txt | 8 +++++++- builtin/am.c | 11 ++++++++--- t/t4150-am.sh | 32 ++++++++++++++++++++++++++++++++ 3 files changed, 47 insertions(+), 4 deletions(-)
Documentation/git-am.txt +7 -1
@@ -9,7 +9,7 @@ git-am - Apply a series of patches from a mailbox SYNOPSIS -------- [verse] -'git am' [--signoff] [--keep] [--[no-]keep-cr] [--[no-]utf8] +'git am' [--signoff] [--keep] [--[no-]keep-cr] [--[no-]utf8] [--no-verify] [--[no-]3way] [--interactive] [--committer-date-is-author-date] [--ignore-date] [--ignore-space-change | --ignore-whitespace] [--whitespace=<option>] [-C<n>] [-p<n>] [--directory=<dir>]
@@ -138,6 +138,12 @@ include::rerere-options.txt[] --interactive:: Run interactively. +-n:: +--no-verify:: + By default, the pre-applypatch and applypatch-msg hooks are run. + When any of `--no-verify` or `-n` is given, these are bypassed. + See also linkgit:githooks[5]. + --committer-date-is-author-date:: By default the command records the date from the e-mail message as the commit author date, and uses the time of
builtin/am.c +8 -3
@@ -117,6 +117,7 @@ struct am_state {/* various operating modes and command line options */ int interactive; +int no_verify;int threeway;int quiet;int signoff;/* enum signoff_type */
@@ -472,10 +473,12 @@ static void am_destroy(const struct am_state *state)*/ static int run_applypatch_msg_hook (struct am_state *state) { -int ret; +int ret =0 ;assert (state->msg); - ret =run_hooks_l ("applypatch-msg" ,am_path (state,"final-commit" ),NULL ); + +if (!state->no_verify) + ret =run_hooks_l ("applypatch-msg" ,am_path (state,"final-commit" ),NULL );if (!ret) {FREE_AND_NULL (state->msg);
@@ -1640,7 +1643,7 @@ static void do_commit(const struct am_state *state)const char *reflog_msg, *author, *committer =NULL ;struct strbuf sb =STRBUF_INIT ; -if (run_hooks ("pre-applypatch" )) +if (!state->no_verify &&run_hooks ("pre-applypatch" ))exit (1 );if (write_cache_as_tree (&tree,0 ,NULL ))
@@ -2330,6 +2333,8 @@ int cmd_am(int argc, const char **argv, const char *prefix)struct option options[] = {OPT_BOOL ('i' ,"interactive" , &state.interactive,N_ ("run interactively" )), +OPT_BOOL ('n' ,"no-verify" , &state.no_verify, +N_ ("bypass pre-applypatch and applypatch-msg hooks" )),OPT_HIDDEN_BOOL ('b' ,"binary" , &binary,N_ ("historical option -- no-op" )), OPT_BOOL('3', "3way", &state.threeway,
t/t4150-am.sh +32 -0
@@ -345,6 +345,22 @@ test_expect_success 'am with failing applypatch-msg hook' ' test_cmp_rev first HEAD ' +test_expect_success 'am with failing applypatch-msg hook (no verify)' ' + rm -fr .git/rebase-apply && + git reset --hard && + git checkout first && + test_hook applypatch-msg <<-\EOF && + echo hook-message >"$1" + exit 1 + EOF + git am --no-verify patch1 && + test_path_is_missing .git/rebase-apply && + git diff --exit-code second && + test_cmp_rev second HEAD && + git log -1 --format=format:%B >actual && + test_cmp msg actual +' + test_expect_success 'am with pre-applypatch hook' ' rm -fr .git/rebase-apply && git reset --hard &&
@@ -374,6 +390,22 @@ test_expect_success 'am with failing pre-applypatch hook' ' test_cmp_rev first HEAD ' +test_expect_success 'am with failing pre-applypatch hook (no verify)' ' + rm -fr .git/rebase-apply && + git reset --hard && + git checkout first && + touch empty-file && + test_hook pre-applypatch <<-\EOF && + rm empty-file + exit 1 + EOF + git am --no-verify patch1 && + test_path_is_missing .git/rebase-apply && + git diff --exit-code second && + test_cmp_rev second HEAD && + test_path_is_file empty-file +' + test_expect_success 'am with post-applypatch hook' ' rm -fr .git/rebase-apply && git reset --hard &&
Signature · 1 line
2.38.1
builtin/am.c int cmd_am(int argc, const char **argv, const char *prefix) · line 2337
Quoted 2 lines · Thierry Reding
builtin/am.c +2
-0+OPT_BOOL ('n' ,"no-verify" , &state.no_verify, + N_("bypass pre-applypatch and applypatch-msg hooks")),
I think parse_options machinery is smart enough to do the right to allow "git am --no-verify --verify" a way to express "last one wins, turn the .no_verify bit off to countermand an earlier --no-verify", so this looks good.
Quoted 10 lines
t/t4150-am.sh +2
-0@@ -345,6 +345,22 @@ test_expect_success 'am with failing applypatch-msg hook' ' test_cmp_rev first HEAD ' +test_expect_success 'am with failing applypatch-msg hook (no verify)' ' + rm -fr .git/rebase-apply &&
t/t4150-am.sh test_expect_success 'am with failing applypatch-msg hook' ' · line 359
Quoted 10 lines
t/t4150-am.sh +10
-0+ git reset --hard && + git checkout first && + test_hook applypatch-msg <<-\EOF && + echo hook-message >"$1" + exit 1 + EOF + git am --no-verify patch1 && + test_path_is_missing .git/rebase-apply && + git diff --exit-code second && + test_cmp_rev second HEAD &&
This somewhat raised my eyebrows, as the condition will not generally hold.
I am guessing this was merely copied and pasted from the previous test piece before this one, which uses "test_cmp_rev first HEAD" and its use of test_cmp_rev is more sensible, as it is making sure that "we started with 'first' commit at HEAD, 'am' should not have done anything by failing, so expect HEAD is still at 'first'".
The reason to expect HEAD to be 'second' here is very different. We start from 'first', 'am' should have applied the patch as-is while pretending that the wallclock is frozen (i.e. even the committer timestamp should be the same as the original commit), so expect HEAD is pointing at the exact same commit recreated by 'am'". That is a bit unrealistic expectation outside the context of the tests.
If we added test_commit or test_tick anywhere before this step in an unrelated test, it likely will break this expectation; in other words, I think the use of "test_cmp_rev second" here makes it unnecessarily brittle.
t/t4150-am.sh test_expect_success 'am with failing applypatch-msg hook' ' · line 362
Quoted 3 lines
t/t4150-am.sh +3
-0+ git log -1 --format=format:%B >actual && + test_cmp msg actual +'
Other than that, this test looks good.
Quoted 9 lines
t/t4150-am.sh +5
-0@@ -374,6 +390,22 @@ test_expect_success 'am with failing pre-applypatch hook' ' test_cmp_rev first HEAD ' +test_expect_success 'am with failing pre-applypatch hook (no verify)' ' + rm -fr .git/rebase-apply && + git reset --hard && + git checkout first && + touch empty-file &&
t/t4150-am.sh test_expect_success 'am with failing pre-applypatch hook' ' · line 407
Quoted 10 lines
t/t4150-am.sh +10
-0+ test_hook pre-applypatch <<-\EOF && + rm empty-file + exit 1 + EOF + git am --no-verify patch1 && + test_path_is_missing .git/rebase-apply && + git diff --exit-code second && + test_cmp_rev second HEAD && + test_path_is_file empty-file +'
This "pre" stuff, unlike the other hook, does not affect the resulting commit, so you invent an extra file "empty-file" as a marker and remove it from the hook, so that the absense of the file can be used as a signal that the hook did run. We could do it the other way around (i.e. make sure the marker file does not exist before running "git am", arrange the marker to be created by running the hook, and ensure that the marker does not exist after running "git am"), and either way is fine.
The same comment as the previous one applies to "test_cmp_rev second" check. I think removing them would make the tests better.
Oh, also I keep forgetting but
Quoted 1 line
Subject: Re: [PATCH v4] am: Allow passing --no-verify flag
our convention is not capitalize "Allow" here.
Thanks.
Quoted 3 lines · Junio C Hamano
...
The same comment as the previous one applies to "test_cmp_revsecond" check. I think removing them would make the tests better.
I will queue this on top for now. Thanks.
t/t4150-am.sh | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-)
t/t4150-am.sh +3 -3
@@ -356,7 +356,6 @@ test_expect_success 'am with failing applypatch-msg hook (no verify)' ' git am --no-verify patch1 && test_path_is_missing .git/rebase-apply && git diff --exit-code second && - test_cmp_rev second HEAD && git log -1 --format=format:%B >actual && test_cmp msg actual '
@@ -401,9 +400,10 @@ test_expect_success 'am with failing pre-applypatch hook (no verify)' ' EOF git am --no-verify patch1 && test_path_is_missing .git/rebase-apply && + test_path_is_file empty-file && git diff --exit-code second && - test_cmp_rev second HEAD && - test_path_is_file empty-file + git log -1 --format=format:%B >actual && + test_cmp msg actual ' test_expect_success 'am with post-applypatch hook' '
Quoted 7 lines · Junio C Hamano
Quoted 3 lines · Junio C Hamano
...
The same comment as the previous one applies to "test_cmp_revsecond" check. I think removing them would make the tests better.I will queue this on top for now. Thanks.
Just to clarify: do you want me to send out another version with your changes on top or should I consider this done?
Thierry
Quoted 29 lines
t/t4150-am.sh | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-)t/t4150-am.sh +3
-3@@ -356,7 +356,6 @@ test_expect_success 'am with failing applypatch-msg hook (no verify)' ' git am --no-verify patch1 && test_path_is_missing .git/rebase-apply && git diff --exit-code second && - test_cmp_rev second HEAD && git log -1 --format=format:%B >actual && test_cmp msg actual '@@ -401,9 +400,10 @@ test_expect_success 'am with failing pre-applypatch hook (no verify)' ' EOF git am --no-verify patch1 && test_path_is_missing .git/rebase-apply && + test_path_is_file empty-file && git diff --exit-code second && - test_cmp_rev second HEAD && - test_path_is_file empty-file + git log -1 --format=format:%B >actual && + test_cmp msg actual ' test_expect_success 'am with post-applypatch hook' '
Quoted 11 lines · Thierry Reding
Quoted 7 lines · Junio C Hamano
Quoted 3 lines · Junio C Hamano
...
The same comment as the previous one applies to "test_cmp_revsecond" check. I think removing them would make the tests better.I will queue this on top for now. Thanks.
Just to clarify: do you want me to send out another version with your changes on top or should I consider this done?
It is up to you.
* If you agree with the "fix-up" done with the extra commit (marked as "SQUASH???") on top and there is no other changes you want to make, you can tell me to squash it into your patch.
* If you don't and have better idea, you can send out an updated version, and you have my permission to include any (or all) parts of the changes I gave in the message you are responding to.
* Or if you make a very good argument and convince me why your original without my fix-up is better, I may change my mind and drop the changes, keeping your original alone.
Of course, folks on the list may have other suggestions and review comments, which may change the picture again ;-)
In any case, thanks for contributing!
Quoted 24 lines · Junio C Hamano
Quoted 11 lines · Thierry Reding
Quoted 7 lines · Junio C Hamano
Quoted 3 lines · Junio C Hamano
...
The same comment as the previous one applies to "test_cmp_revsecond" check. I think removing them would make the tests better.I will queue this on top for now. Thanks.
Just to clarify: do you want me to send out another version with your changes on top or should I consider this done?
It is up to you.
* If you agree with the "fix-up" done with the extra commit (marked as "SQUASH???") on top and there is no other changes you want to make, you can tell me to squash it into your patch.
* If you don't and have better idea, you can send out an updated version, and you have my permission to include any (or all) parts of the changes I gave in the message you are responding to.
Quoted 8 lines
* Or if you make a very good argument and convince me why your original without my fix-up is better, I may change my mind and drop the changes, keeping your original alone.
Of course, folks on the list may have other suggestions and review comments, which may change the picture again ;-)
In any case, thanks for contributing!
Your changes look fine. I applied them to my local tree and everything still works as expected, so feel free to squash those into the commit.
Thanks,
Thierry
Quoted 2 lines · Thierry Reding
Your changes look fine. I applied them to my local tree and everything still works as expected, so feel free to squash those into the commit.
Thanks, will do.