Provide public rootdir / topdir and deprecate others

Author: gnodet

apache-maven/src/assembly/shared/run

@@ -16,7 +16,7 @@ exec "$JAVACMD" \
   "-Dmaven.home=$MAVEN_HOME" \
   "-Dlibrary.jansi.path=${MAVEN_HOME}/lib/jansi-native" \
   "-Dmaven.multiModuleProjectDirectory=$MAVEN_PROJECTBASEDIR" \
-  "-Dproject.topdir=$MAVEN_PROJECTBASEDIR" \
+  "-Dmaven.rootdir=$MAVEN_PROJECTBASEDIR" \
   $LAUNCHER_CLASS \
   $MAVEN_ARGS \
   "$@"

apache-maven/src/assembly/shared/run.cmd

@@ -6,7 +6,7 @@
   "-Dmaven.home=%MAVEN_HOME%" ^
   "-Dlibrary.jansi.path=%MAVEN_HOME%\lib\jansi-native" ^
   "-Dmaven.multiModuleProjectDirectory=%MAVEN_PROJECTBASEDIR%" ^
-  "-Dproject.topdir=%MAVEN_PROJECTBASEDIR%" ^
+  "-Dmaven.rootdir=%MAVEN_PROJECTBASEDIR%" ^
   %LAUNCHER_CLASS% ^
   %MAVEN_ARGS% ^
   %*

api/maven-api-core/src/main/java/org/apache/maven/api/Project.java

@@ -86,8 +86,34 @@ default String getId() {
         return getModel().getId();
     }
 
+    /**
+     * @deprecated use {@link #isTopdirProject()} instead
+     */
+    @Deprecated
     boolean isExecutionRoot();
 
+    /**
+     * Returns a boolean indicating if the project is the top leve project for
+     * this reactor build.  The top level project may be different from the
+     * {@code rootDirProject}, especially if a subtree of the project is being
+     * built, either because maven has been launched in a subdirectory or using
+     * a {@code -f} option.
+     *
+     * @return {@code true} if the project is the top level project for this build
+     */
+    boolean isTopdirProject();
+
+    /**
+     * Returns a boolean indicating if the project is the project from the root
+     * directory of this reactor. The root project is the top-most project containing
+     * the {@code .mvn} directory.  If only a subtree of the reactor is build (because
+     * the current directory is in a subtree or because the {@code -f} option has been
+     * specified, then there may be no rootDirProject in this reactor.
+     *
+     * @return {@code true} if the project is the root dir project
+     */
+    boolean isRootdirProject();
+
     @Nonnull
     Optional<Project> getParent();
 

api/maven-api-core/src/main/java/org/apache/maven/api/Session.java

