Merge pull request github#12957 from owen-mc/go/autobuilder-identify-environment

Go: Add `go-autobuilder --identify-environment`

Author: owen-mc

go/extractor/cli/go-autobuilder/go-autobuilder.go

@@ -33,3 +33,56 @@ func TestParseGoVersion(t *testing.T) {
 		}
 	}
 }
+
+func TestGetVersionToInstall(t *testing.T) {
+	tests := map[versionInfo]string{
+		// checkForUnsupportedVersions()
+
+		// go.mod version below minGoVersion
+		{"0.0", true, "1.20.3", true}: "",
+		{"0.0", true, "9999.0", true}: "",
+		{"0.0", true, "1.2.2", true}:  "",
+		{"0.0", true, "", false}:      "",
+		// go.mod version above maxGoVersion
+		{"9999.0", true, "1.20.3", true}:   "",
+		{"9999.0", true, "9999.0.1", true}: "",
+		{"9999.0", true, "1.1", true}:      "",
+		{"9999.0", true, "", false}:        "",
+		// Go installation found with version below minGoVersion
+		{"1.20", true, "1.2.2", true}: "",
+		{"1.11", true, "1.2.2", true}: "",
+		{"", false, "1.2.2", true}:    "",
+		// Go installation found with version above maxGoVersion
+		{"1.20", true, "9999.0.1", true}: "",
+		{"1.11", true, "9999.0.1", true}: "",
+		{"", false, "9999.0.1", true}:    "",
+
+		// checkForVersionsNotFound()
+
+		// Go installation not found, go.mod version in supported range
+		{"1.20", true, "", false}: "1.20",
+		{"1.11", true, "", false}: "1.11",
+		// Go installation not found, go.mod not found
+		{"", false, "", false}: maxGoVersion,
+		// Go installation found with version in supported range, go.mod not found
+		{"", false, "1.11.13", true}: "",
+		{"", false, "1.20.3", true}:  "",
+
+		// compareVersions()
+
+		// Go installation found with version in supported range, go.mod version in supported range and go.mod version > go installation version
+		{"1.20", true, "1.11.13", true}: "1.20",
+		{"1.20", true, "1.12", true}:    "1.20",
+		// Go installation found with version in supported range, go.mod version in supported range and go.mod version <= go installation version
+		// (Note comparisons ignore the patch version)
+		{"1.11", true, "1.20", true}:   "",
+		{"1.11", true, "1.20.3", true}: "",
+		{"1.20", true, "1.20.3", true}: "",
+	}
+	for input, expected := range tests {
+		_, actual := getVersionToInstall(input)
+		if actual != expected {
+			t.Errorf("Expected getVersionToInstall(\"%s\") to be \"%s\", but got \"%s\".", input, expected, actual)
+		}
+	}
+}

go/extractor/cli/go-autobuilder/go-autobuilder_test.go

