You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@isis.apache.org by ah...@apache.org on 2020/09/09 12:59:41 UTC

[isis] branch master updated: ISIS-2426: tooling: also inspect pom.xml when visiting gradle tree

This is an automated email from the ASF dual-hosted git repository.

ahuber pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/isis.git


The following commit(s) were added to refs/heads/master by this push:
     new 600db6a  ISIS-2426: tooling: also inspect pom.xml when visiting gradle tree
600db6a is described below

commit 600db6aaf2c55e0c77249fe178b45efef137d536
Author: Andi Huber <ah...@apache.org>
AuthorDate: Wed Sep 9 14:59:22 2020 +0200

    ISIS-2426: tooling: also inspect pom.xml when visiting gradle tree
    
    the gradle model holds no maven artifact info
    so we resort to the info from pom.xml files
---
 .../isis/tooling/projectmodel/ArtifactKey.java     | 61 ++++++++++++++++++++++
 .../isis/tooling/projectmodel/ProjectNode.java     |  4 +-
 .../tooling/projectmodel/ProjectNodeFactory.java   | 29 ++++++++--
 .../projectmodel/maven/MavenModelFactory.java      |  4 +-
 .../tooling/projectmodel/test/ProjectTreeTest.java | 29 ++++++++--
 5 files changed, 116 insertions(+), 11 deletions(-)

diff --git a/tooling/project-model/src/main/java/org/apache/isis/tooling/projectmodel/ArtifactKey.java b/tooling/project-model/src/main/java/org/apache/isis/tooling/projectmodel/ArtifactKey.java
new file mode 100644
index 0000000..f005357
--- /dev/null
+++ b/tooling/project-model/src/main/java/org/apache/isis/tooling/projectmodel/ArtifactKey.java
@@ -0,0 +1,61 @@
+/*
+ *  Licensed to the Apache Software Foundation (ASF) under one
+ *  or more contributor license agreements.  See the NOTICE file
+ *  distributed with this work for additional information
+ *  regarding copyright ownership.  The ASF licenses this file
+ *  to you under the Apache License, Version 2.0 (the
+ *  "License"); you may not use this file except in compliance
+ *  with the License.  You may obtain a copy of the License at
+ *
+ *        http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *  Unless required by applicable law or agreed to in writing,
+ *  software distributed under the License is distributed on an
+ *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ *  KIND, either express or implied.  See the License for the
+ *  specific language governing permissions and limitations
+ *  under the License.
+ */
+package org.apache.isis.tooling.projectmodel;
+
+import java.util.Comparator;
+import java.util.concurrent.atomic.AtomicReference;
+
+import org.apache.maven.artifact.versioning.ComparableVersion;
+
+import lombok.NonNull;
+import lombok.Value;
+
+@Value(staticConstructor = "of")
+public class ArtifactKey implements Comparator<ArtifactKey> {
+
+    @NonNull private final String groupId;
+    @NonNull private final String artifactId;
+    @NonNull private final String version;
+    
+    private final AtomicReference<ComparableVersion> comparableVersion = new AtomicReference<ComparableVersion>();
+    
+    @Override
+    public String toString() {
+        return String.format("%s:%s:%s", groupId, artifactId, version); 
+    }
+
+    // -- COMPARATOR
+    
+    private final static Comparator<ArtifactKey> comparator = Comparator
+            .comparing(ArtifactKey::getGroupId)
+            .thenComparing(ArtifactKey::getComparableVersion);
+    
+    private ComparableVersion getComparableVersion() {
+        if(comparableVersion.get()==null) {
+            comparableVersion.set(new ComparableVersion(getVersion()));
+        }
+        return comparableVersion.get();
+    }
+    
+    @Override
+    public int compare(ArtifactKey o1, ArtifactKey o2) {
+        return comparator.compare(o1, o2);
+    }
+    
+}
diff --git a/tooling/project-model/src/main/java/org/apache/isis/tooling/projectmodel/ProjectNode.java b/tooling/project-model/src/main/java/org/apache/isis/tooling/projectmodel/ProjectNode.java
index 5de56d3..ff68946 100644
--- a/tooling/project-model/src/main/java/org/apache/isis/tooling/projectmodel/ProjectNode.java
+++ b/tooling/project-model/src/main/java/org/apache/isis/tooling/projectmodel/ProjectNode.java
@@ -30,9 +30,9 @@ public class ProjectNode {
 
     @ToString.Exclude private final ProjectNode parent;
     @ToString.Exclude private final TreeSet<ProjectNode> children = new TreeSet<ProjectNode>(
-            (a,b)->a.getArtifactId().compareTo(b.getArtifactId()));
+            (a,b)->a.getName().compareTo(b.getName()));
     
