refactor: show legend after table

aquasecurity · Jan 29, 2025 · 7f863b9 · 7f863b9
1 parent 5f13964
commit 7f863b9
Show file tree

Hide file tree

Showing 3 changed files with 28 additions and 19 deletions.
diff --git a/pkg/report/table/table.go b/pkg/report/table/table.go
@@ -91,10 +91,7 @@ func (tw Writer) renderSummary(report types.Report) error {
 	}
 
 	// Fprintln has a bug
-	if err := tml.Fprintf(tw.Output, "\n<underline><bold>Report Summary</bold></underline>\n\n"+
-		"Legend:\n"+
-		"- '-': Not scanned\n"+
-		"- '0': Clean (no security findings detected)\n"); err != nil {
+	if err := tml.Fprintf(tw.Output, "\n<underline><bold>Report Summary</bold></underline>\n\n"); err != nil {
 		return err
 	}
 
@@ -149,6 +146,13 @@ func (tw Writer) renderSummary(report types.Report) error {
 		t.AddRows(rows)
 	}
 	t.Render()
+
+	// Show legend
+	if err := tml.Fprintf(tw.Output, "Legend:\n"+
+		"- '-': Not scanned\n"+
+		"- '0': Clean (no security findings detected)\n\n"); err != nil {
+		return err
+	}
 	return nil
 }
 

diff --git a/pkg/report/table/table_private_test.go b/pkg/report/table/table_private_test.go
@@ -191,9 +191,6 @@ func Test_renderSummary(t *testing.T) {
 			want: `
 Report Summary
 
-Legend:
-- '-': Not scanned
-- '0': Clean (no security findings detected)
 ┌───────────────────────────────────┬────────────┬─────────────────┬───────────────────┬─────────┬──────────┐
 │              Target               │    Type    │ Vulnerabilities │ Misconfigurations │ Secrets │ Licenses │
 ├───────────────────────────────────┼────────────┼─────────────────┼───────────────────┼─────────┼──────────┤
@@ -219,6 +216,10 @@ Legend:
 ├───────────────────────────────────┼────────────┼─────────────────┼───────────────────┼─────────┼──────────┤
 │ Loose File License(s)             │     -      │        -        │         -         │    -    │    1     │
 └───────────────────────────────────┴────────────┴─────────────────┴───────────────────┴─────────┴──────────┘
+Legend:
+- '-': Not scanned
+- '0': Clean (no security findings detected)
+
 `,
 		},
 		{
@@ -235,9 +236,6 @@ Legend:
 			want: `
 Report Summary
 
-Legend:
-- '-': Not scanned
-- '0': Clean (no security findings detected)
 ┌───────────────────────────────────┬────────┬─────────────────┐
 │              Target               │  Type  │ Vulnerabilities │
 ├───────────────────────────────────┼────────┼─────────────────┤
@@ -247,6 +245,10 @@ Legend:
 ├───────────────────────────────────┼────────┼─────────────────┤
 │ app/jackson-databind-2.13.4.1.jar │  jar   │        2        │
 └───────────────────────────────────┴────────┴─────────────────┘
+Legend:
+- '-': Not scanned
+- '0': Clean (no security findings detected)
+
 `,
 		},
 		{
@@ -264,16 +266,17 @@ Legend:
 			want: `
 Report Summary
 
-Legend:
-- '-': Not scanned
-- '0': Clean (no security findings detected)
 ┌──────────────────┬──────┬─────────────────┬─────────┐
 │      Target      │ Type │ Vulnerabilities │ Secrets │
 ├──────────────────┼──────┼─────────────────┼─────────┤
 │ requirements.txt │ pip  │        0        │    -    │
 ├──────────────────┼──────┼─────────────────┼─────────┤
 │ requirements.txt │ text │        -        │    1    │
 └──────────────────┴──────┴─────────────────┴─────────┘
+Legend:
+- '-': Not scanned
+- '0': Clean (no security findings detected)
+
 `,
 		},
 	}

diff --git a/pkg/report/table/table_test.go b/pkg/report/table/table_test.go
@@ -66,14 +66,15 @@ func TestWriter_Write(t *testing.T) {
 			wantOutput: `
 Report Summary
 
-Legend:
-- '-': Not scanned
-- '0': Clean (no security findings detected)
 ┌──────────┬──────┬─────────────────┐
 │  Target  │ Type │ Vulnerabilities │
 ├──────────┼──────┼─────────────────┤
 │ test.jar │ jar  │        1        │
 └──────────┴──────┴─────────────────┘
+Legend:
+- '-': Not scanned
+- '0': Clean (no security findings detected)
+
 
 test (jar)
 ==========
@@ -109,14 +110,15 @@ Total: 1 (MEDIUM: 0, HIGH: 1)
 			wantOutput: `
 Report Summary
 
-Legend:
-- '-': Not scanned
-- '0': Clean (no security findings detected)
 ┌──────────┬──────┬─────────────────┐
 │  Target  │ Type │ Vulnerabilities │
 ├──────────┼──────┼─────────────────┤
 │ test.jar │ jar  │        0        │
 └──────────┴──────┴─────────────────┘
+Legend:
+- '-': Not scanned
+- '0': Clean (no security findings detected)
+
 `,
 		},
 		{