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

Backport: Fix licenses not being resolved by name #3786

Merged
merged 1 commit into from
Jun 1, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -562,14 +562,14 @@ public static Component convert(final QueryManager qm, final org.cyclonedx.model
for (final org.cyclonedx.model.License cycloneLicense : licenseOptions) {
if (cycloneLicense != null) {
if (StringUtils.isNotBlank(cycloneLicense.getId())) {
final License license = qm.getLicense(StringUtils.trimToNull(cycloneLicense.getId()));
final License license = qm.getLicenseByIdOrName(StringUtils.trimToNull(cycloneLicense.getId()));
if (license != null) {
component.setResolvedLicense(license);
}
}
else if (StringUtils.isNotBlank(cycloneLicense.getName()))
{
final License license = qm.getLicense(StringUtils.trimToNull(cycloneLicense.getName()));
final License license = qm.getLicenseByIdOrName(StringUtils.trimToNull(cycloneLicense.getName()));
if (license != null) {
component.setResolvedLicense(license);
} else {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@
import javax.jdo.PersistenceManager;
import javax.jdo.Query;
import java.util.List;
import java.util.Map;

final class LicenseQueryManager extends QueryManager implements IQueryManager {

Expand Down Expand Up @@ -93,6 +94,18 @@ public License getLicense(String licenseId) {
return singleResult(query.execute(licenseId));
}

public License getLicenseByIdOrName(final String licenseIdOrName) {
final Query<License> query = pm.newQuery(License.class);
query.setFilter("licenseId == :licenseIdOrName || name == :licenseIdOrName");
query.setNamedParameters(Map.of("licenseIdOrName", licenseIdOrName));
try {
final License license = query.executeUnique();
return license != null ? license : License.UNRESOLVED;
} finally {
query.closeAll();
}
}

/**
* Returns a Custom License object from the specified name
* @param licenseName license name of custom license
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -620,6 +620,10 @@ public License getLicense(String licenseId) {
return getLicenseQueryManager().getLicense(licenseId);
}

public License getLicenseByIdOrName(final String licenseIdOrName) {
return getLicenseQueryManager().getLicenseByIdOrName(licenseIdOrName);
}

public License getCustomLicense(String licenseName) {
return getLicenseQueryManager().getCustomLicense(licenseName);
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -673,8 +673,7 @@ private static void resolveAndApplyLicense(final QueryManager qm,
// by priority, and simply take the first resolvable candidate.
for (final org.cyclonedx.model.License licenseCandidate : component.getLicenseCandidates()) {
if (isNotBlank(licenseCandidate.getId())) {
final License resolvedLicense = licenseCache.computeIfAbsent(licenseCandidate.getId(),
licenseId -> resolveLicense(qm, licenseId));
final License resolvedLicense = licenseCache.computeIfAbsent(licenseCandidate.getId(), qm::getLicenseByIdOrName);
if (resolvedLicense != License.UNRESOLVED) {
component.setResolvedLicense(resolvedLicense);
component.setLicenseUrl(trimToNull(licenseCandidate.getUrl()));
Expand All @@ -683,8 +682,7 @@ private static void resolveAndApplyLicense(final QueryManager qm,
}

if (isNotBlank(licenseCandidate.getName())) {
final License resolvedLicense = licenseCache.computeIfAbsent(licenseCandidate.getName(),
licenseName -> resolveLicense(qm, licenseName));
final License resolvedLicense = licenseCache.computeIfAbsent(licenseCandidate.getName(), qm::getLicenseByIdOrName);
if (resolvedLicense != License.UNRESOLVED) {
component.setResolvedLicense(resolvedLicense);
component.setLicenseUrl(trimToNull(licenseCandidate.getUrl()));
Expand Down Expand Up @@ -714,18 +712,6 @@ private static void resolveAndApplyLicense(final QueryManager qm,
}
}

private static License resolveLicense(final QueryManager qm, final String licenseId) {
final Query<License> query = qm.getPersistenceManager().newQuery(License.class);
query.setFilter("licenseId == :licenseId");
query.setParameters(licenseId);
try {
final License license = query.executeUnique();
return license != null ? license : License.UNRESOLVED;
} finally {
query.closeAll();
}
}

private static License resolveCustomLicense(final QueryManager qm, final String licenseName) {
final Query<License> query = qm.getPersistenceManager().newQuery(License.class);
query.setFilter("name == :name && customLicense == true");
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -1046,6 +1046,49 @@ public void informWithExistingComponentPropertiesAndBomWithComponentProperties()
});
}

@Test
public void informWithLicenseResolutionByNameTest() {
final var license = new License();
license.setLicenseId("MIT");
license.setName("MIT License");
qm.persist(license);

final var project = new Project();
project.setName("acme-license-app");
qm.persist(project);

final byte[] bomBytes = """
{
"bomFormat": "CycloneDX",
"specVersion": "1.4",
"serialNumber": "urn:uuid:3e671687-395b-41f5-a30f-a58921a69b80",
"version": 1,
"components": [
{
"type": "library",
"name": "acme-lib-x",
"licenses": [
{
"license": {
"name": "MIT License"
}
}
]
}
]
}
""".getBytes(StandardCharsets.UTF_8);

final var bomUploadEvent = new BomUploadEvent(qm.detach(Project.class, project.getId()), bomBytes);
new BomUploadProcessingTaskV2().inform(bomUploadEvent);
awaitBomProcessedNotification(bomUploadEvent);

assertThat(qm.getAllComponents(project)).satisfiesExactly(component -> {
assertThat(component.getResolvedLicense()).isNotNull();
assertThat(component.getResolvedLicense().getLicenseId()).isEqualTo("MIT");
});
}

@Test // https://github.com/DependencyTrack/dependency-track/issues/1905
public void informIssue1905Test() throws Exception {
// Known to now work with old task implementation.
Expand Down