[MNG-7881] Expose the rootDirectory for model processing

apache · Sep 14, 2023 · 85130dd · 85130dd
1 parent 838cda7
commit 85130dd
Show file tree

Hide file tree

Showing 8 changed files with 64 additions and 0 deletions.
diff --git a/maven-compat/src/test/java/org/apache/maven/artifact/AbstractArtifactComponentTestCase.java b/maven-compat/src/test/java/org/apache/maven/artifact/AbstractArtifactComponentTestCase.java
@@ -35,14 +35,18 @@
 import org.apache.maven.artifact.repository.ArtifactRepository;
 import org.apache.maven.artifact.repository.ArtifactRepositoryPolicy;
 import org.apache.maven.artifact.repository.layout.ArtifactRepositoryLayout;
+import org.apache.maven.bridge.MavenRepositorySystem;
 import org.apache.maven.execution.DefaultMavenExecutionRequest;
 import org.apache.maven.execution.DefaultMavenExecutionResult;
 import org.apache.maven.execution.MavenSession;
+import org.apache.maven.internal.impl.DefaultSessionFactory;
 import org.apache.maven.plugin.LegacySupport;
 import org.apache.maven.repository.legacy.repository.ArtifactRepositoryFactory;
+import org.apache.maven.rtinfo.RuntimeInformation;
 import org.codehaus.plexus.PlexusContainer;
 import org.codehaus.plexus.testing.PlexusTest;
 import org.eclipse.aether.DefaultRepositorySystemSession;
+import org.eclipse.aether.RepositorySystem;
 import org.eclipse.aether.RepositorySystemSession;
 import org.eclipse.aether.collection.DependencyGraphTransformer;
 import org.eclipse.aether.collection.DependencyManager;
@@ -100,6 +104,12 @@ public void setUp() throws Exception {
         RepositorySystemSession repoSession = initRepoSession();
         MavenSession session = new MavenSession(
                 getContainer(), repoSession, new DefaultMavenExecutionRequest(), new DefaultMavenExecutionResult());
+        new DefaultSessionFactory(
+                        getContainer().lookup(RepositorySystem.class),
+                        getContainer().lookup(MavenRepositorySystem.class),
+                        getContainer(),
+                        getContainer().lookup(RuntimeInformation.class))
+                .getSession(session);
 
         legacySupport.setSession(session);
     }

diff --git a/maven-core/src/main/java/org/apache/maven/project/DefaultProjectBuilder.java b/maven-core/src/main/java/org/apache/maven/project/DefaultProjectBuilder.java
@@ -44,6 +44,7 @@
 import org.apache.maven.artifact.InvalidRepositoryException;
 import org.apache.maven.artifact.repository.ArtifactRepository;
 import org.apache.maven.bridge.MavenRepositorySystem;
+import org.apache.maven.internal.impl.DefaultSession;
 import org.apache.maven.model.Build;
 import org.apache.maven.model.Dependency;
 import org.apache.maven.model.DependencyManagement;
@@ -279,6 +280,14 @@ private ModelBuildingRequest getModelBuildingRequest(InternalConfig config) {
             request.setModelCache(modelCacheFactory.createCache(config.session));
         }
         request.setTransformerContextBuilder(config.transformerContextBuilder);
+        DefaultSession session = (DefaultSession) config.session.getData().get(DefaultSession.class);
+        if (session != null) {
+            try {
+                request.setRootDirectory(session.getRootDirectory());
+            } catch (IllegalStateException e) {
+                // can happen if root directory can not be found, just ignore
+            }
+        }
 
         return request;
     }

diff --git a/maven-model-builder/src/main/java/org/apache/maven/model/building/DefaultModelBuilder.java b/maven-model-builder/src/main/java/org/apache/maven/model/building/DefaultModelBuilder.java
@@ -67,6 +67,7 @@
 import org.apache.maven.model.interpolation.ModelInterpolator;
 import org.apache.maven.model.interpolation.ModelVersionProcessor;
 import org.apache.maven.model.io.ModelParseException;
+import org.apache.maven.model.io.ModelReader;
 import org.apache.maven.model.management.DependencyManagementInjector;
 import org.apache.maven.model.management.PluginManagementInjector;
 import org.apache.maven.model.normalization.ModelNormalizer;
