SPDX License feature UI and task changes #2296

msys-sgarg · 2021-10-14T10:55:20Z

Description

With this change
if any cook has a license mentioned and there is a respective entry for license url in https://github.com/spdx/license-list-data/blob/master/json/licenses.json

The license url information will be updated for the cookbook and a link will be shown in ui for the user to go through the license url

Have added ctl commands for updating license information in supermarket deployments. Attaching some screenshots for reference
After running ctl command or uploading a new cookbook UI changes :

CTL command running succesfully

Issues Resolved

#2188

Check List

New functionality includes tests
All buildkite tests pass
Full omnibus build and tests in buildkite pass
All commits have been signed-off for the Developer Certificate of Origin. See https://github.com/chef/chef/blob/main/CONTRIBUTING.md#developer-certification-of-origin-dco
PR title is a worthy inclusion in the CHANGELOG

msys-sgarg · 2021-10-14T14:07:45Z

https://buildkite.com/chef/chef-supermarket-main-omnibus-adhoc/builds/207#73842179-2df9-46f8-ada2-d84598f8d3de

omnibus/cookbooks/omnibus-supermarket/attributes/default.rb

RajeshPaul38 · 2021-10-18T06:54:49Z

src/supermarket/app/services/fetch_spdx_license_json.rb

+    [:error, e]
+  end
+
+end


as per the lint pattern we should add a newline at the end of every file.

Suggested change

end

end

But linter never complained about this .. if this would have been the rule .. linter would have failed ? I don't suggest making a change without linter complaining about it explicitly

If you see the file in github diff you will notice. Sharing SS

Also it's a guideline from rubocop. Refer this link:
https://www.rubydoc.info/gems/rubocop/0.20.1/Rubocop/Cop/Style/FinalNewline

It might be a guideline but in our project we are not following that .. no project follows all the guidelines from rubocop.. I will make a change thats not an issue .. but I expect linter to suggest linter changes if this has to be followed .. this has to be put in the cops definition for the project

yes makes sense.

RajeshPaul38 · 2021-10-18T06:55:01Z

src/supermarket/app/services/update_spdx_license_url.rb

+
+    [:ok, I18n.t("spdx_license.scheduled.single", name: cookbook.name, version: cookbook_version.id)]
+  end
+end


as per the lint pattern we should add a newline at the end of every file.

Suggested change

end

end

src/supermarket/app/services/update_spdx_license_url.rb

src/supermarket/app/workers/spdx_license_update_worker.rb

src/supermarket/db/schema.rb

src/supermarket/lib/tasks/update_spdx_license.rake

RajeshPaul38 · 2021-10-18T07:12:25Z

src/supermarket/lib/tasks/update_spdx_license.rake

+        exit 1
+      end
+
+      result, message = UpdateSpdxLicenseUrl.on_version args[:cookbook_name], args[:version]


when u use multiple assignment use parenthesis to mark the scope of function arguments for better readibility.

Suggested change

result, message = UpdateSpdxLicenseUrl.on_version args[:cookbook_name], args[:version]

result, message = UpdateSpdxLicenseUrl.on_version(args[:cookbook_name], args[:version])

In case of language like ruby I do not agree with this suggestion.

No issues from the language point of view. It's just for readibility. U can keep it as it is.

saghoshprogress · 2021-10-25T07:30:40Z

@RajeshPaul38 Please merge this if everything looks good.

RajeshPaul38 · 2021-10-29T15:04:35Z

@RajeshPaul38 Please merge this if everything looks good.

Have approved. Pls go ahead.

tas50 · 2021-11-06T03:30:16Z

src/supermarket/.env

@@ -25,3 +25,4 @@ FIERI_FOODCRITIC_TAGS="metadata,correctness,supermarket,portability,deprecated ~
 FIERI_SUPERMARKET_ENDPOINT=http://localhost:13000
 ROBOTS_ALLOW=/
 ENFORCE_PRIVACY=true
