feat(output): add HTML output format #1258

hogo6002 · 2024-09-18T06:26:05Z

Implement #1274
Add an HTML output format to display results more effectively, particularly for container scanning.
This format retains all the information from the existing table output, including called/uncalled vulnerability details.

New features:

Provides a package summary page
Groups vulnerabilities by source package and ecosystem. Vulnerabilities from OS images are displayed last by default.
Provides a total count of vulnerabilities (excluding uncalled vulnerabilities by default).
Surfaces container scanning metrics, such as layer commands.
Shows fix version information.

codecov-commenter · 2024-09-25T04:56:09Z

Codecov Report

Attention: Patch coverage is 68.73065% with 101 lines in your changes missing coverage. Please review.

Project coverage is 68.48%. Comparing base (b14f6c7) to head (96505fb).

Files with missing lines	Patch %	Lines
internal/output/html.go	77.41%	53 Missing and 10 partials ⚠️
pkg/reporter/html_reporter.go	0.00%	26 Missing ⚠️
internal/utility/severity/severity.go	54.54%	5 Missing ⚠️
cmd/osv-scanner/scan/main.go	0.00%	2 Missing and 1 partial ⚠️
internal/semantic/parse.go	0.00%	2 Missing ⚠️
pkg/reporter/format.go	0.00%	2 Missing ⚠️

Additional details and impacted files

@@           Coverage Diff            @@
##             main    #1258    +/-   ##
========================================
  Coverage   68.47%   68.48%            
========================================
  Files         175      177     +2     
  Lines       16832    17155   +323     
========================================
+ Hits        11526    11748   +222     
- Misses       4679     4769    +90     
- Partials      627      638    +11

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

another-rex

Looking good! Did a quick first pass at reviewing this.

internal/output/html/report_template.html

internal/output/html/vuln_table_template.html

internal/output/html/report_template.html

internal/output/html/package_table_template.html

internal/output/html.go

hogo6002 · 2024-10-01T08:34:51Z

Added a tooltip for layer command file name and enabled UT

cuixq

LGTM

pkg/reporter/format.go

internal/output/html.go

oliverchang

this looks awesome!!!

internal/output/html.go

another-rex

Last review!

internal/output/html.go

another-rex

LGTM, one minor comment

internal/output/html.go

.prettierignore

HTML output added #1258 New design (sample one: https://hogo6002.github.io/scanner-report/): - Changed the color scheme to match osv.dev. - Merged the package view and vulnerability view into a single nested table. - Added a layer view. - Added a vulnerability type filter (project, OS, and uncalled). - Added a vulnerability search bar. - Refined the vulnerability severity count design. - Integrated the osv.dev vulnerability page into results (allowing users to click to view details). - Improved the UI. Future plan: Use frontend framework to enhance code maintainability and readability ![image](https://github.com/user-attachments/assets/5aa1559d-3d41-4ce1-9aff-6e68c25200ac) ![image](https://github.com/user-attachments/assets/e23d7a97-b295-4d10-a8cc-1350dd33576e) ![image](https://github.com/user-attachments/assets/849dc0cf-2b12-4bc9-a08a-10b426d16155) ![image](https://github.com/user-attachments/assets/ba787cda-3e07-479a-976d-171de4db6c7e) --------- Signed-off-by: Holly Gong <gongh@google.com>

hogo6002 added 3 commits September 18, 2024 15:43

feat(output): add HTML output format

0bace98

Merge remote-tracking branch 'upstream/main' into html

0cede1e

change lib to html/template

f0deb86

hogo6002 requested a review from another-rex September 18, 2024 06:26

hogo6002 marked this pull request as draft September 18, 2024 06:27

hogo6002 added 4 commits September 19, 2024 16:19

only show on ID from one group

6a78e53

Add package summary tab

a083205

Merge remote-tracking branch 'upstream/main' into html

f6df334

add severity count

a694df8

