Merge pull request #386 from smowton/smowton/admin/improve-error-messages

smowton · web-flow · commit e9278b54771d · 2020-10-23T08:27:03.000+01:00
Improve error messages
diff --git a/extractor/cli/go-autobuilder/go-autobuilder.go b/extractor/cli/go-autobuilder/go-autobuilder.go
@@ -216,7 +216,7 @@ func getOsToolsSubdir() (string, error) {
 	case "windows":
 		return "win64", nil
 	}
-	return "", errors.New("Unknown OS: " + runtime.GOOS)
+	return "", errors.New("Unsupported OS: " + runtime.GOOS)
 }
 
 func getExtractorDir() (string, error) {
@@ -229,7 +229,7 @@ func getExtractorDir() (string, error) {
 	// Fall back to rebuilding our own path from the extractor root:
 	extractorRoot := os.Getenv("CODEQL_EXTRACTOR_GO_ROOT")
 	if extractorRoot == "" {
-		return "", errors.New("CODEQL_EXTRACTOR_GO_ROOT not set")
+		return "", errors.New("CODEQL_EXTRACTOR_GO_ROOT not set.\nThis binary should not be run manually; instead, use the CodeQL CLI or VSCode extension. See https://securitylab.github.com/tools/codeql")
 	}
 
 	osSubdir, err := getOsToolsSubdir()

Original file line number	Diff line number	Diff line change
`@@ -216,7 +216,7 @@ func getOsToolsSubdir() (string, error) {`
`216`	`216`	`case "windows":`
`217`	`217`	`return "win64", nil`
`218`	`218`	`}`
`219`		`- return "", errors.New("Unknown OS: " + runtime.GOOS)`
	`219`	`+ return "", errors.New("Unsupported OS: " + runtime.GOOS)`
`220`	`220`	`}`
`221`	`221`
`222`	`222`	`func getExtractorDir() (string, error) {`
`@@ -229,7 +229,7 @@ func getExtractorDir() (string, error) {`
`229`	`229`	`// Fall back to rebuilding our own path from the extractor root:`
`230`	`230`	`extractorRoot := os.Getenv("CODEQL_EXTRACTOR_GO_ROOT")`
`231`	`231`	`if extractorRoot == "" {`
`232`		`- return "", errors.New("CODEQL_EXTRACTOR_GO_ROOT not set")`
	`232`	`+ return "", errors.New("CODEQL_EXTRACTOR_GO_ROOT not set.\nThis binary should not be run manually; instead, use the CodeQL CLI or VSCode extension. See https://securitylab.github.com/tools/codeql")`
`233`	`233`	`}`
`234`	`234`
`235`	`235`	`osSubdir, err := getOsToolsSubdir()`