Allow forced alignment of groupId, artifactId and version (#361)

ohecker · web-flow · commit 8ca2d74905fd · 2026-03-23T17:23:15.000+01:00
* Allow forced alignment of groupId, artifactId and version to PackageURL when reading component data with Readers

* Fix spellcheck findings.
diff --git a/core/src/main/java/com/devonfw/tools/solicitor/common/ApplicationComponentCoordinates.java b/core/src/main/java/com/devonfw/tools/solicitor/common/ApplicationComponentCoordinates.java
@@ -0,0 +1,59 @@
+package com.devonfw.tools.solicitor.common;
+
+/**
+ * This class represents the coordinates of an application component.
+ */
+public class ApplicationComponentCoordinates {
+
+  private final String groupId;
+
+  private final String artifactId;
+
+  private final String version;
+
+  /**
+   * Creates a new instance of {@link ApplicationComponentCoordinates} with the given values.
+   *
+   * @param groupId the groupId
+   * @param artifactId the artifactId
+   * @param version the version
+   */
+  public ApplicationComponentCoordinates(String groupId, String artifactId, String version) {
+
+    super();
+    this.groupId = groupId;
+    this.artifactId = artifactId;
+    this.version = version;
+  }
+
+  /**
+   * This method gets the field <code>groupId</code>.
+   *
+   * @return the field groupId
+   */
+  public String getGroupId() {
+
+    return this.groupId;
+  }
+
+  /**
+   * This method gets the field <code>artifactId</code>.
+   *
+   * @return the field artifactId
+   */
+  public String getArtifactId() {
+
+    return this.artifactId;
+  }
+
+  /**
+   * This method gets the field <code>version</code>.
+   *
+   * @return the field version
+   */
+  public String getVersion() {
+
+    return this.version;
+  }
+
+}
diff --git a/core/src/main/java/com/devonfw/tools/solicitor/common/packageurl/PackageURLHandler.java b/core/src/main/java/com/devonfw/tools/solicitor/common/packageurl/PackageURLHandler.java
@@ -1,5 +1,6 @@
 package com.devonfw.tools.solicitor.common.packageurl;
 
+import com.devonfw.tools.solicitor.common.ApplicationComponentCoordinates;
 import com.github.packageurl.PackageURL;
 
 /**
@@ -45,4 +46,15 @@ public interface PackageURLHandler {
    */
   String sourceArchiveSuffixFor(PackageURL packageUrl) throws SolicitorPackageURLUnavailableOperationException;
 
+  /**
+   * Returns the coordinates of the application component represented by the given package URL.
+   *
+   * @param packageUrl the package URL of the package
+   * @return the coordinates of the application component represented by the given package URL
+   * @throws SolicitorPackageURLUnavailableOperationException if the method is unavailable in the implementing
+   *         {@link PackageURLHandler} or for the given {@link PackageURL}.
+   */
+  ApplicationComponentCoordinates coordinatesFor(PackageURL packageUrl)
+      throws SolicitorPackageURLUnavailableOperationException;
+
 }
diff --git a/core/src/main/java/com/devonfw/tools/solicitor/common/packageurl/impl/CranPackageURLHandlerImpl.java b/core/src/main/java/com/devonfw/tools/solicitor/common/packageurl/impl/CranPackageURLHandlerImpl.java
@@ -4,6 +4,7 @@
 import org.springframework.beans.factory.annotation.Value;
 import org.springframework.stereotype.Component;
 
