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.

Sign up for GitHub

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

Jump to bottom

Backport: Set license name instead of ID when using custom license #3942

Merged
merged 1 commit into from
Jul 8, 2024
Merged

Backport: Set license name instead of ID when using custom license #3942

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion src/main/java/org/dependencytrack/parser/cyclonedx/util/ModelConverter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -754,7 +754,11 @@ public static org.cyclonedx.model.Component convert(final QueryManager qm, final
final LicenseChoice licenses = new LicenseChoice();
if (component.getResolvedLicense() != null) {
final org.cyclonedx.model.License license = new org.cyclonedx.model.License();
license.setId(component.getResolvedLicense().getLicenseId());
if (!component.getResolvedLicense().isCustomLicense()) {
license.setId(component.getResolvedLicense().getLicenseId());
} else {
license.setName(component.getResolvedLicense().getName());
}
license.setUrl(component.getLicenseUrl());
licenses.addLicense(license);
cycloneComponent.setLicenses(licenses);
Expand Down
75 changes: 75 additions & 0 deletions src/test/java/org/dependencytrack/resources/v1/BomResourceTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -312,6 +312,81 @@ public void exportProjectAsCycloneDxInventoryTest() {
assertThat(componentWithVulnAndAnalysis.getDirectDependencies()).isNotNull();
}

@Test
public void exportProjectAsCycloneDxLicenseTest() {
Project project = qm.createProject("Acme Example", null, "1.0", null, null, null, true, false);
Component c = new Component();
c.setProject(project);
c.setName("sample-component");
c.setVersion("1.0");
org.dependencytrack.model.License license = new org.dependencytrack.model.License();
license.setId(1234);
license.setName("CustomName");
license.setCustomLicense(true);
c.setResolvedLicense(license);
c.setDirectDependencies("[]");
Component component = qm.createComponent(c, false);
qm.persist(project);
Response response = jersey.target(V1_BOM + "/cyclonedx/project/" + project.getUuid()).request()
.header(X_API_KEY, apiKey)
.get(Response.class);

final String jsonResponse = getPlainTextBody(response);
assertThatNoException().isThrownBy(() -> CycloneDxValidator.getInstance().validate(jsonResponse.getBytes()));
assertThatJson(jsonResponse)
.withMatcher("component", equalTo(component.getUuid().toString()))
.withMatcher("projectUuid", equalTo(project.getUuid().toString()))
.isEqualTo(json("""
{
"bomFormat": "CycloneDX",
"specVersion": "1.5",
"serialNumber": "${json-unit.ignore}",
"version": 1,
"metadata": {
"timestamp": "${json-unit.any-string}",
"tools": [
{
"vendor": "OWASP",
"name": "Dependency-Track",
"version": "${json-unit.any-string}"
}
],
"component": {
"type": "library",
"bom-ref": "${json-unit.matches:projectUuid}",
"name": "Acme Example",
"version": "1.0"
}
},
"components": [
{
"type": "library",
"bom-ref": "${json-unit.matches:component}",
"name": "sample-component",
"version": "1.0",
"licenses": [
{
"license": {
"name": "CustomName"
}
}
]
}
],
"dependencies": [
{
"ref": "${json-unit.matches:projectUuid}",
"dependsOn": []
},
{
"ref": "${json-unit.matches:component}",
"dependsOn": []
}
]
}
"""));
}

@Test
public void exportProjectAsCycloneDxInventoryWithVulnerabilitiesTest() {
var vulnerability = new Vulnerability();
Expand Down