* [PATCH v3 0/1] Expose header information to git-send-email's sendemail-validate hook
@ 2022-11-11 19:42 Strawbridge, Michael
2022-11-11 19:42 ` [PATCH v3 1/1] " Strawbridge, Michael
0 siblings, 1 reply; 3+ messages in thread
From: Strawbridge, Michael @ 2022-11-11 19:42 UTC (permalink / raw)
To: git@vger.kernel.org
Cc: Strawbridge, Michael, Tuikov, Luben, brian m . carlson
I accidentally missed previous feedback to squash doc edit into main change of git-send-email.
Michael
Cc: Luben Tuikov <luben.tuikov@amd.com>
Cc: brian m. carlson <sandals@crustytoothpaste.net>
Michael Strawbridge (1):
Expose header information to git-send-email's sendemail-validate hook
Documentation/githooks.txt | 8 +++---
git-send-email.perl | 57 +++++++++++++++++++++++++-------------
2 files changed, 41 insertions(+), 24 deletions(-)
--
2.34.1
^ permalink raw reply [flat|nested] 3+ messages in thread
* [PATCH v3 1/1] Expose header information to git-send-email's sendemail-validate hook
2022-11-11 19:42 [PATCH v3 0/1] Expose header information to git-send-email's sendemail-validate hook Strawbridge, Michael
@ 2022-11-11 19:42 ` Strawbridge, Michael
2022-11-15 14:00 ` Johannes Schindelin
0 siblings, 1 reply; 3+ messages in thread
From: Strawbridge, Michael @ 2022-11-11 19:42 UTC (permalink / raw)
To: git@vger.kernel.org
Cc: Strawbridge, Michael, Tuikov, Luben, brian m . carlson
To allow further flexibility in the git hook, the smtp header
information of the email that git-send-email intends to send, is now
passed as a 2nd argument to the sendemail-validate hook. Docs are
also updated.
As an example, this can be useful for acting upon keywords in the
subject or specific email addresses.
Cc: Luben Tuikov <luben.tuikov@amd.com>
Cc: brian m. carlson <sandals@crustytoothpaste.net>
Signed-off-by: Michael Strawbridge <michael.strawbridge@amd.com>
---
Documentation/githooks.txt | 8 +++---
git-send-email.perl | 57 +++++++++++++++++++++++++-------------
2 files changed, 41 insertions(+), 24 deletions(-)
diff --git a/Documentation/githooks.txt b/Documentation/githooks.txt
index a16e62bc8c..346e536cbe 100644
--- a/Documentation/githooks.txt
+++ b/Documentation/githooks.txt
@@ -583,10 +583,10 @@ processed by rebase.
sendemail-validate
~~~~~~~~~~~~~~~~~~
-This hook is invoked by linkgit:git-send-email[1]. It takes a single parameter,
-the name of the file that holds the e-mail to be sent. Exiting with a
-non-zero status causes `git send-email` to abort before sending any
-e-mails.
+This hook is invoked by linkgit:git-send-email[1]. It takes two parameters,
+the name of a file that holds the patch and the name of a file that holds the
+SMTP headers. Exiting with a non-zero status causes `git send-email` to abort
+before sending any e-mails.
fsmonitor-watchman
~~~~~~~~~~~~~~~~~~
diff --git a/git-send-email.perl b/git-send-email.perl
index 5861e99a6e..3ce5b1aad3 100755
--- a/git-send-email.perl
+++ b/git-send-email.perl
@@ -787,14 +787,6 @@ sub is_format_patch_arg {
@files = handle_backup_files(@files);
-if ($validate) {
- foreach my $f (@files) {
- unless (-p $f) {
- validate_patch($f, $target_xfer_encoding);
- }
- }
-}
-
if (@files) {
unless ($quiet) {
print $_,"\n" for (@files);
@@ -1495,16 +1487,7 @@ sub file_name_is_absolute {
return File::Spec::Functions::file_name_is_absolute($path);
}
-# Prepares the email, then asks the user what to do.
-#
-# If the user chooses to send the email, it's sent and 1 is returned.
-# If the user chooses not to send the email, 0 is returned.
-# If the user decides they want to make further edits, -1 is returned and the
-# caller is expected to call send_message again after the edits are performed.
-#
-# If an error occurs sending the email, this just dies.
-
-sub send_message {
+sub gen_header {
my @recipients = unique_email_list(@to);
@cc = (grep { my $cc = extract_valid_address_or_die($_);
not grep { $cc eq $_ || $_ =~ /<\Q${cc}\E>$/ } @recipients
@@ -1546,6 +1529,22 @@ sub send_message {
if (@xh) {
$header .= join("\n", @xh) . "\n";
}
+ return $header;
+}
+
+# Prepares the email, then asks the user what to do.
+#
+# If the user chooses to send the email, it's sent and 1 is returned.
+# If the user chooses not to send the email, 0 is returned.
+# If the user decides they want to make further edits, -1 is returned and the
+# caller is expected to call send_message again after the edits are performed.
+#
+# If an error occurs sending the email, this just dies.
+
+sub send_message {
+ my @recipients = unique_email_list(@to);
+
+ my $header = gen_header();
my @sendmail_parameters = ('-i', @recipients);
my $raw_from = $sender;
@@ -1955,6 +1954,15 @@ sub process_file {
}
}
+
+ if ($validate) {
+ foreach my $f (@files) {
+ unless (-p $f) {
+ validate_patch($f, $target_xfer_encoding);
+ }
+ }
+ }
+
my $message_was_sent = send_message();
if ($message_was_sent == -1) {
do_edit($t);
@@ -2088,11 +2096,20 @@ sub validate_patch {
chdir($repo->wc_path() or $repo->repo_path())
or die("chdir: $!");
local $ENV{"GIT_DIR"} = $repo->repo_path();
+
+ my $header = gen_header();
+
+ require File::Temp;
+ my ($header_filehandle, $header_filename) = File::Temp::tempfile(
+ ".gitsendemail.header.XXXXXX", DIR => $repo->repo_path());
+ print $header_filehandle $header;
+
my @cmd = ("git", "hook", "run", "--ignore-missing",
$hook_name, "--");
- my @cmd_msg = (@cmd, "<patch>");
- my @cmd_run = (@cmd, $target);
+ my @cmd_msg = (@cmd, "<patch>", "<header>");
+ my @cmd_run = (@cmd, $target, $header_filename);
$hook_error = system_or_msg(\@cmd_run, undef, "@cmd_msg");
+ unlink($header_filehandle);
chdir($cwd_save) or die("chdir: $!");
}
if ($hook_error) {
--
2.34.1
^ permalink raw reply related [flat|nested] 3+ messages in thread
* Re: [PATCH v3 1/1] Expose header information to git-send-email's sendemail-validate hook
2022-11-11 19:42 ` [PATCH v3 1/1] " Strawbridge, Michael
@ 2022-11-15 14:00 ` Johannes Schindelin
0 siblings, 0 replies; 3+ messages in thread
From: Johannes Schindelin @ 2022-11-15 14:00 UTC (permalink / raw)
To: Strawbridge, Michael
Cc: git@vger.kernel.org, Tuikov, Luben, brian m . carlson
Hi Michael,
On Fri, 11 Nov 2022, Strawbridge, Michael wrote:
> To allow further flexibility in the git hook, the smtp header
> information of the email that git-send-email intends to send, is now
> passed as a 2nd argument to the sendemail-validate hook. Docs are
> also updated.
>
> As an example, this can be useful for acting upon keywords in the
> subject or specific email addresses.
This patch seems to break t9001:
Error: failed: t9001.9 Verify commandline
failure: t9001.9 Verify commandline
test_cmp expected commandline1
+ test_cmp expected commandline1
+ test 2 -ne 2
+ eval diff -u "$@"
+ diff -u expected commandline1
--- expected 2022-11-12 01:49:23.477741140
+0000
+++ commandline1 2022-11-12 01:49:21.921718804
+0000
@@ -1,4 +1 @@
!nobody@example.com!
-!author@example.com!
-!one@example.com!
-!two@example.com!
error: last command exited with $?=1
not ok 9 - Verify commandline
#
# test_cmp expected
# commandline1
#
See
https://github.com/gitgitgadget/git/actions/runs/3448445848/jobs/5755529504#step:4:1791
for details.
If you need help with debugging this, I would like to point you to the
information I wrote up for the Git for Windows project (but it applies
here, too):
https://github.com/git-for-windows/git/wiki/Running-Git's-regression-tests#running-individual-tests
Ciao,
Johannes
>
> Cc: Luben Tuikov <luben.tuikov@amd.com>
> Cc: brian m. carlson <sandals@crustytoothpaste.net>
> Signed-off-by: Michael Strawbridge <michael.strawbridge@amd.com>
> ---
> Documentation/githooks.txt | 8 +++---
> git-send-email.perl | 57 +++++++++++++++++++++++++-------------
> 2 files changed, 41 insertions(+), 24 deletions(-)
>
> diff --git a/Documentation/githooks.txt b/Documentation/githooks.txt
> index a16e62bc8c..346e536cbe 100644
> --- a/Documentation/githooks.txt
> +++ b/Documentation/githooks.txt
> @@ -583,10 +583,10 @@ processed by rebase.
> sendemail-validate
> ~~~~~~~~~~~~~~~~~~
>
> -This hook is invoked by linkgit:git-send-email[1]. It takes a single parameter,
> -the name of the file that holds the e-mail to be sent. Exiting with a
> -non-zero status causes `git send-email` to abort before sending any
> -e-mails.
> +This hook is invoked by linkgit:git-send-email[1]. It takes two parameters,
> +the name of a file that holds the patch and the name of a file that holds the
> +SMTP headers. Exiting with a non-zero status causes `git send-email` to abort
> +before sending any e-mails.
>
> fsmonitor-watchman
> ~~~~~~~~~~~~~~~~~~
> diff --git a/git-send-email.perl b/git-send-email.perl
> index 5861e99a6e..3ce5b1aad3 100755
> --- a/git-send-email.perl
> +++ b/git-send-email.perl
> @@ -787,14 +787,6 @@ sub is_format_patch_arg {
>
> @files = handle_backup_files(@files);
>
> -if ($validate) {
> - foreach my $f (@files) {
> - unless (-p $f) {
> - validate_patch($f, $target_xfer_encoding);
> - }
> - }
> -}
> -
> if (@files) {
> unless ($quiet) {
> print $_,"\n" for (@files);
> @@ -1495,16 +1487,7 @@ sub file_name_is_absolute {
> return File::Spec::Functions::file_name_is_absolute($path);
> }
>
> -# Prepares the email, then asks the user what to do.
> -#
> -# If the user chooses to send the email, it's sent and 1 is returned.
> -# If the user chooses not to send the email, 0 is returned.
> -# If the user decides they want to make further edits, -1 is returned and the
> -# caller is expected to call send_message again after the edits are performed.
> -#
> -# If an error occurs sending the email, this just dies.
> -
> -sub send_message {
> +sub gen_header {
> my @recipients = unique_email_list(@to);
> @cc = (grep { my $cc = extract_valid_address_or_die($_);
> not grep { $cc eq $_ || $_ =~ /<\Q${cc}\E>$/ } @recipients
> @@ -1546,6 +1529,22 @@ sub send_message {
> if (@xh) {
> $header .= join("\n", @xh) . "\n";
> }
> + return $header;
> +}
> +
> +# Prepares the email, then asks the user what to do.
> +#
> +# If the user chooses to send the email, it's sent and 1 is returned.
> +# If the user chooses not to send the email, 0 is returned.
> +# If the user decides they want to make further edits, -1 is returned and the
> +# caller is expected to call send_message again after the edits are performed.
> +#
> +# If an error occurs sending the email, this just dies.
> +
> +sub send_message {
> + my @recipients = unique_email_list(@to);
> +
> + my $header = gen_header();
>
> my @sendmail_parameters = ('-i', @recipients);
> my $raw_from = $sender;
> @@ -1955,6 +1954,15 @@ sub process_file {
> }
> }
>
> +
> + if ($validate) {
> + foreach my $f (@files) {
> + unless (-p $f) {
> + validate_patch($f, $target_xfer_encoding);
> + }
> + }
> + }
> +
> my $message_was_sent = send_message();
> if ($message_was_sent == -1) {
> do_edit($t);
> @@ -2088,11 +2096,20 @@ sub validate_patch {
> chdir($repo->wc_path() or $repo->repo_path())
> or die("chdir: $!");
> local $ENV{"GIT_DIR"} = $repo->repo_path();
> +
> + my $header = gen_header();
> +
> + require File::Temp;
> + my ($header_filehandle, $header_filename) = File::Temp::tempfile(
> + ".gitsendemail.header.XXXXXX", DIR => $repo->repo_path());
> + print $header_filehandle $header;
> +
> my @cmd = ("git", "hook", "run", "--ignore-missing",
> $hook_name, "--");
> - my @cmd_msg = (@cmd, "<patch>");
> - my @cmd_run = (@cmd, $target);
> + my @cmd_msg = (@cmd, "<patch>", "<header>");
> + my @cmd_run = (@cmd, $target, $header_filename);
> $hook_error = system_or_msg(\@cmd_run, undef, "@cmd_msg");
> + unlink($header_filehandle);
> chdir($cwd_save) or die("chdir: $!");
> }
> if ($hook_error) {
> --
> 2.34.1
>
>
^ permalink raw reply [flat|nested] 3+ messages in thread
end of thread, other threads:[~2022-11-15 14:01 UTC | newest]
Thread overview: 3+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2022-11-11 19:42 [PATCH v3 0/1] Expose header information to git-send-email's sendemail-validate hook Strawbridge, Michael
2022-11-11 19:42 ` [PATCH v3 1/1] " Strawbridge, Michael
2022-11-15 14:00 ` Johannes Schindelin
Code repositories for project(s) associated with this public inbox
https://80x24.org/mirrors/git.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).