+import com.devonfw.tools.solicitor.common.ApplicationComponentCoordinates;
 import com.github.packageurl.PackageURL;
 
 /**
@@ -88,4 +89,10 @@ protected String doSourceArchiveSuffixFor(PackageURL purl) {
 
     return "tar.gz";
   }
+
+  @Override
+  public ApplicationComponentCoordinates coordinatesFor(PackageURL packageUrl) {
+
+    return new ApplicationComponentCoordinates(null, packageUrl.getName(), packageUrl.getVersion());
+  }
 }
diff --git a/core/src/main/java/com/devonfw/tools/solicitor/common/packageurl/impl/DelegatingPackageURLHandlerImpl.java b/core/src/main/java/com/devonfw/tools/solicitor/common/packageurl/impl/DelegatingPackageURLHandlerImpl.java
@@ -7,6 +7,7 @@
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.stereotype.Component;
 
+import com.devonfw.tools.solicitor.common.ApplicationComponentCoordinates;
 import com.devonfw.tools.solicitor.common.packageurl.AllKindsPackageURLHandler;
 import com.devonfw.tools.solicitor.common.packageurl.PackageURLHandler;
 import com.devonfw.tools.solicitor.common.packageurl.SolicitorPackageURLUnavailableOperationException;
@@ -60,4 +61,10 @@ public String sourceArchiveSuffixFor(PackageURL packageUrl) throws SolicitorPack
     return findApplicableDelegateHandler(packageUrl).sourceArchiveSuffixFor(packageUrl);
   }
 
+  @Override
+  public ApplicationComponentCoordinates coordinatesFor(PackageURL packageUrl)
+      throws SolicitorPackageURLUnavailableOperationException {
+
+    return findApplicableDelegateHandler(packageUrl).coordinatesFor(packageUrl);
+  }
 }
diff --git a/core/src/main/java/com/devonfw/tools/solicitor/common/packageurl/impl/FallbackPackageURLHandlerImpl.java b/core/src/main/java/com/devonfw/tools/solicitor/common/packageurl/impl/FallbackPackageURLHandlerImpl.java
@@ -2,6 +2,7 @@
 
 import org.springframework.stereotype.Component;
 
+import com.devonfw.tools.solicitor.common.ApplicationComponentCoordinates;
 import com.devonfw.tools.solicitor.common.packageurl.SolicitorPackageURLUnavailableOperationException;
 import com.github.packageurl.PackageURL;
 
@@ -42,4 +43,12 @@ public String sourceArchiveSuffixFor(PackageURL packageUrl) throws SolicitorPack
         "No package suffix can be determined for PackageUrl '" + packageUrl + "'");
   }
 
+  @Override
+  public ApplicationComponentCoordinates coordinatesFor(PackageURL packageUrl)
+      throws SolicitorPackageURLUnavailableOperationException {
+
+    throw new SolicitorPackageURLUnavailableOperationException(
+        "No coordinates can be determined for PackageUrl '" + packageUrl + "'");
+  }
+
 }
diff --git a/core/src/main/java/com/devonfw/tools/solicitor/common/packageurl/impl/MavenPackageURLHandlerImpl.java b/core/src/main/java/com/devonfw/tools/solicitor/common/packageurl/impl/MavenPackageURLHandlerImpl.java
@@ -4,6 +4,7 @@
 import org.springframework.beans.factory.annotation.Value;
 import org.springframework.stereotype.Component;
 
+import com.devonfw.tools.solicitor.common.ApplicationComponentCoordinates;
 import com.github.packageurl.PackageURL;
 
 /**
@@ -64,4 +65,14 @@ public String doSourceArchiveSuffixFor(PackageURL purl) {
     return "jar";
   }
 
+  @Override
+  public ApplicationComponentCoordinates coordinatesFor(PackageURL packageUrl) {
+
+    if (packageUrl.getNamespace() == null) {
+      throw new IllegalArgumentException("A maven package URL must have a namespace (groupId) : " + packageUrl);
+    }
+    return new ApplicationComponentCoordinates(packageUrl.getNamespace(), packageUrl.getName(),
+        packageUrl.getVersion());
+  }
+
 }
diff --git a/core/src/main/java/com/devonfw/tools/solicitor/common/packageurl/impl/NpmPackageURLHandlerImpl.java b/core/src/main/java/com/devonfw/tools/solicitor/common/packageurl/impl/NpmPackageURLHandlerImpl.java
@@ -4,6 +4,7 @@
 import org.springframework.beans.factory.annotation.Value;
 import org.springframework.stereotype.Component;
 
+import com.devonfw.tools.solicitor.common.ApplicationComponentCoordinates;
 import com.github.packageurl.PackageURL;
 
 /**
@@ -66,4 +67,20 @@ protected String doSourceArchiveSuffixFor(PackageURL packageURL) {
     return "tgz";
   }
 
+  @Override
+  public ApplicationComponentCoordinates coordinatesFor(PackageURL packageUrl) {
+
+    if (packageUrl.getNamespace() == null) {
+      return new ApplicationComponentCoordinates(null, packageUrl.getName(), packageUrl.getVersion());
+    } else {
+      // due to historical reasons the namespace is not mapped to groupId in Solicitor, but instead is part of the
+      // artifactId. So we need to merge namespace and name here. From todays standpoint this does not follow the
+      // standard mapping of packageURL to coordinates, but we need to do this for npm to not break existing usage of
+      // npm package URLs in Solicitor. In the future we should consider to change this and map namespace to groupId and
+      // name to artifactId, but that would be a breaking change.
+      return new ApplicationComponentCoordinates(null, packageUrl.getNamespace() + "/" + packageUrl.getName(),
+          packageUrl.getVersion());
+    }
+  }
+
 }
diff --git a/core/src/main/java/com/devonfw/tools/solicitor/common/packageurl/impl/NugetPackageURLHandlerImpl.java b/core/src/main/java/com/devonfw/tools/solicitor/common/packageurl/impl/NugetPackageURLHandlerImpl.java
@@ -4,6 +4,7 @@
 import org.springframework.beans.factory.annotation.Value;
 import org.springframework.stereotype.Component;
 
+import com.devonfw.tools.solicitor.common.ApplicationComponentCoordinates;
 import com.github.packageurl.PackageURL;
 
 @Component
@@ -53,4 +54,10 @@ public String doSourceArchiveSuffixFor(PackageURL packageURL) {
     return "nupkg";
   }
 
+  @Override
+  public ApplicationComponentCoordinates coordinatesFor(PackageURL packageUrl) {
+
+    return new ApplicationComponentCoordinates(null, packageUrl.getName(), packageUrl.getVersion());
+  }
+
 }
diff --git a/core/src/main/java/com/devonfw/tools/solicitor/common/packageurl/impl/PyPIPackageURLHandlerImpl.java b/core/src/main/java/com/devonfw/tools/solicitor/common/packageurl/impl/PyPIPackageURLHandlerImpl.java
@@ -4,6 +4,7 @@
 import org.springframework.beans.factory.annotation.Value;
 import org.springframework.stereotype.Component;
 
+import com.devonfw.tools.solicitor.common.ApplicationComponentCoordinates;
 import com.github.packageurl.PackageURL;
 
 /**
@@ -65,4 +66,10 @@ public String doSourceArchiveSuffixFor(PackageURL purl) {
     return "tar.gz";
   }
 
+  @Override
+  public ApplicationComponentCoordinates coordinatesFor(PackageURL packageUrl) {
+
+    return new ApplicationComponentCoordinates(null, packageUrl.getName(), packageUrl.getVersion());
+  }
+
 }
diff --git a/core/src/main/java/com/devonfw/tools/solicitor/reader/AbstractReader.java b/core/src/main/java/com/devonfw/tools/solicitor/reader/AbstractReader.java
@@ -11,8 +11,11 @@
 import org.slf4j.LoggerFactory;
 import org.springframework.beans.factory.annotation.Autowired;
 
+import com.devonfw.tools.solicitor.common.ApplicationComponentCoordinates;
 import com.devonfw.tools.solicitor.common.InputStreamFactory;
 import com.devonfw.tools.solicitor.common.LogMessages;
+import com.devonfw.tools.solicitor.common.packageurl.AllKindsPackageURLHandler;
+import com.devonfw.tools.solicitor.common.packageurl.SolicitorPackageURLUnavailableOperationException;
 import com.devonfw.tools.solicitor.model.ModelFactory;
 import com.devonfw.tools.solicitor.model.inventory.ApplicationComponent;
 import com.devonfw.tools.solicitor.model.inventory.RawLicense;
@@ -59,6 +62,8 @@ public static class ReaderStatistics {
 
   private ModelFactory modelFactory;
 
+  private AllKindsPackageURLHandler packageURLHandler;
+
   @Autowired
   protected InputStreamFactory inputStreamFactory;
 
@@ -189,10 +194,41 @@ public boolean addComponentToApplicationIfNotFiltered(Application application, A
       statistics.filteredComponentCount++;
       return false;
     }
+    possiblyCorrectCoordinatesViaPurlData(appComponent, configuration);
     appComponent.setApplication(application);
     return true;
   }
 
+  /**
+   * Checks if the configuration contains the parameter "deriveCoordinatesFromPurl" set to "true" and if so tries to
+   * obtain coordinates for the appComponent from the purl data and overwrite the previously set coordinates with the
+   * ones obtained from the purl as they map better to the naming convention used by Solicitor.
+   *
+   * @param appComponent the appComponent for which the coordinates should potentially be corrected based on purl data
+   * @param configuration the configuration which might contain the parameter "deriveCoordinatesFromPurl" set to
+   *        "true"
+   */
+  private void possiblyCorrectCoordinatesViaPurlData(ApplicationComponent appComponent,
+      Map<String, String> configuration) {
+
+    if (configuration != null && "true".equals(configuration.get("deriveCoordinatesFromPurl"))) {
+      if (appComponent.getPackageUrl() != null) {
+        try {
+          ApplicationComponentCoordinates coordinates = this.packageURLHandler
+              .coordinatesFor(appComponent.getPackageUrl());
+          // if we can map the purl to coordinates then we overwrite the previously set coordinates with the
+          // ones
+          // obtained from the purl as they map better to the naming convention used by Solicitor
+          appComponent.setGroupId(coordinates.getGroupId());
+          appComponent.setArtifactId(coordinates.getArtifactId());
+          appComponent.setVersion(coordinates.getVersion());
+        } catch (SolicitorPackageURLUnavailableOperationException e) {
+          // if we do not know how to map to coordinates then we silently skip this
+        }
+      }
+    }
+  }
+
   /**
    * This method gets the field <code>modelFactory</code>.
    *
@@ -232,4 +268,15 @@ public void setModelFactory(ModelFactory modelFactory) {
     this.modelFactory = modelFactory;
   }
 
+  /**
+   * This method gets the field <code>packageURLHandler</code>.
+   *
+   * @param packageURLHandler the packageURLHandler to set
+   */
+  @Autowired
+  public void setPackageURLHandler(AllKindsPackageURLHandler packageURLHandler) {
+
+    this.packageURLHandler = packageURLHandler;
+  }
+
 }
