Add tests for Value

If Violations are set, this is preferred. Otherwise attempt to parse value and maintain old behavior

Signed-off-by: Charlie Egan <[email protected]>

Author: charlieegan3

pkg/results/results.go

@@ -25,14 +25,32 @@ type Result struct {
 
 // IsSuccessState returns true if Value is boolean and it is true.
 func (r *Result) IsSuccessState() bool {
+	if r.Violations != nil {
+		return len(r.Violations) == 0
+	}
+
 	success, ok := r.Value.(bool)
-	return len(r.Violations) == 0 || (ok && success)
+	if ok {
+		log.Println("Using a boolean for `Value` is deprecated")
+		return success
+	} else {
+		return false
+	}
 }
 
 // IsFailureState returns true if Value is boolean and it is false.
 func (r *Result) IsFailureState() bool {
+	if r.Violations != nil {
+		return len(r.Violations) != 0
+	}
+
 	success, ok := r.Value.(bool)
-	return len(r.Violations) != 0 || (ok && !success)
+	if ok {
+		log.Println("Using a boolean for `Value` is deprecated")
+		return !success
+	} else {
+		return false
+	}
 }
 
 // ResultCollection is a collection of Result
@@ -120,6 +138,7 @@ func NewResultCollectionFromRegoResultSet(rs *rego.ResultSet) (*ResultCollection
 		}
 		rc = append(rc, &Result{
 			ID:         k,
+			Value:      violations,
 			Violations: violations,
 			Package:    pkg,
 		})

pkg/results/results_test.go

@@ -29,6 +29,28 @@ func TestIsSuccessState(t *testing.T) {
 	}
 }
 
+func TestIsSuccessStateWithLegacyValueResult(t *testing.T) {
+	testCases := []struct {
+		result *Result
+		want   bool
+	}{
+		{&Result{ID: "1", Value: ""}, false},
+		{&Result{ID: "2", Value: "aaa"}, false},
+		{&Result{ID: "3", Value: []interface{}{}}, false},
+		{&Result{ID: "4", Value: []string{"aaa"}}, false},
+		{&Result{ID: "5", Value: true}, true},
+		{&Result{ID: "6", Value: false}, false},
+	}
+
+	for idx, tc := range testCases {
+		t.Run(string(idx), func(t *testing.T) {
+			if got, want := tc.result.IsSuccessState(), tc.want; got != want {
+				t.Fatalf("got!=want: got=%v, want=%v", got, want)
+			}
+		})
+	}
+}
+
 func TestIsFailureState(t *testing.T) {
 	testCases := []struct {
 		result *Result
@@ -48,6 +70,28 @@ func TestIsFailureState(t *testing.T) {
 	}
 }
 
+func TestIsFailureStateWithLegacyValueResult(t *testing.T) {
+	testCases := []struct {
+		result *Result
+		want   bool
+	}{
+		{&Result{ID: "1", Value: ""}, false},
+		{&Result{ID: "2", Value: "aaa"}, false},
+		{&Result{ID: "3", Value: []interface{}{}}, false},
+		{&Result{ID: "4", Value: []string{"aaa"}}, false},
+		{&Result{ID: "5", Value: true}, false},
+		{&Result{ID: "6", Value: false}, true},
+	}
+
+	for idx, tc := range testCases {
+		t.Run(string(idx), func(t *testing.T) {
+			if got, want := tc.result.IsFailureState(), tc.want; got != want {
+				t.Fatalf("got!=want: got=%v, want=%v", got, want)
+			}
+		})
+	}
+}
+
 func TestNewResultCollectionFromRegoResultSet(t *testing.T) {
 	err1 := "ResultSet does not contain 1 exact element"
 	err2 := "'expressions' does not contain exactly 1 element"
@@ -104,12 +148,12 @@ func TestNewResultCollectionFromRegoResultSet(t *testing.T) {
 		}
 
 		expectedResults := []*Result{
-			&Result{ID: "_1_4_3", Violations: []string{}, Package: "package.name"},
-			&Result{ID: "_1_4_4", Violations: []string{"violation"}, Package: "package.name"},
-			&Result{ID: "_1_4_5", Violations: []string{}, Package: "package.name"},
-			&Result{ID: "_1_4_6", Violations: []string{}, Package: "package.name"},
-			&Result{ID: "node_pools_with_legacy_endpoints_enabled", Violations: []string{}, Package: "package.name"},
-			&Result{ID: "node_pools_without_cloud_platform_scope", Violations: []string{"violation"}, Package: "package.name"},
+			&Result{ID: "_1_4_3", Value: []string{}, Violations: []string{}, Package: "package.name"},
+			&Result{ID: "_1_4_4", Value: []string{"violation"}, Violations: []string{"violation"}, Package: "package.name"},
+			&Result{ID: "_1_4_5", Value: []string{}, Violations: []string{}, Package: "package.name"},
+			&Result{ID: "_1_4_6", Value: []string{}, Violations: []string{}, Package: "package.name"},
+			&Result{ID: "node_pools_with_legacy_endpoints_enabled", Value: []string{}, Violations: []string{}, Package: "package.name"},
+			&Result{ID: "node_pools_without_cloud_platform_scope", Value: []string{"violation"}, Violations: []string{"violation"}, Package: "package.name"},
 		}
 
 		rc, err := NewResultCollectionFromRegoResultSet(regoResultSet)