mojohaus#1310: Handling a similar case in SetMojo, SetScmTagMojo, UpdateChildModulesMojo

Author: andrzejj0

versions-maven-plugin/src/main/java/org/codehaus/mojo/versions/SetMojo.java

@@ -213,9 +213,12 @@ public class SetMojo extends AbstractVersionsUpdaterMojo {
     protected Integer nextSnapshotIndexToIncrement;
 
     /**
-     * Whether to start processing at the local aggregation root (which might be a parent module
+     * <p>Whether to start processing at the local aggregation root (which might be a parent module
      * of that module where Maven is executed in, and the version change may affect parent and sibling modules).
-     * Setting to false makes sure only the module (and it's submodules) where Maven is executed for is affected.
+     * Setting to false makes sure only the module (and its submodules) where Maven is executed for is affected.</p>
+     *
+     * <p>Since 2.20.2: If the plugin is executed with a project list (Maven CLI option {@code -pl}),
+     * the plugin is always executed on every project on the list as local aggregation root.</p>
      *
      * @since 2.9
      */
@@ -301,10 +304,19 @@ private synchronized void addChange(String groupId, String artifactId, String ol
      * Called when this mojo is executed.
      *
      * @throws org.apache.maven.plugin.MojoExecutionException when things go wrong.
-     * @throws org.apache.maven.plugin.MojoFailureException   when things go wrong.
      */
-    public void execute() throws MojoExecutionException, MojoFailureException {
-        if (getProject().getOriginalModel().getVersion() == null) {
+    public void execute() throws MojoExecutionException {
+        for (MavenProject currentProject : session.getProjects()) {
+            if (getLog().isDebugEnabled() && session.getProjects().size() > 1) {
+                getLog().debug("Processing " + project.getGroupId() + ":" + project.getArtifactId() + ":"
+                        + project.getVersion() + "...");
+            }
+            execute(currentProject);
+        }
+    }
+
+    private void execute(MavenProject currentProject) throws MojoExecutionException {
+        if (currentProject.getOriginalModel().getVersion() == null) {
             throw new MojoExecutionException("Project version is inherited from parent.");
         }
 
@@ -335,7 +347,7 @@ public void execute() throws MojoExecutionException, MojoFailureException {
                 try {
                     newVersion = prompter.prompt(
                             "Enter the new version to set",
-                            getProject().getOriginalModel().getVersion());
+                            currentProject.getOriginalModel().getVersion());
                 } catch (PrompterException e) {
                     throw new MojoExecutionException(e.getMessage(), e);
                 }
@@ -354,9 +366,9 @@ public void execute() throws MojoExecutionException, MojoFailureException {
         }
 
         try {
-            final MavenProject project = processFromLocalAggregationRoot
+            final MavenProject project = session.getProjects().size() == 1 && processFromLocalAggregationRoot
                     ? PomHelper.getLocalRoot(projectBuilder, session, getLog())
-                    : getProject();
+                    : currentProject;
 
             getLog().info("Local aggregation root: " + project.getBasedir());
             Map<File, Model> reactorModels = PomHelper.getChildModels(project, getLog());
@@ -370,7 +382,11 @@ public void execute() throws MojoExecutionException, MojoFailureException {
             // needs to be changed as well
             // setting them to the main project coordinates in case they are not set by the user,
             // so that the main project can be selected
-            Model rootModel = reactorModels.get(session.getCurrentProject().getFile());
+            Model rootModel = reactorModels.get(currentProject.getFile());
+
+            String groupId = this.groupId;
+            String artifactId = this.artifactId;
+            String oldVersion = this.oldVersion;
             if (groupId == null) {
                 groupId = PomHelper.getGroupId(rootModel);
             }
@@ -429,11 +445,10 @@ public void execute() throws MojoExecutionException, MojoFailureException {
                 process(file);
             }
 
-        } catch (IOException e) {
+        } catch (IOException | MojoFailureException e) {
             throw new MojoExecutionException(e.getMessage(), e);
         }
     }
-
     /**
      * Returns the incremented version, with the nextSnapshotIndexToIncrement indicating the 1-based index,
      * from the left, or the most major version component, of the version string.

versions-maven-plugin/src/main/java/org/codehaus/mojo/versions/SetScmTagMojo.java

@@ -3,6 +3,7 @@
 import javax.inject.Inject;
 import javax.xml.stream.XMLStreamException;
 
+import java.io.File;
 import java.io.IOException;
 import java.util.ArrayList;
 import java.util.List;
@@ -13,6 +14,7 @@
 import org.apache.maven.plugin.MojoFailureException;
 import org.apache.maven.plugins.annotations.Mojo;
 import org.apache.maven.plugins.annotations.Parameter;
+import org.apache.maven.project.MavenProject;
 import org.apache.maven.wagon.Wagon;
 import org.codehaus.mojo.versions.api.PomHelper;
 import org.codehaus.mojo.versions.api.recording.ChangeRecorder;
@@ -104,12 +106,23 @@ protected boolean getAllowSnapshots() {
      */
     @Override
     public void execute() throws MojoExecutionException, MojoFailureException {
+        validateInput();
+        for (MavenProject currentProject : session.getProjects()) {
+            if (getLog().isDebugEnabled() && session.getProjects().size() > 1) {
+                getLog().debug("Processing " + project.getGroupId() + ":" + project.getArtifactId() + ":"
+                        + project.getVersion() + "...");
+            }
+            File outFile = currentProject.getFile();
+            process(outFile);
+        }
+    }
+
+    @Override
+    protected void validateInput() throws MojoExecutionException {
         if (isAllBlank(newTag, connection, developerConnection, url)) {
-            throw new MojoFailureException(
+            throw new MojoExecutionException(
                     "One of: \"newTag\", \"connection\", \"developerConnection\", \"url\" should be provided.");
         }
-
-        super.execute();
     }
 
     @Override

versions-maven-plugin/src/main/java/org/codehaus/mojo/versions/UpdateChildModulesMojo.java

@@ -35,6 +35,7 @@
 import org.apache.maven.plugin.MojoFailureException;
 import org.apache.maven.plugins.annotations.Mojo;
 import org.apache.maven.plugins.annotations.Parameter;
+import org.apache.maven.project.MavenProject;
 import org.apache.maven.wagon.Wagon;
 import org.codehaus.mojo.versions.api.PomHelper;
 import org.codehaus.mojo.versions.api.recording.ChangeRecorder;
@@ -105,11 +106,21 @@ protected boolean getAllowSnapshots() {
      * @throws MojoFailureException   when things go wrong.
      */
     public void execute() throws MojoExecutionException, MojoFailureException {
+        validateInput();
+        for (MavenProject currentProject : session.getProjects()) {
+            if (getLog().isDebugEnabled() && session.getProjects().size() > 1) {
+                getLog().debug("Processing " + project.getGroupId() + ":" + project.getArtifactId() + ":"
+                        + project.getVersion() + "...");
+            }
+            execute(currentProject);
+        }
+    }
 
+    private void execute(MavenProject currentProject) throws MojoExecutionException {
         boolean didSomething = false;
 
         try {
-            final Map<File, Model> reactor = PomHelper.getChildModels(getProject(), getLog());
+            final Map<File, Model> reactor = PomHelper.getChildModels(currentProject, getLog());
             List<File> order = new ArrayList<>(reactor.keySet());
             order.sort((o1, o2) -> {
                 Model m1 = reactor.get(o1);
@@ -180,7 +191,7 @@ public void execute() throws MojoExecutionException, MojoFailureException {
                 }
             }
 
-        } catch (IOException e) {
+        } catch (IOException | MojoFailureException e) {
             throw new MojoExecutionException(e.getMessage(), e);
         }
         if (!didSomething) {
@@ -196,6 +207,7 @@ public void execute() throws MojoExecutionException, MojoFailureException {
      * @throws MojoFailureException   when things go wrong.
      * @throws XMLStreamException     when things go wrong.
      */
+    @Override
     protected synchronized void update(MutableXMLStreamReader pom)
             throws MojoExecutionException, MojoFailureException, XMLStreamException {
         getLog().debug("Updating parent to " + sourceVersion);

versions-maven-plugin/src/test/java/org/codehaus/mojo/versions/SetMojoTest.java

@@ -5,12 +5,14 @@
 import java.nio.file.Files;
 import java.nio.file.Path;
 import java.nio.file.Paths;
+import java.util.Collections;
 import java.util.function.Consumer;
 import java.util.stream.Collectors;
 import java.util.stream.Stream;
 
 import org.apache.commons.lang3.tuple.Triple;
 import org.apache.maven.artifact.handler.manager.ArtifactHandlerManager;
+import org.apache.maven.execution.MavenSession;
 import org.apache.maven.model.Model;
 import org.apache.maven.plugin.MojoExecutionException;
 import org.apache.maven.plugin.MojoFailureException;
@@ -29,13 +31,16 @@
 import org.mockito.Mock;
 
 import static java.nio.file.StandardCopyOption.REPLACE_EXISTING;
+import static org.codehaus.mojo.versions.utils.MockUtils.mockAetherRepositorySystem;
 import static org.codehaus.mojo.versions.utils.MockUtils.mockArtifactHandlerManager;
 import static org.hamcrest.MatcherAssert.assertThat;
 import static org.hamcrest.Matchers.containsString;
 import static org.hamcrest.Matchers.is;
 import static org.hamcrest.Matchers.matchesPattern;
 import static org.hamcrest.Matchers.matchesRegex;
 import static org.hamcrest.Matchers.not;
+import static org.mockito.Mockito.doReturn;
+import static org.mockito.Mockito.mock;
 import static org.mockito.MockitoAnnotations.openMocks;
 
 public class SetMojoTest extends AbstractMojoTestCase {
@@ -121,7 +126,8 @@ public void testNextSnapshotIndexWithoutNextSnapshot() throws MojoFailureExcepti
                     project.setParent(new MavenProject());
                     project.setOriginalModel(new Model());
                     project.getOriginalModel().setVersion("1.2.3-SNAPSHOT");
-
+                    session = mock(MavenSession.class);
+                    doReturn(Collections.singletonList(project)).when(session).getProjects();
                     nextSnapshotIndexToIncrement = 4;
                 }
             }.execute();
@@ -277,4 +283,29 @@ public void testNextSnapshotIndexToIncrement() throws MojoExecutionException {
             }
         };
     }
+
+    /**
+     * Tests against a case where {@link SetMojo} is executed on a module project list
+     * (that is, if a -pl parameter is used providing a list of modules to process).
+     *
+     * @throws Exception thrown if something goes not according to plan
+     */
+    @Test
+    public void testModuleList() throws Exception {
+        TestUtils.copyDir(Paths.get("src/test/resources/org/codehaus/mojo/set/module-list"), tempDir);
+
+        MavenSession session = TestUtils.createMavenSession(
+                mojoRule.getContainer(), mojoRule::readMavenProject, tempDir, "mod1", "mod2");
+        SetMojo mojo = mojoRule.lookupConfiguredMojo(session, newMojoExecution("set"));
+        setVariableValueToObject(mojo, "newVersion", "2.0.0");
+        setVariableValueToObject(mojo, "repositorySystem", mockAetherRepositorySystem());
+        setVariableValueToObject(mojo, "log", log);
+
+        mojo.execute();
+
+        String mod1 = String.join("", Files.readAllLines(tempDir.resolve("mod1/pom.xml")));
+        String mod2 = String.join("", Files.readAllLines(tempDir.resolve("mod2/pom.xml")));
+        assertThat(mod1, containsString("<version>2.0.0</version>"));
+        assertThat(mod2, containsString("<version>2.0.0</version>"));
+    }
 }

versions-maven-plugin/src/test/java/org/codehaus/mojo/versions/SetScmTagMojoTest.java

@@ -19,18 +19,27 @@
  * under the License.
  */
 
+import java.io.IOException;
 import java.nio.file.Files;
 import java.nio.file.Path;
 import java.nio.file.Paths;
+import java.util.Arrays;
 
+import org.apache.maven.execution.MavenSession;
+import org.apache.maven.plugin.logging.Log;
 import org.apache.maven.plugin.testing.AbstractMojoTestCase;
 import org.apache.maven.plugin.testing.MojoRule;
+import org.codehaus.mojo.versions.utils.TestUtils;
+import org.junit.After;
+import org.junit.Before;
 import org.junit.Rule;
 import org.junit.Test;
+import org.mockito.Mock;
 
 import static org.hamcrest.MatcherAssert.assertThat;
 import static org.hamcrest.Matchers.allOf;
 import static org.hamcrest.Matchers.matchesPattern;
+import static org.mockito.MockitoAnnotations.openMocks;
 
 /**
  * Basic tests for {@linkplain SetPropertyMojoTest}.
@@ -41,12 +50,29 @@ public class SetScmTagMojoTest extends AbstractMojoTestCase {
     @Rule
     public MojoRule mojoRule = new MojoRule(this);
 
+    private Path tempDir;
+
+    @Mock
+    protected Log log;
+
+    @Before
+    public void setUp() throws Exception {
+        super.setUp();
+        openMocks(this);
+        tempDir = TestUtils.createTempDir("set");
+    }
+
+    @After
+    public void tearDown() throws IOException {
+        TestUtils.tearDownTempDir(tempDir);
+    }
+
     @Test
     public void testNewScmValues() throws Exception {
-        Path pomFile = Paths.get("target/test-classes/org/codehaus/mojo/set-scm-tag/pom.xml");
-        mojoRule.lookupConfiguredMojo(pomFile.toFile().getParentFile(), "set-scm-tag")
-                .execute();
-        String output = String.join("", Files.readAllLines(pomFile)).replaceAll("\\s*", "");
+        TestUtils.copyDir(Paths.get("src/test/resources/org/codehaus/mojo/set-scm-tag/new-scm-values"), tempDir);
+        mojoRule.lookupConfiguredMojo(tempDir.toFile(), "set-scm-tag").execute();
+        String output =
+                String.join("", Files.readAllLines(tempDir.resolve("pom.xml"))).replaceAll("\\s*", "");
         assertThat(
                 output,
                 allOf(
@@ -56,4 +82,36 @@ public void testNewScmValues() throws Exception {
                         matchesPattern(".*<scm>.*<developerConnection>\\s*"
                                 + "developerConnection\\s*</developerConnection>.*</scm>.*")));
     }
+
+    /**
+     * Tests against a case where {@link SetScmTagMojo} is executed on a module project list
+     * (that is, if a -pl parameter is used providing a list of modules to process).
+     *
+     * @throws Exception thrown if something goes not according to plan
+     */
+    @Test
+    public void testModuleList() throws Exception {
+        TestUtils.copyDir(Paths.get("src/test/resources/org/codehaus/mojo/set-scm-tag/module-list"), tempDir);
+
+        MavenSession session = TestUtils.createMavenSession(
+                mojoRule.getContainer(), mojoRule::readMavenProject, tempDir, "mod1", "mod2");
+        SetScmTagMojo mojo = mojoRule.lookupConfiguredMojo(session, newMojoExecution("set-scm-tag"));
+        setVariableValueToObject(mojo, "newTag", "newTag");
+        setVariableValueToObject(mojo, "connection", "connection");
+        setVariableValueToObject(mojo, "developerConnection", "developerConnection");
+        setVariableValueToObject(mojo, "url", "url");
+        mojo.execute();
+        for (String project : Arrays.asList("mod1", "mod2")) {
+            Path pomFile = tempDir.resolve(project).resolve("pom.xml");
+            String output = String.join("", Files.readAllLines(pomFile)).replaceAll("\\s*", "");
+            assertThat(
+                    output,
+                    allOf(
+                            matchesPattern(".*<scm>.*<tag>\\s*newTag\\s*</tag>.*</scm>.*"),
+                            matchesPattern(".*<scm>.*<url>\\s*url\\s*</url>.*</scm>.*"),
+                            matchesPattern(".*<scm>.*<connection>\\s*connection\\s*</connection>.*</scm>.*"),
+                            matchesPattern(".*<scm>.*<developerConnection>\\s*"
+                                    + "developerConnection\\s*</developerConnection>.*</scm>.*")));
+        }
+    }
 }