Merge pull request Checkmarx#6809 from Dstklr/feature/add-platform-fi…

…eld-to-sarif-format feat(kics): add platform field to sarif format
liorj-orca · Dec 14, 2023 · 302f2ca · 302f2ca
2 parents f57c4a6 + 84360a0
commit 302f2ca
Show file tree

Hide file tree

Showing 4 changed files with 37 additions and 8 deletions.
diff --git a/e2e/fixtures/schemas/result-sarif-required.json b/e2e/fixtures/schemas/result-sarif-required.json
@@ -206,7 +206,15 @@
                                     ]
                                 },
                                 "message": {
-                                    "$ref": "#/definitions/text_object"
+                                  "type": "object",
+                                  "additionalProperties": true,
+                                  "required": ["text"],
+                                  "properties": {
+                                    "text": {
+                                      "type": "string",
+                                      "minLength": 1
+                                    }
+                                  }
                                 },
                                 "locations": {
                                     "type": "array",

diff --git a/e2e/fixtures/schemas/result-sarif.json b/e2e/fixtures/schemas/result-sarif.json
@@ -217,7 +217,15 @@
                                     ]
                                 },
                                 "message": {
-                                    "$ref": "#/definitions/text_object"
+                                  "type": "object",
+                                  "additionalProperties": true,
+                                  "required": ["text"],
+                                  "properties": {
+                                    "text": {
+                                      "type": "string",
+                                      "minLength": 1
+                                    }
+                                  }
                                 },
                                 "locations": {
                                     "type": "array",

diff --git a/pkg/report/model/sarif.go b/pkg/report/model/sarif.go
@@ -41,7 +41,8 @@ type ruleCISMetadata struct {
 }
 
 type sarifMessage struct {
-	Text string `json:"text"`
+	Text              string          `json:"text"`
+	MessageProperties sarifProperties `json:"properties,omitempty"`
 }
 
 type sarifComponentReference struct {
@@ -294,7 +295,10 @@ func (sr *sarifReport) BuildSarifIssue(issue *model.QueryResult) {
 				ResultRuleID:    issue.QueryID,
 				ResultRuleIndex: ruleIndex,
 				ResultKind:      kind,
-				ResultMessage:   sarifMessage{Text: issue.Files[idx].KeyActualValue},
+				ResultMessage: sarifMessage{
+					Text:              issue.Files[idx].KeyActualValue,
+					MessageProperties: sarifProperties{"platform": issue.Platform},
+				},
 				ResultLocations: []sarifLocation{
 					{
 						PhysicalLocation: sarifPhysicalLocation{

diff --git a/pkg/report/model/sarif_test.go b/pkg/report/model/sarif_test.go
@@ -89,7 +89,7 @@ var sarifTests = []sarifTest{
 							ResultRuleID:    "1",
 							ResultRuleIndex: 0,
 							ResultKind:      "fail",
-							ResultMessage:   sarifMessage{Text: "test"},
+							ResultMessage:   sarifMessage{Text: "test", MessageProperties: sarifProperties{"platform": ""}},
 							ResultLocations: []sarifLocation{
 								{
 									PhysicalLocation: sarifPhysicalLocation{
@@ -193,7 +193,10 @@ var sarifTests = []sarifTest{
 							ResultRuleID:    "1",
 							ResultRuleIndex: 0,
 							ResultKind:      "fail",
-							ResultMessage:   sarifMessage{Text: "test"},
+							ResultMessage: sarifMessage{
+								Text:              "test",
+								MessageProperties: sarifProperties{"platform": ""},
+							},
 							ResultLocations: []sarifLocation{
 								{
 									PhysicalLocation: sarifPhysicalLocation{
@@ -207,7 +210,10 @@ var sarifTests = []sarifTest{
 							ResultRuleID:    "1",
 							ResultRuleIndex: 0,
 							ResultKind:      "fail",
-							ResultMessage:   sarifMessage{Text: "test"},
+							ResultMessage: sarifMessage{
+								Text:              "test",
+								MessageProperties: sarifProperties{"platform": ""},
+							},
 							ResultLocations: []sarifLocation{
 								{
 									PhysicalLocation: sarifPhysicalLocation{
@@ -221,7 +227,10 @@ var sarifTests = []sarifTest{
 							ResultRuleID:    "2",
 							ResultRuleIndex: 1,
 							ResultKind:      "informational",
-							ResultMessage:   sarifMessage{Text: "test"},
+							ResultMessage: sarifMessage{
+								Text:              "test",
+								MessageProperties: sarifProperties{"platform": ""},
+							},
 							ResultLocations: []sarifLocation{
 								{
 									PhysicalLocation: sarifPhysicalLocation{