Merge pull request #57 from cultureamp/better-errors

fix: failure reasons display

.envrc

@@ -9,10 +9,12 @@
 
 # BUILDKITE_PLUGIN_ECR_SCAN_RESULTS_IMAGE_NAME is only specified in .envc.private
 
+export BUILDKITE_JOB_ID="JOB_ID"
+
 export BUILDKITE_PLUGIN_ECR_SCAN_RESULTS_MAX_CRITICALS=0
 export BUILDKITE_PLUGIN_ECR_SCAN_RESULTS_MAX_HIGHS=0
 
-export ECRSCANRESULTS_DISABLE_AGENT=true
+export ECR_SCAN_RESULTS_BUILDKITE_AGENT_TEST_MODE=true
 
 # load local values if specified
 source_env_if_exists .envrc.private

src/buildkite/agent.go

@@ -6,11 +6,12 @@ import (
 	"os"
 	"os/signal"
 	"strings"
-	"syscall"
 
 	osexec "golang.org/x/sys/execabs"
 )
 
+var AgentEnabled = true
+
 type Agent struct {
 }
 
@@ -26,7 +27,7 @@ func execCmd(ctx context.Context, executableName string, stdin *string, args ...
 	Logf("Executing: %s %s\n", executableName, strings.Join(args, " "))
 
 	// allow disabling the agent for local development purposes
-	if os.Getenv("ECRSCANRESULTS_DISABLE_AGENT") == "true" {
+	if !AgentEnabled {
 		return nil
 	}
 
@@ -58,8 +59,7 @@ func execCmd(ctx context.Context, executableName string, stdin *string, args ...
 		return fmt.Errorf("failed to wait for command termination: %w", err)
 	}
 
-	waitStatus := cmd.ProcessState.Sys().(syscall.WaitStatus)
-	exitStatus := waitStatus.ExitStatus()
+	exitStatus := cmd.ProcessState.ExitCode()
 	if exitStatus != 0 {
 		return fmt.Errorf("command exited with non-zero status: %d", exitStatus)
 	}

src/finding/summary.go

@@ -1,6 +1,8 @@
 package finding
 
 import (
+	"errors"
+	"fmt"
 	"net/url"
 	"regexp"
 	"slices"
@@ -154,6 +156,18 @@ func (s Summary) ThresholdsExceeded(criticalThreshold int32, highThreshold int32
 	return overThreshold
 }
 
+// FailureReasons returns a single error that contains the set of failures for
+// all platforms.
+func (s Summary) FailureReasons() error {
+	reasons := make([]error, len(s.FailedPlatforms))
+
+	for i, f := range s.FailedPlatforms {
+		reasons[i] = fmt.Errorf("(%s/%s) %s", f.Platform.OS, f.Platform.Architecture, f.Reason)
+	}
+
+	return errors.Join(reasons...)
+}
+
 // includedCountFor returns the number of findings that count towards the
 // threshold for the given severity, returning 0 if there are no counts for the
 // given severity value.

src/main.go

@@ -7,6 +7,7 @@ import (
 	"errors"
 	"fmt"
 	"io/fs"
+	"net/url"
 	"os"
 	"strings"
 
@@ -21,19 +22,19 @@ import (
 	"github.com/sourcegraph/conc/iter"
 )
 
-const pluginEnvironmentPrefix = "BUILDKITE_PLUGIN_ECR_SCAN_RESULTS"
-
 type Config struct {
-	Repository                string `envconfig:"IMAGE_NAME" split_words:"true" required:"true"`
-	ImageLabel                string `envconfig:"IMAGE_LABEL" split_words:"true"`
-	CriticalSeverityThreshold int32  `envconfig:"MAX_CRITICALS" split_words:"true"`
-	HighSeverityThreshold     int32  `envconfig:"MAX_HIGHS" split_words:"true"`
+	AgentTestMode             bool   `envconfig:"ECR_SCAN_RESULTS_BUILDKITE_AGENT_TEST_MODE" split_words:"true"`
+	JobID                     string `envconfig:"BUILDKITE_JOB_ID" split_words:"true" required:"true"`
+	Repository                string `envconfig:"BUILDKITE_PLUGIN_ECR_SCAN_RESULTS_IMAGE_NAME" split_words:"true" required:"true"`
+	ImageLabel                string `envconfig:"BUILDKITE_PLUGIN_ECR_SCAN_RESULTS_IMAGE_LABEL" split_words:"true"`
+	CriticalSeverityThreshold int32  `envconfig:"BUILDKITE_PLUGIN_ECR_SCAN_RESULTS_MAX_CRITICALS" split_words:"true"`
+	HighSeverityThreshold     int32  `envconfig:"BUILDKITE_PLUGIN_ECR_SCAN_RESULTS_MAX_HIGHS" split_words:"true"`
 	FailBuildOnPluginFailure  bool   `envconfig:"FAIL_BUILD_ON_PLUGIN_FAILURE" default:"false"`
 }
 
 func main() {
 	var pluginConfig Config
-	if err := envconfig.Process(pluginEnvironmentPrefix, &pluginConfig); err != nil {
+	if err := envconfig.Process("", &pluginConfig); err != nil {
 		buildkite.LogFailuref("plugin configuration error: %s\n", err.Error())
 		os.Exit(1)
 	}
@@ -46,6 +47,8 @@ func main() {
 		os.Exit(1)
 	}
 
+	buildkite.AgentEnabled = !pluginConfig.AgentTestMode
+
 	ctx := context.Background()
 	agent := buildkite.Agent{}
 
@@ -63,7 +66,10 @@ func main() {
 			// Attempt to annotate the build with the issue, but it's OK if the
 			// annotation fails. We annotate to notify the user of the issue,
 			// otherwise it would be lost in the log.
-			annotation := fmt.Sprintf("ECR scan results plugin could not create a result for the image %s", "")
+			annotation := fmt.Sprintf("ECR scan results plugin [could not create a result](%s) for the image: `%s`",
+				"#"+url.QueryEscape(pluginConfig.JobID),
+				pluginConfig.Repository,
+			)
 			_ = agent.Annotate(ctx, annotation, "error", hash(pluginConfig.Repository))
 		}
 	}
@@ -148,7 +154,7 @@ func runCommand(ctx context.Context, pluginConfig Config, agent buildkite.Agent)
 		// builds are only blocked if thresholds are exceeded. When only some
 		// platforms have failed, the report will include details of the partial
 		// failure.
-		return runtimeerrors.NonFatal("no scan results could be retrieved", nil)
+		return runtimeerrors.NonFatal("no scan results could be retrieved", findingSummary.FailureReasons())
 	}
 
 	criticalFindings, highFindings := findingSummary.IncludedCounts()