| Message ID | 20210511204044.69047-1-greg@gpanders.com (mailing list archive) |
|---|---|
| State | Superseded |
| Headers | show |
| Series | [v4] git-send-email: use ! to indicate relative path to command | expand |
On Tue, May 11, 2021 at 02:40:44PM -0600, Gregory Anders wrote: > Presently, the smtpServer config option can use a sendmail-like program > by providing an absolute path to the program as the value for this > option. However, an absolute path is not always portable and it is often > preferable to simply specify a program name and have `git-send-email` > find that program on $PATH. > > For example, if a user wishes to use msmtp to send emails, they might > be able to simply use > > [sendemail] > smtpServer = !msmtp > > instead of using the full path. This is particularly useful when a > common git config file is used across multiple systems where the > absolute path to a given program may differ. > > To that end, this patch allows the smtpServer config option to be > prefixed with a ! character that implements the above behavior; namely, > the specified value (sans the ! character) is used as if the user had > entered it directly on the command line. Thanks, this justifies the change quite nicely, I think. > See also https://lore.kernel.org/git/YJrH8uqzapnpNEsb@gpanders.com/. IMHO this link could be dropped. I referenced it earlier in the thread since there wasn't much context in your commit message. In general we prefer to copy that context into the commit, so it doesn't depend on having access to the list. And you already did that quite nicely, so the link tells us nothing new. :) > diff --git a/Documentation/git-send-email.txt b/Documentation/git-send-email.txt > index 93708aefea..418e66c703 100644 > --- a/Documentation/git-send-email.txt > +++ b/Documentation/git-send-email.txt > @@ -212,12 +212,13 @@ a password is obtained using 'git-credential'. > --smtp-server=<host>:: > If set, specifies the outgoing SMTP server to use (e.g. > `smtp.example.com` or a raw IP address). Alternatively it can > - specify a full pathname of a sendmail-like program instead; > - the program must support the `-i` option. Default value can > - be specified by the `sendemail.smtpServer` configuration > - option; the built-in default is to search for `sendmail` in > - `/usr/sbin`, `/usr/lib` and $PATH if such program is > - available, falling back to `localhost` otherwise. > + specify a sendmail-like program instead, either by a full > + path-name or by prefixing the program name with `!`. The > + program must support the `-i` option. Default value can be > + specified by the `sendemail.smtpServer` configuration option; > + the built-in default is to search for `sendmail` in `/usr/sbin`, > + `/usr/lib` and $PATH if such program is available, falling back > + to `localhost` otherwise. Ah, thanks for remembering to update the documentation. This looks good. > diff --git a/t/t9001-send-email.sh b/t/t9001-send-email.sh > index 65b3035371..14cc61ace7 100755 > --- a/t/t9001-send-email.sh > +++ b/t/t9001-send-email.sh > @@ -2225,4 +2225,14 @@ test_expect_success $PREREQ 'test forbidSendmailVariables behavior override' ' > HEAD^ > ' > > +test_expect_success $PREREQ 'test using a command for smtpServer with !' ' > + clean_fake_sendmail && > + PATH="$(pwd):$PATH" \ > + git send-email \ > + --from="Example <nobody@example.com>" \ > + --to=nobody@example.com \ > + --smtp-server="!fake.sendmail" \ > + $patches 2>errors > +' How do we know that we successfully ran our fake.sendmail script? I guess probably send-email would error out, but should we confirm that it touched commandline1, etc? It also seems to fail for me. I think $patches isn't valid at this point in the script, as the patch files have been removed. Switching to just HEAD~2 doesn't seem to work either, as earlier tests set up a hook which rejects it. I think we could pass HEAD^ to send just one path, but I thought it would be nice to confirm that sending multiple works (i.e., avoiding the bug we discussed earlier). I think the existing hook tests are somewhat poor to leave this confusing state. But the easiest thing to me is to just bump our test up a bit, like: diff --git a/t/t9001-send-email.sh b/t/t9001-send-email.sh index 14cc61ace7..31d25b32b5 100755 --- a/t/t9001-send-email.sh +++ b/t/t9001-send-email.sh @@ -2148,6 +2148,18 @@ test_expect_success $PREREQ 'leading and trailing whitespaces are removed' ' test_cmp expected-list actual-list ' +test_expect_success $PREREQ 'test using a command for smtpServer with !' ' + clean_fake_sendmail && + PATH="$(pwd):$PATH" \ + git send-email \ + --from="Example <nobody@example.com>" \ + --to=nobody@example.com \ + --smtp-server="!fake.sendmail" \ + HEAD~2 2>errors && + test_path_is_file commandline1 && + test_path_is_file commandline2 +' + test_expect_success $PREREQ 'invoke hook' ' mkdir -p .git/hooks && @@ -2225,14 +2237,4 @@ test_expect_success $PREREQ 'test forbidSendmailVariables behavior override' ' HEAD^ ' -test_expect_success $PREREQ 'test using a command for smtpServer with !' ' - clean_fake_sendmail && - PATH="$(pwd):$PATH" \ - git send-email \ - --from="Example <nobody@example.com>" \ - --to=nobody@example.com \ - --smtp-server="!fake.sendmail" \ - $patches 2>errors -' - test_done
On Tue, 11 May 2021 17:39 -0400, Jeff King wrote: >It also seems to fail for me. I think $patches isn't valid at this >point in the script, as the patch files have been removed. Switching to >just HEAD~2 doesn't seem to work either, as earlier tests set up a hook >which rejects it. I think we could pass HEAD^ to send just one path, >but I thought it would be nice to confirm that sending multiple works >(i.e., avoiding the bug we discussed earlier). I had to play around with this too (being unfamiliar with how this test harness worked). It would pass if I ran the first ~20 tests (20 is not significant, it's just a number I chose to ensure that whatever necessary setup needed to happen was done), but would fail otherwise. Moving the test up seems fine, I put it at the bottom simply because I wasn't sure where else to put it.
Gregory Anders <greg@gpanders.com> writes: > Presently, the smtpServer config option can use a sendmail-like program s/Presently, t/T/; Also if I understand it correctly this is not just about configuration varible but equally applies to the command line option --smtp-server, so mention both of them in their full name, i.e. The sendemail.smtpServer configuration variable and the "--smtp-server" command line option can name a program to use by providing ... > by providing an absolute path to the program as the value for this > option. However, an absolute path is not always portable and it is often > preferable to simply specify a program name and have `git-send-email` > find that program on $PATH. > > For example, if a user wishes to use msmtp to send emails, they might > be able to simply use > > [sendemail] > smtpServer = !msmtp > > instead of using the full path. This is particularly useful when a > common git config file is used across multiple systems where the > absolute path to a given program may differ. Nicely explained. > To that end, this patch allows the smtpServer config option to be > prefixed with a ! character that implements the above behavior; namely, > the specified value (sans the ! character) is used as if the user had > entered it directly on the command line. Allow the value of the configuration variable and the command line option to be prefixed with a '!' to signal that the specified command needs to be looked up on $PATH. > See also https://lore.kernel.org/git/YJrH8uqzapnpNEsb@gpanders.com/. You summarised the problem description in that message pretty well in the proposed log message (which is much better than leaving only a URL and forcing readers to go there), and I suspect there aren't much readers can learn from by seeing also the article, though. > + } elsif (file_name_is_absolute($smtp_server) || $smtp_server =~ /^!/) { > + my $prog = $smtp_server; > + $prog =~ s/^!//; > + > my $pid = open my $sm, '|-'; > defined $pid or die $!; > if (!$pid) { > - exec($smtp_server, @sendmail_parameters) or die $!; > + exec($prog, @sendmail_parameters) or die $!; > } Looking good. Thanks.
diff --git a/Documentation/git-send-email.txt b/Documentation/git-send-email.txt index 93708aefea..418e66c703 100644 --- a/Documentation/git-send-email.txt +++ b/Documentation/git-send-email.txt @@ -212,12 +212,13 @@ a password is obtained using 'git-credential'. --smtp-server=<host>:: If set, specifies the outgoing SMTP server to use (e.g. `smtp.example.com` or a raw IP address). Alternatively it can - specify a full pathname of a sendmail-like program instead; - the program must support the `-i` option. Default value can - be specified by the `sendemail.smtpServer` configuration - option; the built-in default is to search for `sendmail` in - `/usr/sbin`, `/usr/lib` and $PATH if such program is - available, falling back to `localhost` otherwise. + specify a sendmail-like program instead, either by a full + path-name or by prefixing the program name with `!`. The + program must support the `-i` option. Default value can be + specified by the `sendemail.smtpServer` configuration option; + the built-in default is to search for `sendmail` in `/usr/sbin`, + `/usr/lib` and $PATH if such program is available, falling back + to `localhost` otherwise. --smtp-server-port=<port>:: Specifies a port different from the default port (SMTP diff --git a/git-send-email.perl b/git-send-email.perl index 175da07d94..022dcf0999 100755 --- a/git-send-email.perl +++ b/git-send-email.perl @@ -1492,11 +1492,14 @@ sub send_message { if ($dry_run) { # We don't want to send the email. - } elsif (file_name_is_absolute($smtp_server)) { + } elsif (file_name_is_absolute($smtp_server) || $smtp_server =~ /^!/) { + my $prog = $smtp_server; + $prog =~ s/^!//; + my $pid = open my $sm, '|-'; defined $pid or die $!; if (!$pid) { - exec($smtp_server, @sendmail_parameters) or die $!; + exec($prog, @sendmail_parameters) or die $!; } print $sm "$header\n$message"; close $sm or die $!; diff --git a/t/t9001-send-email.sh b/t/t9001-send-email.sh index 65b3035371..14cc61ace7 100755 --- a/t/t9001-send-email.sh +++ b/t/t9001-send-email.sh @@ -2225,4 +2225,14 @@ test_expect_success $PREREQ 'test forbidSendmailVariables behavior override' ' HEAD^ ' +test_expect_success $PREREQ 'test using a command for smtpServer with !' ' + clean_fake_sendmail && + PATH="$(pwd):$PATH" \ + git send-email \ + --from="Example <nobody@example.com>" \ + --to=nobody@example.com \ + --smtp-server="!fake.sendmail" \ + $patches 2>errors +' + test_done
Presently, the smtpServer config option can use a sendmail-like program by providing an absolute path to the program as the value for this option. However, an absolute path is not always portable and it is often preferable to simply specify a program name and have `git-send-email` find that program on $PATH. For example, if a user wishes to use msmtp to send emails, they might be able to simply use [sendemail] smtpServer = !msmtp instead of using the full path. This is particularly useful when a common git config file is used across multiple systems where the absolute path to a given program may differ. To that end, this patch allows the smtpServer config option to be prefixed with a ! character that implements the above behavior; namely, the specified value (sans the ! character) is used as if the user had entered it directly on the command line. See also https://lore.kernel.org/git/YJrH8uqzapnpNEsb@gpanders.com/. Signed-off-by: Gregory Anders <greg@gpanders.com> --- Documentation/git-send-email.txt | 13 +++++++------ git-send-email.perl | 7 +++++-- t/t9001-send-email.sh | 10 ++++++++++ 3 files changed, 22 insertions(+), 8 deletions(-)