+SPDX_LICENSE_URL=https://raw.githubusercontent.com/spdx/license-list-data/master/json/licenses.json


We need to make sure that Supermarket can work with as little external connectivity as possible. Is it possible to fetch this file in the omnibus build so we ship Supermarket with the file.

ok, will make this change

Hi, How often do we expect this file to get updated? What will happen if the file gets updated since we have static copy of the same now?

We should be pulling in the latest copy at build time in Supermarket.

omnibus/cookbooks/omnibus-supermarket/files/default/ctl-commands/update-spdx-license.rb

msys-sgarg · 2021-11-12T11:09:16Z

https://buildkite.com/chef/chef-supermarket-main-omnibus-adhoc/builds/261 - Omnibus build success

Signed-off-by: smriti <sgarg@msystechnologies.com>

netlify · 2021-11-24T13:00:40Z

👷 Deploy Preview for chef-supermarket processing.

🔨 Explore the source changes: fc2fcee

🔍 Inspect the deploy log: https://app.netlify.com/sites/chef-supermarket/deploys/619e39f6289a4c000857151f

Signed-off-by: smriti <sgarg@msystechnologies.com>

github-actions · 2021-11-24T13:15:02Z

Simplecov Report

Covered	Threshold
97.24%	90%

msys-sgarg requested review from a team as code owners October 14, 2021 10:55

msys-sgarg force-pushed the smriti/2188_spdx_license_link_to_cookbook branch 4 times, most recently from 292215b to fe463f1 Compare October 14, 2021 12:41

msys-sgarg force-pushed the smriti/2188_spdx_license_link_to_cookbook branch from 08caf4a to 6c16204 Compare October 18, 2021 05:43

RajeshPaul38 reviewed Oct 18, 2021

View reviewed changes

omnibus/cookbooks/omnibus-supermarket/attributes/default.rb Outdated Show resolved Hide resolved

msys-sgarg force-pushed the smriti/2188_spdx_license_link_to_cookbook branch 2 times, most recently from bea5c81 to daeca94 Compare October 18, 2021 07:10

RajeshPaul38 reviewed Oct 18, 2021

View reviewed changes

msys-sgarg changed the title ~~Changes for update spdx worker~~ SPDX License feature UI and task changes Oct 18, 2021

msys-sgarg force-pushed the smriti/2188_spdx_license_link_to_cookbook branch 2 times, most recently from 22529d4 to c6ffaa9 Compare October 19, 2021 13:20

RajeshPaul38 approved these changes Oct 29, 2021

View reviewed changes

tas50 reviewed Nov 6, 2021

View reviewed changes

msys-sgarg force-pushed the smriti/2188_spdx_license_link_to_cookbook branch 5 times, most recently from f1683b9 to 6b9e714 Compare November 8, 2021 10:08

msys-sgarg changed the title ~~SPDX License feature UI and task changes~~ WIP:SPDX License feature UI and task changes Nov 9, 2021

msys-sgarg force-pushed the smriti/2188_spdx_license_link_to_cookbook branch 4 times, most recently from 98e0d50 to 7c64054 Compare November 10, 2021 14:28

msys-sgarg changed the title ~~WIP:SPDX License feature UI and task changes~~ SPDX License feature UI and task changes Nov 11, 2021

msys-sgarg changed the title ~~SPDX License feature UI and task changes~~ WIP:SPDX License feature UI and task changes Nov 11, 2021

msys-sgarg force-pushed the smriti/2188_spdx_license_link_to_cookbook branch from 2ce2213 to 795cad3 Compare November 11, 2021 11:05

msys-sgarg requested a review from a team as a code owner November 12, 2021 04:30

tas50 reviewed Nov 12, 2021

View reviewed changes

omnibus/cookbooks/omnibus-supermarket/files/default/ctl-commands/update-spdx-license.rb Outdated Show resolved Hide resolved

