| Message ID | patch-5.5-cb9ef7a89c4-20230123T170551Z-avarab@gmail.com (mailing list archive) |
|---|---|
| State | Superseded |
| Headers | show |
| Series | hook API: support stdin, convert post-rewrite | expand |
Ævar Arnfjörð Bjarmason <avarab@gmail.com> writes: > From: Emily Shaffer <emilyshaffer@google.com> > > Expose the "path_to_stdin" API added in the preceding commit in the > "git hook run" command. For now we won't be using this command > interface outside of the tests, but exposing this functionality makes > it easier to test the hook API. Presumably, the send-email validation topic would be using this immediately once it becomes available, no? When "git hook" finds and runs more than one hook script, do they get the same input? What I am wondering is if "to-stdin" should be exposed like this interface (which may be sufficient for testing purposes). I imagine that scripters (e.g. send-email developers) would find it more convenient if they do not have to come up with a temporary file and they can just run "git hook" and feed whatever they want to give to the hook from its standard input. "git hook" command, upon startup, should do the reading of its standard input and spooling it to a temporary file it uses to pass the contents to the hook scripts, in other words. Other than that, it surely looks not just handy for tests, but has immediate uses. Thanks.
On 2023-01-23 19:55, Junio C Hamano wrote: > Ævar Arnfjörð Bjarmason <avarab@gmail.com> writes: > >> From: Emily Shaffer <emilyshaffer@google.com> >> >> Expose the "path_to_stdin" API added in the preceding commit in the >> "git hook run" command. For now we won't be using this command >> interface outside of the tests, but exposing this functionality makes >> it easier to test the hook API. > Presumably, the send-email validation topic would be using this > immediately once it becomes available, no? Yes I would be trying to use it for my send-email header patch right away. > > When "git hook" finds and runs more than one hook script, do they > get the same input? What I am wondering is if "to-stdin" should be > exposed like this interface (which may be sufficient for testing > purposes). I imagine that scripters (e.g. send-email developers) > would find it more convenient if they do not have to come up with a > temporary file and they can just run "git hook" and feed whatever > they want to give to the hook from its standard input. "git hook" > command, upon startup, should do the reading of its standard input > and spooling it to a temporary file it uses to pass the contents to > the hook scripts, in other words. > > Other than that, it surely looks not just handy for tests, but has > immediate uses. > > Thanks.
diff --git a/Documentation/git-hook.txt b/Documentation/git-hook.txt index 77c3a8ad909..3407f3c2c07 100644 --- a/Documentation/git-hook.txt +++ b/Documentation/git-hook.txt @@ -8,7 +8,7 @@ git-hook - Run git hooks SYNOPSIS -------- [verse] -'git hook' run [--ignore-missing] <hook-name> [-- <hook-args>] +'git hook' run [--ignore-missing] [--to-stdin=<path>] <hook-name> [-- <hook-args>] DESCRIPTION ----------- @@ -31,6 +31,11 @@ linkgit:githooks[5] for arguments hooks might expect (if any). OPTIONS ------- +--to-stdin:: + For "run"; Specify a file which will be streamed into the + hook's stdin. The hook will receive the entire file from + beginning to EOF. + --ignore-missing:: Ignore any missing hook by quietly returning zero. Used for tools that want to do a blind one-shot run of a hook that may diff --git a/builtin/hook.c b/builtin/hook.c index b6530d189ad..f95b7965c58 100644 --- a/builtin/hook.c +++ b/builtin/hook.c @@ -7,7 +7,7 @@ #include "strvec.h" #define BUILTIN_HOOK_RUN_USAGE \ - N_("git hook run [--ignore-missing] <hook-name> [-- <hook-args>]") + N_("git hook run [--ignore-missing] [--to-stdin=<path>] <hook-name> [-- <hook-args>]") static const char * const builtin_hook_usage[] = { BUILTIN_HOOK_RUN_USAGE, @@ -28,6 +28,8 @@ static int run(int argc, const char **argv, const char *prefix) struct option run_options[] = { OPT_BOOL(0, "ignore-missing", &ignore_missing, N_("silently ignore missing requested <hook-name>")), + OPT_STRING(0, "to-stdin", &opt.path_to_stdin, N_("path"), + N_("file to read into hooks' stdin")), OPT_END(), }; int ret; diff --git a/t/t1800-hook.sh b/t/t1800-hook.sh index 2ef3579fa7c..3506f627b6c 100755 --- a/t/t1800-hook.sh +++ b/t/t1800-hook.sh @@ -177,4 +177,22 @@ test_expect_success 'git hook run a hook with a bad shebang' ' test_cmp expect actual ' +test_expect_success 'stdin to hooks' ' + write_script .git/hooks/test-hook <<-\EOF && + echo BEGIN stdin + cat + echo END stdin + EOF + + cat >expect <<-EOF && + BEGIN stdin + hello + END stdin + EOF + + echo hello >input && + git hook run --to-stdin=input test-hook 2>actual && + test_cmp expect actual +' + test_done