BOM: Include full list of transient go dependencies #2085
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
k8s-ci-robot
added
release-note
k8s-ci-robot
added
area/release-eng
|
/milestone v1.22 |
puerco
force-pushed
the
deep-mods
branch
2 times, most recently
from
f4ad8e0 to
dfa6cbc
Compare
pkg/spdx/package.go
Outdated
| @@ -189,6 +222,7 @@ func (p *Package) Render() (docFragment string, err error) { | |||
| } | |||
|
|
|||
| // If files were analyzed, calculate the verification | |||
| filesTagList := map[string]*struct{}{} | |||
There was a problem hiding this comment.
Can we make this a []string?
There was a problem hiding this comment.
Done. One question: I use that map of empty structs a lot as a temp dict to look up things that have to be listed once instead of looping a slice over and over.
Is it more efficient to loop the slice?
There was a problem hiding this comment.
Is it more efficient to loop the slice?
In theory yes, but practically I don't know.
This commit makes the go module download code parallel. It also fixes a bug where the temprary go downlaods were not removed correctly. Signed-off-by: Adolfo García Veytia (Puerco) <[email protected]>
This commit reduces the verbosity of the license package by shifting some of the output to the debug level. It also fixes a bug where a division by zero may occur when reporting the number of licenses found. Signed-off-by: Adolfo García Veytia (Puerco) <[email protected]>
This commit modofies the behaviour of bom when scanning go modules to include all transient dependencies. All modules included in the as transient dependencies as reported by go list will now be included in the sbom. This commit also includes new code to take advantage of the local go module cache. When scanning gp package licenses, bom will use any packages already downloaded and determine the licensins information from there before attempting to download the modules. This PR also includes a new flag to `bom generate`: `--no-transient` When defined, this flag will revert to the original behvaiour where only direct go dependencies are included in the Bill of Materials. Signed-off-by: Adolfo García Veytia (Puerco) <[email protected]>
Signed-off-by: Adolfo García Veytia (Puerco) <[email protected]>
k8s-ci-robot
added
size/L
This commit also simplifies the data structure used to determine the LicenseInfoFromFiles entry in the PSDX package. Signed-off-by: Adolfo García Veytia (Puerco) <[email protected]>
saschagrunert
approved these changes
May 31, 2021
k8s-ci-robot
added
the
lgtm
|
[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 |
|
#2077 is merged |
k8s-ci-robot
removed
the
do-not-merge/hold
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 bug
/kind cleanup
/kind feature
/kind design
What this PR does / why we need it:
Full List of Dependencies is now the Default
Based on the discussion on #2077 this PR modifies the way we determine dependencies when scanning directories that contain go modules. All modules pulled by go as transient dependencies will now be included in the SBOM. The dependencies are determined by running
go -list --deps.This PR also includes code to take advantage of the local go
module cache. When scanning go package licenses,
bomwill use anypackages already downloaded and determine the licensing information
from there before attempting to download the modules. This results in a considerable performance improvement.
A new flag is introduced to
bom generate:--no-transientWhen set, this flag will revert to the original behvaior where only direct go dependencies are included in the Bill of Materials.
Parallel Downloads
When
bomhas to download go dependencies, all downloads will now be done in parallel, also resulting in a considerable performance improvement.License package bugfix
Finally, a bug in the license package has been fixed, avoiding an edge case where a division by zero would crash the program under certain cases. Also, the license output has been improved by shifting some of the output to log level debug.
Which issue(s) this PR fixes:
Part of #1837
Follow up to: #2077
Special notes for your reviewer:
Only the last 4 commits are relevant, needs a rebase once #2077 merges.
Hold until 2077 merged
/hold
Does this PR introduce a user-facing change?