[PATCH v2 0/3] send-email: teach git send-email mode to translate aliases

[PATCH v2 0/3] send-email: teach git send-email mode to translate aliases

[Jacob Keller]

The b4 program has its own "b4 send" utility for sending a patch series. It
is similar in many respects to git send-email. Currently, it lacks support
for processing aliases, which makes switching between git send-email and b4
send somewhat annoying.

It would be convenient if b4 (or other programs interacting with git) could
make use of git send-email's alias file support.

Teach git send-email a new --translate-aliases option, which enables a new
mode for git send-email. When executed with this option, git send-email
will read standard input and convert each input according to the configured
alias file. The resulting address will be output to standard out.

I also considered implementing a new "full" format for --dump-aliases which
would dump the entire alias file along with its configured email addresses.
I ended up dropping that change as I felt that it would be less usable than
the translation feature.

Signed-off-by: Jacob Keller <jacob.keller@gmail.com>
---
Changes in v2:
- Use standard input instead of command line arguments
- Link to v1: https://lore.kernel.org/r/20240808-jk-translate-alias-send-email-v1-0-10a03b3d6b06@gmail.com

---
Jacob Keller (3):
      t90001-send-email.sh: fix quoting for mailrc --dump-aliases test
      t9001-send-email.sh: update alias list used for pine test
      send-email: teach git send-email option to translate aliases

 Documentation/git-send-email.txt |   7 +++
 git-send-email.perl              |  21 ++++++-
 t/t9001-send-email.sh            | 118 +++++++++++++++++++++++++++++++++++++--
 3 files changed, 139 insertions(+), 7 deletions(-)
---
base-commit: 406f326d271e0bacecdb00425422c5fa3f314930
change-id: 20240808-jk-translate-alias-send-email-1ce048643e5d

Best regards,
-- 
Jacob Keller <jacob.keller@gmail.com>

[PATCH v2 1/3] t90001-send-email.sh: fix quoting for mailrc --dump-aliases test

[Jacob Keller]

From: Jacob Keller <jacob.keller@gmail.com>

The .mailrc alias file format documents that multiple addresses are
separated by spaces. The alias file used in the t9001 --dump-aliases
mailrc test have addresses which include both a name and email. These
are unquoted, so git send-email will parse this as an alias that
translates to multiple independent addresses.

The existing test does not care about this, as --dump-aliases only dumps
the alias and not the address. However, it is incorrect for a future
where --dump-aliases could also dump the mail addresses.

Fix the test to quote the aliases properly, so that they translate to a
single address.

Signed-off-by: Jacob Keller <jacob.keller@gmail.com>
---
 t/t9001-send-email.sh | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/t/t9001-send-email.sh b/t/t9001-send-email.sh
index 64a4ab3736ef..aa36ace393b7 100755
--- a/t/t9001-send-email.sh
+++ b/t/t9001-send-email.sh
@@ -2084,9 +2084,9 @@ test_dump_aliases '--dump-aliases mailrc format' \
 	'bob' \
 	'chloe' \
 	'eve' <<-\EOF
-	alias alice   Alice W Land <awol@example.com>
-	alias eve     Eve <eve@example.com>
-	alias bob     Robert Bobbyton <bob@example.com>
+	alias alice   "Alice W Land <awol@example.com>"
+	alias eve     "Eve <eve@example.com>"
+	alias bob     "Robert Bobbyton <bob@example.com>"
 	alias chloe   chloe@example.com
 	EOF
 

-- 
2.46.0.124.g2dc1a81c8933

Re: [PATCH v2 1/3] t90001-send-email.sh: fix quoting for mailrc --dump-aliases test

[Junio C Hamano]

Jacob Keller <jacob.e.keller@intel.com> writes:

> From: Jacob Keller <jacob.keller@gmail.com>
>
> The .mailrc alias file format documents that multiple addresses are
> separated by spaces. The alias file used in the t9001 --dump-aliases
> mailrc test have addresses which include both a name and email. These
> are unquoted, so git send-email will parse this as an alias that
> translates to multiple independent addresses.
>
> The existing test does not care about this, as --dump-aliases only dumps
> the alias and not the address. However, it is incorrect for a future
> where --dump-aliases could also dump the mail addresses.
>
> Fix the test to quote the aliases properly, so that they translate to a
> single address.
>
> Signed-off-by: Jacob Keller <jacob.keller@gmail.com>
> ---
>  t/t9001-send-email.sh | 6 +++---
>  1 file changed, 3 insertions(+), 3 deletions(-)

