maven-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From GitBox <...@apache.org>
Subject [GitHub] [maven] rfscholte commented on a change in pull request #373: [MNG-6118] submodule invocation
Date Wed, 09 Sep 2020 17:57:48 GMT

rfscholte commented on a change in pull request #373:
URL: https://github.com/apache/maven/pull/373#discussion_r485795358



##########
File path: maven-core/src/main/java/org/apache/maven/graph/ProjectCollector.java
##########
@@ -0,0 +1,37 @@
+package org.apache.maven.graph;
+
+/*
+ * 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.
+ */
+
+import org.apache.maven.execution.MavenExecutionRequest;
+import org.apache.maven.project.MavenProject;
+import org.apache.maven.project.ProjectBuildingException;
+
+import java.io.File;
+import java.util.List;
+
+/**
+ * Facade to collect projects for a given set of pom.xml files.
+ */
+public interface ProjectCollector
+{
+    String HINT = "projectCollector";

Review comment:
       No need use hints anymore. If you see "hint", it was used by the Java 1.4  compatible
plexus container. We now use @Inject / @Named 

##########
File path: maven-core/src/main/java/org/apache/maven/graph/MultiModuleCollectionStrategy.java
##########
@@ -0,0 +1,181 @@
+package org.apache.maven.graph;
+
+/*
+ * 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.
+ */
+
+import org.apache.maven.execution.MavenExecutionRequest;
+import org.apache.maven.model.Plugin;
+import org.apache.maven.model.building.ModelProblem;
+import org.apache.maven.plugin.PluginManagerException;
+import org.apache.maven.plugin.PluginResolutionException;
+import org.apache.maven.project.MavenProject;
+import org.apache.maven.project.ProjectBuildingException;
+import org.apache.maven.project.ProjectBuildingResult;
+import org.codehaus.plexus.logging.Logger;
+import org.eclipse.aether.resolution.ArtifactResolutionException;
+import org.eclipse.aether.transfer.ArtifactNotFoundException;
+
+import javax.inject.Inject;
+import javax.inject.Named;
+import javax.inject.Singleton;
+import java.io.File;
+import java.util.ArrayList;
+import java.util.Collections;
+import java.util.List;
+import java.util.Objects;
+import java.util.function.Predicate;
+
+/**
+ * Strategy for collecting Maven projects from the multi-module project root, even when executed
in a submodule.
+ */
+@Named( "MultiModuleCollectionStrategy" )
+@Singleton
+public class MultiModuleCollectionStrategy implements ProjectCollectionStrategy
+{
+    private final Logger logger;
+    private final ProjectCollector projectCollector;
+
+    @Inject
+    public MultiModuleCollectionStrategy( Logger logger, ProjectCollector projectCollector
)
+    {
+        this.logger = logger;
+        this.projectCollector = projectCollector;
+    }
+
+    @Override
+    public List<MavenProject> collectProjects( MavenExecutionRequest request ) throws
ProjectBuildingException
+    {
+        File moduleProjectPomFile = getMultiModuleProjectPomFile( request );
+        List<File> files = Collections.singletonList( moduleProjectPomFile.getAbsoluteFile()
);
+        try
+        {
+            List<MavenProject> projects = new ArrayList<>();
+            projectCollector.collectProjects( projects, files, request );
+            boolean isRequestedProjectCollected = isRequestedProjectCollected( request, projects
);
+            if ( isRequestedProjectCollected )
+            {
+                return projects;
+            }
+            else
+            {
+                return Collections.emptyList();
+            }
+        }
+        catch ( ProjectBuildingException e )
+        {
+            boolean fallThrough = isModuleOutsideRequestScopeDependingOnPluginModule( request,
e );
+
+            if ( fallThrough )
+            {
+                return Collections.emptyList();
+            }
+
+            throw e;
+        }
+    }
+
+    private File getMultiModuleProjectPomFile( MavenExecutionRequest request )
+    {
+        if ( request.getPom().getParentFile().equals( request.getMultiModuleProjectDirectory()
) )
+        {
+            return request.getPom();
+        }
+        else
+        {
+            File multiModuleProjectPom = new File( request.getMultiModuleProjectDirectory(),
"pom.xml" );

Review comment:
       This might not work with [polyglot-maven](https://github.com/takari/polyglot-maven).
IIRC there's a PomLocator that handles the right extension.

##########
File path: maven-core/src/main/java/org/apache/maven/graph/DefaultGraphBuilder.java
##########
@@ -361,76 +406,35 @@ private File getReactorDirectory( MavenExecutionRequest request )
         throws ProjectBuildingException
     {
         MavenExecutionRequest request = session.getRequest();
-
         request.getProjectBuildingRequest().setRepositorySession( session.getRepositorySession()
);
 
-        List<MavenProject> projects = new ArrayList<>();
+        List<ProjectCollectionStrategy> projectCollectionStrategies = Arrays.asList(
+                projectlessCollectionStrategy, // 1. Collect project for invocation without
a POM.
+                multiModuleCollectionStrategy, // 2. Collect projects for all modules in
the multi-module project.
+                requestPomCollectionStrategy   // 3. Collect projects for explicitly requested
POM.
+        );
 
-        // We have no POM file.
-        //
-        if ( request.getPom() == null )
+        for ( ProjectCollectionStrategy strategy : projectCollectionStrategies )

Review comment:
       This looks weird to me. Now all stragegies are executes, but I would expect that only
one really applies.
   Instead I would expect to see a swich/if-elseif codeblock selecting the right strategy
per case.

##########
File path: maven-core/src/main/java/org/apache/maven/graph/DefaultGraphBuilder.java
##########
@@ -361,76 +406,35 @@ private File getReactorDirectory( MavenExecutionRequest request )
         throws ProjectBuildingException
     {
         MavenExecutionRequest request = session.getRequest();
-
         request.getProjectBuildingRequest().setRepositorySession( session.getRepositorySession()
);
 
-        List<MavenProject> projects = new ArrayList<>();
+        List<ProjectCollectionStrategy> projectCollectionStrategies = Arrays.asList(
+                projectlessCollectionStrategy, // 1. Collect project for invocation without
a POM.
+                multiModuleCollectionStrategy, // 2. Collect projects for all modules in
the multi-module project.
+                requestPomCollectionStrategy   // 3. Collect projects for explicitly requested
POM.
+        );
 
-        // We have no POM file.
-        //
-        if ( request.getPom() == null )
+        for ( ProjectCollectionStrategy strategy : projectCollectionStrategies )
         {
-            ModelSource modelSource = new UrlModelSource( DefaultMaven.class.getResource(
"project/standalone.xml" ) );
-            MavenProject project = projectBuilder.build( modelSource, request.getProjectBuildingRequest()
)
-                .getProject();
-            project.setExecutionRoot( true );
-            projects.add( project );
-            request.setProjectPresent( false );
-            return projects;
-        }
+            List<MavenProject> projects = strategy.collectProjects( request );
 
-        List<File> files = Arrays.asList( request.getPom().getAbsoluteFile() );
-        collectProjects( projects, files, request );
-        return projects;
-    }
-
-    private void collectProjects( List<MavenProject> projects, List<File> files,
MavenExecutionRequest request )
-        throws ProjectBuildingException
-    {
-        ProjectBuildingRequest projectBuildingRequest = request.getProjectBuildingRequest();
-
-        List<ProjectBuildingResult> results = projectBuilder.build( files, request.isRecursive(),
-                                                                    projectBuildingRequest
);
-
-        boolean problems = false;
-
-        for ( ProjectBuildingResult result : results )
-        {
-            projects.add( result.getProject() );
-
-            if ( !result.getProblems().isEmpty() && logger.isWarnEnabled() )
+            if ( !projects.isEmpty() )
             {
-                logger.warn( "" );
-                logger.warn( "Some problems were encountered while building the effective
model for "
-                    + result.getProject().getId() );
-
-                for ( ModelProblem problem : result.getProblems() )
-                {
-                    String loc = ModelProblemUtils.formatLocation( problem, result.getProjectId()
);
-                    logger.warn( problem.getMessage() + ( StringUtils.isNotEmpty( loc ) ?
" @ " + loc : "" ) );
-                }
-
-                problems = true;
+                logger.debug( "Successfully collected projects using the " + strategy.getClass().getSimpleName()
);

Review comment:
       Doesn't look like a helpful message anymore

##########
File path: maven-core/src/main/java/org/apache/maven/graph/MultiModuleCollectionStrategy.java
##########
@@ -0,0 +1,181 @@
+package org.apache.maven.graph;
+
+/*
+ * 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.
+ */
+
+import org.apache.maven.execution.MavenExecutionRequest;
+import org.apache.maven.model.Plugin;
+import org.apache.maven.model.building.ModelProblem;
+import org.apache.maven.plugin.PluginManagerException;
+import org.apache.maven.plugin.PluginResolutionException;
+import org.apache.maven.project.MavenProject;
+import org.apache.maven.project.ProjectBuildingException;
+import org.apache.maven.project.ProjectBuildingResult;
+import org.codehaus.plexus.logging.Logger;
+import org.eclipse.aether.resolution.ArtifactResolutionException;
+import org.eclipse.aether.transfer.ArtifactNotFoundException;
+
+import javax.inject.Inject;
+import javax.inject.Named;
+import javax.inject.Singleton;
+import java.io.File;
+import java.util.ArrayList;
+import java.util.Collections;
+import java.util.List;
+import java.util.Objects;
+import java.util.function.Predicate;
+
+/**
+ * Strategy for collecting Maven projects from the multi-module project root, even when executed
in a submodule.
+ */
+@Named( "MultiModuleCollectionStrategy" )
+@Singleton
+public class MultiModuleCollectionStrategy implements ProjectCollectionStrategy
+{
+    private final Logger logger;
+    private final ProjectCollector projectCollector;
+
+    @Inject
+    public MultiModuleCollectionStrategy( Logger logger, ProjectCollector projectCollector
)

Review comment:
       No need to inject Loggers anymore, instead simply do `private static final Logger LOGGER
= LoggerFactory...`

##########
File path: maven-core/src/main/java/org/apache/maven/graph/ProjectCollector.java
##########
@@ -0,0 +1,37 @@
+package org.apache.maven.graph;
+
+/*
+ * 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.
+ */
+
+import org.apache.maven.execution.MavenExecutionRequest;
+import org.apache.maven.project.MavenProject;
+import org.apache.maven.project.ProjectBuildingException;
+
+import java.io.File;
+import java.util.List;
+
+/**
+ * Facade to collect projects for a given set of pom.xml files.
+ */
+public interface ProjectCollector
+{
+    String HINT = "projectCollector";

Review comment:
       Shouldn't this be called `ProjectsCollector`

##########
File path: maven-core/src/main/java/org/apache/maven/graph/DefaultProjectCollector.java
##########
@@ -0,0 +1,99 @@
+package org.apache.maven.graph;
+
+/*
+ * 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.
+ */
+
+import org.apache.maven.execution.MavenExecutionRequest;
+import org.apache.maven.model.building.ModelProblem;
+import org.apache.maven.model.building.ModelProblemUtils;
+import org.apache.maven.project.MavenProject;
+import org.apache.maven.project.ProjectBuilder;
+import org.apache.maven.project.ProjectBuildingException;
+import org.apache.maven.project.ProjectBuildingRequest;
+import org.apache.maven.project.ProjectBuildingResult;
+import org.codehaus.plexus.logging.Logger;
+import org.codehaus.plexus.util.StringUtils;
+
+import javax.inject.Inject;
+import javax.inject.Named;
+import javax.inject.Singleton;
+import java.io.File;
+import java.util.List;
+
+/**
+ * Utility to collect projects for a given set of pom.xml files.
+ */
+@Named( ProjectCollector.HINT )
+@Singleton
+public class DefaultProjectCollector implements ProjectCollector
+{
+    private final Logger logger;
+    private final ProjectBuilder projectBuilder;
+
+    @Inject
+    public DefaultProjectCollector( Logger logger, ProjectBuilder projectBuilder )
+    {
+        this.logger = logger;
+        this.projectBuilder = projectBuilder;
+    }
+
+    @Override
+    public void collectProjects( List<MavenProject> projects, List<File> files,
MavenExecutionRequest request )
+            throws ProjectBuildingException
+    {
+        // TODO [mthmulders] Refactor so the result of the method is returned instead of
passed to the method argument.

Review comment:
       TODO still valid?




----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



Mime
View raw message