Adds project specific effective-model mojos (#178)

Adds two new mojos as counterpart to existing gav-effective-model:
* effective-model: is aggregator and show model of selected project
  within reactor
* effective-model-all: is not an aggregator and shows effective model of all projects
  within reactor

Author: cstamas

shared/src/main/java/eu/maveniverse/maven/toolbox/shared/ProjectLocator.java

@@ -31,5 +31,5 @@ interface Project {
     /**
      * Locates project by given artifact. If not present, it means artifact is "external" relative to these projects.
      */
-    Optional<Project> locateProject(Artifact artifact);
+    Optional<? extends Project> locateProject(Artifact artifact);
 }

shared/src/main/java/eu/maveniverse/maven/toolbox/shared/ReactorLocator.java

@@ -9,35 +9,40 @@
 
 import eu.maveniverse.maven.toolbox.shared.internal.Artifacts;
 import java.util.List;
+import org.apache.maven.model.Model;
 
 /**
  * Construction to represent "reactor" abstraction.
  */
 public interface ReactorLocator extends ProjectLocator, Artifacts.Source {
+    interface ReactorProject extends Project {
+        Model effectiveModel();
+    }
+
     /**
      * Returns "top level" project, never {@code null}.
      */
-    Project getTopLevelProject();
+    ReactorProject getTopLevelProject();
 
     /**
      * Returns "current" project, never {@code null}.
      */
-    Project getCurrentProject();
+    ReactorProject getCurrentProject();
 
     /**
      * Returns list of all projects, never {@code null}.
      */
-    List<Project> getAllProjects();
+    List<ReactorProject> getAllProjects();
 
     /**
      * Locates children projects of given project within reactor, that is projects that refer to passed in project
      * as parent.
      */
-    List<Project> locateChildren(Project project);
+    List<ReactorProject> locateChildren(Project project);
 
     /**
      * Locates children projects of given project within reactor, that is projects that are referred from passed in
      * project as modules.
      */
-    List<Project> locateCollected(Project project);
+    List<ReactorProject> locateCollected(Project project);
 }

shared/src/main/java/eu/maveniverse/maven/toolbox/shared/ToolboxCommando.java

@@ -332,6 +332,11 @@ Result<List<List<Artifact>>> treeFind(
      */
     Result<Model> effectiveModel(ResolutionRoot resolutionRoot) throws Exception;
 
+    /**
+     * Returns the effective model. Requires reactor locator.
+     */
+    Result<Model> effectiveModel(ReactorLocator reactorLocator) throws Exception;
+
     // Search API related commands: they target one single RemoteRepository
 
     /**

shared/src/main/java/eu/maveniverse/maven/toolbox/shared/internal/ToolboxCommandoImpl.java

@@ -976,6 +976,19 @@ public Result<Model> effectiveModel(ResolutionRoot resolutionRoot) throws Except
         return Result.success(response.getEffectiveModel());
     }
 
+    @Override
+    public Result<Model> effectiveModel(ReactorLocator reactorLocator) throws Exception {
+        requireNonNull(reactorLocator);
+        Result<Model> result = Result.success(reactorLocator.getCurrentProject().effectiveModel());
+
+        ByteArrayOutputStream baos = new ByteArrayOutputStream();
+        MavenXpp3Writer mavenXpp3Writer = new MavenXpp3Writer();
+        mavenXpp3Writer.write(baos, result.getData().orElseThrow());
+        output.doTell("Effective model:\n{}", baos.toString(StandardCharsets.UTF_8));
+
+        return result;
+    }
+
     @Override
     public Map<String, RemoteRepository> getKnownSearchRemoteRepositories() {
         return knownSearchRemoteRepositories;

shared/src/main/java/eu/maveniverse/maven/toolbox/shared/internal/ToolboxResolverImpl.java

@@ -337,12 +337,12 @@ public CollectResult parentChildTree(ReactorLocator reactorLocator) {
         Optional<Artifact> parentArtifact = currentProject.getParent();
         while (parentArtifact.isPresent()) {
             Artifact pa = parentArtifact.orElseThrow();
-            Optional<ProjectLocator.Project> parentProject = reactorLocator.locateProject(pa);
+            Optional<? extends ProjectLocator.Project> parentProject = reactorLocator.locateProject(pa);
             if (parentProject.isPresent()) {
                 currentProject = parentProject.orElseThrow();
                 node = new DefaultDependencyNode(new Dependency(source(currentProject), ""));
             } else {
-                Optional<ProjectLocator.Project> external = projectLocator.locateProject(pa);
+                Optional<? extends ProjectLocator.Project> external = projectLocator.locateProject(pa);
                 if (external.isPresent()) {
                     currentProject = external.orElseThrow();
                     node = new DefaultDependencyNode(new Dependency(source(currentProject), ""));
@@ -362,7 +362,7 @@ public CollectResult parentChildTree(ReactorLocator reactorLocator) {
 
     private void parentChildTree(
             DependencyNode parentNode, ReactorLocator reactorLocator, ProjectLocator.Project parent) {
-        List<ProjectLocator.Project> children = reactorLocator.locateChildren(parent);
+        List<? extends ProjectLocator.Project> children = reactorLocator.locateChildren(parent);
         for (ProjectLocator.Project child : children) {
             DependencyNode childNode = new DefaultDependencyNode(new Dependency(source(child), ""));
             parentNode.getChildren().add(childNode);
@@ -383,7 +383,7 @@ public CollectResult subprojectTree(ReactorLocator reactorLocator) {
 
     private void subprojectTree(
             DependencyNode parentNode, ReactorLocator reactorLocator, ProjectLocator.Project parent) {
-        List<ProjectLocator.Project> children = reactorLocator.locateCollected(parent);
+        List<? extends ProjectLocator.Project> children = reactorLocator.locateCollected(parent);
         for (ProjectLocator.Project child : children) {
             DependencyNode childNode = new DefaultDependencyNode(new Dependency(source(child), ""));
             parentNode.getChildren().add(childNode);
@@ -410,7 +410,8 @@ private void projectDependencyTree(
             HashSet<String> seen) {
         ArrayDeque<DependencyNode> recursiveNodes = new ArrayDeque<>();
         for (Dependency dependency : current.dependencies()) {
-            Optional<ProjectLocator.Project> depProject = reactorLocator.locateProject(dependency.getArtifact());
+            Optional<? extends ProjectLocator.Project> depProject =
+                    reactorLocator.locateProject(dependency.getArtifact());
             String key = ArtifactIdUtils.toId(dependency.getArtifact());
             if (seen.add(key)) {
                 if (depProject.isPresent()) {

toolbox/src/main/java/eu/maveniverse/maven/toolbox/plugin/MavenReactorLocator.java

@@ -20,6 +20,7 @@
 import java.util.stream.Stream;
 import org.apache.maven.RepositoryUtils;
 import org.apache.maven.execution.MavenSession;
+import org.apache.maven.model.Model;
 import org.apache.maven.model.Parent;
 import org.apache.maven.project.MavenProject;
 import org.eclipse.aether.RepositorySystemSession;
@@ -32,9 +33,9 @@
  * Maven project locator.
  */
 public class MavenReactorLocator implements ReactorLocator {
-    private final Project topLevel;
-    private final Project current;
-    private final List<Project> allProjects;
+    private final ReactorProject topLevel;
+    private final ReactorProject current;
+    private final List<ReactorProject> allProjects;
 
     public MavenReactorLocator(MavenSession session, String selector) {
         requireNonNull(session, "session");
@@ -87,7 +88,7 @@ private Predicate<MavenProject> createSelector(String selector) {
         throw new IllegalArgumentException("Unsupported selector expression: '" + selector + "'");
     }
 
-    private Project convert(RepositorySystemSession session, MavenProject project) {
+    private ReactorProject convert(RepositorySystemSession session, MavenProject project) {
         requireNonNull(project, "project");
         Artifact pa = RepositoryUtils.toArtifact(project.getArtifact());
         Artifact pp = null;
@@ -101,33 +102,33 @@ private Project convert(RepositorySystemSession session, MavenProject project) {
         List<Artifact> collected = project.getCollectedProjects().stream()
                 .map(p -> RepositoryUtils.toArtifact(p.getArtifact()))
                 .collect(Collectors.toList());
-        return new MProject(pa, pp, pd, collected, this);
+        return new MProject(pa, pp, pd, collected, this, project.getModel());
     }
 
     @Override
-    public Project getTopLevelProject() {
+    public ReactorProject getTopLevelProject() {
         return topLevel;
     }
 
     @Override
-    public Project getCurrentProject() {
+    public ReactorProject getCurrentProject() {
         return current;
     }
 
     @Override
-    public List<Project> getAllProjects() {
+    public List<ReactorProject> getAllProjects() {
         return allProjects;
     }
 
     @Override
-    public Optional<Project> locateProject(Artifact artifact) {
+    public Optional<ReactorProject> locateProject(Artifact artifact) {
         return allProjects.stream()
                 .filter(p -> ArtifactIdUtils.equalsId(p.artifact(), artifact))
                 .findFirst();
     }
 
     @Override
-    public List<Project> locateChildren(Project project) {
+    public List<ReactorProject> locateChildren(Project project) {
         return allProjects.stream()
                 .filter(p -> {
                     Optional<Artifact> parentArtifact = p.getParent();
@@ -138,7 +139,7 @@ public List<Project> locateChildren(Project project) {
     }
 
     @Override
-    public List<Project> locateCollected(Project project) {
+    public List<ReactorProject> locateCollected(Project project) {
         if (project instanceof MProject) {
             MProject mProject = (MProject) project;
             List<Project> allOfGrandchildren = mProject.collected().stream()
@@ -169,24 +170,27 @@ public Stream<Artifact> get() {
         return getAllProjects().stream().map(Project::artifact);
     }
 
-    private static final class MProject implements Project {
+    private static final class MProject implements ReactorProject {
         private final Artifact artifact;
         private final Artifact parent;
         private final List<Dependency> dependencies;
         private final List<Artifact> collected;
         private final ProjectLocator origin;
+        private final Model effectiveModel;
 
         private MProject(
                 Artifact artifact,
                 Artifact parent,
                 List<Dependency> dependencies,
                 List<Artifact> collected,
-                ProjectLocator origin) {
+                ProjectLocator origin,
+                Model effectiveModel) {
             this.artifact = requireNonNull(artifact, "artifact");
             this.parent = parent; // nullable
             this.dependencies = requireNonNull(dependencies, "dependencies");
             this.collected = requireNonNull(collected, "collected");
             this.origin = origin;
+            this.effectiveModel = requireNonNull(effectiveModel, "effectiveModel");
         }
 
         @Override
@@ -217,6 +221,11 @@ public ProjectLocator origin() {
             return origin;
         }
 
+        @Override
+        public Model effectiveModel() {
+            return effectiveModel;
+        }
+
         @Override
         public boolean equals(Object o) {
             if (this == o) {

toolbox/src/main/java/eu/maveniverse/maven/toolbox/plugin/mp/EffectiveModelAggregatorMojo.java

@@ -0,0 +1,35 @@
+/*
+ * Copyright (c) 2023-2024 Maveniverse Org.
+ * All rights reserved. This program and the accompanying materials
+ * are made available under the terms of the Eclipse Public License v2.0
+ * which accompanies this distribution, and is available at
+ * https://www.eclipse.org/legal/epl-v20.html
+ */
+package eu.maveniverse.maven.toolbox.plugin.mp;
+
+import eu.maveniverse.maven.toolbox.plugin.MPMojoSupport;
+import eu.maveniverse.maven.toolbox.shared.Result;
+import eu.maveniverse.maven.toolbox.shared.ToolboxCommando;
+import org.apache.maven.model.Model;
+import org.apache.maven.plugins.annotations.Mojo;
+import org.apache.maven.plugins.annotations.Parameter;
+
+/**
+ * Shows effective model for project; is aggregator mojo.
+ */
+@Mojo(name = "effective-model", aggregator = true, threadSafe = true)
+public class EffectiveModelAggregatorMojo extends MPMojoSupport {
+    /**
+     * Set the project selector, like {@code -rf} Maven command uses it, can be {@code :A} or {@code G:A}. If the
+     * selector is set, it must match exactly one project within reactor, otherwise it will fail. By default,
+     * selector is {@code null}, and Maven session "current project" is used.
+     */
+    @Parameter(property = "selector")
+    private String selector;
+
+    @Override
+    protected Result<Model> doExecute() throws Exception {
+        ToolboxCommando toolboxCommando = getToolboxCommando();
+        return toolboxCommando.effectiveModel(getReactorLocator(selector));
+    }
+}

toolbox/src/main/java/eu/maveniverse/maven/toolbox/plugin/mp/EffectiveModelMojo.java

@@ -0,0 +1,26 @@
+/*
+ * Copyright (c) 2023-2024 Maveniverse Org.
+ * All rights reserved. This program and the accompanying materials
+ * are made available under the terms of the Eclipse Public License v2.0
+ * which accompanies this distribution, and is available at
+ * https://www.eclipse.org/legal/epl-v20.html
+ */
+package eu.maveniverse.maven.toolbox.plugin.mp;
+
+import eu.maveniverse.maven.toolbox.plugin.MPMojoSupport;
+import eu.maveniverse.maven.toolbox.shared.Result;
+import eu.maveniverse.maven.toolbox.shared.ToolboxCommando;
+import org.apache.maven.model.Model;
+import org.apache.maven.plugins.annotations.Mojo;
+
+/**
+ * Shows effective model for project.
+ */
+@Mojo(name = "effective-model-all", threadSafe = true)
+public class EffectiveModelMojo extends MPMojoSupport {
+    @Override
+    protected Result<Model> doExecute() throws Exception {
+        ToolboxCommando toolboxCommando = getToolboxCommando();
+        return toolboxCommando.effectiveModel(getReactorLocator(null));
+    }
+}