Improve HTML output

* Add the tool name to the findings * Don't show a linenumber if the line number is 0
simpsonjulian · Nov 3, 2024 · 55d6b84 · 55d6b84
1 parent 19c406c
commit 55d6b84
Show file tree

Hide file tree

Showing 3 changed files with 26 additions and 18 deletions.
diff --git a/html_report.rb b/html_report.rb
@@ -44,7 +44,8 @@ def format_result(result, report)
                      description: CGI::escapeHTML(result.message.text),
                      linenum: region ? region.startLine : 0,
                      file_url: result.locations[0].physicalLocation.artifactLocation.uri,
-                     rule_id: rule_id })
+                     rule_id: rule_id,
+                     tool: report.runs.first.tool.driver.name })
   end
 
   def results
@@ -101,8 +102,6 @@ def generate
   end
 
 
-  # add in tool
-  #
   def results_matching(severity, rule_id)
     @results.select do |result|
       _description = result.description

diff --git a/spec/html_report_spec.rb b/spec/html_report_spec.rb
@@ -73,6 +73,10 @@
       expect(sarif_file.results.first.rule_id).to eq "no-unused-vars"
     end
 
+    it 'has a tool name' do
+      expect(sarif_file.results.first.tool).to eq "ESLint"
+    end
+
     it 'copes with codeql sarif output' do
       sarif_file = SarifFile.new("spec/webgoat_codeql.sarif")
       expect(sarif_file.results.first.description).to match /This data transmitted to the user depends on \[sensitive information\].*/

diff --git a/template.erb b/template.erb
@@ -56,11 +56,13 @@
           font-weight: bold;
           margin: 20px 0 10px;
       }
+
       .header-container {
           display: flex;
           justify-content: center;
           margin: auto;
       }
+
       .header {
           text-align: left;
           display: inline-block;
@@ -83,17 +85,18 @@
   <div class="header-container">
 
 
-  <div class="header">
+    <div class="header">
 
 
-    <h1>Statica AppSec Findings</h1>
-    <p><strong>Repository URL:</strong> <a href="<%= ENV['REPO_URL'] %>" target="_blank"><%= ENV['REPO_URL'] %></a></p>
-    <p><strong>Repo Branch:</strong> <%= ENV['REPO_BRANCH'] %></p>
-    <p><strong>Latest Commit SHA:</strong> <%= ENV['LATEST_COMMIT_SHA'] %></p>
-    <p><strong>Scan Date:</strong> <%= @scan_date %></p>
-    <p><strong>Findings:</strong> <%= @results.length %></p>
-    <p><strong>Tools used:</strong> <%= @tools.join(", ") %></p>
-  </div>
+      <h1>Statica AppSec Findings</h1>
+      <p><strong>Repository URL:</strong> <a href="<%= ENV['REPO_URL'] %>" target="_blank"><%= ENV['REPO_URL'] %></a>
+      </p>
+      <p><strong>Repo Branch:</strong> <%= ENV['REPO_BRANCH'] %></p>
+      <p><strong>Latest Commit SHA:</strong> <%= ENV['LATEST_COMMIT_SHA'] %></p>
+      <p><strong>Scan Date:</strong> <%= @scan_date %></p>
+      <p><strong>Findings:</strong> <%= @results.length %></p>
+      <p><strong>Tools used:</strong> <%= @tools.join(", ") %></p>
+    </div>
   </div>
 
 
@@ -107,15 +110,17 @@
 
       <% results_matching = results_matching(severity, rule_id) %>
 
-      <p class="collapsible <%= results_matching.length <= 5 ? 'active' : '' %>">
-        <b><%= rule_id %></b>:
-        <%= desc %>
-        <strong>(<%= results_matching.length %>)</strong>
-      </p>
+   <p class="collapsible <%= results_matching.length <= 5 ? 'active' : '' %>">
+      <b><%= rule_id %></b>:
+      <%= desc %>
+      <em>[ <%= results_matching.first.tool %>] </em>
+      <strong>(<%= results_matching.length %>)</strong>
+    </p>
+
       <ul>
         <% results_matching.each do |finding| %>
           <li>
-            <a href="<%= finding.file_url %>" target="_blank"><%= finding.file_url %></a>:<%= finding.linenum %>
+            <a href="<%= finding.file_url %>" target="_blank"><%= finding.file_url %></a><%= finding.linenum > 0 ? ":#{finding.linenum}" : nil %>
           </li>
         <% end %>
       </ul>