Makes sense.  I'll amend the excess "0" out of the title while
queuing.

Thanks.

>
> diff --git a/t/t9001-send-email.sh b/t/t9001-send-email.sh
> index 64a4ab3736ef..aa36ace393b7 100755
> --- a/t/t9001-send-email.sh
> +++ b/t/t9001-send-email.sh
> @@ -2084,9 +2084,9 @@ test_dump_aliases '--dump-aliases mailrc format' \
>  	'bob' \
>  	'chloe' \
>  	'eve' <<-\EOF
> -	alias alice   Alice W Land <awol@example.com>
> -	alias eve     Eve <eve@example.com>
> -	alias bob     Robert Bobbyton <bob@example.com>
> +	alias alice   "Alice W Land <awol@example.com>"
> +	alias eve     "Eve <eve@example.com>"
> +	alias bob     "Robert Bobbyton <bob@example.com>"
>  	alias chloe   chloe@example.com
>  	EOF

[PATCH v2 2/3] t9001-send-email.sh: update alias list used for pine test

[Jacob Keller]

From: Jacob Keller <jacob.keller@gmail.com>

The set of aliases used for the pine --dump-aliases test do not
perfectly mesh with the way the pine address book is defined. While
technically all valid, there are some oddities including bob's name
being partially split so that the actual address is returned as
"Bobbyton <bob@example.com". A strict reading of the pine documentation
indicates that the address should either be of the form
"address@domain" or a comma separated list of address, name/address
pairs, or other aliases enclosed by ().

The parsing implementation in git-send-email is not as strict, but it
makes sense to ensure the test data used is. Although the --dump-aliases
test does not make use of the address data, it is helpful to avoid
giving future developers the wrong impression of the file format.

Also add an alias which translates to multiple addresses using the ()
format.

Signed-off-by: Jacob Keller <jacob.keller@gmail.com>
---
 t/t9001-send-email.sh | 8 +++++---
 1 file changed, 5 insertions(+), 3 deletions(-)

diff --git a/t/t9001-send-email.sh b/t/t9001-send-email.sh
index aa36ace393b7..c96d6955b9f2 100755
--- a/t/t9001-send-email.sh
+++ b/t/t9001-send-email.sh
@@ -2093,13 +2093,15 @@ test_dump_aliases '--dump-aliases mailrc format' \
 test_dump_aliases '--dump-aliases pine format' \
 	'pine' \
 	'alice' \
+	'bcgrp' \
 	'bob' \
 	'chloe' \
 	'eve' <<-\EOF
-	alice	Alice W Land	<awol@example.com>
-	eve	Eve	<eve@example.com>
-	bob	Robert	Bobbyton <bob@example.com>
+	alice	Alice W Land	awol@example.com		Friend
+	eve	Eve	eve@example.com
+	bob	Robert Bobbyton	bob@example.com
 	chloe		chloe@example.com
+	bcgrp		(bob, chloe, Other <o@example.com>)
 	EOF
 
 test_dump_aliases '--dump-aliases gnus format' \

-- 
2.46.0.124.g2dc1a81c8933

Re: [PATCH v2 2/3] t9001-send-email.sh: update alias list used for pine test

[Junio C Hamano]

Jacob Keller <jacob.e.keller@intel.com> writes:

> From: Jacob Keller <jacob.keller@gmail.com>
>
> The set of aliases used for the pine --dump-aliases test do not
> perfectly mesh with the way the pine address book is defined. While
> technically all valid, there are some oddities including bob's name
> being partially split so that the actual address is returned as
> "Bobbyton <bob@example.com".

With "partially split" bob's name, do you mean the HT between Robert
and Bobbyton in the original?  

I am asking to see if the closing angle-bracket ">" after the
address is deliberately omitted to illustrate a breakage coming from
a malformed entry in the original address book, or it is missing
merely by mistake.

