Parse commit trailers using mail.ParseAddress()

Author: kemzeb

modules/util/commit_trailers.go

@@ -6,7 +6,6 @@ package util
 import (
 	"errors"
 	"net/mail"
-	"strings"
 )
 
 var ErrInvalidCommitTrailerValueSyntax = errors.New("syntax error occurred while parsing a commit trailer value")
@@ -17,26 +16,17 @@ var ErrInvalidCommitTrailerValueSyntax = errors.New("syntax error occurred while
 //
 // Foo Bar <[email protected]>
 func ParseCommitTrailerValueWithAuthor(value string) (name, email string, err error) {
-	value = strings.TrimSpace(value)
-	if !strings.HasSuffix(value, ">") {
-		return "", "", ErrInvalidCommitTrailerValueSyntax
+	addr, err := mail.ParseAddress(value)
+	if err != nil {
+		return name, email, err
 	}
 
-	closedBracketIdx := len(value) - 1
-	openBracketIdx := strings.LastIndex(value, "<")
-	if openBracketIdx == -1 {
-		return "", "", ErrInvalidCommitTrailerValueSyntax
+	if addr.Name == "" {
+		return name, email, errors.New("commit trailer missing name")
 	}
 
-	email = value[openBracketIdx+1 : closedBracketIdx]
-	if _, err := mail.ParseAddress(email); err != nil {
-		return "", "", ErrInvalidCommitTrailerValueSyntax
-	}
-
-	name = strings.TrimSpace(value[:openBracketIdx])
-	if len(name) == 0 {
-		return "", "", ErrInvalidCommitTrailerValueSyntax
-	}
+	name = addr.Name
+	email = addr.Address
 
 	return name, email, nil
 }

modules/util/commit_trailers_test.go

@@ -24,15 +24,16 @@ func TestParseCommitTrailerValueWithAuthor(t *testing.T) {
 		{"    <[email protected]>", true, "", ""},
 		{"Foo Bar <[email protected]>", false, "Foo Bar", "[email protected]"},
 		{"   Foo Bar    <[email protected]>", false, "Foo Bar", "[email protected]"},
-		// Account for edge case where name contains an open bracket.
-		{"   Foo < Bar    <[email protected]>", false, "Foo < Bar", "[email protected]"},
 	}
 
 	for n, c := range cases {
 		name, email, err := ParseCommitTrailerValueWithAuthor(c.input)
 		if c.shouldBeError {
 			assert.Error(t, err, "case %d should be a syntax error", n)
 		} else {
+			if err != nil {
+				assert.Fail(t, "did not expect an error: %v", err)
+			}
 			assert.Equal(t, c.expectedName, name, "case %d should have correct name", n)
 			assert.Equal(t, c.expectedEmail, email, "case %d should have correct email", n)
 		}