Add k8s.io/release/pkg/license package #1874
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Example run of test script (with licenses cached): |
|
Running times without licenses pre cached: |
pkg/license/license.go
Outdated
| // Get the license corresponding to the ID label | ||
| license := d.spdx.GetLicense(label) | ||
| if license == nil { | ||
| return nil, unrecognizedPaths, errors.Wrapf(nil, "ID does not correspond to a valid license: %s", label) |
There was a problem hiding this comment.
Wrapping a nil error will always result in nil.
This commit adds a new `license` package which as if now includes a new license reader that identifies licenses in a source code directory. The source consists of three parts: * The license reader code * The SPDX functions and data structures * A downloader object that gets and caches license data from spdx.org Signed-off-by: Adolfo García Veytia (Puerco) <adolfo.garcia@uservers.net>
This commit contains the autogenerated fakes to mock the implementations in the license package Signed-off-by: Adolfo García Veytia (Puerco) <adolfo.garcia@uservers.net>
Tests for the license package. They are split in a couple of unit tests performed in package and the rest, in their own package (license_test) Signed-off-by: Adolfo García Veytia (Puerco) <adolfo.garcia@uservers.net>
Signed-off-by: Adolfo García Veytia (Puerco) <adolfo.garcia@uservers.net>
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: puerco, saschagrunert The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What type of PR is this?
/kind feature
What this PR does / why we need it:
This PR adds a new
licensepackage which, as of now, includes a new license readerthat scans a directory and identifies license files located in it.
The main source consists of three parts:
* The license reader code
* The SPDX functions and data structures
* A downloader object that gets and caches license data from spdx.org
An example test program (see bellow for sample output):
After trying several solutions and even writing my own, I settled on using google's license classifier which turned out to be the most practical to use as well as the fastest and most accurate.
Which issue(s) this PR fixes:
Part of #1837
Special notes for your reviewer:
Tests and mock implementations are included. One test file contains unit tests that run in -package while the other has all unit and integration tests that run in its own package (license_test)
Does this PR introduce a user-facing change?