@@ -2,7 +2,6 @@ package main
 
 import (
 	"fmt"
-	"io/ioutil"
 	"log"
 	"os"
 	"regexp"
@@ -22,7 +21,7 @@ func main() {
 	buildSteps := os.Args[2]
 
 	haveRepo := false
-	content, err := ioutil.ReadFile(vars)
+	content, err := os.ReadFile(vars)
 	if err != nil {
 		log.Fatal(err)
 	}
@@ -34,7 +33,7 @@ func main() {
 		additionalVars += "SEMMLE_REPO_URL=${repository}\n"
 	}
 	content = append(content, []byte(additionalVars)...)
-	err = ioutil.WriteFile(vars, content, 0644)
+	err = os.WriteFile(vars, content, 0644)
 	if err != nil {
 		log.Fatal(err)
 	}
@@ -47,7 +46,7 @@ func main() {
   <build export="%s">${semmle_dist}/language-packs/go/tools/platform/${semmle_platform}/bin/go-autobuilder</build>
 </autoupdate>
 `, export))
-	err = ioutil.WriteFile(buildSteps, content, 0644)
+	err = os.WriteFile(buildSteps, content, 0644)
 	if err != nil {
 		log.Fatal(err)
 	}

go/extractor/cli/go-bootstrap/go-bootstrap.go

@@ -6,7 +6,6 @@ import (
 	"fmt"
 	"go/scanner"
 	"go/token"
-	"io/ioutil"
 	"log"
 	"os"
 	"strings"
@@ -20,7 +19,7 @@ func main() {
 	defer csv.Flush()
 
 	for _, fileName := range flag.Args() {
-		src, err := ioutil.ReadFile(fileName)
+		src, err := os.ReadFile(fileName)
 		if err != nil {
 			log.Fatalf("Unable to read file %s.", fileName)
 		}

go/extractor/cli/go-tokenizer/go-tokenizer.go

@@ -30,6 +30,7 @@ type visibilityStruct struct {
 }
 
 var fullVisibility *visibilityStruct = &visibilityStruct{true, true, true}
+var telemetryOnly *visibilityStruct = &visibilityStruct{false, false, true}
 
 type locationStruct struct {
 	File        string `json:"file,omitempty"`
@@ -192,3 +193,80 @@ func EmitRelativeImportPaths() {
 		noLocation,
 	)
 }
+
+func EmitUnsupportedVersionGoMod(msg string) {
+	emitDiagnostic(
+		"go/autobuilder/env-unsupported-version-in-go-mod",
+		"Unsupported Go version in `go.mod` file",
+		msg,
+		severityNote,
+		telemetryOnly,
+		noLocation,
+	)
+}
+
+func EmitUnsupportedVersionEnvironment(msg string) {
+	emitDiagnostic(
+		"go/autobuilder/env-unsupported-version-in-environment",
+		"Unsupported Go version in environment",
+		msg,
+		severityNote,
+		telemetryOnly,
+		noLocation,
+	)
+}
+
+func EmitNoGoModAndNoGoEnv(msg string) {
+	emitDiagnostic(
+		"go/autobuilder/env-no-go-mod-and-no-go-env",
+		"No `go.mod` file found and no Go version in environment",
+		msg,
+		severityNote,
+		telemetryOnly,
+		noLocation,
+	)
+}
+
+func EmitNoGoEnv(msg string) {
+	emitDiagnostic(
+		"go/autobuilder/env-no-go-env",
+		"No Go version in environment",
+		msg,
+		severityNote,
+		telemetryOnly,
+		noLocation,
+	)
+}
+
+func EmitNoGoMod(msg string) {
+	emitDiagnostic(
+		"go/autobuilder/env-no-go-mod",
+		"No `go.mod` file found",
+		msg,
+		severityNote,
+		telemetryOnly,
+		noLocation,
+	)
+}
+
+func EmitVersionGoModHigherVersionEnvironment(msg string) {
+	emitDiagnostic(
+		"go/autobuilder/env-version-go-mod-higher-than-go-env",
+		"The Go version in `go.mod` file is higher than the Go version in environment",
+		msg,
+		severityNote,
+		telemetryOnly,
+		noLocation,
+	)
+}
+
+func EmitVersionGoModNotHigherVersionEnvironment(msg string) {
+	emitDiagnostic(
+		"go/autobuilder/env-version-go-mod-lower-than-or-equal-to-go-env",
+		"The Go version in `go.mod` file is lower than or equal to the Go version in environment",
+		msg,
+		severityNote,
+		telemetryOnly,
+		noLocation,
+	)
+}

go/extractor/diagnostics/diagnostics.go

@@ -10,7 +10,6 @@ import (
 	"go/token"
 	"go/types"
 	"io"
-	"io/ioutil"
 	"log"
 	"os"
 	"path/filepath"
@@ -1807,7 +1806,7 @@ func extractNumLines(tw *trap.Writer, fileName string, ast *ast.File) {
 
 	// count lines of code by tokenizing
 	linesOfCode := 0
-	src, err := ioutil.ReadFile(fileName)
+	src, err := os.ReadFile(fileName)
 	if err != nil {
 		log.Fatalf("Unable to read file %s.", fileName)
 	}

go/extractor/extractor.go

@@ -2,13 +2,14 @@ package extractor
 
 import (
 	"fmt"
-	"golang.org/x/mod/modfile"
-	"io/ioutil"
+	"io"
 	"log"
 	"os"
 	"path/filepath"
 	"strings"
 
+	"golang.org/x/mod/modfile"
+
 	"github.com/github/codeql-go/extractor/dbscheme"
 	"github.com/github/codeql-go/extractor/srcarchive"
 	"github.com/github/codeql-go/extractor/trap"
@@ -45,7 +46,7 @@ func (extraction *Extraction) extractGoMod(path string) error {
 	if err != nil {
 		return fmt.Errorf("failed to open go.mod file %s: %s", path, err.Error())
 	}
-	data, err := ioutil.ReadAll(file)
+	data, err := io.ReadAll(file)
 	if err != nil {
 		return fmt.Errorf("failed to read go.mod file %s: %s", path, err.Error())
 	}

go/extractor/gomodextractor.go

@@ -1,13 +1,12 @@
 package srcarchive
 
 import (
-	"io/ioutil"
 	"os"
 	"testing"
 )
 
 func mkProjectLayout(projectLayoutSource string, t *testing.T) (*ProjectLayout, error) {
-	pt, err := ioutil.TempFile("", "path-transformer")
+	pt, err := os.CreateTemp("", "path-transformer")
 	if err != nil {
 		t.Fatalf("Unable to create temporary file for project layout: %s", err.Error())
 	}

go/extractor/srcarchive/projectlayout_test.go

@@ -7,7 +7,6 @@ import (
 	"fmt"
 	"go/ast"
 	"go/types"
-	"io/ioutil"
 	"os"
 	"path/filepath"
 	"unicode/utf8"
@@ -51,7 +50,7 @@ func NewWriter(path string, pkg *packages.Package) (*Writer, error) {
 	if err != nil {
 		return nil, err
 	}
-	tmpFile, err := ioutil.TempFile(trapFileDir, filepath.Base(trapFilePath))
+	tmpFile, err := os.CreateTemp(trapFileDir, filepath.Base(trapFilePath))
 	if err != nil {
 		return nil, err
 	}