feat(static-html): Add an advisor issue summary table

Show advisor issues analog to analyzer and scanner issues. Signed-off-by: Frank Viernau <frank_viernau@epam.com>
oss-review-toolkit · Apr 30, 2024 · 2ae0173 · 2ae0173
1 parent fe329ae
commit 2ae0173
Show file tree

Hide file tree

Showing 4 changed files with 101 additions and 2 deletions.
diff --git a/...s/reporters/static-html/src/funTest/assets/static-html-reporter-test-expected-output.html b/...s/reporters/static-html/src/funTest/assets/static-html-reporter-test-expected-output.html
@@ -456,6 +456,7 @@ <h2>Index</h2>
             <li><a href="#rule-violation-summary">Rule Violation Summary (1 errors, 1 warnings, 0 hints to resolve)</a></li>
             <li><a href="#analyzer-issue-summary">Analyzer Issue Summary (1 errors, 2 warnings, 1 hints to resolve)</a></li>
             <li><a href="#scanner-issue-summary">Scanner Issue Summary (3 errors, 1 warnings, 1 hints to resolve)</a></li>
+            <li><a href="#advisor-issue-summary">Advisor Issue Summary (1 errors, 1 warnings, 1 hints to resolve)</a></li>
             <li><a href="#Gradle:org.ossreviewtoolkit:nested-fake-project:1.0.0">Gradle:org.ossreviewtoolkit:nested-fake-project:1.0.0 
                   <div class="ort-reason">Excluded: EXAMPLE_OF - The project is an example.</div></a></li>
             <li><a href="#Gradle:org.ossreviewtoolkit.gradle.example:lib:1.0.0">Gradle:org.ossreviewtoolkit.gradle.example:lib:1.0.0</a></li>
