Skip to content

SBOM: fix issue with unresolved artifacts and empty "components" #688

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

Merged
merged 2 commits into from
Feb 14, 2025
Merged

SBOM: fix issue with unresolved artifacts and empty "components" #688

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f60ed42
SBOM: fix issue with unresolved artifact
rudsberg Jan 31, 2025
5532735
SBOM: fallback if augmented SBOM generation fails
rudsberg Jan 31, 2025
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
2 changes: 2 additions & 0 deletions ...n-plugin/src/functionalTest/groovy/org/graalvm/buildtools/maven/SBOMFunctionalTest.groovy
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,7 @@ class SBOMFunctionalTest extends AbstractGraalVMMavenFunctionalTest {
buildSucceeded
outputContainsPattern".*CycloneDX SBOM with \\d+ component\\(s\\) is embedded in binary \\(.*?\\) and exported as JSON \\(see build artifacts\\)\\."
outputDoesNotContain "Use '--enable-sbom' to assemble a Software Bill of Materials (SBOM)"
outputDoesNotContain "Could not generate an augmented SBOM"
validateExportedSBOM sbom
!file(String.format("target/%s", SBOMGenerator.SBOM_FILENAME)).exists()
outputContains "Hello, native!"
Expand All @@ -101,6 +102,7 @@ class SBOMFunctionalTest extends AbstractGraalVMMavenFunctionalTest {
buildSucceeded
outputContainsPattern".*CycloneDX SBOM with \\d+ component\\(s\\) is embedded in binary \\(.*?\\)."
outputDoesNotContain "Use '--enable-sbom' to assemble a Software Bill of Materials (SBOM)"
outputDoesNotContain "Could not generate an augmented SBOM"
!file(String.format("target/%s", SBOMGenerator.SBOM_FILENAME)).exists()
outputContains "Hello, native!"
}
Expand Down
11 changes: 10 additions & 1 deletion native-maven-plugin/src/main/java/org/graalvm/buildtools/maven/NativeCompileNoForkMojo.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -177,7 +177,16 @@ private void generateAugmentedSBOMIfNeeded() throws IllegalArgumentException, Mo
}

var sbomGenerator = new SBOMGenerator(mavenProject, mavenSession, pluginManager, repositorySystem, mainClass, logger);
sbomGenerator.generate();
try {
sbomGenerator.generate();
} catch (MojoExecutionException e) {
/* Only throw exception for users that explicitly opt-in to using augmented SBOMs. */
if (optionWasSet) {
throw e;
}
logger.warn(String.format("Could not generate an augmented SBOM: %s. Fallback to generating a non-augmented SBOM.",
e.getCause().getMessage()));
}
}

private String consumeConfigurationNodeValue(String pluginKey, String... nodeNames) {
Expand Down
10 changes: 8 additions & 2 deletions ...plugin/src/main/java/org/graalvm/buildtools/maven/sbom/ArtifactToPackageNameResolver.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ Set<ArtifactAdapter> getArtifactAdapters() throws Exception {
return artifactsWithPackageNameMappings;
}

private Optional<ArtifactAdapter> resolvePackageNamesFromArtifact(Artifact artifact) throws ArtifactResolutionException, IOException {
private Optional<ArtifactAdapter> resolvePackageNamesFromArtifact(Artifact artifact) throws IOException {
File artifactFile = artifact.getFile();
if (artifactFile != null && artifactFile.exists()) {
return resolvePackageNamesFromArtifactFile(artifactFile, ArtifactAdapter.fromMavenArtifact(artifact));
Expand All @@ -124,7 +124,13 @@ private Optional<ArtifactAdapter> resolvePackageNamesFromArtifact(Artifact artif
.setArtifact(sourceArtifact)
.setRepositories(remoteRepositories);

ArtifactResult result = repositorySystem.resolveArtifact(repositorySystemSession, request);
ArtifactResult result;
try {
result = repositorySystem.resolveArtifact(repositorySystemSession, request);
} catch (ArtifactResolutionException e) {
return Optional.empty();
}

if (result != null && result.getArtifact() != null && result.getArtifact().getFile() != null) {
File sourceFile = result.getArtifact().getFile();
return resolvePackageNamesFromArtifactFile(sourceFile, ArtifactAdapter.fromEclipseArtifact(result.getArtifact()));
Expand Down
7 changes: 2 additions & 5 deletions native-maven-plugin/src/main/java/org/graalvm/buildtools/maven/sbom/SBOMGenerator.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -238,13 +238,10 @@ private void augmentSBOM(Path baseSBOMPath, Set<ArtifactAdapter> artifacts) thro
JSONObject sbomJson = new JSONObject(Files.readString(baseSBOMPath));

JSONArray componentsArray = sbomJson.optJSONArray("components");
if (componentsArray == null) {
throw new RuntimeException(String.format("SBOM generated by %s:%s contained no components.", Plugin.groupId, Plugin.artifactId));
if (componentsArray != null) {
componentsArray.forEach(componentNode -> augmentComponentNode((JSONObject) componentNode, artifacts));
}

/* Augment the "components" */
componentsArray.forEach(componentNode -> augmentComponentNode((JSONObject) componentNode, artifacts));

/* Augment the main component in "metadata/component" */
JSONObject metadataNode = sbomJson.optJSONObject("metadata");
if (metadataNode != null && metadataNode.has("component")) {
Expand Down
Loading