Skip to content
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.

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

Update License Of Existing Components On BOM Upload #3556

Merged

Conversation

aravindparappil46
Copy link
Contributor

@aravindparappil46 aravindparappil46 commented Mar 17, 2024

Description

When an SBOM is re-uploaded with different license information on an already imported component, the component should be updated with the new license.

Similarly, if license information previously existed on a component but not on a subsequent SBOM upload, the resolved license should be deleted from the component

Addressed Issue

Fixes #3498

Additional Details

In the V1 BomUploadProcessingTask, we were looking up licenses only if the component does not have a resolvedLicense already.

In such a case, if a new SBOM with an updated license for the component was uploaded, component.getResolvedLicense() == null will be false, since the component already had a previously resolved license and we would ignore the new license. Hence, removed this null check for getResolvedLicense().

On a similar note, the logic to lookup license is dependent on whether licenseChoice != null, which is correct. However, if licenseChoice == null , then we should consider that the component does not have a license and hence nullify the previously resolved license (which came from an earlier BOM upload)

The changes in ModelConverter.java are:

  • Remove if (component.getResolvedLicense() == null) and fix indentation
  • Add an else block to if (licenseChoice != null), which sets license fields to null

Checklist

  • I have read and understand the contributing guidelines
  • This PR fixes a defect, and I have provided tests to verify that the fix is effective
  • This PR implements an enhancement, and I have provided tests to verify that it works as intended
  • This PR introduces changes to the database model, and I have added corresponding update logic
  • This PR introduces new or alters existing behavior, and I have updated the documentation accordingly

When an SBOM is re-uploaded with different license information on an already imported component,
the component should be updated with the new license.

Similarly, if license information previously existed on a component but not on a subsequent SBOM upload,
the resolved license should be deleted from the component

Signed-off-by: Aravind Parappil <aravindparappil@gmail.com>
Copy link

Coverage summary from Codacy

See diff coverage on Codacy

Coverage variation Diff coverage
+0.04% (target: -1.00%) 85.71% (target: 70.00%)
Coverage variation details
Coverable lines Covered lines Coverage
Common ancestor commit (4356d02) 21523 15942 74.07%
Head commit (e55e950) 21527 (+4) 15953 (+11) 74.11% (+0.04%)

Coverage variation is the difference between the coverage for the head and common ancestor commits of the pull request branch: <coverage of head commit> - <coverage of common ancestor commit>

Diff coverage details
Coverable lines Covered lines Diff coverage
Pull request (#3556) 21 18 85.71%

Diff coverage is the percentage of lines that are covered by tests out of the coverable lines that the pull request added or modified: <covered lines added or modified>/<coverable lines added or modified> * 100%

See your quality gate settings    Change summary preferences

You may notice some variations in coverage metrics with the latest Coverage engine update. For more details, visit the documentation

@nscuro nscuro added this to the 4.11 milestone Mar 17, 2024
@nscuro nscuro added the defect Something isn't working label Mar 17, 2024
Copy link
Member

@nscuro nscuro left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Another quality PR, thanks @aravindparappil46!

@nscuro nscuro merged commit 5ace7dc into DependencyTrack:master Mar 17, 2024
12 checks passed
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Apr 17, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
defect Something isn't working
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Uploading a BOM doesn't update the license of any existing components
2 participants