@@ -733,6 +734,76 @@ <h2 id="scanner-issue-summary">Scanner Issue Summary (3 errors, 1 warnings, 1 hi
                </tr>
             </tbody>
          </table>
+         <h2 id="advisor-issue-summary">Advisor Issue Summary (1 errors, 1 warnings, 1 hints to resolve)</h2>
+         <p>Issues from excluded components are not shown in this summary.</p>
+         <table class="ort-report-table">
+            <thead>
+               <tr>
+                  <th>#</th>
+                  <th>Package</th>
+                  <th>Message</th>
+               </tr>
+            </thead>
+            <tbody>
+               <tr class="ort-error" id="advisor-issue-summary-1">
+                  <td><a href="#advisor-issue-summary-1">1</a></td>
+                  <td>Maven:org.apache.commons:commons-text:1.1</td>
+                  <td>
+                     <p>Unknown time [ERROR]: VulnerableCode - Example advisor error.</p>
+                     <details>
+                        <summary>How to fix</summary>
+                        <ul>
+
+                           <li><em>Step 1</em></li>
+
+                           <li><strong>Step 2</strong></li>
+
+                           <li><em><strong>Step 3</strong></em>
+                              <code>Some long issue resolution text to verify that overflow:scroll is working as expected.</code></li>
+                           </ul>
+                        </details>
+                  </td>
+               </tr>
+               <tr class="ort-warning" id="advisor-issue-summary-2">
+                  <td><a href="#advisor-issue-summary-2">2</a></td>
+                  <td>Maven:org.apache.commons:commons-text:1.1</td>
+                  <td>
+                     <p>Unknown time [WARNING]: VulnerableCode - Example advisor warning.</p>
+                     <details>
+                        <summary>How to fix</summary>
+                        <ul>
+
+                           <li><em>Step 1</em></li>
+
+                           <li><strong>Step 2</strong></li>
+
+                           <li><em><strong>Step 3</strong></em>
+                              <code>Some long issue resolution text to verify that overflow:scroll is working as expected.</code></li>
+                           </ul>
+                        </details>
+                  </td>
+               </tr>
+               <tr class="ort-hint" id="advisor-issue-summary-3">
+                  <td><a href="#advisor-issue-summary-3">3</a></td>
+                  <td>Maven:org.apache.commons:commons-text:1.1</td>
+                  <td>
+                     <p>Unknown time [HINT]: VulnerableCode - Example advisor hint.</p>
+                     <details>
+                        <summary>How to fix</summary>
+                        <ul>
+
+                           <li><em>Step 1</em></li>
+
+                           <li><strong>Step 2</strong></li>
+
+                           <li><em><strong>Step 3</strong></em>
+                              <code>Some long issue resolution text to verify that overflow:scroll is working as expected.</code></li>
+                           </ul>
+                        </details>
+                  </td>
+               </tr>
+            </tbody>
+         </table>
          <h2 id="Gradle:org.ossreviewtoolkit:nested-fake-project:1.0.0">Gradle:org.ossreviewtoolkit:nested-fake-project:1.0.0 (sub/module/project/build.gradle)</h2>
          <h3>Project is Excluded</h3>
          <p>The project is excluded for the following reason(s):</p>

diff --git a/plugins/reporters/static-html/src/main/kotlin/ReportTableModel.kt b/plugins/reporters/static-html/src/main/kotlin/ReportTableModel.kt
@@ -63,6 +63,11 @@ internal data class ReportTableModel(
      */
     val scannerIssueSummary: IssueTable,
 
+    /**
+     * A [IssueTable] containing all advisor issues.
+     */
+    val advisorIssueSummary: IssueTable,
+
     /**
      * The [ProjectTable]s containing the dependencies for each [Project].
      */
@@ -156,7 +161,8 @@ internal data class ReportTableModel(
 
         enum class Type {
             ANALYZER,
-            SCANNER
+            SCANNER,
+            ADVISOR
         }
     }
 

diff --git a/plugins/reporters/static-html/src/main/kotlin/ReportTableModelMapper.kt b/plugins/reporters/static-html/src/main/kotlin/ReportTableModelMapper.kt
@@ -116,6 +116,7 @@ internal object ReportTableModelMapper {
             ruleViolations,
             getAnalyzerIssueSummaryTable(input),
             getScannerIssueSummaryTable(input),
+            getAdvisorIssueSummaryTable(input),
             projectTables,
             labels
         )
@@ -191,6 +192,10 @@ private fun getScannerIssueSummaryTable(input: ReporterInput): IssueTable =
     input.ortResult.getScannerIssues(omitExcluded = true, omitResolved = true)
         .toIssueSummaryTable(IssueTable.Type.SCANNER, input)
 
+private fun getAdvisorIssueSummaryTable(input: ReporterInput): IssueTable =
+    input.ortResult.getAdvisorIssues(omitExcluded = true, omitResolved = true)
+        .toIssueSummaryTable(IssueTable.Type.ADVISOR, input)
+
 private fun Map<Identifier, Set<Issue>>.toIssueSummaryTable(type: IssueTable.Type, input: ReporterInput): IssueTable {
     val rows = flatMap { (id, issues) ->
         issues.map { issue ->

diff --git a/plugins/reporters/static-html/src/main/kotlin/StaticHtmlReporter.kt b/plugins/reporters/static-html/src/main/kotlin/StaticHtmlReporter.kt
@@ -161,6 +161,10 @@ class StaticHtmlReporter : Reporter {
                         issueTable(reportTableModel.scannerIssueSummary)
                     }
 
+                    if (reportTableModel.advisorIssueSummary.rows.isNotEmpty()) {
+                        issueTable(reportTableModel.advisorIssueSummary)
+                    }
+
                     reportTableModel.projectDependencies.forEach { (project, table) ->
                         projectTable(project, table)
                     }
@@ -224,6 +228,14 @@ class StaticHtmlReporter : Reporter {
                 }
             }
 
+            if (reportTableModel.advisorIssueSummary.rows.isNotEmpty()) {
+                li {
+                    a("#${reportTableModel.advisorIssueSummary.id()}") {
+                        +reportTableModel.advisorIssueSummary.title()
+                    }
+                }
+            }
+
             reportTableModel.projectDependencies.forEach { (project, projectTable) ->
                 li {
                     a("#${project.id.toCoordinates()}") {
@@ -711,6 +723,11 @@ private val ScopeExclude.description: String get() = joinNonBlank(reason.toStrin
 private fun IssueTable.title(): String =
     "${type.name.titlecase()} Issue Summary ($errorCount errors, $warningCount warnings, $hintCount hints to resolve)"
 
-private fun IssueTable.id(): String = "${type.name.lowercase()}-issue-summary"
+private fun IssueTable.id(): String =
+    when (type) {
+        IssueTable.Type.ANALYZER -> "analyzer-issue-summary"
+        IssueTable.Type.SCANNER -> "scanner-issue-summary"
+        IssueTable.Type.ADVISOR -> "advisor-issue-summary"
+    }
 
 private fun IssueTable.rowId(index: Int): String = "${id()}-$index"