Resolves mojohaus#793: Added includeParent to DisplayPropertyUpdates …

…and PropertyUpdatesReport
jarmoniuk · Oct 25, 2022 · 869bc1d · 869bc1d
1 parent 1826b64
commit 869bc1d
Show file tree

Hide file tree

Showing 16 changed files with 163 additions and 108 deletions.
diff --git a/src/it/it-property-updates-report-issue-684-001/invoker.properties b/src/it/it-property-updates-report-issue-684-001/invoker.properties
diff --git a/src/it/it-property-updates-report-issue-684-001/pom.xml b/src/it/it-property-updates-report-issue-684-001/pom.xml
diff --git a/src/it/it-property-updates-report-issue-684-001/verify.groovy b/src/it/it-property-updates-report-issue-684-001/verify.groovy
diff --git a/src/main/java/org/codehaus/mojo/versions/CompareDependenciesMojo.java b/src/main/java/org/codehaus/mojo/versions/CompareDependenciesMojo.java
@@ -206,7 +206,8 @@ protected void update( ModifiedPomXMLEventReader pom )
         if ( updatePropertyVersions )
         {
             Map<Property, PropertyVersions> versionProperties =
-                this.getHelper().getVersionPropertiesMap( getProject(), null, null, null, true );
+                this.getHelper().getVersionPropertiesMap( getProject(), null, null, null,
+                        true, true );
             List<String> diff = updatePropertyVersions( pom, versionProperties, remoteDepsMap );
             propertyDiffs.addAll( diff );
         }

diff --git a/src/main/java/org/codehaus/mojo/versions/DisplayPropertyUpdatesMojo.java b/src/main/java/org/codehaus/mojo/versions/DisplayPropertyUpdatesMojo.java
@@ -128,6 +128,14 @@ public class DisplayPropertyUpdatesMojo
     @Parameter( property = "allowIncrementalUpdates", defaultValue = "true" )
     private boolean allowIncrementalUpdates;
 
+    /**
+     * <p>Whether to include property updates from parent.</p>
+     *
+     * @since 2.14.0
+     */
+    @Parameter( property = "includeParent", defaultValue = "true" )
+    protected boolean includeParent = true;
+
     // -------------------------- STATIC METHODS --------------------------
 
     // -------------------------- OTHER METHODS --------------------------