@@ -85,15 +85,22 @@ public interface Session {
     Instant getStartTime();
 
     /**
-     * @deprecated use {@link #getTopdir()} instead
+     * @deprecated use {@link #getRootdir()} instead
      */
     @Nonnull
     @Deprecated
     Path getMultiModuleProjectDirectory();
 
+    @Nonnull
+    Path getRootdir();
+
     @Nonnull
     Path getTopdir();
 
+    /**
+     * @deprecated use {@link #getTopdir()} instead
+     */
+    @Deprecated
     @Nonnull
     Path getExecutionRootDirectory();
 

maven-core/src/main/java/org/apache/maven/execution/DefaultMavenExecutionRequest.java

@@ -101,10 +101,12 @@ public class DefaultMavenExecutionRequest implements MavenExecutionRequest {
 
     private File multiModuleProjectDirectory;
 
-    private Path topdir;
-
     private File basedir;
 
+    private Path rootdir;
+
+    private Path topdir;
+
     private List<String> goals;
 
     private boolean useReactor = false;
@@ -1054,24 +1056,38 @@ public MavenExecutionRequest setToolchains(Map<String, List<ToolchainModel>> too
         return this;
     }
 
+    @Deprecated
     @Override
     public void setMultiModuleProjectDirectory(File directory) {
         this.multiModuleProjectDirectory = directory;
     }
 
+    @Deprecated
     @Override
     public File getMultiModuleProjectDirectory() {
         return multiModuleProjectDirectory;
     }
 
+    @Override
+    public Path getRootdir() {
+        return rootdir;
+    }
+
+    @Override
+    public MavenExecutionRequest setRootdir(Path rootdir) {
+        this.rootdir = rootdir;
+        return this;
+    }
+
     @Override
     public Path getTopdir() {
         return topdir;
     }
 
     @Override
-    public void setTopdir(Path topdir) {
+    public MavenExecutionRequest setTopdir(Path topdir) {
         this.topdir = topdir;
+        return this;
     }
 
     @Override

maven-core/src/main/java/org/apache/maven/execution/MavenExecutionRequest.java

@@ -92,8 +92,17 @@ public interface MavenExecutionRequest {
     // ----------------------------------------------------------------------
 
     // Base directory
+
+    /**
+     * @deprecated use {@link #getTopdir()} instead
+     */
+    @Deprecated
     MavenExecutionRequest setBaseDirectory(File basedir);
 
+    /**
+     * @deprecated use {@link #getTopdir()} instead
+     */
+    @Deprecated
     String getBaseDirectory();
 
     // Timing (remove this)
@@ -495,18 +504,32 @@ public interface MavenExecutionRequest {
 
     /**
      * @since 3.3.0
+     * @deprecated use {@link #setRootdir(Path)} instead
      */
+    @Deprecated
     void setMultiModuleProjectDirectory(File file);
 
     /**
      * @since 3.3.0
+     * @deprecated use {@link #getRootdir()} instead
      */
+    @Deprecated
     File getMultiModuleProjectDirectory();
 
     /**
      * @since 4.0.0
      */
-    void setTopdir(Path topdir);
+    MavenExecutionRequest setRootdir(Path rootdir);
+
+    /**
+     * @since 4.0.0
+     */
+    Path getRootdir();
+
+    /**
+     * @since 4.0.0
+     */
+    MavenExecutionRequest setTopdir(Path topdir);
 
     /**
      * @since 4.0.0

maven-core/src/main/java/org/apache/maven/execution/MavenSession.java

@@ -142,6 +142,10 @@ public List<MavenProject> getProjects() {
         return projects;
     }
 
+    /**
+     * @deprecated use {@link #getTopdir()}
+     */
+    @Deprecated
     public String getExecutionRootDirectory() {
         return request.getBaseDirectory();
     }
@@ -153,6 +157,13 @@ public Path getTopdir() {
         return request.getTopdir();
     }
 
+    /**
+     * @since 4.0
+     */
+    public Path getRootdir() {
+        return request.getRootdir();
+    }
+
     public MavenExecutionRequest getRequest() {
         return request;
     }

maven-core/src/main/java/org/apache/maven/internal/impl/DefaultProject.java

@@ -129,6 +129,18 @@ public boolean isExecutionRoot() {
         return project.isExecutionRoot();
     }
 
+    @Override
+    public boolean isTopdirProject() {
+        return getBasedir().isPresent()
+                && getBasedir().get().equals(getSession().getTopdir());
+    }
+
+    @Override
+    public boolean isRootdirProject() {
+        return getBasedir().isPresent()
+                && getBasedir().get().equals(getSession().getRootdir());
+    }
+
     @Override
     public Optional<Project> getParent() {
         MavenProject parent = project.getParent();

maven-core/src/main/java/org/apache/maven/internal/impl/DefaultSession.java

@@ -19,7 +19,6 @@
 package org.apache.maven.internal.impl;
 
 import java.nio.file.Path;
-import java.nio.file.Paths;
 import java.time.Instant;
 import java.util.Collections;
 import java.util.HashMap;
@@ -144,18 +143,23 @@ public Instant getStartTime() {
     @Nonnull
     @Override
     public Path getMultiModuleProjectDirectory() {
-        return mavenSession.getRequest().getMultiModuleProjectDirectory().toPath();
+        return getRootdir();
     }
 
+    @Nonnull
     @Override
-    public Path getTopdir() {
-        return mavenSession.getRequest().getTopdir();
+    public Path getExecutionRootDirectory() {
+        return getTopdir();
     }
 
-    @Nonnull
     @Override
-    public Path getExecutionRootDirectory() {
-        return Paths.get(mavenSession.getRequest().getBaseDirectory());
+    public Path getRootdir() {
+        return mavenSession.getRequest().getRootdir();
+    }
+
+    @Override
+    public Path getTopdir() {
+        return mavenSession.getRequest().getTopdir();
     }
 
     @Nonnull

maven-core/src/main/java/org/apache/maven/lifecycle/internal/LifecycleStarter.java

@@ -91,7 +91,7 @@ public void execute(MavenSession session) {
         try {
             if (buildExecutionRequiresProject(session) && projectIsNotPresent(session)) {
                 throw new MissingProjectException("The goal you specified requires a project to execute"
-                        + " but there is no POM in this directory (" + session.getExecutionRootDirectory() + ")."
+                        + " but there is no POM in this directory (" + session.getTopdir() + ")."
                         + " Please verify you invoked Maven from the correct directory.");
             }