You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by rf...@apache.org on 2020/06/20 09:33:18 UTC

[maven] 05/31: When -r is given, load resume.properties and apply it to the execution request.

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

rfscholte pushed a commit to branch MNG-5760
in repository https://gitbox.apache.org/repos/asf/maven.git

commit 25e8d807d33ab70373f9b76385cac6e544b21117
Author: Martin Kanters <Ma...@infosupport.com>
AuthorDate: Fri May 22 15:04:38 2020 +0200

    When -r is given, load resume.properties and apply it to the execution request.
---
 .../maven/execution}/BuildResumptionManager.java   | 128 +++++++++++++++------
 .../execution/DefaultMavenExecutionRequest.java    |  16 +++
 .../maven/execution/MavenExecutionRequest.java     |  11 ++
 .../apache/maven/graph/DefaultGraphBuilder.java    |  17 +++
 .../execution}/BuildResumptionManagerTest.java     |  60 +++++++++-
 .../main/java/org/apache/maven/cli/CLIManager.java |   3 +
 .../main/java/org/apache/maven/cli/MavenCli.java   |   8 +-
 7 files changed, 202 insertions(+), 41 deletions(-)

diff --git a/maven-embedder/src/main/java/org/apache/maven/cli/BuildResumptionManager.java b/maven-core/src/main/java/org/apache/maven/execution/BuildResumptionManager.java
similarity index 74%
rename from maven-embedder/src/main/java/org/apache/maven/cli/BuildResumptionManager.java
rename to maven-core/src/main/java/org/apache/maven/execution/BuildResumptionManager.java
index 900699f..0f6bf39 100644
--- a/maven-embedder/src/main/java/org/apache/maven/cli/BuildResumptionManager.java
+++ b/maven-core/src/main/java/org/apache/maven/execution/BuildResumptionManager.java
@@ -1,4 +1,4 @@
-package org.apache.maven.cli;
+package org.apache.maven.execution;
 
 /*
  * Licensed to the Apache Software Foundation (ASF) under one
@@ -21,7 +21,6 @@ package org.apache.maven.cli;
 
 import com.google.common.annotations.VisibleForTesting;
 import org.apache.commons.lang3.StringUtils;
-import org.apache.maven.execution.MavenExecutionResult;
 import org.apache.maven.lifecycle.LifecycleExecutionException;
 import org.apache.maven.model.Dependency;
 import org.apache.maven.project.MavenProject;
@@ -31,10 +30,12 @@ import javax.inject.Inject;
 import javax.inject.Named;
 import javax.inject.Singleton;
 import java.io.IOException;
+import java.io.Reader;
 import java.io.Writer;
 import java.nio.file.Files;
 import java.nio.file.Path;
 import java.nio.file.Paths;
+import java.util.Arrays;
 import java.util.List;
 import java.util.Objects;
 import java.util.Optional;
@@ -43,16 +44,24 @@ import java.util.stream.Collectors;
 
 import static java.util.Comparator.comparing;
 
+/**
+ * This class contains most of the logic needed for the --resume / -r feature.
+ * It persists information in a properties file to ensure newer builds, using the -r feature,
+ *   skip successfully built projects.
+ */
 @Named
 @Singleton
