michael-o commented on a change in pull request #342: URL: https://github.com/apache/maven/pull/342#discussion_r429572926
########## File path: maven-core/src/main/java/org/apache/maven/execution/DefaultBuildResumptionManager.java ########## @@ -0,0 +1,308 @@ +package org.apache.maven.execution; + +/* + * 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 com.google.common.annotations.VisibleForTesting; +import org.apache.commons.lang3.StringUtils; +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 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; +import java.util.Properties; +import java.util.stream.Collectors; + +import static java.util.Comparator.comparing; + +/** + * This implementation of {@link BuildResumptionManager} persists information in a properties file. The file is stored + * in the build output directory under the Maven execution root. + */ +@Named +@Singleton +public class DefaultBuildResumptionManager implements 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; Review comment: Don't use the Plexus logger. You can use SLF4J directly. ########## File path: maven-core/src/main/java/org/apache/maven/execution/DefaultBuildResumptionManager.java ########## @@ -0,0 +1,308 @@ +package org.apache.maven.execution; + +/* + * 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 com.google.common.annotations.VisibleForTesting; +import org.apache.commons.lang3.StringUtils; +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 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; +import java.util.Properties; +import java.util.stream.Collectors; + +import static java.util.Comparator.comparing; + +/** + * This implementation of {@link BuildResumptionManager} persists information in a properties file. The file is stored + * in the build output directory under the Maven execution root. + */ +@Named +@Singleton +public class DefaultBuildResumptionManager implements 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; + + @Override + public boolean persistResumptionData( MavenExecutionResult result, MavenProject rootProject ) + { + Properties properties = determineResumptionProperties( result ); + + if ( properties.isEmpty() ) + { + logger.debug( "Will not create " + RESUME_PROPERTIES_FILENAME + " file: nothing to resume from" ); + return false; + } + + return writeResumptionFile( rootProject, properties ); + } + + @Override + public void applyResumptionData( MavenExecutionRequest request, MavenProject rootProject ) + { + Properties properties = loadResumptionFile( rootProject.getBuild().getDirectory() ); + applyResumptionProperties( request, properties ); + } + + @Override + public void removeResumptionData( MavenProject rootProject ) + { + Path resumeProperties = Paths.get( rootProject.getBuild().getDirectory(), RESUME_PROPERTIES_FILENAME ); + try + { + Files.deleteIfExists( resumeProperties ); + } + catch ( IOException e ) + { + logger.warn( "Could not delete " + RESUME_PROPERTIES_FILENAME + " file. ", e ); + } + } + + @Override + 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 ) + { + Properties properties = new Properties(); + + List<MavenProject> failedProjects = getFailedProjectsInOrder( result ); + if ( !failedProjects.isEmpty() ) + { + MavenProject resumeFromProject = failedProjects.get( 0 ); + Optional<String> resumeFrom = getResumeFrom( result, resumeFromProject ); + Optional<String> projectsToSkip = determineProjectsToSkip( result, failedProjects, resumeFromProject ); + + resumeFrom.ifPresent( value -> properties.setProperty( RESUME_FROM_PROPERTY, value ) ); + projectsToSkip.ifPresent( value -> properties.setProperty( EXCLUDED_PROJECTS_PROPERTY, value ) ); + } + else + { + logger.warn( "Could not create " + RESUME_PROPERTIES_FILENAME + " file: no failed projects found" ); + } + + return properties; + } + + private List<MavenProject> getFailedProjectsInOrder( MavenExecutionResult result ) + { + List<MavenProject> sortedProjects = result.getTopologicallySortedProjects(); + + return result.getExceptions().stream() + .filter( LifecycleExecutionException.class::isInstance ) + .map( LifecycleExecutionException.class::cast ) + .map( LifecycleExecutionException::getProject ) + .sorted( comparing( sortedProjects::indexOf ) ) + .collect( Collectors.toList() ); + } + + /** + * Determine the project where the next build can be resumed from. + * If the failed project is the first project of the build, + * it does not make sense to use --resume-from, so the result will be empty. + * @param result The result of the Maven build. + * @param failedProject The first failed project of the build. + * @return An optional containing the resume-from suggestion. + */ + private Optional<String> getResumeFrom( MavenExecutionResult result, MavenProject failedProject ) + { + List<MavenProject> allSortedProjects = result.getTopologicallySortedProjects(); + if ( !allSortedProjects.get( 0 ).equals( failedProject ) ) + { + return Optional.of( String.format( "%s:%s", failedProject.getGroupId(), failedProject.getArtifactId() ) ); Review comment: Inconsistent with `getResumeFromSelector()`. I see no real benefit of `format()` for this case. Static concat will be replaced with a builder at compile time anyway. ########## File path: maven-core/src/main/java/org/apache/maven/execution/DefaultBuildResumptionManager.java ########## @@ -0,0 +1,308 @@ +package org.apache.maven.execution; + +/* + * 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 com.google.common.annotations.VisibleForTesting; +import org.apache.commons.lang3.StringUtils; +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 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; +import java.util.Properties; +import java.util.stream.Collectors; + +import static java.util.Comparator.comparing; + +/** + * This implementation of {@link BuildResumptionManager} persists information in a properties file. The file is stored + * in the build output directory under the Maven execution root. + */ +@Named +@Singleton +public class DefaultBuildResumptionManager implements 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; + + @Override + public boolean persistResumptionData( MavenExecutionResult result, MavenProject rootProject ) + { + Properties properties = determineResumptionProperties( result ); + + if ( properties.isEmpty() ) + { + logger.debug( "Will not create " + RESUME_PROPERTIES_FILENAME + " file: nothing to resume from" ); + return false; + } + + return writeResumptionFile( rootProject, properties ); + } + + @Override + public void applyResumptionData( MavenExecutionRequest request, MavenProject rootProject ) + { + Properties properties = loadResumptionFile( rootProject.getBuild().getDirectory() ); + applyResumptionProperties( request, properties ); + } + + @Override + public void removeResumptionData( MavenProject rootProject ) + { + Path resumeProperties = Paths.get( rootProject.getBuild().getDirectory(), RESUME_PROPERTIES_FILENAME ); + try + { + Files.deleteIfExists( resumeProperties ); + } + catch ( IOException e ) + { + logger.warn( "Could not delete " + RESUME_PROPERTIES_FILENAME + " file. ", e ); + } + } + + @Override + 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 ) + { + Properties properties = new Properties(); + + List<MavenProject> failedProjects = getFailedProjectsInOrder( result ); + if ( !failedProjects.isEmpty() ) + { + MavenProject resumeFromProject = failedProjects.get( 0 ); + Optional<String> resumeFrom = getResumeFrom( result, resumeFromProject ); + Optional<String> projectsToSkip = determineProjectsToSkip( result, failedProjects, resumeFromProject ); + + resumeFrom.ifPresent( value -> properties.setProperty( RESUME_FROM_PROPERTY, value ) ); + projectsToSkip.ifPresent( value -> properties.setProperty( EXCLUDED_PROJECTS_PROPERTY, value ) ); + } + else + { + logger.warn( "Could not create " + RESUME_PROPERTIES_FILENAME + " file: no failed projects found" ); + } + + return properties; + } + + private List<MavenProject> getFailedProjectsInOrder( MavenExecutionResult result ) + { + List<MavenProject> sortedProjects = result.getTopologicallySortedProjects(); + + return result.getExceptions().stream() + .filter( LifecycleExecutionException.class::isInstance ) + .map( LifecycleExecutionException.class::cast ) + .map( LifecycleExecutionException::getProject ) + .sorted( comparing( sortedProjects::indexOf ) ) + .collect( Collectors.toList() ); + } + + /** + * Determine the project where the next build can be resumed from. + * If the failed project is the first project of the build, + * it does not make sense to use --resume-from, so the result will be empty. + * @param result The result of the Maven build. + * @param failedProject The first failed project of the build. + * @return An optional containing the resume-from suggestion. + */ + private Optional<String> getResumeFrom( MavenExecutionResult result, MavenProject failedProject ) + { + List<MavenProject> allSortedProjects = result.getTopologicallySortedProjects(); + if ( !allSortedProjects.get( 0 ).equals( failedProject ) ) + { + return Optional.of( String.format( "%s:%s", failedProject.getGroupId(), failedProject.getArtifactId() ) ); + } + + return Optional.empty(); + } + + /** + * Projects after the first failed project could have succeeded by using -T or --fail-at-end. + * These projects can be skipped from later builds. + * This is not the case these projects are dependent on one of the failed projects. + * @param result The result of the Maven build. + * @param failedProjects The list of failed projects in the build. + * @param resumeFromProject The project where the build will be resumed with in the next run. + * @return An optional containing a comma separated list of projects which can be skipped, + * or an empty optional if no projects can be skipped. + */ + private Optional<String> determineProjectsToSkip( MavenExecutionResult result, List<MavenProject> failedProjects, + MavenProject resumeFromProject ) + { + List<MavenProject> allProjects = result.getTopologicallySortedProjects(); + int resumeFromProjectIndex = allProjects.indexOf( resumeFromProject ); + List<MavenProject> remainingProjects = allProjects.subList( resumeFromProjectIndex + 1, allProjects.size() ); + + List<GroupArtifactPair> failedProjectsGAList = failedProjects.stream() + .map( GroupArtifactPair::new ) + .collect( Collectors.toList() ); + + String projectsToSkip = remainingProjects.stream() + .filter( project -> result.getBuildSummary( project ) instanceof BuildSuccess ) + .filter( project -> hasNoDependencyOnProjects( project, failedProjectsGAList ) ) + .map( project -> String.format( "%s:%s", project.getGroupId(), project.getArtifactId() ) ) + .collect( Collectors.joining( PROPERTY_DELIMITER ) ); + + if ( !StringUtils.isEmpty( projectsToSkip ) ) + { + return Optional.of( projectsToSkip ); + } + + return Optional.empty(); + } + + private boolean hasNoDependencyOnProjects( MavenProject project, List<GroupArtifactPair> projectsGAs ) + { + return project.getDependencies().stream() + .map( GroupArtifactPair::new ) + .noneMatch( projectsGAs::contains ); + } + + private boolean writeResumptionFile( MavenProject rootProject, Properties properties ) + { + Path resumeProperties = Paths.get( rootProject.getBuild().getDirectory(), RESUME_PROPERTIES_FILENAME ); + try + { + Files.createDirectories( resumeProperties.getParent() ); Review comment: Does this one assume that we are in a phase/goal where Maven hasn't created `target` yet? ########## File path: maven-core/src/main/java/org/apache/maven/execution/DefaultBuildResumptionManager.java ########## @@ -0,0 +1,308 @@ +package org.apache.maven.execution; + +/* + * 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 com.google.common.annotations.VisibleForTesting; +import org.apache.commons.lang3.StringUtils; +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 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; +import java.util.Properties; +import java.util.stream.Collectors; + +import static java.util.Comparator.comparing; + +/** + * This implementation of {@link BuildResumptionManager} persists information in a properties file. The file is stored + * in the build output directory under the Maven execution root. + */ +@Named +@Singleton +public class DefaultBuildResumptionManager implements 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; + + @Override + public boolean persistResumptionData( MavenExecutionResult result, MavenProject rootProject ) + { + Properties properties = determineResumptionProperties( result ); + + if ( properties.isEmpty() ) + { + logger.debug( "Will not create " + RESUME_PROPERTIES_FILENAME + " file: nothing to resume from" ); + return false; + } + + return writeResumptionFile( rootProject, properties ); + } + + @Override + public void applyResumptionData( MavenExecutionRequest request, MavenProject rootProject ) + { + Properties properties = loadResumptionFile( rootProject.getBuild().getDirectory() ); + applyResumptionProperties( request, properties ); + } + + @Override + public void removeResumptionData( MavenProject rootProject ) + { + Path resumeProperties = Paths.get( rootProject.getBuild().getDirectory(), RESUME_PROPERTIES_FILENAME ); + try + { + Files.deleteIfExists( resumeProperties ); + } + catch ( IOException e ) + { + logger.warn( "Could not delete " + RESUME_PROPERTIES_FILENAME + " file. ", e ); + } + } + + @Override + 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 ) + { + Properties properties = new Properties(); + + List<MavenProject> failedProjects = getFailedProjectsInOrder( result ); + if ( !failedProjects.isEmpty() ) + { + MavenProject resumeFromProject = failedProjects.get( 0 ); + Optional<String> resumeFrom = getResumeFrom( result, resumeFromProject ); + Optional<String> projectsToSkip = determineProjectsToSkip( result, failedProjects, resumeFromProject ); + + resumeFrom.ifPresent( value -> properties.setProperty( RESUME_FROM_PROPERTY, value ) ); + projectsToSkip.ifPresent( value -> properties.setProperty( EXCLUDED_PROJECTS_PROPERTY, value ) ); + } + else + { + logger.warn( "Could not create " + RESUME_PROPERTIES_FILENAME + " file: no failed projects found" ); + } + + return properties; + } + + private List<MavenProject> getFailedProjectsInOrder( MavenExecutionResult result ) + { + List<MavenProject> sortedProjects = result.getTopologicallySortedProjects(); + + return result.getExceptions().stream() + .filter( LifecycleExecutionException.class::isInstance ) + .map( LifecycleExecutionException.class::cast ) + .map( LifecycleExecutionException::getProject ) + .sorted( comparing( sortedProjects::indexOf ) ) + .collect( Collectors.toList() ); + } + + /** + * Determine the project where the next build can be resumed from. + * If the failed project is the first project of the build, + * it does not make sense to use --resume-from, so the result will be empty. + * @param result The result of the Maven build. + * @param failedProject The first failed project of the build. + * @return An optional containing the resume-from suggestion. + */ + private Optional<String> getResumeFrom( MavenExecutionResult result, MavenProject failedProject ) + { + List<MavenProject> allSortedProjects = result.getTopologicallySortedProjects(); + if ( !allSortedProjects.get( 0 ).equals( failedProject ) ) + { + return Optional.of( String.format( "%s:%s", failedProject.getGroupId(), failedProject.getArtifactId() ) ); + } + + return Optional.empty(); + } + + /** + * Projects after the first failed project could have succeeded by using -T or --fail-at-end. + * These projects can be skipped from later builds. + * This is not the case these projects are dependent on one of the failed projects. + * @param result The result of the Maven build. + * @param failedProjects The list of failed projects in the build. + * @param resumeFromProject The project where the build will be resumed with in the next run. + * @return An optional containing a comma separated list of projects which can be skipped, + * or an empty optional if no projects can be skipped. + */ + private Optional<String> determineProjectsToSkip( MavenExecutionResult result, List<MavenProject> failedProjects, + MavenProject resumeFromProject ) + { + List<MavenProject> allProjects = result.getTopologicallySortedProjects(); + int resumeFromProjectIndex = allProjects.indexOf( resumeFromProject ); + List<MavenProject> remainingProjects = allProjects.subList( resumeFromProjectIndex + 1, allProjects.size() ); + + List<GroupArtifactPair> failedProjectsGAList = failedProjects.stream() + .map( GroupArtifactPair::new ) + .collect( Collectors.toList() ); + + String projectsToSkip = remainingProjects.stream() + .filter( project -> result.getBuildSummary( project ) instanceof BuildSuccess ) + .filter( project -> hasNoDependencyOnProjects( project, failedProjectsGAList ) ) + .map( project -> String.format( "%s:%s", project.getGroupId(), project.getArtifactId() ) ) + .collect( Collectors.joining( PROPERTY_DELIMITER ) ); + + if ( !StringUtils.isEmpty( projectsToSkip ) ) + { + return Optional.of( projectsToSkip ); + } + + return Optional.empty(); + } + + private boolean hasNoDependencyOnProjects( MavenProject project, List<GroupArtifactPair> projectsGAs ) + { + return project.getDependencies().stream() + .map( GroupArtifactPair::new ) + .noneMatch( projectsGAs::contains ); + } + + private boolean writeResumptionFile( MavenProject rootProject, Properties properties ) + { + Path resumeProperties = Paths.get( rootProject.getBuild().getDirectory(), RESUME_PROPERTIES_FILENAME ); + try + { + Files.createDirectories( resumeProperties.getParent() ); + try ( Writer writer = Files.newBufferedWriter( resumeProperties ) ) + { + properties.store( writer, null ); + } + } + catch ( IOException e ) + { + logger.warn( "Could not create " + RESUME_PROPERTIES_FILENAME + " file. ", e ); + return false; + } + + return true; + } + + private Properties loadResumptionFile( String rootBuildDirectory ) Review comment: The signature is inconsistent with `writeResumptionFile()`. once you pass the string directly, on the other one you pass the Maven project. Any reason for this? ---------------------------------------------------------------- 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: [email protected]
