Skip to content

Commit 869bf65

Browse files
fviernaufviernau
committed
feat(static-html): Make the descriptions of issues more compact
Only show the `Issue.message`, but stop showing `Issue.timestamp` and `Issue.severity`, to make the representation more compact and to align with the WebApp report. Note that the timestamp is rarely relevant and the severity is represented by a dedicated styling anyway. Signed-off-by: Frank Viernau <[email protected]>
1 parent 84aa5b0 commit 869bf65

File tree

2 files changed

+35
-44
lines changed

2 files changed

+35
-44
lines changed

‎plugins/reporters/static-html/src/funTest/assets/static-html-reporter-test-expected-output.html‎

Lines changed: 34 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -577,7 +577,7 @@ <h2 id="analyzer-issue-summary">Analyzer Issue Summary (1 errors, 2 warnings, 1
577577
<td><a href="#analyzer-issue-summary-1">1</a></td>
578578
<td>Gradle:org.ossreviewtoolkit.gradle.example:lib:1.0.0</td>
579579
<td>
580-
<p>2024-04-25T07:44:20.725613974Z [ERROR]: Gradle - Example error.</p>
580+
<p>Example error.</p>
581581
<details>
582582
<summary>How to fix</summary>
583583
<ul>
@@ -596,7 +596,7 @@ <h2 id="analyzer-issue-summary">Analyzer Issue Summary (1 errors, 2 warnings, 1
596596
<td><a href="#analyzer-issue-summary-2">2</a></td>
597597
<td>Gradle:org.ossreviewtoolkit.gradle.example:lib:1.0.0</td>
598598
<td>
599-
<p>2024-04-25T07:44:20.725613974Z [WARNING]: Gradle - Example warning.</p>
599+
<p>Example warning.</p>
600600
<details>
601601
<summary>How to fix</summary>
602602
<ul>
@@ -615,8 +615,7 @@ <h2 id="analyzer-issue-summary">Analyzer Issue Summary (1 errors, 2 warnings, 1
615615
<td><a href="#analyzer-issue-summary-3">3</a></td>
616616
<td>Maven:org.apache.commons:commons-text:1.1</td>
617617
<td>
618-
<p>2024-04-25T07:44:20.725613974Z [WARNING]: Gradle - Example analyzer warning in included
619-
package.</p>
618+
<p>Example analyzer warning in included package.</p>
620619
<details>
621620
<summary>How to fix</summary>
622621
<ul>
@@ -635,7 +634,7 @@ <h2 id="analyzer-issue-summary">Analyzer Issue Summary (1 errors, 2 warnings, 1
635634
<td><a href="#analyzer-issue-summary-4">4</a></td>
636635
<td>Gradle:org.ossreviewtoolkit.gradle.example:lib:1.0.0</td>
637636
<td>
638-
<p>2024-04-25T07:44:20.725613974Z [HINT]: Gradle - Example hint.</p>
637+
<p>Example hint.</p>
639638
<details>
640639
<summary>How to fix</summary>
641640
<ul>
@@ -667,8 +666,7 @@ <h2 id="scanner-issue-summary">Scanner Issue Summary (3 errors, 1 warnings, 1 hi
667666
<td><a href="#scanner-issue-summary-1">1</a></td>
668667
<td>Gradle:org.ossreviewtoolkit.gradle.example:lib:1.0.0</td>
669668
<td>
670-
<p>Unknown time [ERROR]: Dummy - DownloadException: No source artifact URL provided for
671-
'Gradle:org.ossreviewtoolkit.gradle.example:lib:1.0.0'.<br>Caused by: DownloadException: No VCS URL provided for 'Gradle:org.ossreviewtoolkit.gradle.example:lib:1.0.0'.
669+
<p>DownloadException: No source artifact URL provided for 'Gradle:org.ossreviewtoolkit.gradle.example:lib:1.0.0'.<br>Caused by: DownloadException: No VCS URL provided for 'Gradle:org.ossreviewtoolkit.gradle.example:lib:1.0.0'.
672670
Please make sure the published POM file includes the SCM connection, see: https://docs.gradle.org/current/userguide/publishing_maven.html#sec:modifying_the_generated_pom</p>
673671
<details>
674672
<summary>How to fix</summary>
@@ -688,8 +686,7 @@ <h2 id="scanner-issue-summary">Scanner Issue Summary (3 errors, 1 warnings, 1 hi
688686
<td><a href="#scanner-issue-summary-2">2</a></td>
689687
<td>Gradle:org.ossreviewtoolkit.gradle.example:lib:1.0.0</td>
690688
<td>
691-
<p>2024-04-22T10:36:10.661544294Z [ERROR]: FakeScanner - ERROR: Timeout after 300 seconds
692-
while scanning file 'analyzer/src/funTest/assets/projects/synthetic/gradle/lib/included-file.dat'.</p>
689+
<p>ERROR: Timeout after 300 seconds while scanning file 'analyzer/src/funTest/assets/projects/synthetic/gradle/lib/included-file.dat'.</p>
693690
<details>
694691
<summary>How to fix</summary>
695692
<ul>
@@ -708,7 +705,7 @@ <h2 id="scanner-issue-summary">Scanner Issue Summary (3 errors, 1 warnings, 1 hi
708705
<td><a href="#scanner-issue-summary-3">3</a></td>
709706
<td>Gradle:org.ossreviewtoolkit.gradle.example:lib:1.0.0</td>
710707
<td>
711-
<p>2024-04-25T07:44:20.725613974Z [ERROR]: FakeScanner - Example error.</p>
708+
<p>Example error.</p>
712709
<details>
713710
<summary>How to fix</summary>
714711
<ul>
@@ -727,7 +724,7 @@ <h2 id="scanner-issue-summary">Scanner Issue Summary (3 errors, 1 warnings, 1 hi
727724
<td><a href="#scanner-issue-summary-4">4</a></td>
728725
<td>Gradle:org.ossreviewtoolkit.gradle.example:lib:1.0.0</td>
729726
<td>
730-
<p>2024-04-25T07:44:20.725613974Z [WARNING]: FakeScanner - Example warning.</p>
727+
<p>Example warning.</p>
731728
<details>
732729
<summary>How to fix</summary>
733730
<ul>
@@ -746,7 +743,7 @@ <h2 id="scanner-issue-summary">Scanner Issue Summary (3 errors, 1 warnings, 1 hi
746743
<td><a href="#scanner-issue-summary-5">5</a></td>
747744
<td>Gradle:org.ossreviewtoolkit.gradle.example:lib:1.0.0</td>
748745
<td>
749-
<p>2024-04-25T07:44:20.725613974Z [HINT]: FakeScanner - Example hint.</p>
746+
<p>Example hint.</p>
750747
<details>
751748
<summary>How to fix</summary>
752749
<ul>
@@ -778,7 +775,7 @@ <h2 id="advisor-issue-summary">Advisor Issue Summary (1 errors, 1 warnings, 1 hi
778775
<td><a href="#advisor-issue-summary-1">1</a></td>
779776
<td>Maven:org.apache.commons:commons-text:1.1</td>
780777
<td>
781-
<p>Unknown time [ERROR]: VulnerableCode - Example advisor error.</p>
778+
<p>Example advisor error.</p>
782779
<details>
783780
<summary>How to fix</summary>
784781
<ul>
@@ -797,7 +794,7 @@ <h2 id="advisor-issue-summary">Advisor Issue Summary (1 errors, 1 warnings, 1 hi
797794
<td><a href="#advisor-issue-summary-2">2</a></td>
798795
<td>Maven:org.apache.commons:commons-text:1.1</td>
799796
<td>
800-
<p>Unknown time [WARNING]: VulnerableCode - Example advisor warning.</p>
797+
<p>Example advisor warning.</p>
801798
<details>
802799
<summary>How to fix</summary>
803800
<ul>
@@ -816,7 +813,7 @@ <h2 id="advisor-issue-summary">Advisor Issue Summary (1 errors, 1 warnings, 1 hi
816813
<td><a href="#advisor-issue-summary-3">3</a></td>
817814
<td>Maven:org.apache.commons:commons-text:1.1</td>
818815
<td>
819-
<p>Unknown time [HINT]: VulnerableCode - Example advisor hint.</p>
816+
<p>Example advisor hint.</p>
820817
<details>
821818
<summary>How to fix</summary>
822819
<ul>
@@ -899,30 +896,29 @@ <h3>Packages</h3>
899896
<table class="report-table package-issue-table">
900897
<tr class="resolved">
901898
<td>
902-
<p>2024-04-25T07:44:20.725613974Z [ERROR]: FakeScanner - Example error, resolved.</p>
899+
<p>Example error, resolved.</p>
903900
<p>
904901
Resolved by: CANT_FIX_ISSUE - Resolved for illustration.</p>
905902
</td>
906903
</tr>
907904
<tr class="excluded">
908905
<td>
909-
<p>2024-04-22T10:36:10.661544294Z [ERROR]: FakeScanner - ERROR: Timeout after 300 seconds
910-
while scanning file 'project/file-within-excluded-project.dat'.</p>
906+
<p>ERROR: Timeout after 300 seconds while scanning file 'project/file-within-excluded-project.dat'.</p>
911907
</td>
912908
</tr>
913909
<tr class="excluded">
914910
<td>
915-
<p>2024-04-25T07:44:20.725613974Z [HINT]: FakeScanner - Example hint.</p>
911+
<p>Example hint.</p>
916912
</td>
917913
</tr>
918914
<tr class="excluded">
919915
<td>
920-
<p>2024-04-25T07:44:20.725613974Z [WARNING]: FakeScanner - Example warning.</p>
916+
<p>Example warning.</p>
921917
</td>
922918
</tr>
923919
<tr class="excluded">
924920
<td>
925-
<p>2024-04-25T07:44:20.725613974Z [ERROR]: FakeScanner - Example error.</p>
921+
<p>Example error.</p>
926922
</td>
927923
</tr>
928924
</table>
@@ -989,45 +985,43 @@ <h3>Packages</h3>
989985
<table class="report-table package-issue-table">
990986
<tr class="error">
991987
<td>
992-
<p>2024-04-25T07:44:20.725613974Z [ERROR]: Gradle - Example error.</p>
988+
<p>Example error.</p>
993989
</td>
994990
</tr>
995991
<tr class="error">
996992
<td>
997-
<p>Unknown time [ERROR]: Dummy - DownloadException: No source artifact URL provided for
998-
'Gradle:org.ossreviewtoolkit.gradle.example:lib:1.0.0'.<br>Caused by: DownloadException: No VCS URL provided for 'Gradle:org.ossreviewtoolkit.gradle.example:lib:1.0.0'.
993+
<p>DownloadException: No source artifact URL provided for 'Gradle:org.ossreviewtoolkit.gradle.example:lib:1.0.0'.<br>Caused by: DownloadException: No VCS URL provided for 'Gradle:org.ossreviewtoolkit.gradle.example:lib:1.0.0'.
999994
Please make sure the published POM file includes the SCM connection, see: https://docs.gradle.org/current/userguide/publishing_maven.html#sec:modifying_the_generated_pom</p>
1000995
</td>
1001996
</tr>
1002997
<tr class="error">
1003998
<td>
1004-
<p>2024-04-22T10:36:10.661544294Z [ERROR]: FakeScanner - ERROR: Timeout after 300 seconds
1005-
while scanning file 'analyzer/src/funTest/assets/projects/synthetic/gradle/lib/included-file.dat'.</p>
999+
<p>ERROR: Timeout after 300 seconds while scanning file 'analyzer/src/funTest/assets/projects/synthetic/gradle/lib/included-file.dat'.</p>
10061000
</td>
10071001
</tr>
10081002
<tr class="error">
10091003
<td>
1010-
<p>2024-04-25T07:44:20.725613974Z [ERROR]: FakeScanner - Example error.</p>
1004+
<p>Example error.</p>
10111005
</td>
10121006
</tr>
10131007
<tr class="warning">
10141008
<td>
1015-
<p>2024-04-25T07:44:20.725613974Z [WARNING]: Gradle - Example warning.</p>
1009+
<p>Example warning.</p>
10161010
</td>
10171011
</tr>
10181012
<tr class="warning">
10191013
<td>
1020-
<p>2024-04-25T07:44:20.725613974Z [WARNING]: FakeScanner - Example warning.</p>
1014+
<p>Example warning.</p>
10211015
</td>
10221016
</tr>
10231017
<tr class="hint">
10241018
<td>
1025-
<p>2024-04-25T07:44:20.725613974Z [HINT]: Gradle - Example hint.</p>
1019+
<p>Example hint.</p>
10261020
</td>
10271021
</tr>
10281022
<tr class="hint">
10291023
<td>
1030-
<p>2024-04-25T07:44:20.725613974Z [HINT]: FakeScanner - Example hint.</p>
1024+
<p>Example hint.</p>
10311025
</td>
10321026
</tr>
10331027
</table>
@@ -1036,22 +1030,21 @@ <h3>Packages</h3>
10361030
<table class="report-table package-issue-table">
10371031
<tr class="resolved">
10381032
<td>
1039-
<p>2024-04-25T07:44:20.725613974Z [ERROR]: Gradle - Example error, resolved.</p>
1033+
<p>Example error, resolved.</p>
10401034
<p>
10411035
Resolved by: CANT_FIX_ISSUE - Resolved for illustration.</p>
10421036
</td>
10431037
</tr>
10441038
<tr class="resolved">
10451039
<td>
1046-
<p>2024-04-25T07:44:20.725613974Z [ERROR]: FakeScanner - Example error, resolved.</p>
1040+
<p>Example error, resolved.</p>
10471041
<p>
10481042
Resolved by: CANT_FIX_ISSUE - Resolved for illustration.</p>
10491043
</td>
10501044
</tr>
10511045
<tr class="excluded">
10521046
<td>
1053-
<p>2024-04-22T10:36:10.661544294Z [ERROR]: FakeScanner - ERROR: Timeout after 300 seconds
1054-
while scanning file 'analyzer/src/funTest/assets/projects/synthetic/gradle/lib/excluded-file.dat'.</p>
1047+
<p>ERROR: Timeout after 300 seconds while scanning file 'analyzer/src/funTest/assets/projects/synthetic/gradle/lib/excluded-file.dat'.</p>
10551048
</td>
10561049
</tr>
10571050
</table>
@@ -1082,8 +1075,7 @@ <h3>Packages</h3>
10821075
<table class="report-table package-issue-table">
10831076
<tr class="excluded">
10841077
<td>
1085-
<p>2024-04-25T07:44:20.725613974Z [WARNING]: Gradle - Example analyzer warning in excluded
1086-
package.</p>
1078+
<p>Example analyzer warning in excluded package.</p>
10871079
</td>
10881080
</tr>
10891081
</table>
@@ -1194,23 +1186,22 @@ <h3>Packages</h3>
11941186
<table class="report-table package-issue-table">
11951187
<tr class="error">
11961188
<td>
1197-
<p>Unknown time [ERROR]: VulnerableCode - Example advisor error.</p>
1189+
<p>Example advisor error.</p>
11981190
</td>
11991191
</tr>
12001192
<tr class="warning">
12011193
<td>
1202-
<p>2024-04-25T07:44:20.725613974Z [WARNING]: Gradle - Example analyzer warning in included
1203-
package.</p>
1194+
<p>Example analyzer warning in included package.</p>
12041195
</td>
12051196
</tr>
12061197
<tr class="warning">
12071198
<td>
1208-
<p>Unknown time [WARNING]: VulnerableCode - Example advisor warning.</p>
1199+
<p>Example advisor warning.</p>
12091200
</td>
12101201
</tr>
12111202
<tr class="hint">
12121203
<td>
1213-
<p>Unknown time [HINT]: VulnerableCode - Example advisor hint.</p>
1204+
<p>Example advisor hint.</p>
12141205
</td>
12151206
</tr>
12161207
</table>
@@ -1219,7 +1210,7 @@ <h3>Packages</h3>
12191210
<table class="report-table package-issue-table">
12201211
<tr class="resolved">
12211212
<td>
1222-
<p>Unknown time [ERROR]: VulnerableCode - Example advisor error, resolved.</p>
1213+
<p>Example advisor error, resolved.</p>
12231214
<p>
12241215
Resolved by: CANT_FIX_ISSUE - A comment explaining why the issue can be ignored.</p>
12251216
</td>

‎plugins/reporters/static-html/src/main/kotlin/TablesReportModelMapper.kt‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ private fun Issue.toTableReportIssue(
9090
val resolutions = ortResult.getResolutionsFor(this)
9191
return TablesReportIssue(
9292
source = source,
93-
description = toString(),
93+
description = message,
9494
resolutionDescription = buildString {
9595
if (resolutions.isNotEmpty()) {
9696
append(

0 commit comments

Comments
 (0)