@@ -151,7 +159,7 @@ public void execute()
 
         Map<Property, PropertyVersions> propertyVersions =
             this.getHelper().getVersionPropertiesMap( getProject(), properties, includeProperties, excludeProperties,
-                                                      autoLinkItems );
+                                                      includeParent, autoLinkItems );
         for ( Map.Entry<Property, PropertyVersions> entry : propertyVersions.entrySet() )
         {
             Property property = entry.getKey();

diff --git a/src/main/java/org/codehaus/mojo/versions/PropertyUpdatesReportMojo.java b/src/main/java/org/codehaus/mojo/versions/PropertyUpdatesReportMojo.java
@@ -84,6 +84,14 @@ public class PropertyUpdatesReportMojo extends AbstractVersionsReport<PropertyUp
     @Parameter( property = "autoLinkItems", defaultValue = "true" )
     private boolean autoLinkItems;
 
+    /**
+     * <p>Whether to include property updates from parent.</p>
+     *
+     * @since 2.14.0
+     */
+    @Parameter( property = "includeParent", defaultValue = "true" )
+    private boolean includeParent = true;
+
     @Inject
     protected PropertyUpdatesReportMojo( I18N i18n, RepositorySystem repositorySystem,
                                          ArtifactResolver artifactResolver,
@@ -121,7 +129,7 @@ protected void doGenerateReport( Locale locale, Sink sink )
         try
         {
             updateSet.putAll( getHelper().getVersionPropertiesMap( getProject(), properties, includeProperties,
-                                                                   excludeProperties, autoLinkItems ) );
+                                                                   excludeProperties, includeParent, autoLinkItems ) );
         }
         catch ( MojoExecutionException e )
         {

diff --git a/src/main/java/org/codehaus/mojo/versions/ResolveRangesMojo.java b/src/main/java/org/codehaus/mojo/versions/ResolveRangesMojo.java
@@ -304,7 +304,8 @@ private void resolvePropertyRanges( ModifiedPomXMLEventReader pom )
     {
 
         Map<Property, PropertyVersions> propertyVersions =
-            this.getHelper().getVersionPropertiesMap( getProject(), null, includeProperties, excludeProperties, true );
+            this.getHelper().getVersionPropertiesMap( getProject(), null, includeProperties, excludeProperties,
+                    true, true );
         for ( Map.Entry<Property, PropertyVersions> entry : propertyVersions.entrySet() )
         {
             Property property = entry.getKey();

diff --git a/src/main/java/org/codehaus/mojo/versions/SetPropertyMojo.java b/src/main/java/org/codehaus/mojo/versions/SetPropertyMojo.java
@@ -155,7 +155,7 @@ private void update( ModifiedPomXMLEventReader pom, Property[] propertiesConfig,
     {
         Map<Property, PropertyVersions> propertyVersions =
             this.getHelper().getVersionPropertiesMap( getProject(), propertiesConfig, properties, "",
-                                                      autoLinkItems );
+                                                      false, autoLinkItems );
         for ( Map.Entry<Property, PropertyVersions> entry : propertyVersions.entrySet() )
         {
             Property currentProperty = entry.getKey();

diff --git a/src/main/java/org/codehaus/mojo/versions/UpdatePropertiesMojo.java b/src/main/java/org/codehaus/mojo/versions/UpdatePropertiesMojo.java
@@ -160,6 +160,7 @@ protected void update( ModifiedPomXMLEventReader pom )
                                                                                                      properties,
                                                                                                      includeProperties,
                                                                                                      excludeProperties,
+                                                                                                     false,
                                                                                                      autoLinkItems );
         for ( Map.Entry<Property, PropertyVersions> entry : propertyVersions.entrySet() )
         {

diff --git a/src/main/java/org/codehaus/mojo/versions/UpdatePropertyMojo.java b/src/main/java/org/codehaus/mojo/versions/UpdatePropertyMojo.java
@@ -159,7 +159,7 @@ protected void update( ModifiedPomXMLEventReader pom )
         propertyConfig.setVersion( newVersion );
         Map<Property, PropertyVersions> propertyVersions =
             this.getHelper().getVersionPropertiesMap( getProject(), new Property[] {propertyConfig}, property, "",
-                                                      autoLinkItems );
+                                                      false, autoLinkItems );
         for ( Map.Entry<Property, PropertyVersions> entry : propertyVersions.entrySet() )
         {
             Property property = entry.getKey();

diff --git a/src/main/java/org/codehaus/mojo/versions/api/DefaultVersionsHelper.java b/src/main/java/org/codehaus/mojo/versions/api/DefaultVersionsHelper.java
@@ -785,7 +785,9 @@ public ExpressionEvaluator getExpressionEvaluator( MavenProject project )
     @Override
     public Map<Property, PropertyVersions> getVersionPropertiesMap( MavenProject project,
                                                                     Property[] propertyDefinitions,
-                                                                    String includeProperties, String excludeProperties,
+                                                                    String includeProperties,
+                                                                    String excludeProperties,
+                                                                    boolean includeParent,
                                                                     boolean autoLinkItems )
         throws MojoExecutionException
     {
@@ -803,7 +805,7 @@ public Map<Property, PropertyVersions> getVersionPropertiesMap( MavenProject pro
             final PropertyVersionsBuilder[] propertyVersionsBuilders;
             try
             {
-                propertyVersionsBuilders = PomHelper.getPropertyVersionsBuilders( this, project );
+                propertyVersionsBuilders = PomHelper.getPropertyVersionsBuilders( this, project, includeParent );
             }
             catch ( ExpressionEvaluationException | IOException e )
             {

diff --git a/src/main/java/org/codehaus/mojo/versions/api/PomHelper.java b/src/main/java/org/codehaus/mojo/versions/api/PomHelper.java
@@ -72,6 +72,7 @@
 import org.codehaus.plexus.util.StringUtils;
 import org.codehaus.plexus.util.xml.pull.XmlPullParserException;
 
+import static java.util.Collections.singletonMap;
 import static java.util.stream.IntStream.range;
 
 /**
@@ -1018,16 +1019,20 @@ private static Map<MavenProject, Model> getRawModelWithParents( MavenProject pro
      *
      * @param helper  Our versions helper.
      * @param project The project to examine.
+     * @param includeParent whether parent POMs should be included
      * @return An array of properties that are associated within the project.
      * @throws ExpressionEvaluationException if an expression cannot be evaluated.
      * @throws IOException                   if the project's pom file cannot be parsed.
      * @since 1.0-alpha-3
      */
-    public static PropertyVersionsBuilder[] getPropertyVersionsBuilders( VersionsHelper helper, MavenProject project )
+    public static PropertyVersionsBuilder[] getPropertyVersionsBuilders( VersionsHelper helper, MavenProject project,
+                                                                         boolean includeParent )
             throws ExpressionEvaluationException, IOException
     {
         ExpressionEvaluator expressionEvaluator = helper.getExpressionEvaluator( project );
-        Map<MavenProject, Model> reactorModels = getRawModelWithParents( project );
+        Map<MavenProject, Model> reactorModels = includeParent
+                ? getRawModelWithParents( project )
+                : singletonMap( project, getRawModel( project ) );
 
         Map<String, PropertyVersionsBuilder> propertiesMap = new TreeMap<>();
 
@@ -1081,7 +1086,9 @@ public static PropertyVersionsBuilder[] getPropertyVersionsBuilders( VersionsHel
         reactorModels.values().forEach( model -> addProperties( helper, propertiesMap, null, model.getProperties() ) );
 
 
-        for ( MavenProject currentPrj = project; currentPrj != null; currentPrj = currentPrj.getParent() )
+        for ( MavenProject currentPrj = project; currentPrj != null; currentPrj = includeParent
+                        ? currentPrj.getParent()
+                        : null )
         {
             Model model = reactorModels.get( currentPrj );
 

diff --git a/src/main/java/org/codehaus/mojo/versions/api/VersionsHelper.java b/src/main/java/org/codehaus/mojo/versions/api/VersionsHelper.java
@@ -225,14 +225,15 @@ PluginUpdatesDetails lookupPluginUpdates( Plugin plugin, boolean allowSnapshots
      * @param propertyDefinitions Any extra hints about properties.
      * @param includeProperties A comma separated list of properties to include.
      * @param excludeProperties A comma separated list of properties to exclude.
+     * @param includeParent whether to include parent POMs
      * @param autoLinkItems whether to automatically infer associations
      * @return a map of {@link org.codehaus.mojo.versions.api.PropertyVersions} values keyed by
      *         {@link org.codehaus.mojo.versions.Property} instances.
      * @throws MojoExecutionException if something goes wrong.
      */
     Map<Property, PropertyVersions> getVersionPropertiesMap( MavenProject project, Property[] propertyDefinitions,
                                                              String includeProperties, String excludeProperties,
-                                                             boolean autoLinkItems )
+                                                             boolean includeParent, boolean autoLinkItems )
         throws MojoExecutionException;
 
     /**

diff --git a/src/test/java/org/codehaus/mojo/versions/DisplayPropertyUpdatesMojoTest.java b/src/test/java/org/codehaus/mojo/versions/DisplayPropertyUpdatesMojoTest.java
@@ -35,6 +35,7 @@
 import static org.apache.commons.codec.CharEncoding.UTF_8;
 import static org.hamcrest.MatcherAssert.assertThat;
 import static org.hamcrest.Matchers.matchesPattern;
+import static org.hamcrest.Matchers.not;
 
 /**
  * Unit tests for {@link DisplayPropertyUpdatesMojo}
@@ -85,4 +86,25 @@ public void testPropertiesFromParent() throws Exception
         assertThat( String.join( "", Files.readAllLines( tempFile ) ),
                 matchesPattern( ".*\\$\\{ver} \\.* 1\\.0\\.0 -> 2\\.0\\.0.*" ) );
     }
+
+    @Test
+    public void testDisablePropertiesFromParent() throws Exception
+    {
+        Path tempFile = Files.createTempFile( tempDir, "output", "" );
+
+        TestUtils.copyDir( Paths.get( "src/test/resources/org/codehaus/mojo/display-property-updates/issue-367" ),
+                tempDir );
+        DisplayPropertyUpdatesMojo mojo =
+                (DisplayPropertyUpdatesMojo) mojoRule.lookupConfiguredMojo( tempDir.resolve( "child" ).toFile(),
+                        "display-property-updates" );
+        mojo.outputEncoding = UTF_8;
+        mojo.outputFile = tempFile.toFile();
+        mojo.setPluginContext( new HashMap<>() );
+        mojo.artifactMetadataSource = MockUtils.mockArtifactMetadataSource();
+        mojo.includeParent = false;
+        mojo.execute();
+
+        assertThat( String.join( "", Files.readAllLines( tempFile ) ),
+                not( matchesPattern( ".*\\$\\{ver} \\.* 1\\.0\\.0 -> 2\\.0\\.0.*" ) ) );
+    }
 }