Merge pull request #44 from charlieegan3/surface-violations-in-report-json

Surface violations in report JSON

Author: jetstack-bot

api/report.go

@@ -62,6 +62,8 @@ type ReportRule struct {
 	Success bool `json:"success"`
 	// Value contains the raw result of the check.
 	Value interface{} `json:"value,omitempty"`
+	// Violations contains the list of messages from the execution of the check
+	Violations interface{} `json:"violations,omitempty"`
 	// Missing indicates whether the Rego rule was missing or not.
 	Missing bool `json:"missing"`
 }

pkg/exporter/json.go

@@ -51,6 +51,7 @@ func (e *JSONExporter) Export(ctx context.Context, policyManifest *packaging.Pol
 			results := rc.ByID()
 			result := results[ruleToResult(rule.ID)]
 			var value interface{}
+			violations := []string{}
 			success := false
 			missing := false
 
@@ -59,6 +60,7 @@ func (e *JSONExporter) Export(ctx context.Context, policyManifest *packaging.Pol
 				missing = true
 			case result.IsFailureState():
 				success = false
+				violations = result.Violations
 			case result.IsSuccessState():
 				success = true
 			default:
@@ -72,6 +74,7 @@ func (e *JSONExporter) Export(ctx context.Context, policyManifest *packaging.Pol
 				Manual:      rule.Manual,
 				Remediation: rule.Remediation,
 				Links:       links,
+				Violations:  violations,
 				Success:     success,
 				Value:       value,
 				Missing:     missing,

pkg/exporter/json_test.go

@@ -85,6 +85,7 @@ func TestJSONExport(t *testing.T) {
         {
           "missing": false,
           "success": true,
+          "violations": [],
           "links": [
             "http://jetstack.io/docs",
             "http://jetstack.io/docs2"
@@ -97,6 +98,9 @@ func TestJSONExport(t *testing.T) {
         {
           "missing": false,
           "success": false,
+          "violations": [
+            "violation"
+          ],
           "links": [
             "http://jetstack.io/docs",
             "http://jetstack.io/docs2"
@@ -116,6 +120,7 @@ func TestJSONExport(t *testing.T) {
         {
           "missing": true,
           "success": false,
+          "violations": [],
           "links": [
             "http://jetstack.io/docs",
             "http://jetstack.io/docs2"