feat(report): added path, platform, start and end times to HTML report (

Checkmarx#3455) Signed-off-by: Felipe Avelar <[email protected]>
jaevans · May 28, 2021 · 9748012 · 9748012
1 parent 34b710e
commit 9748012
Show file tree

Hide file tree

Showing 8 changed files with 54 additions and 6 deletions.
diff --git a/docs/img/html_report.png b/docs/img/html_report.png
diff --git a/e2e/fixtures/E2E_CLI_032_RESULT.json b/e2e/fixtures/E2E_CLI_032_RESULT.json
@@ -92,6 +92,9 @@
     "MEDIUM": 3
   },
   "total_counter": 4,
-  "Start": "2021-05-01T09:00:00.0+01:00",
-  "End": "2021-05-01T09:00:00.0+01:00"
+  "start": "2021-05-01T09:00:00.0+01:00",
+  "end": "2021-05-01T09:00:00.0+01:00",
+  "paths": [
+    "fixtures/samples/terraform-single.tf"
+  ]
 }
diff --git a/e2e/fixtures/E2E_CLI_033_RESULT.json b/e2e/fixtures/E2E_CLI_033_RESULT.json
@@ -92,6 +92,9 @@
     "MEDIUM": 3
   },
   "total_counter": 4,
-  "Start": "2021-05-01T09:00:00.0+01:00",
-  "End": "2021-05-01T09:00:00.0+01:00"
+  "start": "2021-05-01T09:00:00.0+01:00",
+  "end": "2021-05-01T09:00:00.0+01:00",
+  "paths": [
+    "fixtures/samples/terraform-single.tf"
+  ]
 }
diff --git a/internal/console/scan.go b/internal/console/scan.go
@@ -595,7 +595,7 @@ func scan(changedDefaultQueryPath bool) error {
 
 	elapsed := time.Since(scanStartTime)
 
-	summary := getSummary(t, results, scanStartTime, time.Now())
+	summary := getSummary(t, results, scanStartTime, time.Now(), path)
 
 	if err := resolveOutputs(&summary, files.Combine(), inspector.GetFailedQueries(), printer); err != nil {
 		log.Err(err)
@@ -613,7 +613,7 @@ func scan(changedDefaultQueryPath bool) error {
 	return nil
 }
 
-func getSummary(t *tracker.CITracker, results []model.Vulnerability, start, end time.Time) model.Summary {
+func getSummary(t *tracker.CITracker, results []model.Vulnerability, start, end time.Time, scannedPaths []string) model.Summary {
 	counters := model.Counters{
 		ScannedFiles:           t.FoundFiles,
 		ParsedFiles:            t.ParsedFiles,
@@ -627,6 +627,7 @@ func getSummary(t *tracker.CITracker, results []model.Vulnerability, start, end
 		Start: start,
 		End:   end,
 	}
+	summary.ScannedPaths = scannedPaths
 	return summary
 }
 

diff --git a/pkg/model/summary.go b/pkg/model/summary.go
@@ -66,6 +66,7 @@ type Summary struct {
 	Queries VulnerableQuerySlice `json:"queries"`
 	SeveritySummary
 	Times
+	ScannedPaths []string `json:"paths"`
 }
 
 // CreateSummary creates a report for a single scan, based on its scanID

diff --git a/pkg/report/html.go b/pkg/report/html.go
@@ -8,6 +8,7 @@ import (
 	"path/filepath"
 	"strings"
 
+	"github.com/Checkmarx/kics/pkg/model"
 	"github.com/tdewolff/minify/v2"
 	minifyCSS "github.com/tdewolff/minify/v2/css"
 	minifyHtml "github.com/tdewolff/minify/v2/html"
@@ -66,6 +67,22 @@ func includeJS(name string) template.HTML {
 	return template.HTML("<script>" + jsMinified + "</script>") //nolint
 }
 
+func getPaths(paths []string) string {
+	return strings.Join(paths, ", ")
+}
+
+func getPlatforms(queries model.VulnerableQuerySlice) string {
+	platforms := make([]string, 0)
+	alreadyAdded := make(map[string]string)
+	for idx := range queries {
+		if _, ok := alreadyAdded[queries[idx].Platform]; !ok {
+			alreadyAdded[queries[idx].Platform] = ""
+			platforms = append(platforms, queries[idx].Platform)
+		}
+	}
+	return strings.Join(platforms, ", ")
+}
+
 // PrintHTMLReport creates a report file on HTML format
 func PrintHTMLReport(path, filename string, body interface{}) error {
 	if !strings.HasSuffix(filename, ".html") {
@@ -75,6 +92,8 @@ func PrintHTMLReport(path, filename string, body interface{}) error {
 	templateFuncs["includeSVG"] = includeSVG
 	templateFuncs["includeCSS"] = includeCSS
 	templateFuncs["includeJS"] = includeJS
+	templateFuncs["getPaths"] = getPaths
+	templateFuncs["getPlatforms"] = getPlatforms
 
 	fullPath := filepath.Join(path, filename)
 	t := template.Must(template.New("report.tmpl").Funcs(templateFuncs).Parse(htmlTemplate))

diff --git a/pkg/report/template/html/report.css b/pkg/report/template/html/report.css
@@ -17,6 +17,19 @@ body {
   border: 1px solid #bebebe;
 }
 
+.run-info {
+  display: flex;
+  flex-wrap: wrap;
+  border: 1px solid #bebebe;
+  margin-top: 10px;
+  width: 50vw;
+}
+
+.run-info > span {
+  flex-basis: 50%;
+  text-align: center;
+}
+
 .counters {
   display: flex;
   flex-direction: row;

diff --git a/pkg/report/template/html/report.tmpl b/pkg/report/template/html/report.tmpl
@@ -10,6 +10,14 @@
 <body>
   <div class="container">
     <div class="report-header-footer"><span class="title">KICS <span>REPORT</span></span><span class="timestamp">{{ getCurrentTime }}</span><a href="https://www.kics.io/" target="_blank">KICS.IO</a></div>
+    <div class="run-info">
+      <span style="flex-basis:100%"><b>Scanned paths:</b> {{ getPaths .ScannedPaths }}</span>
+      <span style="flex-basis:100%"><b>Platforms:</b> {{ getPlatforms .Queries }}</span>
+      {{- with .Times -}}
+        <span><b>Start time:</b> {{ .Start.Format "15:04:05, Jan 02 2006" }}</span>
+        <span><b>End time:</b> {{ .End.Format "15:04:05, Jan 02 2006" }}</span>
+      {{- end}}
+    </div>
     <h2 style="margin-top:41px" class="kics-orange">Vulnerabilities:</h2>
     <div class="counters">
     {{- with .SeveritySummary -}}