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

Handle empty component and service names #4146

Merged
merged 1 commit into from
Sep 13, 2024

Conversation

nscuro
Copy link
Member

@nscuro nscuro commented Sep 13, 2024

Description

Handles empty component and service names.

component.name and service.name are required as per CycloneDX specification, but the schema doesn't sufficiently enforce this requirement (CycloneDX/specification#461).

Because DT trims names from the BOM during model conversion, empty or blank names end up becoming null. Since the respective database columns have a NOT NULL constraint on them, inserting or updating such components will always fail.

Usually we would not want to try to "repair" data, but the name being empty appears to be so common that there's no other sensible way for us to deal with it.

With this change, empty names will end up being saved as - instead, to signal the absence of a proper value.

Addressed Issue

Fixes #2821

Additional Details

N/A

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

`component.name` and `service.name` are required as per CycloneDX specification, but the schema doesn't sufficiently enforce this requirement (CycloneDX/specification#461).

Because DT trims names from the BOM during model conversion, empty or blank names end up becoming `null`. Since the respective database columns have a `NOT NULL` constraint on them, inserting or updating such components will always fail.

Usually we would not want to try to "repair" data, but the name being empty appears to be so common that there's no other sensible way for us to deal with it.

With this change, empty names will end up being saved as `-` instead, to signal the absence of a proper value.

Fixes DependencyTrack#2821

Signed-off-by: nscuro <[email protected]>
@nscuro nscuro added the defect Something isn't working label Sep 13, 2024
@nscuro nscuro added this to the 4.12 milestone Sep 13, 2024
Copy link

Coverage summary from Codacy

See diff coverage on Codacy

Coverage variation Diff coverage
+0.00% (target: -1.00%) 100.00% (target: 70.00%)
Coverage variation details
Coverable lines Covered lines Coverage
Common ancestor commit (a15803f) 21934 17253 78.66%
Head commit (146b9e1) 21934 (+0) 17253 (+0) 78.66% (+0.00%)

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 (#4146) 2 2 100.00%

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

Codacy stopped sending the deprecated coverage status on June 5th, 2024. Learn more

@nscuro nscuro merged commit 2b0bfe1 into DependencyTrack:master Sep 13, 2024
11 checks passed
@nscuro nscuro deleted the handle-empty-names branch September 13, 2024 16:58
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Oct 14, 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.

DT not handling a blank name in an SBOM
1 participant