> -	bob	Robert	Bobbyton <bob@example.com>
> +	bob	Robert Bobbyton	bob@example.com

Thanks.

Re: [PATCH v2 2/3] t9001-send-email.sh: update alias list used for pine test

[Jacob Keller]

On Wed, Aug 14, 2024 at 10:02 AM Junio C Hamano <gitster@pobox.com> wrote:
>
> Jacob Keller <jacob.e.keller@intel.com> writes:
>
> > From: Jacob Keller <jacob.keller@gmail.com>
> >
> > The set of aliases used for the pine --dump-aliases test do not
> > perfectly mesh with the way the pine address book is defined. While
> > technically all valid, there are some oddities including bob's name
> > being partially split so that the actual address is returned as
> > "Bobbyton <bob@example.com".
>
> With "partially split" bob's name, do you mean the HT between Robert
> and Bobbyton in the original?
>
> I am asking to see if the closing angle-bracket ">" after the
> address is deliberately omitted to illustrate a breakage coming from
> a malformed entry in the original address book, or it is missing
> merely by mistake.
>

It is missing as a mistake, I think. The main change here is the HT
between Robert and Bobbyton in the original was causing the fields to
be separated.in what seemed like an unintentional way to me. The
missing > was I think due to a copy-paste error where i failed to
select the final > when copying to paste into the commit log.

> > -     bob     Robert  Bobbyton <bob@example.com>
> > +     bob     Robert Bobbyton bob@example.com
>
> Thanks.

[PATCH v2 3/3] send-email: teach git send-email option to translate aliases

[Jacob Keller]

From: Jacob Keller <jacob.keller@gmail.com>

git send-email has support for converting shorthand alias names to
canonical email addresses via the alias file. It supports a wide variety
of alias file formats based on popular email program file formats.

Other programs, such as b4, would like the ability to convert aliases in
the same way as git send-email without needing to re-implement the logic
for understanding the many file formats.

Teach git send-email a new option, --translate-aliases, which will
enable this functionality. Similar to --dump-aliases, this option works
like a new mode of operation for git send-email.

When run with --translate-aliases, git send-email reads from standard
input and converts any provided alias into its canonical name and email
according to the alias file. Each expanded name and address is printed
to standard output, one per line.

Signed-off-by: Jacob Keller <jacob.keller@gmail.com>
---
 Documentation/git-send-email.txt |   7 +++
 git-send-email.perl              |  21 +++++++-
 t/t9001-send-email.sh            | 104 +++++++++++++++++++++++++++++++++++++++
 3 files changed, 131 insertions(+), 1 deletion(-)

diff --git a/Documentation/git-send-email.txt b/Documentation/git-send-email.txt
index c5d664f4519b..2e6f1d63ae4a 100644
--- a/Documentation/git-send-email.txt
+++ b/Documentation/git-send-email.txt
@@ -12,6 +12,7 @@ SYNOPSIS
 'git send-email' [<options>] (<file>|<directory>)...
 'git send-email' [<options>] <format-patch-options>
 'git send-email' --dump-aliases
+'git send-email' --translate-aliases
 
 
 DESCRIPTION
@@ -475,6 +476,12 @@ Information
 	that this only includes the alias name and not its expanded email addresses.
 	See 'sendemail.aliasesFile' for more information about aliases.
 
+--translate-aliases::
+	Instead of the normal operation, read from standard input and
+	interpret each line as an email alias. Translate it according to the
+	configured alias file(s). Output each translated name and email
+	address to standard output, one per line. See 'sendemail.aliasFile'
+	for more information about aliases.
 
 CONFIGURATION
 -------------
