chore: add multi-project scan summary to UFM presenter (#574)

Author: CatalinSnyk

internal/presenters/funcs.go

@@ -344,9 +344,17 @@ func getDefaultTemplateFuncMap(config configuration.Configuration, ri runtimeinf
 		return strings.ReplaceAll(str, old, replaceWith)
 	}
 	defaultMap["getFindingTypesFromTestResult"] = getFindingTypesFromTestResult
+	defaultMap["getFindingTypesFromMultipleTestResults"] = getFindingTypesFromMultipleTestResults
 	defaultMap["getIssuesFromTestResult"] = func(testResults testapi.TestResult, findingType ...testapi.FindingType) []testapi.Issue {
 		return utils.ValueOf(testapi.GetIssuesFromTestResult(testResults, findingType))
 	}
+	defaultMap["getIssuesFromMultipleTestResults"] = func(testResults []testapi.TestResult, findingType ...testapi.FindingType) []testapi.Issue {
+		var allIssues []testapi.Issue
+		for _, result := range testResults {
+			allIssues = append(allIssues, utils.ValueOf(testapi.GetIssuesFromTestResult(result, findingType))...)
+		}
+		return allIssues
+	}
 	defaultMap["getIssueMetadata"] = func(issue testapi.Issue, key string) interface{} {
 		value, found := issue.GetData(key)
 		if !found {
@@ -362,6 +370,12 @@ func getDefaultTemplateFuncMap(config configuration.Configuration, ri runtimeinf
 		return json_schemas.DEFAULT_SEVERITIES
 	}
 	defaultMap["getSummariesFromIssues"] = testapi.GetSummariesFromIssues
+	defaultMap["newFindingTypeSummary"] = func(ft testapi.FindingType, issues []testapi.Issue) interface{} {
+		return struct {
+			FindingType testapi.FindingType
+			Issues      []testapi.Issue
+		}{FindingType: ft, Issues: issues}
+	}
 	defaultMap["getSortedIssuesFromSummary"] = func(summary *testapi.IssueSummary) []testapi.Issue {
 		if summary == nil {
 			return []testapi.Issue{}
@@ -532,6 +546,22 @@ func getFindingTypesFromTestResult(testResults testapi.TestResult) []testapi.Fin
 	return findingTypesList
 }
 
+func getFindingTypesFromMultipleTestResults(testResults []testapi.TestResult) []testapi.FindingType {
+	findingTypes := map[testapi.FindingType]bool{}
+	for _, result := range testResults {
+		for _, ft := range getFindingTypesFromTestResult(result) {
+			findingTypes[ft] = true
+		}
+	}
+	findingTypesList := slices.Collect(maps.Keys(findingTypes))
+	if len(findingTypesList) == 0 {
+		return []testapi.FindingType{"no findings type found"}
+	}
+	slices.Sort(findingTypesList)
+	slices.Reverse(findingTypesList)
+	return findingTypesList
+}
+
 func getDefaultFindingTypesFromConfig(testResults testapi.TestResult) []testapi.FindingType {
 	if testResults == nil {
 		return nil

internal/presenters/templates/ufm.human.tmpl

@@ -78,6 +78,23 @@
 {{- template "issueBody" . }}
 {{- end }} {{/* end issueDetails */}}
 
+{{- define "findingTypeSummary"}}
+  {{- $summaries := getSummariesFromIssues .Issues }}
+  {{- $effectiveSummary := index $summaries "effective" }}
+  {{- $rawSummary := index $summaries "raw" }}
+  {{- $ignoredSummary := index $summaries "ignored" }}
+  {{- $effectiveSeverities := index $effectiveSummary.CountBy "severity" }}
+  {{- $ignoredSeverities := index $ignoredSummary.CountBy "severity" }}
+  {{- $totalIssueCount := $rawSummary.Count }}
+  {{- $openIssueCount := $effectiveSummary.Count }}
+  {{- $ignoredIssueCount := $ignoredSummary.Count }}
+
+  Total {{ convertTypeToIssueName .FindingType | toLowerCase }} issues: {{ $totalIssueCount }}
+  {{- if gt $totalIssueCount 0}}
+  Ignored: {{ print $ignoredIssueCount | bold }} [{{- range $severity := getSeverities | reverse }}{{- $ignoredCount := index $ignoredSeverities $severity }}{{- print " " $ignoredCount " " $severity " " | renderInSeverityColor }}{{- end}}]
+  Open   : {{ print $openIssueCount | bold }} [{{- range $severity := getSeverities | reverse }}{{- $countFound := index $effectiveSeverities $severity }}{{- print " " $countFound " " $severity " " | renderInSeverityColor }}{{- end}}]{{- end}}
+{{- end }} {{/* end findingTypeSummary */}}
+
 {{- define "testSummary"}}{{ "Test Summary" | bold }}
 {{- "\n" }}
 {{- $metadata := .GetMetadata }}
@@ -92,20 +109,7 @@
 
 {{- range $findingType := $findingTypes }}
   {{- $issuesForType := getIssuesFromTestResult $ $findingType }}
-  {{- $summaries := getSummariesFromIssues $issuesForType }}
-  {{- $effectiveSummary := index $summaries "effective" }}
-  {{- $rawSummary := index $summaries "raw" }}
-  {{- $ignoredSummary := index $summaries "ignored" }}
-  {{- $effectiveSeverities := index $effectiveSummary.CountBy "severity" }}
-  {{- $ignoredSeverities := index $ignoredSummary.CountBy "severity" }}
-  {{- $totalIssueCount := $rawSummary.Count }}
-  {{- $openIssueCount := $effectiveSummary.Count }}
-  {{- $ignoredIssueCount := $ignoredSummary.Count }}
-
-  Total {{ convertTypeToIssueName $findingType | toLowerCase }} issues: {{ $totalIssueCount }}
-  {{- if gt $totalIssueCount 0}}
-  Ignored: {{ print $ignoredIssueCount | bold }} [{{- range $severity := getSeverities | reverse }}{{- $ignoredCount := index $ignoredSeverities $severity }}{{- print " " $ignoredCount " " $severity " " | renderInSeverityColor }}{{- end}}]
-  Open   : {{ print $openIssueCount | bold }} [{{- range $severity := getSeverities | reverse }}{{- $countFound := index $effectiveSeverities $severity }}{{- print " " $countFound " " $severity " " | renderInSeverityColor }}{{- end}}]{{- end}}
+  {{- template "findingTypeSummary" (newFindingTypeSummary $findingType $issuesForType) }}
 {{- end}}
 {{- end }} {{/* end testSummary */}}
 
@@ -296,6 +300,21 @@ Tested {{ int $dependencyCount }} dependencies for known issues, found {{ len $o
     {{- end }}
 {{- end }}
 
+{{- define "overallTestSummary"}}{{ "Overall Test Summary" | bold }}
+{{- "\n" }}
+{{- $findingTypes := getFindingTypesFromMultipleTestResults .TestResults }}
+  Organization:      {{ getValueFromConfig "internal_org_slug" }}
+  Test type:         {{ determineProductNameFromFindingTypes $findingTypes }}
+  Projects tested:   {{ len .TestResults }} projects
+
+{{- range $findingType := $findingTypes }}
+  {{- $issuesForType := getIssuesFromMultipleTestResults $.TestResults $findingType }}
+  {{- if gt (len $issuesForType) 0 }}
+  {{- template "findingTypeSummary" (newFindingTypeSummary $findingType $issuesForType) }}
+  {{- end }}
+{{- end}}
+{{- end }} {{/* end overallTestSummary */}}
+
 {{- /* Main template */}}
 {{- define "main" }}
     {{- $totalResults := len $.TestResults }}
@@ -309,6 +328,12 @@ Tested {{ int $dependencyCount }} dependencies for known issues, found {{ len $o
         {{- end }}
     {{- end }}
 
+    {{- /* Render overall summary for multi-project scans */}}
+    {{- if gt $totalResults 1 }}
+        {{- "\n" }}{{- divider }}{{- "\n" }}
+        {{- box (renderToString "overallTestSummary" $) }}
+    {{- end }}
+
     {{- /* Show hint if results are filtered */}}
     {{- $severityThresholdKey := "severity-threshold"}}
         {{- if not (eq (getValueFromConfig $severityThresholdKey) "") }}

internal/presenters/testdata/ufm/multi_project.human.readable

@@ -743,6 +743,19 @@ Tested 23 dependencies for known issues, found 19 issues, 27 vulnerable paths.
 │   Open   : 19 [ 0 CRITICAL  5 HIGH  10 MEDIUM  4 LOW ]    │
 ╰───────────────────────────────────────────────────────────╯
 
+─────────────────────────────────────────────────────
+
+╭────────────────────────────────────────────────────────────╮
+│ Overall Test Summary                                       │
+│                                                            │
+│   Organization:      My Org                                │
+│   Test type:         Software Composition Analysis         │
+│   Projects tested:   7 projects                            │
+│                                                            │
+│   Total security issues: 67                                │
+│   Ignored: 0 [ 0 CRITICAL  0 HIGH  0 MEDIUM  0 LOW ]       │
+│   Open   : 67 [ 0 CRITICAL  19 HIGH  40 MEDIUM  8 LOW ]    │
+╰────────────────────────────────────────────────────────────╯
 
 💡 Tip