-    private final String artifactId;
+    private final ArtifactKey artifactKey;
     private final String name;
     private final String description;
     
diff --git a/tooling/project-model/src/main/java/org/apache/isis/tooling/projectmodel/ProjectNodeFactory.java b/tooling/project-model/src/main/java/org/apache/isis/tooling/projectmodel/ProjectNodeFactory.java
index 4fad900..f57112a 100644
--- a/tooling/project-model/src/main/java/org/apache/isis/tooling/projectmodel/ProjectNodeFactory.java
+++ b/tooling/project-model/src/main/java/org/apache/isis/tooling/projectmodel/ProjectNodeFactory.java
@@ -31,7 +31,9 @@ import org.apache.isis.tooling.projectmodel.maven.MavenModelFactory;
 import org.apache.isis.tooling.projectmodel.maven.SimpleModelResolver;
 
 import lombok.val;
+import lombok.extern.log4j.Log4j2;
 
+@Log4j2
 public class ProjectNodeFactory {
 
     public static ProjectNode maven(File projRootFolder) {
@@ -70,7 +72,7 @@ public class ProjectNodeFactory {
     private static ProjectNode toProjectNode(ProjectNode parent, Model mavenProj) {
         val projNode = ProjectNode.builder()
                 .parent(parent)
-                .artifactId(mavenProj.getArtifactId())
+                .artifactKey(artifactKeyOf(mavenProj))
                 .name(mavenProj.getName())
                 .build();
 
@@ -82,8 +84,14 @@ public class ProjectNodeFactory {
 
     }
     
+    private static ArtifactKey artifactKeyOf(Model mavenProj) {
+        val groupId = MavenModelFactory.getGroupId(mavenProj);
+        val artifactId = mavenProj.getArtifactId();
+        val version = MavenModelFactory.getVersion(mavenProj);
+        return ArtifactKey.of(groupId, artifactId, version);
+    }
+    
     private static Iterable<Model> childrenOf(Model mavenProj, SimpleModelResolver modelResolver) {
-        
         return Stream.<String>concat(
                 mavenProj.getProfiles().stream().flatMap(profile->profile.getModules().stream()),
                 mavenProj.getModules().stream())
@@ -106,7 +114,7 @@ public class ProjectNodeFactory {
     private static ProjectNode toProjectNode(ProjectNode parent, GradleProject gradleProj) {
         val projNode = ProjectNode.builder()
                 .parent(parent)
-                .artifactId(gradleProj.getProjectIdentifier().getProjectPath())
+                .artifactKey(artifactKeyOf(gradleProj))
                 .name(gradleProj.getName())
                 .build();
         if(parent!=null) {
@@ -115,6 +123,19 @@ public class ProjectNodeFactory {
         return projNode;
     }
 
-
+    private static ArtifactKey artifactKeyOf(GradleProject gradleProj) {
+        val pomFile = new File(gradleProj.getProjectDirectory().getAbsoluteFile(), "pom.xml");
+        if(pomFile.canRead()) {
+            val mavenModel = MavenModelFactory.readModel(pomFile);
+            if(mavenModel!=null) {
+                return artifactKeyOf(mavenModel);
+            }
+        }
+        log.warn("cannot find pom.xml for project {} at {}", gradleProj.getName(), pomFile.getAbsolutePath());
+        val groupId = "?";
+        val artifactId = gradleProj.getName();
+        val version = "?";
+        return ArtifactKey.of(groupId, artifactId, version);
+    }
 
 }
diff --git a/tooling/project-model/src/main/java/org/apache/isis/tooling/projectmodel/maven/MavenModelFactory.java b/tooling/project-model/src/main/java/org/apache/isis/tooling/projectmodel/maven/MavenModelFactory.java
index 2c8f003..d016f15 100644
--- a/tooling/project-model/src/main/java/org/apache/isis/tooling/projectmodel/maven/MavenModelFactory.java
+++ b/tooling/project-model/src/main/java/org/apache/isis/tooling/projectmodel/maven/MavenModelFactory.java
@@ -88,11 +88,11 @@ public class MavenModelFactory {
         return artifactKey;
     }
     
-    private static String getGroupId(Model model) {
+    public static String getGroupId(Model model) {
         return Optional.ofNullable(model.getGroupId()).orElseGet(()->model.getParent().getGroupId());
     }
     
-    private static String getVersion(Model model) {
+    public static String getVersion(Model model) {
         return Optional.ofNullable(model.getVersion()).orElseGet(()->model.getParent().getVersion());
     }
     
diff --git a/tooling/project-model/src/test/java/org/apache/isis/tooling/projectmodel/test/ProjectTreeTest.java b/tooling/project-model/src/test/java/org/apache/isis/tooling/projectmodel/test/ProjectTreeTest.java
index e2efec0..6bff2cc 100644
--- a/tooling/project-model/src/test/java/org/apache/isis/tooling/projectmodel/test/ProjectTreeTest.java
+++ b/tooling/project-model/src/test/java/org/apache/isis/tooling/projectmodel/test/ProjectTreeTest.java
@@ -19,11 +19,16 @@
 package org.apache.isis.tooling.projectmodel.test;
 
 import java.io.File;
+import java.util.HashSet;
+import java.util.Set;
 
 import org.junit.jupiter.api.AfterEach;
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
 
+import static org.junit.jupiter.api.Assertions.assertFalse;
+import static org.junit.jupiter.api.Assertions.assertTrue;
+
 import org.apache.isis.tooling.projectmodel.ProjectNodeFactory;
 import org.apache.isis.tooling.projectmodel.ProjectVisitor;
 
@@ -48,10 +53,14 @@ class ProjectTreeTest {
         
         val projTree = ProjectNodeFactory.gradle(projRootFolder);
         
-        ProjectVisitor projectVisitor = projModel -> {System.out.println(projModel);};
+        val artifactKeys = new HashSet<String>();
         
+        ProjectVisitor projectVisitor = projModel -> {artifactKeys.add(projModel.getArtifactKey().toString());};
+        //ProjectVisitor projectVisitor = projModel -> {System.out.println(projModel.getArtifactKey());};
         projTree.depthFirst(projectVisitor);
         
+        assertHasSomeArtifactKeys(artifactKeys);
+        
     }
     
     @Test
@@ -59,11 +68,25 @@ class ProjectTreeTest {
         
         val projTree = ProjectNodeFactory.maven(projRootFolder);
         
-        ProjectVisitor projectVisitor = projModel -> {System.out.println(projModel);};
+        val artifactKeys = new HashSet<String>();
+        
+        ProjectVisitor projectVisitor = projModel -> {artifactKeys.add(projModel.getArtifactKey().toString());};
         
         projTree.depthFirst(projectVisitor);
         
-      
+        assertHasSomeArtifactKeys(artifactKeys);
+    }
+    
+    private void assertHasSomeArtifactKeys(Set<String> artifactKeys) {
+        assertTrue(artifactKeys.size()>50);
+        assertTrue(artifactKeys.contains("org.apache.isis.core:isis-core-commons:2.0.0-SNAPSHOT"));
+        assertTrue(artifactKeys.contains("org.apache.isis.core:isis-core-config:2.0.0-SNAPSHOT"));
+        assertTrue(artifactKeys.contains("org.apache.isis.core:isis-core-metamodel:2.0.0-SNAPSHOT"));
+        assertTrue(artifactKeys.contains("org.apache.isis.core:isis-core-runtime:2.0.0-SNAPSHOT"));
+        
+        for(val key : artifactKeys) {
+            assertFalse(key.startsWith("?"), ()->"incomplete key " + key);
+        }
         
     }