cmd/go: link to the FAQ for errors that indicate private VCS repos.

julieqiu · julieqiu · commit 9a11b7363589 · 2018-12-12T15:00:01.000Z
Updates golang#25982 Change-Id: I5a284e3844e944f9bfae31fa65b242060d4139c7 Reviewed-on: https://go-review.googlesource.com/c/150777 Run-TryBot: Julie Qiu <julie@golang.org> Run-TryBot: Bryan C. Mills <bcmills@google.com> TryBot-Result: Gobot Gobot <gobot@golang.org> Reviewed-by: Bryan C. Mills <bcmills@google.com>
diff --git a/src/cmd/go/internal/modfetch/codehost/codehost.go b/src/cmd/go/internal/modfetch/codehost/codehost.go
@@ -196,9 +196,10 @@ func WorkDir(typ, name string) (dir, lockfile string, err error) {
 }
 
 type RunError struct {
-	Cmd    string
-	Err    error
-	Stderr []byte
+	Cmd      string
+	Err      error
+	Stderr   []byte
+	HelpText string
 }
 
 func (e *RunError) Error() string {
@@ -207,6 +208,9 @@ func (e *RunError) Error() string {
 	if len(stderr) > 0 {
 		text += ":\n\t" + strings.ReplaceAll(string(stderr), "\n", "\n\t")
 	}
+	if len(e.HelpText) > 0 {
+		text += "\n" + e.HelpText
+	}
 	return text
 }
 
diff --git a/src/cmd/go/internal/modfetch/codehost/git.go b/src/cmd/go/internal/modfetch/codehost/git.go
@@ -164,6 +164,11 @@ func (r *gitRepo) loadRefs() {
 	// Most of the time we only care about tags but sometimes we care about heads too.
 	out, err := Run(r.dir, "git", "ls-remote", "-q", r.remote)
 	if err != nil {
+		if rerr, ok := err.(*RunError); ok {
+			if bytes.Contains(rerr.Stderr, []byte("fatal: could not read Username")) {
+				rerr.HelpText = "If this is a private repository, see https://golang.org/doc/faq#git_https for additional information."
+			}
+		}
 		r.refsErr = err
 		return
 	}
diff --git a/src/cmd/go/testdata/script/mod_get_private_vcs.txt b/src/cmd/go/testdata/script/mod_get_private_vcs.txt
@@ -0,0 +1,10 @@
+env GO111MODULE=on
+
+# Testing stderr for git ls-remote; turn off proxy.
+[!net] skip
+[!exec:git] skip
+env GOPROXY=
+
+! go get github.com/golang/nonexist
+stderr 'If this is a private repository, see https://golang.org/doc/faq#git_https for additional information.'
+! stdout .

Original file line number	Diff line number	Diff line change
`@@ -196,9 +196,10 @@ func WorkDir(typ, name string) (dir, lockfile string, err error) {`
`196`	`196`	`}`
`197`	`197`
`198`	`198`	`type RunError struct {`
`199`		`- Cmd string`
`200`		`- Err error`
`201`		`- Stderr []byte`
	`199`	`+ Cmd string`
	`200`	`+ Err error`
	`201`	`+ Stderr []byte`
	`202`	`+ HelpText string`
`202`	`203`	`}`
`203`	`204`
`204`	`205`	`func (e *RunError) Error() string {`
`@@ -207,6 +208,9 @@ func (e *RunError) Error() string {`
`207`	`208`	`if len(stderr) > 0 {`
`208`	`209`	`text += ":\n\t" + strings.ReplaceAll(string(stderr), "\n", "\n\t")`
`209`	`210`	`}`
	`211`	`+ if len(e.HelpText) > 0 {`
	`212`	`+ text += "\n" + e.HelpText`
	`213`	`+ }`
`210`	`214`	`return text`
`211`	`215`	`}`
`212`	`216`