@@ -1028,6 +1029,7 @@ private org.apache.maven.api.model.Model doReadFileModel(
             Map<String, Object> options = new HashMap<>(3);
             options.put(ModelProcessor.IS_STRICT, strict);
             options.put(ModelProcessor.SOURCE, modelSource);
+            options.put(ModelReader.ROOT_DIRECTORY, request.getRootDirectory());
 
             InputSource source;
             if (request.isLocationTracking()) {

diff --git a/...el-builder/src/main/java/org/apache/maven/model/building/DefaultModelBuildingRequest.java b/...el-builder/src/main/java/org/apache/maven/model/building/DefaultModelBuildingRequest.java
@@ -19,6 +19,7 @@
 package org.apache.maven.model.building;
 
 import java.io.File;
+import java.nio.file.Path;
 import java.util.ArrayList;
 import java.util.Date;
 import java.util.List;
@@ -70,6 +71,8 @@ public class DefaultModelBuildingRequest implements ModelBuildingRequest {
 
     private TransformerContextBuilder contextBuilder;
 
+    private Path rootDirectory;
+
     /**
      * Creates an empty request.
      */
@@ -98,6 +101,7 @@ public DefaultModelBuildingRequest(ModelBuildingRequest request) {
         setModelCache(request.getModelCache());
         setWorkspaceModelResolver(request.getWorkspaceModelResolver());
         setTransformerContextBuilder(request.getTransformerContextBuilder());
+        setRootDirectory(request.getRootDirectory());
     }
 
     @Override
@@ -370,4 +374,15 @@ public ModelBuildingRequest setTransformerContextBuilder(TransformerContextBuild
         this.contextBuilder = contextBuilder;
         return this;
     }
+
+    @Override
+    public Path getRootDirectory() {
+        return rootDirectory;
+    }
+
+    @Override
+    public ModelBuildingRequest setRootDirectory(Path rootDirectory) {
+        this.rootDirectory = rootDirectory;
+        return this;
+    }
 }
diff --git a/...del-builder/src/main/java/org/apache/maven/model/building/FilterModelBuildingRequest.java b/...del-builder/src/main/java/org/apache/maven/model/building/FilterModelBuildingRequest.java
@@ -19,6 +19,7 @@
 package org.apache.maven.model.building;
 
 import java.io.File;
+import java.nio.file.Path;
 import java.util.Date;
 import java.util.List;
 import java.util.Properties;
@@ -264,4 +265,15 @@ public ModelBuildingRequest setTransformerContextBuilder(TransformerContextBuild
         request.setTransformerContextBuilder(contextBuilder);
         return this;
     }
+
+    @Override
+    public Path getRootDirectory() {
+        return request.getRootDirectory();
+    }
+
+    @Override
+    public ModelBuildingRequest setRootDirectory(Path rootDirectory) {
+        request.setRootDirectory(rootDirectory);
+        return this;
+    }
 }
diff --git a/maven-model-builder/src/main/java/org/apache/maven/model/building/ModelBuildingRequest.java b/maven-model-builder/src/main/java/org/apache/maven/model/building/ModelBuildingRequest.java
@@ -19,6 +19,7 @@
 package org.apache.maven.model.building;
 
 import java.io.File;
+import java.nio.file.Path;
 import java.util.Date;
 import java.util.List;
 import java.util.Properties;
@@ -356,4 +357,8 @@ public interface ModelBuildingRequest {
     TransformerContextBuilder getTransformerContextBuilder();
 
     ModelBuildingRequest setTransformerContextBuilder(TransformerContextBuilder contextBuilder);
+
+    Path getRootDirectory();
+
+    ModelBuildingRequest setRootDirectory(Path rootDirectory);
 }
diff --git a/maven-model-builder/src/main/java/org/apache/maven/model/io/DefaultModelReader.java b/maven-model-builder/src/main/java/org/apache/maven/model/io/DefaultModelReader.java
@@ -95,6 +95,11 @@ private InputSource getSource(Map<String, ?> options) {
         return (InputSource) value;
     }
 
+    private Path getRootDirectory(Map<String, ?> options) {
+        Object value = (options != null) ? options.get(ROOT_DIRECTORY) : null;
+        return (Path) value;
+    }
+
     private Model read(InputStream input, Path pomFile, Map<String, ?> options) throws IOException {
         try {
             XMLInputFactory factory = new com.ctc.wstx.stax.WstxInputFactory();

diff --git a/maven-model-builder/src/main/java/org/apache/maven/model/io/ModelReader.java b/maven-model-builder/src/main/java/org/apache/maven/model/io/ModelReader.java
@@ -45,6 +45,12 @@ public interface ModelReader {
      */
     String INPUT_SOURCE = "org.apache.maven.model.io.inputSource";
 
+    /**
+     * Name of the property used to store the project's root directory to use with
+     * XInclude support.
+     */
+    String ROOT_DIRECTORY = "rootDirectory";
+
     /**
      * Reads the model from the specified file.
      *