New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

add stop sbom scanning API #20200

Merged

wy65701436 merged 30 commits into goharbor:main from wy65701436:sbom-stop

Apr 9, 2024

Contributor

wy65701436 commented Apr 1, 2024 •

edited

Loading

Thank you for contributing to Harbor!

Comprehensive Summary of your change

Issue being fixed

Fixes #(issue)

Please indicate you've done the following:

Well Written Title and Summary of the PR
Label the PR as needed. "release-note/ignore-for-release, release-note/new-feature, release-note/update, release-note/enhancement, release-note/community, release-note/breaking-change, release-note/docs, release-note/infra, release-note/deprecation"
Accepted the DCO. Commits without the DCO will delay acceptance.
Made sure tests are passing and test coverage is added if needed.
Considered the docs impact and opened a new docs issue or PR with docs changes if needed in website repository.

wy65701436 requested a review from a team as a code owner

April 1, 2024 08:59

github-actions bot assigned chlins, stonezdj and Vad1mo

wy65701436 force-pushed the sbom-stop branch from 69f48dc to d0a44bb Compare

April 1, 2024 09:13

wy65701436 added the release-note/update label

wy65701436 force-pushed the sbom-stop branch from a009fcf to 0f67952 Compare

April 1, 2024 09:22

xuelichao added a commit to wy65701436/harbor that referenced this pull request


          [UI] support to stop sbom scanning goharbor#20200

01c7308

Signed-off-by: xuelichao <[email protected]>

codecov bot commented Apr 2, 2024 •

edited

Loading

Codecov Report

Attention: Patch coverage is 82.14286% with 10 lines in your changes are missing coverage. Please review.

Project coverage is 67.56%. Comparing base (b7b8847) to head (4b2e006).
Report is 118 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff            @@
##             main   #20200     +/-   ##
=========================================
  Coverage   67.56%   67.56%             
=========================================
  Files         991     1000      +9     
  Lines      109181   110384   +1203     
  Branches     2719     2781     +62     
=========================================
+ Hits        73768    74584    +816     
- Misses      31449    31798    +349     
- Partials     3964     4002     +38

Flag	Coverage Δ
unittests	`67.56% <82.14%> (+<0.01%)`	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files	Coverage Δ
src/controller/scan/base_controller.go	`59.38% <100.00%> (-0.17%)`	⬇️
src/controller/scan/controller.go	`100.00% <ø> (ø)`
src/server/v2.0/handler/scan.go	`17.74% <100.00%> (-1.56%)`	⬇️
src/pkg/task/dao/execution.go	`61.82% <81.13%> (+0.47%)`	⬆️

... and 512 files with indirect coverage changes

wy65701436 force-pushed the sbom-stop branch from 01c7308 to 8ed62f0 Compare

April 2, 2024 10:39

xuelichao added a commit to wy65701436/harbor that referenced this pull request


          [UI] support to stop sbom scanning goharbor#20200

81060e6

Signed-off-by: xuelichao <[email protected]>

xuelichao force-pushed the sbom-stop branch from 8ed62f0 to 81060e6 Compare

April 2, 2024 11:07

Vad1mo previously requested changes

View reviewed changes

Member

Vad1mo left a comment

Furthermore, please be clear and concise in the wording Scan, Create or generate. They all mean different things.

IMO generate is the wrong term here. We either scan the image for libs and create the SBOM. See. https://diffsense.com/diff/create/generate

So to summarize, Harbor scans images from SBOM material and creates a SBOM.

src/portal/src/i18n/lang/en-us-lang.json

@@ @@ -1028,6 +1029,41 @@ @@
                       "IN_PROGRESS": "Search...",
                       "BACK": "Back"
                   },
