internal/gocommand: add GoVersionString

Unlike the existing GoVersion that returns the minor version
number of the go command, GoVersionString returns the part that
indicates the major/minor/patch version from `go version`
output.

The full go version info is necessary when analyzing
vulnerabilities.

Change-Id: I5ea624e877e02009148ad906e6475cb1aba40b3a
Reviewed-on: https://go-review.googlesource.com/c/tools/+/453595
Run-TryBot: Hyang-Ah Hana Kim <[email protected]>
TryBot-Result: Gopher Robot <[email protected]>
gopls-CI: kokoro <[email protected]>
Reviewed-by: Robert Findley <[email protected]>

Author: hyangah

gopls/internal/lsp/cache/view.go

@@ -119,6 +119,9 @@ type workspaceInformation struct {
 	// The Go version in use: X in Go 1.X.
 	goversion int
 
+	// The Go version reported by go version command. (e.g. go1.19.1, go1.20-rc.1, go1.21-abcdef01)
+	goversionString string
+
 	// hasGopackagesDriver is true if the user has a value set for the
 	// GOPACKAGESDRIVER environment variable or a gopackagesdriver binary on
 	// their machine.
@@ -836,6 +839,10 @@ func (s *Session) getWorkspaceInformation(ctx context.Context, folder span.URI,
 	if err != nil {
 		return nil, err
 	}
+	goversionString, err := gocommand.GoVersionString(ctx, inv, s.gocmdRunner)
+	if err != nil {
+		return nil, err
+	}
 
 	// Make sure to get the `go env` before continuing with initialization.
 	envVars, env, err := s.getGoEnv(ctx, folder.Filename(), goversion, options.EnvSlice())
@@ -863,6 +870,7 @@ func (s *Session) getWorkspaceInformation(ctx context.Context, folder span.URI,
 	return &workspaceInformation{
 		hasGopackagesDriver:  hasGopackagesDriver,
 		goversion:            goversion,
+		goversionString:      goversionString,
 		environmentVariables: envVars,
 		goEnv:                env,
 	}, nil
@@ -1072,6 +1080,10 @@ func (v *View) GoVersion() int {
 	return v.workspaceInformation.goversion
 }
 
+func (v *View) GoVersionString() string {
+	return v.workspaceInformation.goversionString
+}
+
 // Copied from
 // https://cs.opensource.google/go/go/+/master:src/cmd/go/internal/str/path.go;l=58;drc=2910c5b4a01a573ebc97744890a07c1a3122c67a
 func globsMatchPath(globs, target string) bool {

gopls/internal/lsp/source/view.go

@@ -329,6 +329,10 @@ type View interface {
 
 	// GoVersion returns the configured Go version for this view.
 	GoVersion() int
+
+	// GoVersionString returns the go version string configured for this view.
+	// Unlike [GoVersion], this encodes the minor version and commit hash information.
+	GoVersionString() string
 }
 
 // A FileSource maps uris to FileHandles. This abstraction exists both for

internal/gocommand/version.go

@@ -7,6 +7,7 @@ package gocommand
 import (
 	"context"
 	"fmt"
+	"regexp"
 	"strings"
 )
 
@@ -56,3 +57,23 @@ func GoVersion(ctx context.Context, inv Invocation, r *Runner) (int, error) {
 	}
 	return 0, fmt.Errorf("no parseable ReleaseTags in %v", tags)
 }
+
+// GoVersionString reports the go version string as shown in `go version` command output.
+// When `go version` outputs in non-standard form, this returns an empty string.
+func GoVersionString(ctx context.Context, inv Invocation, r *Runner) (string, error) {
+	inv.Verb = "version"
+	goVersion, err := r.Run(ctx, inv)
+	if err != nil {
+		return "", err
+	}
+	return parseGoVersionOutput(goVersion.Bytes()), nil
+}
+
+func parseGoVersionOutput(data []byte) string {
+	re := regexp.MustCompile(`^go version (go\S+|devel \S+)`)
+	m := re.FindSubmatch(data)
+	if len(m) != 2 {
+		return "" // unrecognized version
+	}
+	return string(m[1])
+}

internal/gocommand/version_test.go

@@ -0,0 +1,31 @@
+// Copyright 2022 The Go Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style
+// license that can be found in the LICENSE file.
+
+package gocommand
+
+import (
+	"strconv"
+	"testing"
+)
+
+func TestParseGoVersionOutput(t *testing.T) {
+	tests := []struct {
+		args string
+		want string
+	}{
+		{"go version go1.12 linux/amd64", "go1.12"},
+		{"go version go1.18.1 darwin/amd64", "go1.18.1"},
+		{"go version go1.19.rc1 windows/arm64", "go1.19.rc1"},
+		{"go version devel d5de62df152baf4de6e9fe81933319b86fd95ae4 linux/386", "devel d5de62df152baf4de6e9fe81933319b86fd95ae4"},
+		{"go version devel go1.20-1f068f0dc7 Tue Oct 18 20:58:37 2022 +0000 darwin/amd64", "devel go1.20-1f068f0dc7"},
+		{"v1.19.1 foo/bar", ""},
+	}
+	for i, tt := range tests {
+		t.Run(strconv.Itoa(i), func(t *testing.T) {
+			if got := parseGoVersionOutput([]byte(tt.args)); got != tt.want {
+				t.Errorf("parseGoVersionOutput() = %v, want %v", got, tt.want)
+			}
+		})
+	}
+}