msys-sgarg force-pushed the smriti/2188_spdx_license_link_to_cookbook branch from 50232c9 to 70e4aa8 Compare November 12, 2021 08:21

msys-sgarg changed the title ~~WIP:SPDX License feature UI and task changes~~ SPDX License feature UI and task changes Nov 12, 2021

msys-sgarg added 5 commits November 24, 2021 18:01

Rebase errors fixed

97c9729

Signed-off-by: smriti <sgarg@msystechnologies.com>

Changes for merge failure

6723be9

Signed-off-by: smriti <sgarg@msystechnologies.com>

Worker and service for SPDX license url update for cookbooks

9b6c067

Signed-off-by: smriti <sgarg@msystechnologies.com>

changes for ctl command

172d91b

Signed-off-by: smriti <sgarg@msystechnologies.com>

Changes in specs and docs finished for spdx ctl

c0be1ef

Signed-off-by: smriti <sgarg@msystechnologies.com>

msys-sgarg force-pushed the smriti/2188_spdx_license_link_to_cookbook branch from 865a0a1 to 397cf27 Compare November 24, 2021 13:00

msys-sgarg force-pushed the smriti/2188_spdx_license_link_to_cookbook branch 2 times, most recently from ceb1993 to b782667 Compare November 24, 2021 13:03

Commiting sample licenses.json

fc2fcee

Signed-off-by: smriti <sgarg@msystechnologies.com>

msys-sgarg force-pushed the smriti/2188_spdx_license_link_to_cookbook branch from b782667 to fc2fcee Compare November 24, 2021 13:11

saghoshprogress approved these changes Nov 25, 2021

View reviewed changes

tas50 merged commit 6f9b8d2 into main Nov 25, 2021

tas50 deleted the smriti/2188_spdx_license_link_to_cookbook branch November 25, 2021 18:16

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

SPDX License feature UI and task changes #2296

SPDX License feature UI and task changes #2296

msys-sgarg commented Oct 14, 2021 •

edited

msys-sgarg commented Oct 14, 2021

RajeshPaul38 Oct 18, 2021

msys-sgarg Oct 18, 2021

RajeshPaul38 Oct 18, 2021

RajeshPaul38 Oct 18, 2021

msys-sgarg Oct 18, 2021

RajeshPaul38 Oct 18, 2021

RajeshPaul38 Oct 18, 2021

RajeshPaul38 Oct 18, 2021

msys-sgarg Oct 18, 2021

RajeshPaul38 Oct 18, 2021 •

edited

saghoshprogress commented Oct 25, 2021

RajeshPaul38 commented Oct 29, 2021

tas50 Nov 6, 2021

msys-sgarg Nov 8, 2021

msys-sgarg Nov 8, 2021

tas50 Nov 8, 2021

msys-sgarg commented Nov 12, 2021

netlify bot commented Nov 24, 2021 •

edited

github-actions bot commented Nov 24, 2021

	result, message = UpdateSpdxLicenseUrl.on_version args[:cookbook_name], args[:version]
	result, message = UpdateSpdxLicenseUrl.on_version(args[:cookbook_name], args[:version])

SPDX License feature UI and task changes #2296

SPDX License feature UI and task changes #2296

Conversation

msys-sgarg commented Oct 14, 2021 • edited

Description

Issues Resolved

Check List

msys-sgarg commented Oct 14, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

RajeshPaul38 Oct 18, 2021 • edited

Choose a reason for hiding this comment

saghoshprogress commented Oct 25, 2021

RajeshPaul38 commented Oct 29, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

msys-sgarg commented Nov 12, 2021

netlify bot commented Nov 24, 2021 • edited

github-actions bot commented Nov 24, 2021

Simplecov Report

msys-sgarg commented Oct 14, 2021 •

edited

RajeshPaul38 Oct 18, 2021 •

edited

netlify bot commented Nov 24, 2021 •

edited