hogo6002 force-pushed the html branch from b849808 to a694df8 Compare September 24, 2024 07:46

fix lint

ab2c3bb

format style and handle ubuntu version

35ef23b

hogo6002 requested a review from cuixq September 27, 2024 06:31

hogo6002 marked this pull request as ready for review September 27, 2024 06:31

another-rex reviewed Sep 30, 2024

View reviewed changes

hogo6002 added 3 commits October 1, 2024 17:20

Merge remote-tracking branch 'upstream/main' into html

4e39c29

add HTMLVulnResultDetail and add UT

52a47b5

format html

4cd3100

hogo6002 added 3 commits October 2, 2024 13:58

sort ecosystem and source, fix UT

4d3034b

update format

57de67e

add windows replacement

e930bdc

hogo6002 requested a review from another-rex October 2, 2024 04:39

cuixq approved these changes Oct 3, 2024

View reviewed changes

pkg/reporter/format.go Outdated Show resolved Hide resolved

internal/output/html.go Outdated Show resolved Hide resolved

internal/output/html.go Show resolved Hide resolved

another-rex reviewed Oct 3, 2024

View reviewed changes

internal/output/html.go Show resolved Hide resolved

internal/output/html.go Outdated Show resolved Hide resolved

internal/output/html.go Show resolved Hide resolved

update fix version display and hide html from help command

50d4f82

hogo6002 requested a review from another-rex October 3, 2024 04:30

oliverchang reviewed Oct 3, 2024

View reviewed changes

internal/output/html.go Show resolved Hide resolved

internal/output/html.go Show resolved Hide resolved

internal/output/html.go Outdated Show resolved Hide resolved

add more comments and format group Ids in template

7c4cbd7

hogo6002 requested a review from oliverchang October 3, 2024 07:23

add comment for /user/lib fitler

eadb31c

another-rex reviewed Oct 8, 2024

View reviewed changes

hogo6002 added 3 commits October 9, 2024 12:50

Merge remote-tracking branch 'upstream/main' into html

a489f16

rewrite some comment and clean up code

1a4511e

rewrite comment for processPackageResults

96600db

hogo6002 requested a review from another-rex October 9, 2024 02:12

another-rex approved these changes Oct 9, 2024

View reviewed changes

internal/output/html.go Outdated Show resolved Hide resolved

replace if/else with cmp.Or

dc88064

G-Rath reviewed Oct 9, 2024

View reviewed changes

.prettierignore Outdated Show resolved Hide resolved

allow lint check on css/js, and add newline for html

96505fb

hogo6002 merged commit 3702c3b into google:main Oct 9, 2024
13 checks passed

oliverchang mentioned this pull request Oct 9, 2024

Dynamic table output #1315

Closed

hogo6002 mentioned this pull request Nov 6, 2024

feat(output): update HTML output to a new design #1383

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(output): add HTML output format #1258

feat(output): add HTML output format #1258

hogo6002 commented Sep 18, 2024 •

edited

Loading

codecov-commenter commented Sep 25, 2024 •

edited

Loading

another-rex left a comment

hogo6002 commented Oct 1, 2024

cuixq left a comment

oliverchang left a comment

another-rex left a comment

another-rex left a comment

feat(output): add HTML output format #1258

feat(output): add HTML output format #1258

Conversation

hogo6002 commented Sep 18, 2024 • edited Loading

codecov-commenter commented Sep 25, 2024 • edited Loading

Codecov Report

another-rex left a comment

Choose a reason for hiding this comment

hogo6002 commented Oct 1, 2024

cuixq left a comment

Choose a reason for hiding this comment

oliverchang left a comment

Choose a reason for hiding this comment

another-rex left a comment

Choose a reason for hiding this comment

another-rex left a comment

Choose a reason for hiding this comment

hogo6002 commented Sep 18, 2024 •

edited

Loading

codecov-commenter commented Sep 25, 2024 •

edited

Loading