Fixes 1182 and 1184: Buges fix (update scope determination) + slight …

…refactoring, fixed (mojohaus#1185)

versions-common/src/main/java/org/codehaus/mojo/versions/utils/ExtensionUtils.java

@@ -0,0 +1,132 @@
+package org.codehaus.mojo.versions.utils;
+
+/*
+ * Copyright MojoHaus and Contributors
+ *
+ * Licensed 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 javax.xml.stream.XMLStreamException;
+import javax.xml.transform.TransformerException;
+
+import java.io.BufferedReader;
+import java.io.IOException;
+import java.io.InputStreamReader;
+import java.io.Reader;
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+import java.util.Objects;
+import java.util.stream.Stream;
+
+import org.apache.commons.lang3.tuple.Pair;
+import org.apache.maven.model.Build;
+import org.apache.maven.model.Extension;
+import org.apache.maven.model.Model;
+import org.apache.maven.plugin.logging.Log;
+import org.apache.maven.project.MavenProject;
+import org.codehaus.mojo.versions.api.PomHelper;
+import org.codehaus.mojo.versions.model.io.stax.CoreExtensionsStaxReader;
+import org.codehaus.mojo.versions.rewriting.MutableXMLStreamReader;
+
+import static java.util.Optional.ofNullable;
+
+/**
+ * Utilities for reading and handling extensions.
+ */
+public final class ExtensionUtils {
+    /**
+     * Reads the core extensions configured for the given project
+     * from the {@code ${project}/.mvn/extensions.xml} file.
+     *
+     * @param project {@link MavenProject} instance
+     * @return stream of core extensions defined in the {@code ${project}/.mvn/extensions.xml} file
+     * @throws IOException thrown if a file I/O operation fails
+     * @throws XMLStreamException thrown if the file cannot be parsed
+     * @since 2.15.0
+     */
+    public static Stream<Extension> getCoreExtensions(MavenProject project) throws IOException, XMLStreamException {
+        Path extensionsFile = project.getBasedir().toPath().resolve(".mvn/extensions.xml");
+        if (!Files.isRegularFile(extensionsFile)) {
+            return Stream.empty();
+        }
+
+        try (Reader reader = new BufferedReader(new InputStreamReader(Files.newInputStream(extensionsFile)))) {
+            return new CoreExtensionsStaxReader()
+                    .read(reader).getExtensions().stream().map(ex -> ExtensionBuilder.newBuilder()
+                            .withGroupId(ex.getGroupId())
+                            .withArtifactId(ex.getArtifactId())
+                            .withVersion(ex.getVersion())
+                            .build());
+        }
+    }
+
+    /**
+     * Returns a stream of build extensions configured for the given project
+     * @param project {@link MavenProject} instance
+     * @param log {@link Log} instance
+     * @param interpolateProperties when {@code false}, will return extensions based on raw model, otherwise will
+     *                              process the interpolated model
+     * @return stream of build extensions
+     * @throws IOException if the model file can't be read
+     * @throws XMLStreamException if the model file can't be parsed
+     * @throws TransformerException if the model file can't be parsed
+     */
+    public static Stream<Extension> getBuildExtensions(MavenProject project, Log log, boolean interpolateProperties)
+            throws XMLStreamException, IOException, TransformerException {
+        if (interpolateProperties) {
+            return getInterpolatedBuildExtensions(project, log);
+        } else {
+            return PomHelper.getChildModels(project, log).values().stream()
+                    .map(Model::getBuild)
+                    .filter(Objects::nonNull)
+                    .map(Build::getExtensions)
+                    .map(List::stream)
+                    .reduce(Stream::concat)
+                    .orElse(Stream.empty());
+        }
+    }
+
+    private static Stream<Extension> getInterpolatedBuildExtensions(MavenProject project, Log log)
+            throws IOException, XMLStreamException, TransformerException {
+        MutableXMLStreamReader pomReader =
+                new MutableXMLStreamReader(project.getFile().toPath());
+        ModelNode rootNode = new ModelNode(PomHelper.getRawModel(pomReader.getSource(), project.getFile()), pomReader);
+        List<ModelNode> rawModels = PomHelper.getRawModelTree(rootNode, log);
+        return rawModels.stream()
+                .filter(node -> Objects.nonNull(node.getModel()))
+                .filter(node -> ofNullable(node.getModel().getBuild())
+                        .map(Build::getExtensions)
+                        .map(list -> !list.isEmpty())
+                        .orElse(false))
+                .map(node -> Pair.of(node.getModel().getBuild().getExtensions(), getNodeProperties(node)))
+                .flatMap(pair -> pair.getLeft().stream().map(e -> Pair.of(e, pair.getRight())))
+                .map(pair -> ExtensionBuilder.newBuilder()
+                        .withGroupId(PomHelper.evaluate(pair.getLeft().getGroupId(), pair.getRight(), log))
+                        .withArtifactId(PomHelper.evaluate(pair.getLeft().getArtifactId(), pair.getRight(), log))
+                        .withVersion(PomHelper.evaluate(pair.getLeft().getVersion(), pair.getRight(), log))
+                        .build());
+    }
+
+    private static Map<String, String> getNodeProperties(ModelNode node) {
+        Map<String, String> properties = new HashMap<>();
+        for (ModelNode p = node; p != null; p = p.getParent().orElse(null)) {
+            p.getModel()
+                    .getProperties()
+                    .forEach((key, value) -> properties.putIfAbsent(String.valueOf(key), String.valueOf(value)));
+        }
+        return properties;
+    }
+}

versions-common/src/test/java/org/codehaus/mojo/versions/utils/CoreExtensionUtilsTest.java → versions-common/src/test/java/org/codehaus/mojo/versions/utils/ExtensionUtilsTest.java

@@ -35,11 +35,11 @@
 import static org.mockito.Mockito.when;
 
 /**
- * Unit tests for {@link CoreExtensionUtils}
+ * Unit tests for {@link ExtensionUtils}
  *
  * @author Andrzej Jarmoniuk
  */
-class CoreExtensionUtilsTest {
+class ExtensionUtilsTest {
 
     @Test
     void testNoExtensions() throws IOException, XMLStreamException {
@@ -49,7 +49,7 @@ void testNoExtensions() throws IOException, XMLStreamException {
                         new File("src/test/resources/org/codehaus/mojo/versions/utils/core-extensions/no-extensions"));
         MavenSession session = mock(MavenSession.class);
         when(session.getCurrentProject()).thenReturn(project);
-        assertThat(CoreExtensionUtils.getCoreExtensions(project).findAny(), is(Optional.empty()));
+        assertThat(ExtensionUtils.getCoreExtensions(project).findAny(), is(Optional.empty()));
     }
 
     @Test
@@ -59,8 +59,7 @@ void testExtensionsFound() throws IOException, XMLStreamException {
                 .thenReturn(new File("src/test/resources/org/codehaus/mojo/versions/utils/core-extensions"));
         MavenSession session = mock(MavenSession.class);
         when(session.getCurrentProject()).thenReturn(project);
-        Set<Extension> extensions =
-                CoreExtensionUtils.getCoreExtensions(project).collect(Collectors.toSet());
+        Set<Extension> extensions = ExtensionUtils.getCoreExtensions(project).collect(Collectors.toSet());
         assertThat(
                 extensions,
                 hasItems(

versions-maven-plugin/src/it/it-display-plugin-updates-issue-1184-01/invoker.properties

@@ -0,0 +1,2 @@
+invoker.goals = ${project.groupId}:${project.artifactId}:${project.version}:display-plugin-updates
+invoker.mavenOpts = -Dversions.outputFile=./output.txt -DoutputEncoding=UTF-8

versions-maven-plugin/src/it/it-display-plugin-updates-issue-1184-01/pom.xml

@@ -0,0 +1,21 @@
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+          xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+  <modelVersion>4.0.0</modelVersion>
+  <groupId>localhost</groupId>
+  <artifactId>it-display-extension-updates-002</artifactId>
+
+  <version>1.0</version>
+  <packaging>pom</packaging>
+
+  <build>
+    <extensions>
+      <extension>
+        <groupId>localhost</groupId>
+        <artifactId>dummy-api</artifactId>
+        <version>1.0</version>
+      </extension>
+    </extensions>
+  </build>
+
+</project>

versions-maven-plugin/src/it/it-display-plugin-updates-issue-1184-01/verify.groovy

@@ -0,0 +1,3 @@
+def output = new File( basedir, "output.txt").text
+assert !(output =~ /\Qlocalhost:dummy-api\E\s*\.*\s*\Q1.0\E/)
+

versions-maven-plugin/src/it/it-display-plugin-updates-issue-1184/.mvn/extensions.xml

@@ -0,0 +1,10 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<extensions xmlns="http://maven.apache.org/EXTENSIONS/1.1.0"
+            xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+            xsi:schemaLocation="http://maven.apache.org/EXTENSIONS/1.1.0 https://maven.apache.org/xsd/core-extensions-1.1.0.xsd">
+  <extension>
+    <groupId>localhost</groupId>
+    <artifactId>dummy-api</artifactId>
+    <version>1.0</version>
+  </extension>
+</extensions>

versions-maven-plugin/src/it/it-display-plugin-updates-issue-1184/invoker.properties

@@ -0,0 +1,2 @@
+invoker.goals = ${project.groupId}:${project.artifactId}:${project.version}:display-plugin-updates
+invoker.mavenOpts = -Dversions.outputFile=./output.txt -DoutputEncoding=UTF-8

versions-maven-plugin/src/it/it-display-plugin-updates-issue-1184/pom.xml

@@ -0,0 +1,11 @@
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+          xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+  <modelVersion>4.0.0</modelVersion>
+  <groupId>localhost</groupId>
+  <artifactId>it-display-extension-updates-002</artifactId>
+
+  <version>1.0</version>
+  <packaging>pom</packaging>
+
+</project>

versions-maven-plugin/src/it/it-display-plugin-updates-issue-1184/verify.groovy

@@ -0,0 +1,3 @@
+def output = new File( basedir, "output.txt").text
+assert !(output =~ /\Qlocalhost:dummy-api\E\s*\.*\s*\Q1.0\E/)
+

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

@@ -46,6 +46,13 @@ public abstract class AbstractVersionsDisplayMojo extends AbstractVersionsUpdate
 
     private static final int DEFAULT_OUTPUT_LINE_WIDTH = 80;
 
+    /**
+     * The width to pad info messages.
+     *
+     * @since 1.0-alpha-1
+     */
+    static final int INFO_PAD_SIZE = 72;
+
     /**
      * If specified then the display output will be sent to the specified file.
      *