refactor(report): write tables after rendering all results (aquasecurity#8357)

Author: DmitriyLewen

pkg/compliance/report/table.go

@@ -29,10 +29,10 @@ const (
 func (tw TableWriter) Write(ctx context.Context, report *ComplianceReport) error {
 	switch tw.Report {
 	case allReport:
-		t := pkgReport.Writer{
+		t := pkgReport.NewWriter(pkgReport.Options{
 			Output:     tw.Output,
 			Severities: tw.Severities,
-		}
+		})
 		for _, cr := range report.Results {
 			r := types.Report{Results: cr.Results}
 			err := t.Write(ctx, r)

pkg/k8s/report/table.go

@@ -51,10 +51,10 @@ func InfraColumns() []string {
 func (tw TableWriter) Write(ctx context.Context, report Report) error {
 	switch tw.Report {
 	case AllReport:
-		t := pkgReport.Writer{
+		t := pkgReport.NewWriter(pkgReport.Options{
 			Output:     tw.Output,
 			Severities: tw.Severities,
-		}
+		})
 		for i, r := range report.Resources {
 			if r.Report.Results.Failed() {
 				updateTargetContext(&report.Resources[i])

pkg/report/table/licensing.go

@@ -20,46 +20,43 @@ import (
 type pkgLicenseRenderer struct {
 	w           *bytes.Buffer
 	tableWriter *table.Table
-	result      types.Result
 	isTerminal  bool
 	severities  []dbTypes.Severity
 	once        *sync.Once
 }
 
-func NewPkgLicenseRenderer(result types.Result, isTerminal bool, severities []dbTypes.Severity) pkgLicenseRenderer {
-	buf := bytes.NewBuffer([]byte{})
-	return pkgLicenseRenderer{
+func NewPkgLicenseRenderer(buf *bytes.Buffer, isTerminal bool, severities []dbTypes.Severity) *pkgLicenseRenderer {
+	return &pkgLicenseRenderer{
 		w:           buf,
 		tableWriter: newTableWriter(buf, isTerminal),
-		result:      result,
 		isTerminal:  isTerminal,
 		severities:  severities,
 		once:        new(sync.Once),
 	}
 }
 
-func (r pkgLicenseRenderer) Render() string {
+func (r *pkgLicenseRenderer) Render(result types.Result) {
 	// Trivy doesn't currently support showing suppressed licenses
 	// So just skip this result
-	if len(r.result.Licenses) == 0 {
-		return ""
+	if len(result.Licenses) == 0 {
+		return
 	}
 
 	r.setHeaders()
-	r.setRows()
+	r.setRows(result.Licenses)
 
-	total, summaries := summarize(r.severities, r.countSeverities())
+	total, summaries := summarize(r.severities, r.countSeverities(result.Licenses))
 
-	target := r.result.Target + " (license)"
+	target := result.Target + " (license)"
 	RenderTarget(r.w, target, r.isTerminal)
 	r.printf("Total: %d (%s)\n\n", total, strings.Join(summaries, ", "))
 
 	r.tableWriter.Render()
 
-	return r.w.String()
+	return
 }
 
-func (r pkgLicenseRenderer) setHeaders() {
+func (r *pkgLicenseRenderer) setHeaders() {
 	header := []string{
 		"Package",
 		"License",
@@ -69,8 +66,8 @@ func (r pkgLicenseRenderer) setHeaders() {
 	r.tableWriter.SetHeaders(header...)
 }
 
-func (r pkgLicenseRenderer) setRows() {
-	for _, l := range r.result.Licenses {
+func (r *pkgLicenseRenderer) setRows(licenses []types.DetectedLicense) {
+	for _, l := range licenses {
 		var row []string
 		if r.isTerminal {
 			row = []string{
@@ -91,9 +88,9 @@ func (r pkgLicenseRenderer) setRows() {
 	}
 }
 
-func (r pkgLicenseRenderer) countSeverities() map[string]int {
+func (r *pkgLicenseRenderer) countSeverities(licenses []types.DetectedLicense) map[string]int {
 	severityCount := make(map[string]int)
-	for _, l := range r.result.Licenses {
+	for _, l := range licenses {
 		severityCount[l.Severity]++
 	}
 	return severityCount
@@ -107,46 +104,43 @@ func (r *pkgLicenseRenderer) printf(format string, args ...any) {
 type fileLicenseRenderer struct {
 	w           *bytes.Buffer
 	tableWriter *table.Table
-	result      types.Result
 	isTerminal  bool
 	severities  []dbTypes.Severity
 	once        *sync.Once
 }
 
-func NewFileLicenseRenderer(result types.Result, isTerminal bool, severities []dbTypes.Severity) fileLicenseRenderer {
-	buf := bytes.NewBuffer([]byte{})
-	return fileLicenseRenderer{
+func NewFileLicenseRenderer(buf *bytes.Buffer, isTerminal bool, severities []dbTypes.Severity) *fileLicenseRenderer {
+	return &fileLicenseRenderer{
 		w:           buf,
 		tableWriter: newTableWriter(buf, isTerminal),
-		result:      result,
 		isTerminal:  isTerminal,
 		severities:  severities,
 		once:        new(sync.Once),
 	}
 }
 
-func (r fileLicenseRenderer) Render() string {
+func (r *fileLicenseRenderer) Render(result types.Result) {
 	// Trivy doesn't currently support showing suppressed licenses
 	// So just skip this result
-	if len(r.result.Licenses) == 0 {
-		return ""
+	if len(result.Licenses) == 0 {
+		return
 	}
 
 	r.setHeaders()
-	r.setRows()
+	r.setRows(result.Licenses)
 
-	total, summaries := summarize(r.severities, r.countSeverities())
+	total, summaries := summarize(r.severities, r.countSeverities(result.Licenses))
 
-	target := r.result.Target + " (license)"
+	target := result.Target + " (license)"
 	RenderTarget(r.w, target, r.isTerminal)
 	r.printf("Total: %d (%s)\n\n", total, strings.Join(summaries, ", "))
 
 	r.tableWriter.Render()
 
-	return r.w.String()
+	return
 }
 
-func (r fileLicenseRenderer) setHeaders() {
+func (r *fileLicenseRenderer) setHeaders() {
 	header := []string{
 		"Classification",
 		"Severity",
@@ -156,10 +150,10 @@ func (r fileLicenseRenderer) setHeaders() {
 	r.tableWriter.SetHeaders(header...)
 }
 
-func (r fileLicenseRenderer) setRows() {
-	sort.Slice(r.result.Licenses, func(i, j int) bool {
-		a := r.result.Licenses[i]
-		b := r.result.Licenses[j]
+func (r *fileLicenseRenderer) setRows(licenses []types.DetectedLicense) {
+	sort.Slice(licenses, func(i, j int) bool {
+		a := licenses[i]
+		b := licenses[j]
 		if a.Severity != b.Severity {
 			return 0 < dbTypes.CompareSeverityString(b.Severity, a.Severity)
 		}
@@ -172,7 +166,7 @@ func (r fileLicenseRenderer) setRows() {
 		return a.FilePath < b.FilePath
 	})
 
-	for _, l := range r.result.Licenses {
+	for _, l := range licenses {
 		var row []string
 		if r.isTerminal {
 			row = []string{
@@ -193,9 +187,9 @@ func (r fileLicenseRenderer) setRows() {
 	}
 }
 
-func (r fileLicenseRenderer) countSeverities() map[string]int {
+func (r *fileLicenseRenderer) countSeverities(licenses []types.DetectedLicense) map[string]int {
 	severityCount := make(map[string]int)
-	for _, l := range r.result.Licenses {
+	for _, l := range licenses {
 		severityCount[l.Severity]++
 	}
 	return severityCount

pkg/report/table/misconfig.go

@@ -25,7 +25,6 @@ const (
 
 type misconfigRenderer struct {
 	w                  *bytes.Buffer
-	result             types.Result
 	severities         []dbTypes.Severity
 	trace              bool
 	includeNonFailures bool
@@ -34,7 +33,7 @@ type misconfigRenderer struct {
 	renderCause        []ftypes.ConfigType
 }
 
-func NewMisconfigRenderer(result types.Result, severities []dbTypes.Severity, trace, includeNonFailures, ansi bool, renderCause []ftypes.ConfigType) *misconfigRenderer {
+func NewMisconfigRenderer(buf *bytes.Buffer, severities []dbTypes.Severity, trace, includeNonFailures, ansi bool, renderCause []ftypes.ConfigType) *misconfigRenderer {
 	width, _, err := term.GetSize(0)
 	if err != nil || width == 0 {
 		width = 40
@@ -44,8 +43,7 @@ func NewMisconfigRenderer(result types.Result, severities []dbTypes.Severity, tr
 	}
 
 	return &misconfigRenderer{
-		w:                  bytes.NewBuffer([]byte{}),
-		result:             result,
+		w:                  buf,
 		severities:         severities,
 		trace:              trace,
 		includeNonFailures: includeNonFailures,
@@ -55,36 +53,36 @@ func NewMisconfigRenderer(result types.Result, severities []dbTypes.Severity, tr
 	}
 }
 
-func (r *misconfigRenderer) Render() string {
+func (r *misconfigRenderer) Render(result types.Result) {
 	// Trivy doesn't currently support showing suppressed misconfigs
 	// So just skip this result
-	if len(r.result.Misconfigurations) == 0 {
-		return ""
+	if len(result.Misconfigurations) == 0 {
+		return
 	}
-	target := fmt.Sprintf("%s (%s)", r.result.Target, r.result.Type)
+	target := fmt.Sprintf("%s (%s)", result.Target, result.Type)
 	RenderTarget(r.w, target, r.ansi)
 
-	total, summaries := summarize(r.severities, r.countSeverities())
+	total, summaries := summarize(r.severities, r.countSeverities(result.Misconfigurations))
 
-	summary := r.result.MisconfSummary
+	summary := result.MisconfSummary
 	r.printf("Tests: %d (SUCCESSES: %d, FAILURES: %d)\n",
 		summary.Successes+summary.Failures, summary.Successes, summary.Failures)
 	r.printf("Failures: %d (%s)\n\n", total, strings.Join(summaries, ", "))
 
-	for _, m := range r.result.Misconfigurations {
-		r.renderSingle(m)
+	for _, m := range result.Misconfigurations {
+		r.renderSingle(result.Target, result.Type, m)
 	}
 
 	// For debugging
 	if r.trace {
-		r.outputTrace()
+		r.outputTrace(result.Target, result.Misconfigurations)
 	}
-	return r.w.String()
+	return
 }
 
-func (r *misconfigRenderer) countSeverities() map[string]int {
+func (r *misconfigRenderer) countSeverities(misconfigs []types.DetectedMisconfiguration) map[string]int {
 	severityCount := make(map[string]int)
-	for _, misconf := range r.result.Misconfigurations {
+	for _, misconf := range misconfigs {
 		if misconf.Status == types.MisconfStatusFailure {
 			severityCount[misconf.Severity]++
 		}
@@ -110,10 +108,10 @@ func (r *misconfigRenderer) printSingleDivider() {
 	r.printf("<dim>%s\r\n", strings.Repeat("─", r.width))
 }
 
-func (r *misconfigRenderer) renderSingle(misconf types.DetectedMisconfiguration) {
+func (r *misconfigRenderer) renderSingle(target string, typ ftypes.TargetType, misconf types.DetectedMisconfiguration) {
 	r.renderSummary(misconf)
-	r.renderCode(misconf)
-	r.renderMisconfCause(misconf)
+	r.renderCode(target, misconf)
+	r.renderMisconfCause(typ, misconf)
 	r.printf("\r\n\r\n")
 }
 
@@ -160,7 +158,7 @@ func (r *misconfigRenderer) renderSummary(misconf types.DetectedMisconfiguration
 	r.printSingleDivider()
 }
 
-func (r *misconfigRenderer) renderCode(misconf types.DetectedMisconfiguration) {
+func (r *misconfigRenderer) renderCode(target string, misconf types.DetectedMisconfiguration) {
 	// highlight code if we can...
 	if lines := misconf.CauseMetadata.Code.Lines; len(lines) > 0 {
 
@@ -171,7 +169,7 @@ func (r *misconfigRenderer) renderCode(misconf types.DetectedMisconfiguration) {
 				lineInfo = tml.Sprintf("%s<blue>-%d", lineInfo, misconf.CauseMetadata.EndLine)
 			}
 		}
-		r.printf(" <blue>%s%s\r\n", r.result.Target, lineInfo)
+		r.printf(" <blue>%s%s\r\n", target, lineInfo)
 		for i, occ := range misconf.CauseMetadata.Occurrences {
 			lineInfo := fmt.Sprintf("%d-%d", occ.Location.StartLine, occ.Location.EndLine)
 			if occ.Location.StartLine >= occ.Location.EndLine {
@@ -218,8 +216,8 @@ func (r *misconfigRenderer) renderCode(misconf types.DetectedMisconfiguration) {
 	}
 }
 
-func (r *misconfigRenderer) renderMisconfCause(misconf types.DetectedMisconfiguration) {
-	if !slices.Contains(r.renderCause, r.result.Type) {
+func (r *misconfigRenderer) renderMisconfCause(typ ftypes.TargetType, misconf types.DetectedMisconfiguration) {
+	if !slices.Contains(r.renderCause, typ) {
 		return
 	}
 
@@ -239,12 +237,12 @@ func (r *misconfigRenderer) renderMisconfCause(misconf types.DetectedMisconfigur
 	r.printSingleDivider()
 }
 
-func (r *misconfigRenderer) outputTrace() {
+func (r *misconfigRenderer) outputTrace(target string, misconfigs []types.DetectedMisconfiguration) {
 	blue := color.New(color.FgBlue).SprintFunc()
 	green := color.New(color.FgGreen).SprintfFunc()
 	red := color.New(color.FgRed).SprintfFunc()
 
-	for _, misconf := range r.result.Misconfigurations {
+	for _, misconf := range misconfigs {
 		if len(misconf.Traces) == 0 {
 			continue
 		}
@@ -255,7 +253,7 @@ func (r *misconfigRenderer) outputTrace() {
 		}
 
 		r.println(c("\nID: %s", misconf.ID))
-		r.println(c("File: %s", r.result.Target))
+		r.println(c("File: %s", target))
 		r.println(c("Namespace: %s", misconf.Namespace))
 		r.println(c("Query: %s", misconf.Query))
 		r.println(c("Message: %s", misconf.Message))

pkg/report/table/misconfig_test.go

@@ -1,6 +1,7 @@
 package table_test
 
 import (
+	"bytes"
 	"strings"
 	"testing"
 
@@ -13,12 +14,10 @@ import (
 )
 
 func TestMisconfigRenderer(t *testing.T) {
-
 	type args struct {
 		includeNonFailures bool
 		renderCause        []ftypes.ConfigType
 	}
-
 	tests := []struct {
 		name  string
 		input types.Result
@@ -450,12 +449,16 @@ resource "aws_s3_bucket" "this" {
 		},
 	}
 
-	for _, test := range tests {
-		t.Run(test.name, func(t *testing.T) {
-			severities := []dbTypes.Severity{dbTypes.SeverityLow, dbTypes.SeverityMedium, dbTypes.SeverityHigh,
-				dbTypes.SeverityCritical}
-			renderer := table.NewMisconfigRenderer(test.input, severities, false, test.args.includeNonFailures, false, test.args.renderCause)
-			assert.Equal(t, test.want, strings.ReplaceAll(renderer.Render(), "\r\n", "\n"))
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			severities := []dbTypes.Severity{
+				dbTypes.SeverityLow, dbTypes.SeverityMedium, dbTypes.SeverityHigh,
+				dbTypes.SeverityCritical,
+			}
+			buf := bytes.NewBuffer([]byte{})
+			renderer := table.NewMisconfigRenderer(buf, severities, false, tt.args.includeNonFailures, false, tt.args.renderCause)
+			renderer.Render(tt.input)
+			assert.Equal(t, tt.want, strings.ReplaceAll(buf.String(), "\r\n", "\n"))
 		})
 	}
 }