Emit diagnostic to pass first integration test

Author: owen-mc

go/extractor/diagnostics/diagnostics.go

@@ -0,0 +1,103 @@
+package diagnostics
+
+import (
+	"encoding/json"
+	"log"
+	"os"
+	"time"
+)
+
+type sourceStruct struct {
+	Id            string `json:"id"`
+	Name          string `json:"name"`
+	ExtractorName string `json:"extractorName"`
+}
+
+type diagnosticSeverity string
+
+const (
+	severityError   diagnosticSeverity = "error"
+	severityWarning diagnosticSeverity = "warning"
+	severityNote    diagnosticSeverity = "note"
+)
+
+type visibilityStruct struct {
+	StatusPage      bool `json:"statusPage"`      // True if the message should be displayed on the status page (defaults to false)
+	CliSummaryTable bool `json:"cliSummaryTable"` // True if the message should be counted in the diagnostics summary table printed by `codeql database analyze` (defaults to false)
+	Telemetry       bool `json:"telemetry"`       // True if the message should be sent to telemetry (defaults to false)
+}
+
+type locationStruct struct {
+	File        string `json:"file,omitempty"`
+	StartLine   int    `json:"startLine,omitempty"`
+	StartColumn int    `json:"startColumn,omitempty"`
+	EndLine     int    `json:"endLine,omitempty"`
+	EndColumn   int    `json:"endColumn,omitempty"`
+}
+
+type diagnostic struct {
+	Timestamp       string           `json:"timestamp"`
+	Source          sourceStruct     `json:"source"`
+	MarkdownMessage string           `json:"markdownMessage"`
+	Severity        string           `json:"severity"`
+	Internal        bool             `json:"internal"`
+	Visibility      visibilityStruct `json:"visibility"`
+	Location        *locationStruct  `json:"location,omitempty"` // Use a pointer so that it is omitted if nil
+}
+
+var diagnosticsEmitted, diagnosticsLimit uint = 0, 100
+
+func emitDiagnostic(sourceid, sourcename, markdownMessage string, severity diagnosticSeverity, internal, visibilitySP, visibilityCST, visibilityT bool, file string, startLine, startColumn, endLine, endColumn int) {
+	if diagnosticsEmitted <= diagnosticsLimit {
+		diagnosticsEmitted += 1
+
+		diagnosticDir := os.Getenv("CODEQL_EXTRACTOR_GO_DIAGNOSTIC_DIR")
+		if diagnosticDir == "" {
+			log.Println("No diagnostic directory set, so not emitting diagnostic")
+			return
+		}
+
+		var optLoc *locationStruct
+		if file == "" && startLine == 0 && startColumn == 0 && endLine == 0 && endColumn == 0 {
+			optLoc = nil
+		} else {
+			optLoc = &locationStruct{file, startLine, startColumn, endLine, endColumn}
+		}
+		d := diagnostic{
+			time.Now().UTC().Format("2006-01-02T15:04:05.000") + "Z",
+			sourceStruct{sourceid, sourcename, "go"},
+			markdownMessage,
+			string(severity),
+			internal,
+			visibilityStruct{visibilitySP, visibilityCST, visibilityT},
+			optLoc,
+		}
+
+		content, err := json.Marshal(d)
+		if err != nil {
+			log.Println(err)
+		}
+
+		targetFile, err := os.CreateTemp(diagnosticDir, "go-extractor.*.jsonl")
+		if err != nil {
+			log.Println("Failed to create temporary file for diagnostic: ")
+			log.Println(err)
+		}
+		defer targetFile.Close()
+
+		_, err = targetFile.Write(content)
+		if err != nil {
+			log.Fatal(err)
+		}
+	}
+}
+
+func EmitPackageDifferentOSArchitecture(pkgPath string) {
+	emitDiagnostic("go/extractor/package-different-os-architecture",
+		"Package "+pkgPath+" is intended for a different OS or architecture",
+		"Make sure the `GOOS` and `GOARCH` [environment variables are correctly set](https://docs.github.com/en/actions/learn-github-actions/variables#defining-environment-variables-for-a-single-workflow). Alternatively, [change your OS and architecture](https://docs.github.com/en/actions/using-github-hosted-runners/about-github-hosted-runners#using-a-github-hosted-runner)",
+		severityWarning, false,
+		true, true, true,
+		"", 0, 0, 0, 0,
+	)
+}

go/extractor/extractor.go

@@ -22,6 +22,7 @@ import (
 	"time"
 
 	"github.com/github/codeql-go/extractor/dbscheme"
+	"github.com/github/codeql-go/extractor/diagnostics"
 	"github.com/github/codeql-go/extractor/srcarchive"
 	"github.com/github/codeql-go/extractor/trap"
 	"github.com/github/codeql-go/extractor/util"
@@ -144,7 +145,14 @@ func ExtractWithFlags(buildFlags []string, patterns []string) error {
 		if len(pkg.Errors) != 0 {
 			log.Printf("Warning: encountered errors extracting package `%s`:", pkg.PkgPath)
 			for i, err := range pkg.Errors {
-				log.Printf("  %s", err.Error())
+				errString := err.Error()
+				log.Printf("  %s", errString)
+
+				if strings.Contains(errString, "build constraints exclude all Go files in ") {
+					// `err` is a NoGoError from the package cmd/go/internal/load, which we cannot access as it is internal
+					diagnostics.EmitPackageDifferentOSArchitecture(pkg.PkgPath)
+				}
+
 				extraction.extractError(tw, err, lbl, i)
 			}
 		}