-class BuildResumptionManager
+public class BuildResumptionManager
 {
     private static final String RESUME_PROPERTIES_FILENAME = "resume.properties";
+    private static final String RESUME_FROM_PROPERTY = "resumeFrom";
+    private static final String EXCLUDED_PROJECTS_PROPERTY = "excludedProjects";
+    private static final String PROPERTY_DELIMITER = ", ";
 
     @Inject
     private Logger logger;
-
-    public boolean createResumptionFile( MavenExecutionResult result )
+    
+    public boolean persistResumptionData( MavenExecutionResult result )
     {
         Properties properties = determineResumptionProperties( result );
 
@@ -65,6 +74,42 @@ class BuildResumptionManager
         return writeResumptionFile( result, properties );
     }
 
+    public void applyResumptionData( MavenExecutionRequest request, MavenProject rootProject )
+    {
+        Properties properties = loadResumptionFile( rootProject.getBuild().getDirectory() );
+        applyResumptionProperties( request, properties );
+    }
+
+    /**
+     * A helper method to determine the value to resume the build with {@code -rf} taking into account the edge case
+     *   where multiple modules in the reactor have the same artifactId.
+     * <p>
+     * {@code -rf :artifactId} will pick up the first module which matches, but when multiple modules in the reactor
+     *   have the same artifactId, effective failed module might be later in build reactor.
+     * This means that developer will either have to type groupId or wait for build execution of all modules which
+     *   were fine, but they are still before one which reported errors.
+     * <p>Then the returned value is {@code groupId:artifactId} when there is a name clash and
+     * {@code :artifactId} if there is no conflict.
+     *
+     * @param mavenProjects Maven projects which are part of build execution.
+     * @param failedProject Project which has failed.
+     * @return Value for -rf flag to resume build exactly from place where it failed ({@code :artifactId} in general
+     * and {@code groupId:artifactId} when there is a name clash).
+     */
+    public String getResumeFromSelector( List<MavenProject> mavenProjects, MavenProject failedProject )
+    {
+        boolean hasOverlappingArtifactId = mavenProjects.stream()
+                .filter( project -> failedProject.getArtifactId().equals( project.getArtifactId() ) )
+                .count() > 1;
+
+        if ( hasOverlappingArtifactId )
+        {
+            return failedProject.getGroupId() + ":" + failedProject.getArtifactId();
+        }
+
+        return ":" + failedProject.getArtifactId();
+    }
+
     @VisibleForTesting
     Properties determineResumptionProperties( MavenExecutionResult result )
     {
@@ -77,8 +122,8 @@ class BuildResumptionManager
             Optional<String> resumeFrom = getResumeFrom( result, resumeFromProject );
             Optional<String> projectsToSkip = determineProjectsToSkip( result, failedProjects, resumeFromProject );
 
-            resumeFrom.ifPresent( value -> properties.setProperty( "resumeFrom", value ) );
-            projectsToSkip.ifPresent( value -> properties.setProperty( "excludedProjects", value ) );
+            resumeFrom.ifPresent( value -> properties.setProperty( RESUME_FROM_PROPERTY, value ) );
+            projectsToSkip.ifPresent( value -> properties.setProperty( EXCLUDED_PROJECTS_PROPERTY, value ) );
         }
         else
         {
@@ -144,7 +189,7 @@ class BuildResumptionManager
                 .filter( project -> result.getBuildSummary( project ) != null )
                 .filter( project -> hasNoDependencyOnProjects( project, failedProjectsGAList ) )
                 .map( project -> String.format( "%s:%s", project.getGroupId(), project.getArtifactId() ) )
-                .collect( Collectors.joining( ", " ) );
+                .collect( Collectors.joining( PROPERTY_DELIMITER ) );
 
         if ( !StringUtils.isEmpty( projectsToSkip ) )
         {
@@ -161,32 +206,6 @@ class BuildResumptionManager
                 .noneMatch( projectsGAs::contains );
     }
 
-    /**
-     * A helper method to determine the value to resume the build with {@code -rf} taking into account the edge case where multiple modules in the reactor have the same artifactId.
-     * <p>
-     * {@code -rf :artifactId} will pick up the first module which matches, but when multiple modules in the reactor have the same artifactId, effective failed module might be later in build reactor.
-     * This means that developer will either have to type groupId or wait for build execution of all modules which were fine, but they are still before one which reported errors.
-     * <p>Then the returned value is {@code groupId:artifactId} when there is a name clash and
-     * {@code :artifactId} if there is no conflict.
-     *
-     * @param mavenProjects Maven projects which are part of build execution.
-     * @param failedProject Project which has failed.
-     * @return Value for -rf flag to resume build exactly from place where it failed ({@code :artifactId} in general and {@code groupId:artifactId} when there is a name clash).
-     */
-    public String getResumeFromSelector( List<MavenProject> mavenProjects, MavenProject failedProject )
-    {
-        boolean hasOverlappingArtifactId = mavenProjects.stream()
-                .filter( project -> failedProject.getArtifactId().equals( project.getArtifactId() ) )
-                .count() > 1;
-
-        if ( hasOverlappingArtifactId )
-        {
-            return failedProject.getGroupId() + ":" + failedProject.getArtifactId();
-        }
-
-        return ":" + failedProject.getArtifactId();
-    }
-
     private boolean writeResumptionFile( MavenExecutionResult result, Properties properties )
     {
         Path resumeProperties = Paths.get( result.getProject().getBuild().getDirectory(), RESUME_PROPERTIES_FILENAME );
@@ -207,6 +226,47 @@ class BuildResumptionManager
         return true;
     }
 
+    private Properties loadResumptionFile( String rootBuildDirectory )
+    {
+        Properties properties = new Properties();
+        Path path = Paths.get( rootBuildDirectory, RESUME_PROPERTIES_FILENAME );
+        if ( !Files.exists( path ) )
+        {
+            logger.warn( "The " + path + " file does not exist. The --resume / -r feature will not work." );
+            return properties;
+        }
+
+        try ( Reader reader = Files.newBufferedReader( path ) )
+        {
+            properties.load( reader );
+        }
+        catch ( IOException e )
+        {
+            logger.warn( "Unable to read " + path + ". The --resume / -r feature will not work." );
+        }
+
+        return properties;
+    }
+
+    @VisibleForTesting
+    void applyResumptionProperties( MavenExecutionRequest request, Properties properties )
+    {
+        if ( properties.containsKey( RESUME_FROM_PROPERTY ) && StringUtils.isEmpty( request.getResumeFrom() ) )
+        {
+            String propertyValue = properties.getProperty( RESUME_FROM_PROPERTY );
+            request.setResumeFrom( propertyValue );
+            logger.info( "Resuming from " + propertyValue + " due to the --resume / -r feature." );
+        }
+
+        if ( properties.containsKey( EXCLUDED_PROJECTS_PROPERTY ) )
+        {
+            String propertyValue = properties.getProperty( EXCLUDED_PROJECTS_PROPERTY );
+            String[] excludedProjects = propertyValue.split( PROPERTY_DELIMITER );
+            request.getExcludedProjects().addAll( Arrays.asList( excludedProjects ) );
+            logger.info( "Additionally excluding projects '" + propertyValue + "' due to the --resume / -r feature." );
+        }
+    }
+
     private static class GroupArtifactPair
     {
         private final String groupId;
diff --git a/maven-core/src/main/java/org/apache/maven/execution/DefaultMavenExecutionRequest.java b/maven-core/src/main/java/org/apache/maven/execution/DefaultMavenExecutionRequest.java
index 4a039eb..9cbdebe 100644
--- a/maven-core/src/main/java/org/apache/maven/execution/DefaultMavenExecutionRequest.java
+++ b/maven-core/src/main/java/org/apache/maven/execution/DefaultMavenExecutionRequest.java
@@ -116,6 +116,8 @@ public class DefaultMavenExecutionRequest
 
     private List<String> excludedProjects;
 
+    private boolean resume = false;
+
     private String resumeFrom;
 
     private String makeBehavior;
@@ -301,6 +303,12 @@ public class DefaultMavenExecutionRequest
     }
 
     @Override
+    public boolean isResume()
+    {
+        return resume;
+    }
+
+    @Override
     public String getResumeFrom()
     {
         return resumeFrom;
@@ -599,6 +607,14 @@ public class DefaultMavenExecutionRequest
     }
 
     @Override
+    public MavenExecutionRequest setResume()
+    {
+        resume = true;
+
+        return this;
+    }
+
+    @Override
     public MavenExecutionRequest setResumeFrom( String project )
     {
         this.resumeFrom = project;
diff --git a/maven-core/src/main/java/org/apache/maven/execution/MavenExecutionRequest.java b/maven-core/src/main/java/org/apache/maven/execution/MavenExecutionRequest.java
index d006a43..542c34a 100644
--- a/maven-core/src/main/java/org/apache/maven/execution/MavenExecutionRequest.java
+++ b/maven-core/src/main/java/org/apache/maven/execution/MavenExecutionRequest.java
@@ -171,6 +171,17 @@ public interface MavenExecutionRequest
      */
     List<String> getExcludedProjects();
 
+    /**
+     * Sets whether the build should be resumed from the data in the resume.properties file.
+     * @return This request, never {@code null}.
+     */
+    MavenExecutionRequest setResume();
+
+    /**
+     * @return Whether the build should be resumed from the data in the resume.properties file.
+     */
+    boolean isResume();
+
     MavenExecutionRequest setResumeFrom( String project );
 
     String getResumeFrom();
diff --git a/maven-core/src/main/java/org/apache/maven/graph/DefaultGraphBuilder.java b/maven-core/src/main/java/org/apache/maven/graph/DefaultGraphBuilder.java
index 99f0266..091cbaf 100644
--- a/maven-core/src/main/java/org/apache/maven/graph/DefaultGraphBuilder.java
+++ b/maven-core/src/main/java/org/apache/maven/graph/DefaultGraphBuilder.java
@@ -38,6 +38,7 @@ import org.apache.maven.DefaultMaven;
 import org.apache.maven.MavenExecutionException;
 import org.apache.maven.ProjectCycleException;
 import org.apache.maven.artifact.ArtifactUtils;
+import org.apache.maven.execution.BuildResumptionManager;
 import org.apache.maven.execution.MavenExecutionRequest;
 import org.apache.maven.execution.MavenSession;
 import org.apache.maven.execution.ProjectDependencyGraph;
@@ -73,6 +74,9 @@ public class DefaultGraphBuilder
     @Inject
     protected ProjectBuilder projectBuilder;
 
+    @Inject
+    private BuildResumptionManager buildResumptionManager;
+
     @Override
     public Result<ProjectDependencyGraph> build( MavenSession session )
     {
@@ -84,6 +88,7 @@ public class DefaultGraphBuilder
             {
                 final List<MavenProject> projects = getProjectsForMavenReactor( session );
                 validateProjects( projects );
+                enrichRequestFromResumptionData( projects, session.getRequest() );
                 result = reactorDependencyGraph( session, projects );
             }
 
@@ -341,6 +346,18 @@ public class DefaultGraphBuilder
         return result;
     }
 
+    private void enrichRequestFromResumptionData( List<MavenProject> projects, MavenExecutionRequest request )
+    {
+        if ( request.isResume() )
+        {
+            projects.stream()
+                    .filter( MavenProject::isExecutionRoot )
+                    .findFirst()
+                    .ifPresent( rootProject ->
+                            buildResumptionManager.applyResumptionData( request, rootProject ) );
+        }
+    }
+
     private String formatProjects( List<MavenProject> projects )
     {
         StringBuilder projectNames = new StringBuilder();
diff --git a/maven-embedder/src/test/java/org/apache/maven/cli/BuildResumptionManagerTest.java b/maven-core/src/test/java/org/apache/maven/execution/BuildResumptionManagerTest.java
similarity index 72%
rename from maven-embedder/src/test/java/org/apache/maven/cli/BuildResumptionManagerTest.java
rename to maven-core/src/test/java/org/apache/maven/execution/BuildResumptionManagerTest.java
index 5958c80..95a0375 100644
--- a/maven-embedder/src/test/java/org/apache/maven/cli/BuildResumptionManagerTest.java
+++ b/maven-core/src/test/java/org/apache/maven/execution/BuildResumptionManagerTest.java
@@ -1,4 +1,4 @@
-package org.apache.maven.cli;
+package org.apache.maven.execution;
 
 /*
  * Licensed to the Apache Software Foundation (ASF) under one
@@ -19,16 +19,19 @@ package org.apache.maven.cli;
  * under the License.
  */
 
-import org.apache.maven.execution.BuildFailure;
-import org.apache.maven.execution.BuildSuccess;
-import org.apache.maven.execution.DefaultMavenExecutionResult;
-import org.apache.maven.execution.MavenExecutionResult;
 import org.apache.maven.lifecycle.LifecycleExecutionException;
 import org.apache.maven.model.Dependency;
 import org.apache.maven.project.MavenProject;
+import org.codehaus.plexus.logging.Logger;
 import org.junit.Before;
 import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.mockito.InjectMocks;
+import org.mockito.Mock;
+import org.mockito.junit.MockitoJUnitRunner;
 
+import java.util.ArrayList;
+import java.util.List;
 import java.util.Properties;
 
 import static java.util.Arrays.asList;
@@ -36,9 +39,14 @@ import static java.util.Collections.singletonList;
 import static org.hamcrest.MatcherAssert.assertThat;
 import static org.hamcrest.Matchers.*;
 
+@RunWith( MockitoJUnitRunner.class )
 public class BuildResumptionManagerTest
 {
-    private final BuildResumptionManager buildResumptionManager = new BuildResumptionManager();
+    @Mock
+    private Logger logger;
+
+    @InjectMocks
+    private BuildResumptionManager buildResumptionManager;
 
     private MavenExecutionResult result;
 
@@ -111,6 +119,46 @@ public class BuildResumptionManagerTest
         assertThat( properties.get( "excludedProjects" ), is( "test:B, test:C" ) );
     }
 
+    @Test
+    public void resumeFromPropertyGetsApplied()
+    {
+        MavenExecutionRequest request = new DefaultMavenExecutionRequest();
+        Properties properties = new Properties();
+        properties.setProperty( "resumeFrom", ":module-a" );
+
+        buildResumptionManager.applyResumptionProperties( request, properties );
+
+        assertThat( request.getResumeFrom(), is( ":module-a" ) );
+    }
+
+    @Test
+    public void resumeFromPropertyDoesNotOverrideExistingRequestParameters()
+    {
+        MavenExecutionRequest request = new DefaultMavenExecutionRequest();
+        request.setResumeFrom( ":module-b" );
+        Properties properties = new Properties();
+        properties.setProperty( "resumeFrom", ":module-a" );
+
+        buildResumptionManager.applyResumptionProperties( request, properties );
+
+        assertThat( request.getResumeFrom(), is( ":module-b" ) );
+    }
+
+    @Test
+    public void excludedProjectsFromPropertyGetsAddedToExistingRequestParameters()
+    {
+        MavenExecutionRequest request = new DefaultMavenExecutionRequest();
+        List<String> excludedProjects = new ArrayList<>();
+        excludedProjects.add( ":module-a" );
+        request.setExcludedProjects( excludedProjects );
+        Properties properties = new Properties();
+        properties.setProperty( "excludedProjects", ":module-b, :module-c" );
+
+        buildResumptionManager.applyResumptionProperties( request, properties );
+
+        assertThat( request.getExcludedProjects(), contains( ":module-a", ":module-b", ":module-c" ) );
+    }
+
     private MavenProject createMavenProject( String artifactId )
     {
         MavenProject project = new MavenProject();
diff --git a/maven-embedder/src/main/java/org/apache/maven/cli/CLIManager.java b/maven-embedder/src/main/java/org/apache/maven/cli/CLIManager.java
index c9e002a..873fc97 100644
--- a/maven-embedder/src/main/java/org/apache/maven/cli/CLIManager.java
+++ b/maven-embedder/src/main/java/org/apache/maven/cli/CLIManager.java
@@ -83,6 +83,8 @@ public class CLIManager
 
     public static final String FAIL_NEVER = "fn";
 
+    public static final String RESUME = "r";
+
     public static final String RESUME_FROM = "rf";
 
     public static final String PROJECT_LIST = "pl";
@@ -134,6 +136,7 @@ public class CLIManager
         options.addOption( Option.builder( FAIL_FAST ).longOpt( "fail-fast" ).desc( "Stop at first failure in reactorized builds" ).build() );
         options.addOption( Option.builder( FAIL_AT_END ).longOpt( "fail-at-end" ).desc( "Only fail the build afterwards; allow all non-impacted builds to continue" ).build() );
         options.addOption( Option.builder( FAIL_NEVER ).longOpt( "fail-never" ).desc( "NEVER fail the build, regardless of project result" ).build() );
+        options.addOption( Option.builder( RESUME ).longOpt( "resume" ).desc( "Resume reactor from the last failed project, using the resume.properties file in the build directory " ).build() );
         options.addOption( Option.builder( RESUME_FROM ).longOpt( "resume-from" ).hasArg().desc( "Resume reactor from specified project" ).build() );
         options.addOption( Option.builder( PROJECT_LIST ).longOpt( "projects" ).desc( "Comma-delimited list of specified reactor projects to build instead of all projects. A project can be specified by [groupId]:artifactId or by its relative path" ).hasArg().build() );
         options.addOption( Option.builder( ALSO_MAKE ).longOpt( "also-make" ).desc( "If project list is specified, also build projects required by the list" ).build() );
diff --git a/maven-embedder/src/main/java/org/apache/maven/cli/MavenCli.java b/maven-embedder/src/main/java/org/apache/maven/cli/MavenCli.java
index 9dd127a..4ecd095 100644
--- a/maven-embedder/src/main/java/org/apache/maven/cli/MavenCli.java
+++ b/maven-embedder/src/main/java/org/apache/maven/cli/MavenCli.java
@@ -48,6 +48,7 @@ import org.apache.maven.eventspy.internal.EventSpyDispatcher;
 import org.apache.maven.exception.DefaultExceptionHandler;
 import org.apache.maven.exception.ExceptionHandler;
 import org.apache.maven.exception.ExceptionSummary;
+import org.apache.maven.execution.BuildResumptionManager;
 import org.apache.maven.execution.DefaultMavenExecutionRequest;
 import org.apache.maven.execution.ExecutionListener;
 import org.apache.maven.execution.MavenExecutionRequest;
@@ -1029,7 +1030,7 @@ public class MavenCli
                 }
             }
 
-            boolean resumeFileCreated = buildResumptionManager.createResumptionFile( result );
+            boolean resumeFileCreated = buildResumptionManager.persistResumptionData( result );
 
             slf4jLogger.error( "" );
             slf4jLogger.error( "After correcting the problems, you can resume the build with the command" );
@@ -1528,6 +1529,11 @@ public class MavenCli
             request.setBaseDirectory( request.getPom().getParentFile() );
         }
 
+        if ( commandLine.hasOption( CLIManager.RESUME ) )
+        {
+            request.setResume();
+        }
+
         if ( commandLine.hasOption( CLIManager.RESUME_FROM ) )
         {
             request.setResumeFrom( commandLine.getOptionValue( CLIManager.RESUME_FROM ) );