✨ feat(lockfile): Add resolve and repo id field to external poms (#1478)

Author: LogFlames

maven_plugin/src/main/java/io/github/chains_project/maven_lockfile/LockFileFacade.java

@@ -10,6 +10,8 @@
 import io.github.chains_project.maven_lockfile.data.MavenPlugin;
 import io.github.chains_project.maven_lockfile.data.MetaData;
 import io.github.chains_project.maven_lockfile.data.Pom;
+import io.github.chains_project.maven_lockfile.data.RepositoryId;
+import io.github.chains_project.maven_lockfile.data.ResolvedUrl;
 import io.github.chains_project.maven_lockfile.data.VersionNumber;
 import io.github.chains_project.maven_lockfile.graph.DependencyGraph;
 import io.github.chains_project.maven_lockfile.reporting.PluginLogManager;
@@ -367,7 +369,10 @@ private static Pom constructRecursivePom(
                             .relativize(project.getFile().toPath())
                             .toString();
             String checksum = null;
+            ResolvedUrl resolved = null;
+            RepositoryId repoId = null;
             if (project.getFile() == null) {
+                // External POM - get repository information
                 Artifact artifact = project.getArtifact();
                 Artifact pomArtifact = new DefaultArtifact(
                         artifact.getGroupId(),
@@ -378,6 +383,9 @@ private static Pom constructRecursivePom(
                         artifact.getClassifier(),
                         artifact.getArtifactHandler());
                 checksum = checksumCalculator.calculateArtifactChecksum(pomArtifact);
+                RepositoryInformation repoInfo = checksumCalculator.getArtifactResolvedField(pomArtifact);
+                resolved = repoInfo.getResolvedUrl();
+                repoId = repoInfo.getRepositoryId();
             } else {
                 checksum = checksumCalculator.calculatePomChecksum(
                         project.getFile().toPath());
@@ -387,6 +395,8 @@ private static Pom constructRecursivePom(
                     ArtifactId.of(project.getArtifactId()),
                     VersionNumber.of(project.getVersion()),
                     relativePath,
+                    resolved,
+                    repoId,
                     checksumAlgorithm,
                     checksum,
                     lastPom);

maven_plugin/src/main/java/io/github/chains_project/maven_lockfile/data/Pom.java

@@ -6,6 +6,8 @@ public class Pom implements Comparable<Pom> {
     private final ArtifactId artifactId;
     private final VersionNumber version;
     private final String relativePath;
+    private final ResolvedUrl resolved;
+    private final RepositoryId repositoryId;
     private final String checksumAlgorithm;
     private final String checksum;
     private final Pom parent;
@@ -15,13 +17,17 @@ public Pom(
             ArtifactId artifactId,
             VersionNumber version,
             String relativePath,
+            ResolvedUrl resolved,
+            RepositoryId repositoryId,
             String checksumAlgorithm,
             String checksum,
             Pom parent) {
         this.groupId = groupId;
         this.artifactId = artifactId;
         this.version = version;
         this.relativePath = relativePath;
+        this.resolved = resolved;
+        this.repositoryId = repositoryId;
         this.checksumAlgorithm = checksumAlgorithm;
         this.checksum = checksum;
         this.parent = parent;
@@ -43,6 +49,14 @@ public String getRelativePath() {
         return relativePath;
     }
 
+    public ResolvedUrl getResolved() {
+        return resolved;
+    }
+
+    public RepositoryId getRepositoryId() {
+        return repositoryId;
+    }
+
     public String getChecksumAlgorithm() {
         return checksumAlgorithm;
     }
@@ -76,6 +90,20 @@ public int compareTo(Pom o) {
             return pathCmp.compareTo(oPathCmp);
         }
 
+        ResolvedUrl resolvedCmp = this.resolved == null ? ResolvedUrl.Unresolved() : this.resolved;
+        ResolvedUrl oResolvedCmp = o.resolved == null ? ResolvedUrl.Unresolved() : o.resolved;
+
+        if (resolvedCmp.compareTo(oResolvedCmp) != 0) {
+            return resolvedCmp.compareTo(oResolvedCmp);
+        }
+
+        RepositoryId repoIdCmp = this.repositoryId == null ? RepositoryId.None() : this.repositoryId;
+        RepositoryId oRepoIdCmp = o.repositoryId == null ? RepositoryId.None() : o.repositoryId;
+
+        if (repoIdCmp.compareTo(oRepoIdCmp) != 0) {
+            return repoIdCmp.compareTo(oRepoIdCmp);
+        }
+
         if (this.checksumAlgorithm.compareTo(o.checksumAlgorithm) != 0) {
             return this.checksumAlgorithm.compareTo(o.checksumAlgorithm);
         }
@@ -108,16 +136,27 @@ public boolean equals(Object obj) {
             return false;
         }
         Pom other = (Pom) obj;
+        // Poms are either defined by their relative path or resolved from a repository by their GAV.
+        // We cannot know where poms defined by their relative path will be hosted and thus their
+        // resolved fields are null.
         String pathCmp = this.relativePath == null ? "" : this.relativePath;
         String otherPathCmp = other.relativePath == null ? "" : other.relativePath;
 
+        ResolvedUrl resolvedCmp = this.resolved == null ? ResolvedUrl.Unresolved() : this.resolved;
+        ResolvedUrl otherResolvedCmp = other.resolved == null ? ResolvedUrl.Unresolved() : other.resolved;
+
+        RepositoryId repoIdCmp = this.repositoryId == null ? RepositoryId.None() : this.repositoryId;
+        RepositoryId otherRepoIdCmp = other.repositoryId == null ? RepositoryId.None() : other.repositoryId;
+
         boolean parentEqual = (this.parent == null && other.parent == null)
                 || (this.parent != null && other.parent != null && this.parent.equals(other.parent));
 
         return this.groupId.equals(other.groupId)
                 && this.artifactId.equals(other.artifactId)
                 && this.version.equals(other.version)
                 && pathCmp.equals(otherPathCmp)
+                && resolvedCmp.equals(otherResolvedCmp)
+                && repoIdCmp.equals(otherRepoIdCmp)
                 && this.checksumAlgorithm.equals(other.checksumAlgorithm)
                 && this.checksum.equals(other.checksum)
                 && parentEqual;

maven_plugin/src/test/java/io/github/chains_project/maven_lockfile/graph/LockfileTest.java

@@ -42,7 +42,7 @@ void shouldLockFilesEqualWhenOrderIsChanged() {
                 groupId,
                 artifactId,
                 version,
-                new Pom(groupId, artifactId, version, "pom.xml", "SHA-256", "POM-CHECKSUM", null),
+                new Pom(groupId, artifactId, version, "pom.xml", null, null, "SHA-256", "POM-CHECKSUM", null),
                 Set.of(dependencyNodeA(dependencyNodeAChild1(), dependencyNodeAChild2()), dependencyNodeB()),
                 Set.of(pluginA(), pluginB()),
                 metadata);
@@ -51,7 +51,7 @@ void shouldLockFilesEqualWhenOrderIsChanged() {
                 groupId,
                 artifactId,
                 version,
-                new Pom(groupId, artifactId, version, "pom.xml", "SHA-256", "POM-CHECKSUM", null),
+                new Pom(groupId, artifactId, version, "pom.xml", null, null, "SHA-256", "POM-CHECKSUM", null),
                 Set.of(dependencyNodeB(), dependencyNodeA(dependencyNodeAChild1(), dependencyNodeAChild2())),
                 Set.of(pluginB(), pluginA()),
                 metadata);

maven_plugin/src/test/java/it/IntegrationTestsIT.java

@@ -568,6 +568,12 @@ public void externalParentPom(MavenExecutionResult result) throws Exception {
         assertThat(parentPom.getChecksum()).isNotBlank();
         // External pom should not have a relativePath
         assertThat(parentPom.getRelativePath()).isNull();
+        // External pom should have resolved URL and repositoryId
+        assertThat(parentPom.getResolved()).isNotNull();
+        assertThat(parentPom.getResolved().getValue()).contains("spring-boot-starter-parent");
+        assertThat(parentPom.getResolved().getValue()).endsWith(".pom");
+        assertThat(parentPom.getRepositoryId()).isNotNull();
+        assertThat(parentPom.getRepositoryId().getValue()).isNotBlank();
 
         // Verify grandparent pom is present (Spring Boot dependencies)
         var grandparentPom = parentPom.getParent();
@@ -577,6 +583,12 @@ public void externalParentPom(MavenExecutionResult result) throws Exception {
                 .extracting(ArtifactId::getValue)
                 .isEqualTo("spring-boot-dependencies");
         assertThat(grandparentPom.getChecksum()).isNotBlank();
+        // External grandparent pom should also have resolved URL and repositoryId
+        assertThat(grandparentPom.getResolved()).isNotNull();
+        assertThat(grandparentPom.getResolved().getValue()).contains("spring-boot-dependencies");
+        assertThat(grandparentPom.getResolved().getValue()).endsWith(".pom");
+        assertThat(grandparentPom.getRepositoryId()).isNotNull();
+        assertThat(grandparentPom.getRepositoryId().getValue()).isNotBlank();
     }
 
     @MavenTest
@@ -606,5 +618,8 @@ public void relativeParentPom(MavenExecutionResult result) throws Exception {
                 .isEqualTo("relative-parent-pom-parent-project");
         assertThat(parentPom.getChecksum()).isNotBlank();
         assertThat(parentPom.getRelativePath()).isEqualTo("../pom.xml");
+        // Local parent pom should NOT have resolved URL or repositoryId
+        assertThat(parentPom.getResolved()).isNull();
+        assertThat(parentPom.getRepositoryId()).isNull();
     }
 }