diff --git a/core/src/test/java/com/devonfw/tools/solicitor/common/packageurl/impl/CranPackageURLHandlerTests.java b/core/src/test/java/com/devonfw/tools/solicitor/common/packageurl/impl/CranPackageURLHandlerTests.java
@@ -2,10 +2,12 @@
 
 import static org.junit.jupiter.api.Assertions.assertEquals;
 import static org.junit.jupiter.api.Assertions.assertFalse;
+import static org.junit.jupiter.api.Assertions.assertNull;
 import static org.junit.jupiter.api.Assertions.assertTrue;
 
 import org.junit.jupiter.api.Test;
 
+import com.devonfw.tools.solicitor.common.ApplicationComponentCoordinates;
 import com.devonfw.tools.solicitor.common.PackageURLHelper;
 import com.devonfw.tools.solicitor.common.packageurl.SolicitorMalformedPackageURLException;
 
@@ -54,4 +56,15 @@ void testPathFor() throws SolicitorMalformedPackageURLException {
     CranPackageURLHandlerImpl handler = new CranPackageURLHandlerImpl("http://test/");
     assertEquals("pkg/cran/someprod/4.5.35", handler.pathFor(PackageURLHelper.fromString("pkg:cran/someprod@4.5.35")));
   }
+
+  @Test
+  void testCoordinatesFor() throws SolicitorMalformedPackageURLException {
+
+    CranPackageURLHandlerImpl handler = new CranPackageURLHandlerImpl("http://test/");
+    ApplicationComponentCoordinates result = handler
+        .coordinatesFor(PackageURLHelper.fromString("pkg:cran/someprod@4.5.35"));
+    assertNull(result.getGroupId());
+    assertEquals("someprod", result.getArtifactId());
+    assertEquals("4.5.35", result.getVersion());
+  }
 }
