Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

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

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
71c3c34
refactor(report): write tables after rendering all results
DmitriyLewen Feb 5, 2025
4e93197
refactor: use one buffer for all renderers
DmitriyLewen Feb 5, 2025
1332db4
refactor: add NewWriter + Options
DmitriyLewen Feb 6, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
68 changes: 31 additions & 37 deletions pkg/report/table/licensing.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand All @@ -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{
Expand All @@ -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
Expand All @@ -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",
Expand All @@ -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)
}
Expand All @@ -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{
Expand All @@ -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
Expand Down
44 changes: 21 additions & 23 deletions pkg/report/table/misconfig.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,15 +23,14 @@ const (

type misconfigRenderer struct {
w *bytes.Buffer
result types.Result
severities []dbTypes.Severity
trace bool
includeNonFailures bool
width int
ansi bool
}

func NewMisconfigRenderer(result types.Result, severities []dbTypes.Severity, trace, includeNonFailures, ansi bool) *misconfigRenderer {
func NewMisconfigRenderer(buf *bytes.Buffer, severities []dbTypes.Severity, trace, includeNonFailures, ansi bool) *misconfigRenderer {
width, _, err := term.GetSize(0)
if err != nil || width == 0 {
width = 40
Expand All @@ -40,8 +39,7 @@ func NewMisconfigRenderer(result types.Result, severities []dbTypes.Severity, tr
tml.DisableFormatting()
}
return &misconfigRenderer{
w: bytes.NewBuffer([]byte{}),
result: result,
w: buf,
severities: severities,
trace: trace,
includeNonFailures: includeNonFailures,
Expand All @@ -50,36 +48,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, 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]++
}
Expand All @@ -105,9 +103,9 @@ 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, misconf types.DetectedMisconfiguration) {
r.renderSummary(misconf)
r.renderCode(misconf)
r.renderCode(target, misconf)
r.printf("\r\n\r\n")
}

Expand Down Expand Up @@ -154,7 +152,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 {

Expand All @@ -165,7 +163,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 {
Expand Down Expand Up @@ -212,12 +210,12 @@ func (r *misconfigRenderer) renderCode(misconf types.DetectedMisconfiguration) {
}
}

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
}
Expand All @@ -228,7 +226,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))
Expand Down
18 changes: 11 additions & 7 deletions pkg/report/table/misconfig_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
package table_test

import (
"bytes"
"strings"
"testing"

Expand All @@ -13,7 +14,6 @@ import (
)

func TestMisconfigRenderer(t *testing.T) {

tests := []struct {
name string
input types.Result
Expand Down Expand Up @@ -339,12 +339,16 @@ See https://avd.aquasec.com/misconfig/avd-aws-0107
},
}

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.includeNonFailures, false)
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.includeNonFailures, false)
renderer.Render(tt.input)
assert.Equal(t, tt.want, strings.ReplaceAll(buf.String(), "\r\n", "\n"))
})
}
}
Loading
Loading