diff --git a/git-send-email.perl b/git-send-email.perl
index 72044e5ef3a8..cdcee1d0cf96 100755
--- a/git-send-email.perl
+++ b/git-send-email.perl
@@ -31,6 +31,7 @@ sub usage {
 git send-email [<options>] <file|directory>
 git send-email [<options>] <format-patch options>
 git send-email --dump-aliases
+git send-email --translate-aliases
 
   Composing:
     --from                  <str>  * Email From:
@@ -99,6 +100,10 @@ sub usage {
 
   Information:
     --dump-aliases                 * Dump configured aliases and exit.
+    --translate-aliases            * Translate aliases read from standard
+                                     input according to the configured email
+                                     alias file(s), outputting the result to
+                                     standard output.
 
 EOT
 	exit(1);
@@ -212,6 +217,7 @@ sub format_2822_time {
 my $compose_filename;
 my $force = 0;
 my $dump_aliases = 0;
+my $translate_aliases = 0;
 
 # Variables to prevent short format-patch options from being captured
 # as abbreviated send-email options
@@ -476,11 +482,14 @@ sub config_regexp {
 my %dump_aliases_options = (
 	"h" => \$help,
 	"dump-aliases" => \$dump_aliases,
+	"translate-aliases" => \$translate_aliases,
 );
 $rc = GetOptions(%dump_aliases_options);
 usage() unless $rc;
 die __("--dump-aliases incompatible with other options\n")
-    if !$help and $dump_aliases and @ARGV;
+    if !$help and ($dump_aliases or $translate_aliases) and @ARGV;
+die __("--dump-aliases and --translate-aliases are mutually exclusive\n")
+    if !$help and $dump_aliases and $translate_aliases;
 my %options = (
 		    "sender|from=s" => \$sender,
 		    "in-reply-to=s" => \$initial_in_reply_to,
@@ -724,6 +733,16 @@ sub parse_sendmail_aliases {
     exit(0);
 }
 
+if ($translate_aliases) {
+	while (<STDIN>) {
+		my @addr_list = parse_address_line($_);
+		@addr_list = expand_aliases(@addr_list);
+		@addr_list = sanitize_address_list(@addr_list);
+		print "$_\n" for @addr_list;
+	}
+	exit(0);
+}
+
 # is_format_patch_arg($f) returns 0 if $f names a patch, or 1 if
 # $f is a revision list specification to be passed to format-patch.
 sub is_format_patch_arg {
diff --git a/t/t9001-send-email.sh b/t/t9001-send-email.sh
index c96d6955b9f2..13f1453eebb9 100755
--- a/t/t9001-send-email.sh
+++ b/t/t9001-send-email.sh
@@ -2120,6 +2120,110 @@ test_expect_success '--dump-aliases must be used alone' '
 	test_must_fail git send-email --dump-aliases --to=janice@example.com -1 refs/heads/accounting
 '
 
+test_translate_aliases () {
+	msg="$1" && shift &&
+	filetype="$1" && shift &&
+	aliases="$1" && shift &&
+	printf '%s\n' "$@" >expect &&
+	cat >.tmp-email-aliases &&
+	printf '%s\n' "$aliases" >aliases &&
+
+	test_expect_success $PREREQ "$msg" '
+		clean_fake_sendmail && rm -fr outdir &&
+		git config --replace-all sendemail.aliasesfile \
+			"$(pwd)/.tmp-email-aliases" &&
+		git config sendemail.aliasfiletype "$filetype" &&
+		git send-email --translate-aliases <aliases 2>errors >actual &&
+		test_cmp expect actual
+	'
+}
+
+test_translate_aliases '--translate-aliases sendmail format' \
+	'sendmail' \
+	'alice bcgrp' \
+	'Alice W Land <awol@example.com>' \
+	'Robert Bobbyton <bob@example.com>' \
+	'chloe@example.com' \
+	'Other <o@example.com>' <<-\EOF
+	alice: Alice W Land <awol@example.com>
+	bob: Robert Bobbyton <bob@example.com>
+	chloe: chloe@example.com
+	abgroup: alice, bob
+	bcgrp: bob, chloe, Other <o@example.com>
+	EOF
+
+test_translate_aliases '--translate-aliases mutt format' \
+	'mutt' \
+	'donald bob' \
+	'Donald C Carlton <donc@example.com>' \
+	'Robert Bobbyton <bob@example.com>' <<-\EOF
+	alias alice Alice W Land <awol@example.com>
+	alias donald Donald C Carlton <donc@example.com>
+	alias bob Robert Bobbyton <bob@example.com>
+	alias chloe chloe@example.com
+	EOF
+
+test_translate_aliases '--translate-aliases mailrc format' \
+	'mailrc' \
+	'chloe eve alice' \
+	'chloe@example.com' \
+	'Eve <eve@example.com>' \
+	'Alice W Land <awol@example.com>' <<-\EOF
+	alias alice   "Alice W Land <awol@example.com>"
+	alias eve     "Eve <eve@example.com>"
+	alias bob     "Robert Bobbyton <bob@example.com>"
+	alias chloe   chloe@example.com
+	EOF
+
+test_translate_aliases '--translate-aliases pine format' \
+	'pine' \
+	'eve bob bcgrp' \
+	'eve@example.com' \
+	'bob@example.com' \
+	'bob@example.com' \
+	'chloe@example.com' \
+	'Other <o@example.com>' <<-\EOF
+	alice	Alice W Land	awol@example.com		Friend
+	eve	Eve	eve@example.com
+	bob	Robert Bobbyton	bob@example.com
+	chloe		chloe@example.com
+	bcgrp		(bob, chloe, Other <o@example.com>)
+	EOF
+
+test_translate_aliases '--translate-aliases gnus format' \
+	'gnus' \
+	'alice chloe eve' \
+	'awol@example.com' \
+	'chloe@example.com' \
+	'eve@example.com' <<-\EOF
+	(define-mail-alias "alice" "awol@example.com")
+	(define-mail-alias "eve" "eve@example.com")
+	(define-mail-alias "bob" "bob@example.com")
+	(define-mail-alias "chloe" "chloe@example.com")
+	EOF
+
+test_expect_success '--translate-aliases passes valid addresses through' '
+	cat >expect <<-\EOF &&
+	Other <o@example.com>
+	EOF
+	cat >aliases <<-\EOF &&
+	Other <o@example.com>
+	EOF
+	git send-email --translate-aliases <aliases >actual &&
+	test_cmp expect actual
+'
+
+test_expect_success '--translate-aliases passes unknown aliases through' '
+	cat >expect <<-\EOF &&
+	blargh
+	EOF
+	cat >aliases <<-\EOF &&
+	blargh
+	EOF
+	git send-email --translate-aliases <aliases >actual &&
+	test_cmp expect actual
+'
+
 test_expect_success $PREREQ 'aliases and sendemail.identity' '
 	test_must_fail git \
 		-c sendemail.identity=cloud \

-- 
2.46.0.124.g2dc1a81c8933

Re: [PATCH v2 0/3] send-email: teach git send-email mode to translate aliases

[Junio C Hamano]

Jacob Keller <jacob.e.keller@intel.com> writes:

> The b4 program has its own "b4 send" utility for sending a patch series. It
> is similar in many respects to git send-email. Currently, it lacks support
> for processing aliases, which makes switching between git send-email and b4
> send somewhat annoying.
>
> It would be convenient if b4 (or other programs interacting with git) could
> make use of git send-email's alias file support.
>
> Teach git send-email a new --translate-aliases option, which enables a new
> mode for git send-email. When executed with this option, git send-email
> will read standard input and convert each input according to the configured
> alias file. The resulting address will be output to standard out.
>
> I also considered implementing a new "full" format for --dump-aliases which
> would dump the entire alias file along with its configured email addresses.
> I ended up dropping that change as I felt that it would be less usable than
> the translation feature.
>
> Signed-off-by: Jacob Keller <jacob.keller@gmail.com>
> ---
> Changes in v2:
> - Use standard input instead of command line arguments
> - Link to v1: https://lore.kernel.org/r/20240808-jk-translate-alias-send-email-v1-0-10a03b3d6b06@gmail.com
>
> ---
> Jacob Keller (3):
>       t90001-send-email.sh: fix quoting for mailrc --dump-aliases test

Nobody noticed the typo in the filename since the previous iteration
was posted?

>       t9001-send-email.sh: update alias list used for pine test
>       send-email: teach git send-email option to translate aliases
>
>  Documentation/git-send-email.txt |   7 +++
>  git-send-email.perl              |  21 ++++++-
>  t/t9001-send-email.sh            | 118 +++++++++++++++++++++++++++++++++++++--
>  3 files changed, 139 insertions(+), 7 deletions(-)
> ---
> base-commit: 406f326d271e0bacecdb00425422c5fa3f314930
> change-id: 20240808-jk-translate-alias-send-email-1ce048643e5d
>
> Best regards,

Re: [PATCH v2 0/3] send-email: teach git send-email mode to translate aliases

[Jacob Keller]

On Wed, Aug 14, 2024 at 9:54 AM Junio C Hamano <gitster@pobox.com> wrote:
> Jacob Keller <jacob.e.keller@intel.com> writes:
> > ---
> > Jacob Keller (3):
> >       t90001-send-email.sh: fix quoting for mailrc --dump-aliases test
>
> Nobody noticed the typo in the filename since the previous iteration
> was posted?
>

I certainly did not :D Woops. If you had pointed this out in the
initial review, I apologize as I missed that comment.

Re: [PATCH v2 0/3] send-email: teach git send-email mode to translate aliases

[Junio C Hamano]

Jacob Keller <jacob.keller@gmail.com> writes:

> On Wed, Aug 14, 2024 at 9:54 AM Junio C Hamano <gitster@pobox.com> wrote:
>> Jacob Keller <jacob.e.keller@intel.com> writes:
>> > ---
>> > Jacob Keller (3):
>> >       t90001-send-email.sh: fix quoting for mailrc --dump-aliases test
>>
>> Nobody noticed the typo in the filename since the previous iteration
>> was posted?
>>
>
> I certainly did not :D Woops. If you had pointed this out in the
> initial review, I apologize as I missed that comment.

I do recall raising an eyebrow but I do also recall saying nothing
about it ;-)

Re: [PATCH v2 0/3] send-email: teach git send-email mode to translate aliases

[Konstantin Ryabitsev]

On Tue, Aug 13, 2024 at 05:05:08PM GMT, Jacob Keller wrote:
> It would be convenient if b4 (or other programs interacting with git) could
> make use of git send-email's alias file support.

This is, indeed, a very frequent request.

Acked-by: Konstantin Ryabitsev <konstantin@linuxfoundation.org>

-KK

Re: [PATCH v2 0/3] send-email: teach git send-email mode to translate aliases

[Junio C Hamano]

Jacob Keller <jacob.e.keller@intel.com> writes:

> Jacob Keller (3):
>       t90001-send-email.sh: fix quoting for mailrc --dump-aliases test
>       t9001-send-email.sh: update alias list used for pine test
>       send-email: teach git send-email option to translate aliases

Seems to fail t9001 rather miserably on Windows.

https://github.com/git/git/actions/runs/10411559740/job/28835810137#step:5:2444

There seem to be way too many PREREQ related skippage, it is not all
that surprising (it does not make it excuable, though) if a new test
that comes later and not skipped is broken because earlier steps are
not executed.

RE: [PATCH v2 0/3] send-email: teach git send-email mode to translate aliases

[Keller, Jacob E]

> -----Original Message-----
> From: Junio C Hamano <gitster@pobox.com>
> Sent: Thursday, August 15, 2024 3:57 PM
> To: Keller, Jacob E <jacob.e.keller@intel.com>
> Cc: git@vger.kernel.org; Jacob Keller <jacob.keller@gmail.com>; Konstantin
> Ryabitsev <konstantin@linuxfoundation.org>
> Subject: Re: [PATCH v2 0/3] send-email: teach git send-email mode to translate
> aliases
> 
> Jacob Keller <jacob.e.keller@intel.com> writes:
> 
> > Jacob Keller (3):
> >       t90001-send-email.sh: fix quoting for mailrc --dump-aliases test
> >       t9001-send-email.sh: update alias list used for pine test
> >       send-email: teach git send-email option to translate aliases
> 
> Seems to fail t9001 rather miserably on Windows.
> 
> https://github.com/git/git/actions/runs/10411559740/job/28835810137#step:5:24
> 44
> 
> There seem to be way too many PREREQ related skippage, it is not all
> that surprising (it does not make it excuable, though) if a new test
> that comes later and not skipped is broken because earlier steps are
> not executed.

It looks like we're missing the perl PREREQ on the tests, so these execute and then fail because of lack of perl. Should be easy to fix.