Merge pull request #11 from DataDog/bahar.shah/BFO-330

[BFO-330] Remove taxonomy, move category, fix 0-based indexing
DataDog · Aug 14, 2024 · abb34bd · abb34bd
2 parents d0de812 + a1a8cfb
commit abb34bd
Show file tree

Hide file tree

Showing 3 changed files with 33 additions and 22 deletions.
diff --git a/pkg/report/model/sarif.go b/pkg/report/model/sarif.go
@@ -219,7 +219,7 @@ type sarifTaxonomy struct {
 type SarifRun struct {
 	Tool       sarifTool       `json:"tool"`
 	Results    []sarifResult   `json:"results"`
-	Taxonomies []sarifTaxonomy `json:"taxonomies"`
+	Taxonomies []sarifTaxonomy `json:"taxonomies,omitempty"`
 }
 
 // SarifReport represents a usable sarif report reference
@@ -243,6 +243,7 @@ const (
 	diffAwareFileTag         = "DATADOG_DIFF_AWARE_FILE:%s"
 	executionTimeTag         = "DATADOG_EXECUTION_TIME_SECS:%v"
 	ruleTypeProperty         = "DATADOG_RULE_TYPE:IAC_SCANNING"
+	categoryTag              = "DATADOG_CATEGORY:%s"
 )
 
 func initSarifTool() sarifTool {
@@ -360,9 +361,9 @@ func initSarifTaxonomies() []sarifTaxonomy {
 func initSarifRun() []SarifRun {
 	return []SarifRun{
 		{
-			Tool:       initSarifTool(),
-			Results:    make([]sarifResult, 0),
-			Taxonomies: initSarifTaxonomies(),
+			Tool:    initSarifTool(),
+			Results: make([]sarifResult, 0),
+			// Taxonomies: initSarifTaxonomies(),
 		},
 	}
 }
@@ -538,32 +539,34 @@ func (sr *sarifReport) buildSarifRule(queryMetadata *ruleMetadata, cisMetadata r
 			helpURI = queryMetadata.queryURI
 		}
 
-		target := sr.buildSarifCategory(queryMetadata.queryCategory)
-		cwe := sr.buildCweCategory(queryMetadata.queryCwe)
+		// target := sr.buildSarifCategory(queryMetadata.queryCategory)
+		// cwe := sr.buildCweCategory(queryMetadata.queryCwe)
 
-		var relationships []sarifRelationship
+		categoryTag := GetCategoryTag(queryMetadata.queryCategory)
 
-		if cwe.ReferenceID != "" {
-			relationships = []sarifRelationship{
-				{Relationship: target},
-				{Relationship: cwe},
-			}
-		} else {
-			relationships = []sarifRelationship{
-				{Relationship: target},
-			}
-		}
+		// var relationships []sarifRelationship
+
+		// if cwe.ReferenceID != "" {
+		// 	relationships = []sarifRelationship{
+		// 		{Relationship: target},
+		// 		{Relationship: cwe},
+		// 	}
+		// } else {
+		// 	relationships = []sarifRelationship{
+		// 		{Relationship: target},
+		// 	}
+		// }
 
 		rule := sarifRule{
 			RuleID:               queryMetadata.queryID,
 			RuleName:             queryMetadata.queryName,
 			RuleShortDescription: sarifMessage{Text: queryMetadata.queryName},
 			RuleFullDescription:  sarifMessage{Text: queryMetadata.queryDescription},
 			DefaultConfiguration: sarifConfiguration{Level: severityLevelEquivalence[queryMetadata.severity]},
-			Relationships:        relationships,
-			HelpURI:              helpURI,
+			// Relationships:        relationships,
+			HelpURI: helpURI,
 			RuleProperties: sarifProperties{
-				"tags": []string{ruleTypeProperty},
+				"tags": []string{ruleTypeProperty, categoryTag},
 			},
 		}
 		if cisMetadata.id != "" {
@@ -643,6 +646,10 @@ func (sr *sarifReport) BuildSarifIssue(issue *model.QueryResult) string {
 				Line: resourceLocation.ResourceStart.Line,
 				Col:  resourceLocation.ResourceStart.Col,
 			}
+
+			if startLocation.Col < 1 {
+				startLocation.Col = 1
+			}
 			// endLocation := sarifResourceLocation{
 			// 	Line: resourceLocation.ResourceEnd.Line,
 			// 	Col:  resourceLocation.ResourceEnd.Col,
@@ -667,7 +674,7 @@ func (sr *sarifReport) BuildSarifIssue(issue *model.QueryResult) string {
 								StartLine:   line,
 								EndLine:     line + 1,
 								StartColumn: startLocation.Col,
-								EndColumn:   0,
+								EndColumn:   1,
 								// StartResource: startLocation,
 								// EndResource:   endLocation,
 							},

diff --git a/pkg/report/model/utils.go b/pkg/report/model/utils.go
@@ -32,3 +32,7 @@ func GetDiffAwareBaseShaTag(diffAware model.DiffAware) string {
 func GetDiffAwareFilesTag(diffAware model.DiffAware) string {
 	return fmt.Sprintf(diffAwareFileTag, diffAware.Files)
 }
+
+func GetCategoryTag(category string) string {
+	return fmt.Sprintf(categoryTag, category)
+}
diff --git a/pkg/report/sarif.go b/pkg/report/sarif.go
@@ -35,7 +35,7 @@ func PrintSarifReport(path, filename string, body interface{}, sciInfo model.SCI
 			}
 		}
 		sarifReport.AddTags(&summary, &sciInfo.DiffAware)
-		sarifReport.RebuildTaxonomies(auxID, auxGUID)
+		// sarifReport.RebuildTaxonomies(auxID, auxGUID)
 		body = sarifReport
 	}