+                  "SBOM": {
+                      "CHART": {
+                          "SCANNING_TIME": "Scan completed time:",

Member

Vad1mo Apr 2, 2024

This is not clear: It is the time it took to complete the scan or is it the time when the scan terminated?

src/portal/src/i18n/lang/en-us-lang.json Outdated

+                  "SBOM": {
+                      "CHART": {
+                          "SCANNING_TIME": "Scan completed time:",
+                          "SCANNING_PERCENT": "Scan completed percent:",

Member

Vad1mo Apr 2, 2024

Percentage of completed scan.
or
Scan Completion in percent
or
Scan progress

src/portal/src/i18n/lang/en-us-lang.json Outdated

+                      "CHART": {
+                          "SCANNING_TIME": "Scan completed time:",
+                          "SCANNING_PERCENT": "Scan completed percent:",
+                          "SCANNING_PERCENT_EXPLAIN": "Scan completed percentage is calculated as # of successfully scanned images / total number of images referenced within the image index.",

Member

Vad1mo Apr 2, 2024

The scan completion progress is calculated as # of successfully scanned images / total number of images referenced within the image index.

src/portal/src/i18n/lang/en-us-lang.json

+                          "SCANNING_PERCENT_EXPLAIN": "Scan completed percentage is calculated as # of successfully scanned images / total number of images referenced within the image index.",
+                          "TOOLTIPS_TITLE": "{{totalSbom}} of {{totalPackages}} {{package}} have known {{sbom}}.",
+                          "TOOLTIPS_TITLE_SINGULAR": "{{totalSbom}} of {{totalPackages}} {{package}} has known {{sbom}}.",
+                          "TOOLTIPS_TITLE_ZERO": "No recognizable SBOM detected"

Member

Vad1mo Apr 2, 2024

This is not clear, and I don't think it should mean what this means.

src/portal/src/i18n/lang/en-us-lang.json Outdated

+                          "TOOLTIPS_TITLE_ZERO": "No recognizable SBOM detected"
+                      },
+                      "GRID": {
+                          "PLACEHOLDER": "We couldn't find any scanning results!",

Member

Vad1mo Apr 2, 2024

No scan results found.

This is not clear where not able to find any results or have there been no scan results.
In the first case, as a user I would like to know what Harbor could not find anything.

src/portal/src/i18n/lang/en-us-lang.json

+                          "FOOT_OF": "of"
+                      },
+                      "STATE": {
+                          "OTHER_STATUS": "Not Generated",

Member

Vad1mo Apr 2, 2024

The term generated means, here, that the process of writing/creating the SBOM after the SBOM scanning and discovering completed. Am I correct in my assumption?

src/portal/src/i18n/lang/en-us-lang.json Outdated

+                          "QUEUED": "Queued",
+                          "ERROR": "View Log",
+                          "SCANNING": "Generating",
+                          "STOPPED": "Generating SBOM stopped"

Member

Vad1mo Apr 2, 2024

SBOM creation stopped
of
SBOM scan stopped

src/portal/src/i18n/lang/en-us-lang.json Outdated

+                      "NO_SBOM": "No SBOM",
+                      "PACKAGES": "SBOM",
+                      "REPORTED_BY": "Reported by {{scanner}}",
+                      "GENERATE": "Start SBOM",

Member

Vad1mo Apr 2, 2024

Create SBOM

src/portal/src/i18n/lang/en-us-lang.json

+                      "GENERATE": "Start SBOM",
+                      "DOWNLOAD": "Download SBOM",
+                      "Details": "SBOM details",
+                      "STOP": "Stop SBOM",

Member

Vad1mo Apr 2, 2024

Stop SBOM creation/scan

src/portal/src/i18n/lang/en-us-lang.json

+                      "DOWNLOAD": "Download SBOM",
+                      "Details": "SBOM details",
+                      "STOP": "Stop SBOM",
+                      "TRIGGER_STOP_SUCCESS": "Trigger stopping SBOM generation successfully"

Member

Vad1mo Apr 2, 2024

This is not understandable, can you explain what this TRIGGER_STOP_SUCCESS does or should tell the user?

wy65701436 force-pushed the sbom-stop branch from 81060e6 to a788c74 Compare

April 3, 2024 03:37

xuelichao added a commit to wy65701436/harbor that referenced this pull request


          [UI] support to stop sbom scanning goharbor#20200

af7e90b

Signed-off-by: xuelichao <[email protected]>

xuelichao added a commit to wy65701436/harbor that referenced this pull request


          [UI] support to stop sbom scanning goharbor#20200

33a89e4

Signed-off-by: xuelichao <[email protected]>

xuelichao force-pushed the sbom-stop branch from af7e90b to 33a89e4 Compare

April 3, 2024 04:19

wy65701436 pushed a commit to wy65701436/harbor that referenced this pull request


          [UI] support to stop sbom scanning goharbor#20200

5b3b09a

Signed-off-by: xuelichao <[email protected]>

wy65701436 force-pushed the sbom-stop branch from 33a89e4 to 24fc37c Compare

April 8, 2024 05:09

xuelichao force-pushed the sbom-stop branch from c648c76 to c0d8546 Compare

April 9, 2024 05:20

zyyw reviewed

View reviewed changes

api/v2.0/swagger.yaml Outdated Show resolved Hide resolved

zyyw reviewed

View reviewed changes

tests/ci/api_run.sh Show resolved Hide resolved

wy65701436 force-pushed the sbom-stop branch from 4f246b3 to bfa656b Compare

April 9, 2024 05:58

stonezdj reviewed

View reviewed changes

src/controller/scan/base_controller_test.go Outdated Show resolved Hide resolved

wy65701436 force-pushed the sbom-stop branch from 24315ab to a25c808 Compare

April 9, 2024 06:04

wy65701436 added 5 commits

April 9, 2024 14:05


          add stop sbom scanning API

ac1b171

Signed-off-by: wang yan <[email protected]>


          fix ut

a772abb

Signed-off-by: wang yan <[email protected]>


          fix ui failure

Signed-off-by: wang yan <[email protected]>


          remove ui

a5a2544

Signed-off-by: wang yan <[email protected]>


          fix UT

febad78

add the missiong parameter when to call the stop method

Signed-off-by: wang yan <[email protected]>

xuelichao and others added 19 commits

April 9, 2024 14:06


          [UI] support to stop sbom scanning goharbor#20200

5047eb2

Signed-off-by: xuelichao <[email protected]>
Signed-off-by: wang yan <[email protected]>


          fix lint issue

f0f9966

Signed-off-by: wang yan <[email protected]>


          fix ut

f60852c

Signed-off-by: wang yan <[email protected]>


          fix swagger issue

049f9b6

Signed-off-by: wang yan <[email protected]>


          fix api test

19fe0d0

Signed-off-by: wang yan <[email protected]>


          temp disable stop scan

c59d311

Signed-off-by: wang yan <[email protected]>


          Fix UI test case failure

c50ff13

Signed-off-by: xuelichao <[email protected]>
Signed-off-by: wang yan <[email protected]>


          bump golang 1.21.8 on main (goharbor#20197)

70967fd

bump golang 1.21.8

Signed-off-by: yminer <[email protected]>
Signed-off-by: wang yan <[email protected]>


          Add accessory type for sbom (goharbor#20208)

23e0552

Signed-off-by: stonezdj <[email protected]>
Co-authored-by: stonezdj <[email protected]>
Signed-off-by: wang yan <[email protected]>


          fix: close file (goharbor#20189)

bcf4846

Signed-off-by: guoguangwu <[email protected]>
Co-authored-by: Wang Yan <[email protected]>
Signed-off-by: wang yan <[email protected]>


          Update GenAccessoryArt API to generate valid accessory for SBOM (goha…

27b3d5d

…rbor#20214)

Signed-off-by: stonezdj <[email protected]>
Co-authored-by: stonezdj <[email protected]>
Signed-off-by: wang yan <[email protected]>


          Add SBOM scan REST API (goharbor#20215)

b30e634

Update swagger API for generate SBOM

Signed-off-by: stonezdj <[email protected]>
Co-authored-by: stonezdj <[email protected]>
Signed-off-by: wang yan <[email protected]>


          delete membership=0 in getProjectsByName (goharbor#20153)

45cb5f6

delete membership=0 in getProjectsByName but lets getProjects still using membership=1 for reserve if getProjectsByName not found any

Signed-off-by: prima <[email protected]>
Signed-off-by: wang yan <[email protected]>


          feat: add api test case for quota sorting (goharbor#20209)

7ca3a36

Signed-off-by: Shengwen Yu <[email protected]>
Signed-off-by: wang yan <[email protected]>


          fix: test robot account permission (goharbor#20240)

22912f6

Signed-off-by: Shengwen Yu <[email protected]>
Signed-off-by: wang yan <[email protected]>


          update artifact_type column alteration (goharbor#20239)

b77930f

update column if is null

Signed-off-by: yminer <[email protected]>
Co-authored-by: Wang Yan <[email protected]>
Signed-off-by: wang yan <[email protected]>


          Allow empty path in redirect_url (goharbor#20238)

000ac24

fixes goharbor#20226

Signed-off-by: stonezdj <[email protected]>
Co-authored-by: stonezdj <[email protected]>
Signed-off-by: wang yan <[email protected]>


          resolve the review comments

ed52fed

Signed-off-by: wang yan <[email protected]>


          resolve the comments

Signed-off-by: wang yan <[email protected]>

wy65701436 force-pushed the sbom-stop branch from a25c808 to 5093035 Compare

April 9, 2024 06:06


          Merge branch 'main' of https://github.com/goharbor/harbor into sbom-stop

e8947d0

zyyw reviewed

View reviewed changes

src/pkg/task/dao/execution.go Show resolved Hide resolved

src/pkg/task/dao/execution.go Show resolved Hide resolved

stonezdj approved these changes

View reviewed changes

zyyw approved these changes

View reviewed changes

wy65701436 added 3 commits

April 9, 2024 14:51


          add condition for invalide sql

f0dea2f

Signed-off-by: wang yan <[email protected]>


          remove debugging print

ce74100

Signed-off-by: wang yan <[email protected]>


          Merge branch 'main' into sbom-stop

24881c2

wy65701436 dismissed Vad1mo’s stale review

April 9, 2024 07:15

Will raise another PR to resolve the UI issues


          add more testcases

4b2e006

Signed-off-by: xuelichao <[email protected]>

wy65701436 merged commit 461a5fa into goharbor:main

12 checks passed

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

release-note/update