diff --git a/core/src/test/java/com/devonfw/tools/solicitor/common/packageurl/impl/MavenPackageURLHandlerTests.java b/core/src/test/java/com/devonfw/tools/solicitor/common/packageurl/impl/MavenPackageURLHandlerTests.java
@@ -7,6 +7,7 @@
 import org.junit.jupiter.api.Assertions;
 import org.junit.jupiter.api.Test;
 
+import com.devonfw.tools.solicitor.common.ApplicationComponentCoordinates;
 import com.devonfw.tools.solicitor.common.PackageURLHelper;
 import com.devonfw.tools.solicitor.common.packageurl.SolicitorMalformedPackageURLException;
 
@@ -57,4 +58,16 @@ void testPathForFailsForForgedPackageName() {
       handler.pathFor(PackageURLHelper.fromString("pkg:maven/com.someorg/some..prod@4.5.35"));
     });
   }
+
+  @Test
+  void testCoordinatesFor() throws SolicitorMalformedPackageURLException {
+
+    MavenPackageURLHandlerImpl handler = new MavenPackageURLHandlerImpl("http://test/");
+    ApplicationComponentCoordinates result = handler
+        .coordinatesFor(PackageURLHelper.fromString("pkg:maven/com.someorg/someprod@4.5.35"));
+    assertEquals("com.someorg", result.getGroupId());
+    assertEquals("someprod", result.getArtifactId());
+    assertEquals("4.5.35", result.getVersion());
+  }
+
 }
diff --git a/core/src/test/java/com/devonfw/tools/solicitor/common/packageurl/impl/NpmPackageURLHandlerTests.java b/core/src/test/java/com/devonfw/tools/solicitor/common/packageurl/impl/NpmPackageURLHandlerTests.java
diff --git a/core/src/test/java/com/devonfw/tools/solicitor/common/packageurl/impl/NugetPackageURLHandlerTests.java b/core/src/test/java/com/devonfw/tools/solicitor/common/packageurl/impl/NugetPackageURLHandlerTests.java
diff --git a/core/src/test/java/com/devonfw/tools/solicitor/common/packageurl/impl/PyPIPackageURLHandlerTests.java b/core/src/test/java/com/devonfw/tools/solicitor/common/packageurl/impl/PyPIPackageURLHandlerTests.java
diff --git a/core/src/test/java/com/devonfw/tools/solicitor/reader/cyclonedx/CyclonedxReaderTests.java b/core/src/test/java/com/devonfw/tools/solicitor/reader/cyclonedx/CyclonedxReaderTests.java
diff --git a/documentation/master-solicitor.asciidoc b/documentation/master-solicitor.asciidoc
diff --git a/solicitor.dict b/solicitor.dict
