Merge pull request cli#3009 from cli/git-credential-env

mislav · web-flow · commit c5af4ddfdc0f · 2021-02-23T16:32:23.000+01:00
Fix `auth git-credential` when the token comes from environment
diff --git a/pkg/cmd/auth/gitcredential/helper.go b/pkg/cmd/auth/gitcredential/helper.go
@@ -11,8 +11,10 @@ import (
 	"github.com/spf13/cobra"
 )
 
+const tokenUser = "x-access-token"
+
 type config interface {
-	Get(string, string) (string, error)
+	GetWithSource(string, string) (string, string, error)
 }
 
 type CredentialOptions struct {
@@ -98,13 +100,19 @@ func helperRun(opts *CredentialOptions) error {
 		return err
 	}
 
-	gotUser, _ := cfg.Get(wants["host"], "user")
-	gotToken, _ := cfg.Get(wants["host"], "oauth_token")
+	var gotUser string
+	gotToken, source, _ := cfg.GetWithSource(wants["host"], "oauth_token")
+	if strings.HasSuffix(source, "_TOKEN") {
+		gotUser = tokenUser
+	} else {
+		gotUser, _, _ = cfg.GetWithSource(wants["host"], "user")
+	}
+
 	if gotUser == "" || gotToken == "" {
 		return cmdutil.SilentError
 	}
 
-	if wants["username"] != "" && !strings.EqualFold(wants["username"], gotUser) {
+	if wants["username"] != "" && gotUser != tokenUser && !strings.EqualFold(wants["username"], gotUser) {
 		return cmdutil.SilentError
 	}
 
diff --git a/pkg/cmd/auth/gitcredential/helper_test.go b/pkg/cmd/auth/gitcredential/helper_test.go
@@ -10,8 +10,8 @@ import (
 
 type tinyConfig map[string]string
 
-func (c tinyConfig) Get(host, key string) (string, error) {
-	return c[fmt.Sprintf("%s:%s", host, key)], nil
+func (c tinyConfig) GetWithSource(host, key string) (string, string, error) {
+	return c[fmt.Sprintf("%s:%s", host, key)], c["_source"], nil
 }
 
 func Test_helperRun(t *testing.T) {
@@ -29,6 +29,7 @@ func Test_helperRun(t *testing.T) {
 				Operation: "get",
 				Config: func() (config, error) {
 					return tinyConfig{
+						"_source":                 "/Users/monalisa/.config/gh/hosts.yml",
 						"example.com:user":        "monalisa",
 						"example.com:oauth_token": "OTOKEN",
 					}, nil
@@ -53,6 +54,7 @@ func Test_helperRun(t *testing.T) {
 				Operation: "get",
 				Config: func() (config, error) {
 					return tinyConfig{
+						"_source":                 "/Users/monalisa/.config/gh/hosts.yml",
 						"example.com:user":        "monalisa",
 						"example.com:oauth_token": "OTOKEN",
 					}, nil
@@ -78,6 +80,7 @@ func Test_helperRun(t *testing.T) {
 				Operation: "get",
 				Config: func() (config, error) {
 					return tinyConfig{
+						"_source":                 "/Users/monalisa/.config/gh/hosts.yml",
 						"example.com:user":        "monalisa",
 						"example.com:oauth_token": "OTOKEN",
 					}, nil
@@ -101,6 +104,7 @@ func Test_helperRun(t *testing.T) {
 				Operation: "get",
 				Config: func() (config, error) {
 					return tinyConfig{
+						"_source":          "/Users/monalisa/.config/gh/hosts.yml",
 						"example.com:user": "monalisa",
 					}, nil
 				},
@@ -119,6 +123,7 @@ func Test_helperRun(t *testing.T) {
 				Operation: "get",
 				Config: func() (config, error) {
 					return tinyConfig{
+						"_source":                 "/Users/monalisa/.config/gh/hosts.yml",
 						"example.com:user":        "monalisa",
 						"example.com:oauth_token": "OTOKEN",
 					}, nil
@@ -133,6 +138,31 @@ func Test_helperRun(t *testing.T) {
 			wantStdout: "",
 			wantStderr: "",
 		},
+		{
+			name: "token from env",
+			opts: CredentialOptions{
+				Operation: "get",
+				Config: func() (config, error) {
+					return tinyConfig{
+						"_source":                 "GITHUB_ENTERPRISE_TOKEN",
+						"example.com:oauth_token": "OTOKEN",
+					}, nil
+				},
+			},
+			input: heredoc.Doc(`
+				protocol=https
+				host=example.com
+				username=hubot
+			`),
+			wantErr: false,
+			wantStdout: heredoc.Doc(`
+				protocol=https
+				host=example.com
+				username=x-access-token
+				password=OTOKEN
+			`),
+			wantStderr: "",
+		},
 	}
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {

Original file line number	Diff line number	Diff line change
`@@ -11,8 +11,10 @@ import (`
`11`	`11`	`"github.com/spf13/cobra"`
`12`	`12`	`)`
`13`	`13`
	`14`	`+const tokenUser = "x-access-token"`
	`15`	`+`
`14`	`16`	`type config interface {`
`15`		`- Get(string, string) (string, error)`
	`17`	`+ GetWithSource(string, string) (string, string, error)`
`16`	`18`	`}`
`17`	`19`
`18`	`20`	`type CredentialOptions struct {`
`@@ -98,13 +100,19 @@ func helperRun(opts *CredentialOptions) error {`
`98`	`100`	`return err`
`99`	`101`	`}`
`100`	`102`
`101`		`- gotUser, _ := cfg.Get(wants["host"], "user")`
`102`		`- gotToken, _ := cfg.Get(wants["host"], "oauth_token")`
	`103`	`+ var gotUser string`
	`104`	`+ gotToken, source, _ := cfg.GetWithSource(wants["host"], "oauth_token")`
	`105`	`+ if strings.HasSuffix(source, "_TOKEN") {`
	`106`	`+ gotUser = tokenUser`
	`107`	`+ } else {`
	`108`	`+ gotUser, _, _ = cfg.GetWithSource(wants["host"], "user")`
	`109`	`+ }`
	`110`	`+`
`103`	`111`	`if gotUser == "" \|\| gotToken == "" {`
`104`	`112`	`return cmdutil.SilentError`
`105`	`113`	`}`
`106`	`114`
`107`		`- if wants["username"] != "" && !strings.EqualFold(wants["username"], gotUser) {`
	`115`	`+ if wants["username"] != "" && gotUser != tokenUser && !strings.EqualFold(wants["username"], gotUser) {`
`108`	`116`	`return cmdutil.SilentError`
`109`	`117`	`}`
`110`	`118`