refactor(output): Add CheckResults type and helpers (open-policy-agen…

…t#1063)

Adding a new type for a slice of CheckResult to add helper methods for
checking if there were failures, warnings, or exceptions.

Signed-off-by: James Alseth <[email protected]>

internal/commands/test.go

@@ -132,11 +132,9 @@ func NewTestCommand(ctx context.Context) *cobra.Command {
 				return fmt.Errorf("running test: %w", err)
 			}
 
-			var exitCode int
+			exitCode := results.ExitCode()
 			if runner.FailOnWarn {
-				exitCode = output.ExitCodeFailOnWarn(results)
-			} else {
-				exitCode = output.ExitCode(results)
+				exitCode = results.ExitCodeFailOnWarn()
 			}
 
 			if !runner.Quiet || exitCode != 0 {

internal/commands/verify.go

@@ -102,7 +102,7 @@ func NewVerifyCommand(ctx context.Context) *cobra.Command {
 				return fmt.Errorf("running verification: %w", err)
 			}
 
-			exitCode := output.ExitCode(results)
+			exitCode := results.ExitCode()
 			if !runner.Quiet || exitCode != 0 {
 				outputter := output.Get(runner.Output, output.Options{
 					NoColor:          runner.NoColor,

output/azuredevops.go

@@ -24,7 +24,7 @@ func NewAzureDevOps(w io.Writer) *AzureDevOps {
 }
 
 // Output outputs the results.
-func (t *AzureDevOps) Output(checkResults []CheckResult) error {
+func (t *AzureDevOps) Output(checkResults CheckResults) error {
 	var totalFailures int
 	var totalExceptions int
 	var totalWarnings int

output/azuredevops_test.go

@@ -9,12 +9,12 @@ import (
 func TestAzureDevOps(t *testing.T) {
 	tests := []struct {
 		name     string
-		input    []CheckResult
+		input    CheckResults
 		expected []string
 	}{
 		{
 			name: "no warnings or errors",
-			input: []CheckResult{
+			input: CheckResults{
 				{
 					FileName:  "examples/kubernetes/service.yaml",
 					Namespace: "namespace",
@@ -30,7 +30,7 @@ func TestAzureDevOps(t *testing.T) {
 		},
 		{
 			name: "records failure and warnings",
-			input: []CheckResult{
+			input: CheckResults{
 				{
 					FileName:  "examples/kubernetes/service.yaml",
 					Namespace: "namespace",
@@ -50,7 +50,7 @@ func TestAzureDevOps(t *testing.T) {
 		},
 		{
 			name: "mixed failure, warnings and skipped",
-			input: []CheckResult{
+			input: CheckResults{
 				{
 					FileName:  "examples/kubernetes/service.yaml",
 					Namespace: "namespace",
@@ -70,7 +70,7 @@ func TestAzureDevOps(t *testing.T) {
 		},
 		{
 			name: "handles stdin input",
-			input: []CheckResult{
+			input: CheckResults{
 				{
 					FileName:  "-",
 					Namespace: "namespace",

output/github.go

@@ -24,7 +24,7 @@ func NewGitHub(w io.Writer) *GitHub {
 }
 
 // Output outputs the results.
-func (t *GitHub) Output(checkResults []CheckResult) error {
+func (t *GitHub) Output(checkResults CheckResults) error {
 	var totalFailures int
 	var totalExceptions int
 	var totalWarnings int

output/github_test.go

@@ -9,12 +9,12 @@ import (
 func TestGitHub(t *testing.T) {
 	tests := []struct {
 		name     string
-		input    []CheckResult
+		input    CheckResults
 		expected []string
 	}{
 		{
 			name: "no warnings or errors",
-			input: []CheckResult{
+			input: CheckResults{
 				{
 					FileName:  "examples/kubernetes/service.yaml",
 					Namespace: "namespace",
@@ -29,7 +29,7 @@ func TestGitHub(t *testing.T) {
 		},
 		{
 			name: "records failure and warnings",
-			input: []CheckResult{
+			input: CheckResults{
 				{
 					FileName:  "examples/kubernetes/service.yaml",
 					Namespace: "namespace",
@@ -48,7 +48,7 @@ func TestGitHub(t *testing.T) {
 		},
 		{
 			name: "mixed failure, warnings and skipped",
-			input: []CheckResult{
+			input: CheckResults{
 				{
 					FileName:  "examples/kubernetes/service.yaml",
 					Namespace: "namespace",
@@ -67,7 +67,7 @@ func TestGitHub(t *testing.T) {
 		},
 		{
 			name: "handles stdin input",
-			input: []CheckResult{
+			input: CheckResults{
 				{
 					FileName:  "-",
 					Namespace: "namespace",

output/json.go

@@ -25,7 +25,7 @@ func NewJSON(w io.Writer) *JSON {
 }
 
 // Output outputs the results.
-func (j *JSON) Output(results []CheckResult) error {
+func (j *JSON) Output(results CheckResults) error {
 	for r := range results {
 		if results[r].FileName == "-" {
 			results[r].FileName = ""

output/json_test.go

@@ -9,12 +9,12 @@ import (
 func TestJSON(t *testing.T) {
 	tests := []struct {
 		name     string
-		input    []CheckResult
+		input    CheckResults
 		expected []string
 	}{
 		{
 			name: "No warnings or errors",
-			input: []CheckResult{
+			input: CheckResults{
 				{
 					FileName:  "examples/kubernetes/service.yaml",
 					Namespace: "namespace",
@@ -33,7 +33,7 @@ func TestJSON(t *testing.T) {
 		},
 		{
 			name: "A single failure",
-			input: []CheckResult{
+			input: CheckResults{
 				{
 					FileName:  "examples/kubernetes/service.yaml",
 					Namespace: "namespace",
@@ -58,7 +58,7 @@ func TestJSON(t *testing.T) {
 		},
 		{
 			name: "A warning, a failure and a skipped test",
-			input: []CheckResult{
+			input: CheckResults{
 				{
 					FileName:  "examples/kubernetes/service.yaml",
 					Namespace: "namespace",
@@ -95,7 +95,7 @@ func TestJSON(t *testing.T) {
 		},
 		{
 			name: "Renames standard input file name to empty string",
-			input: []CheckResult{
+			input: CheckResults{
 				{
 					FileName:  "-",
 					Namespace: "namespace",
@@ -120,7 +120,7 @@ func TestJSON(t *testing.T) {
 		},
 		{
 			name: "Multiple files",
-			input: []CheckResult{
+			input: CheckResults{
 				{FileName: "examples/kubernetes/service.yaml", Namespace: "namespace"},
 				{FileName: "examples/kubernetes/deployment.yaml", Namespace: "namespace"},
 			},

output/junit.go

@@ -29,7 +29,7 @@ func NewJUnit(w io.Writer, hideMessage bool) *JUnit {
 }
 
 // Output outputs the results.
-func (j *JUnit) Output(results []CheckResult) error {
+func (j *JUnit) Output(results CheckResults) error {
 	namespaceTests := make(map[string][]*parser.Test)
 	for _, result := range results {
 		ns := result.Namespace

output/junit_test.go

@@ -11,13 +11,13 @@ import (
 func TestJUnit(t *testing.T) {
 	tests := []struct {
 		name        string
-		input       []CheckResult
+		input       CheckResults
 		hideMessage bool
 		expected    []string
 	}{
 		{
 			name: "No warnings or failures",
-			input: []CheckResult{
+			input: CheckResults{
 				{
 					FileName:  "examples/kubernetes/service.yaml",
 					Namespace: "namespace",
@@ -31,7 +31,7 @@ func TestJUnit(t *testing.T) {
 		},
 		{
 			name: "A warning, a failure and a skipped test",
-			input: []CheckResult{
+			input: CheckResults{
 				{
 					FileName:  "examples/kubernetes/service.yaml",
 					Namespace: "namespace",
@@ -63,7 +63,7 @@ func TestJUnit(t *testing.T) {
 		},
 		{
 			name: "Failure with a long description",
-			input: []CheckResult{
+			input: CheckResults{
 				{
 					FileName:  "examples/kubernetes/service.yaml",
 					Namespace: "namespace",
@@ -90,7 +90,7 @@ This is the rest of the description of the failed test`}},
 		{
 			name:        "Failure with --junit-hide-message set",
 			hideMessage: true,
-			input: []CheckResult{
+			input: CheckResults{
 				{
 					FileName:  "examples/kubernetes/service.yaml",
 					Namespace: "namespace",

output/output.go

@@ -9,7 +9,7 @@ import (
 // Outputter controls how results of an evaluation will
 // be recorded and reported to the end user.
 type Outputter interface {
-	Output([]CheckResult) error
+	Output(CheckResults) error
 	Report([]*tester.Result, string) error
 }
 

output/result.go

@@ -1,6 +1,9 @@
 package output
 
-import "fmt"
+import (
+	"fmt"
+	"slices"
+)
 
 // Result describes the result of a single rule evaluation.
 type Result struct {
@@ -85,46 +88,67 @@ type CheckResult struct {
 	Queries    []QueryResult `json:"queries,omitempty"`
 }
 
+// HasFailure returns true if any failures were encountered.
+func (cr CheckResult) HasFailure() bool {
+	return len(cr.Failures) > 0
+}
+
+// HasWarning returns true if any warnings were encountered.
+func (cr CheckResult) HasWarning() bool {
+	return len(cr.Warnings) > 0
+}
+
+// HasException returns true if any exceptions were encountered.
+func (cr CheckResult) HasException() bool {
+	return len(cr.Exceptions) > 0
+}
+
+// OnlySuccess returns true if there are no failures, warnings, or exceptions.
+func (cr CheckResult) OnlySuccess() bool {
+	return len(cr.Failures) == 0 && len(cr.Warnings) == 0 && len(cr.Exceptions) == 0
+}
+
+// CheckResults is a slice of CheckResult.
+type CheckResults []CheckResult
+
+// HasFailure returns true if any of the checks in the list has a failure.
+func (cr CheckResults) HasFailure() bool {
+	return slices.ContainsFunc(cr, func(x CheckResult) bool { return x.HasFailure() })
+}
+
+// HasWarning returns true if any of the checks in the list has a warning.
+func (cr CheckResults) HasWarning() bool {
+	return slices.ContainsFunc(cr, func(x CheckResult) bool { return x.HasWarning() })
+}
+
+// HasException returns true if any of the checks in the list has an exception.
+func (cr CheckResults) HasException() bool {
+	return slices.ContainsFunc(cr, func(x CheckResult) bool { return x.HasException() })
+}
+
+// OnlySuccess returns true if all of the checks have only success messages.
+func (cr CheckResults) OnlySuccess() bool {
+	return !slices.ContainsFunc(cr, func(x CheckResult) bool { return !x.OnlySuccess() })
+}
+
 // ExitCode returns the exit code that should be returned
 // given all of the returned results.
-func ExitCode(results []CheckResult) int {
-	var hasFailure bool
-	for _, result := range results {
-		if len(result.Failures) > 0 {
-			hasFailure = true
-		}
-	}
-
-	if hasFailure {
+func (cr CheckResults) ExitCode() int {
+	if cr.HasFailure() {
 		return 1
 	}
-
 	return 0
 }
 
 // ExitCodeFailOnWarn returns the exit code that should be returned
 // given all of the returned results, and will consider warnings
 // as failures.
-func ExitCodeFailOnWarn(results []CheckResult) int {
-	var hasFailure bool
-	var hasWarning bool
-	for _, result := range results {
-		if len(result.Failures) > 0 {
-			hasFailure = true
-		}
-
-		if len(result.Warnings) > 0 {
-			hasWarning = true
-		}
-	}
-
-	if hasFailure {
+func (cr CheckResults) ExitCodeFailOnWarn() int {
+	if cr.HasFailure() {
 		return 2
 	}
-
-	if hasWarning {
+	if cr.HasWarning() {
 		return 1
 	}
-
 	return 0
 }