Resolves mojohaus#837: Add includeParent (default true) to UpdateProp…

…ertiesMojo

versions-maven-plugin/src/it/it-update-properties-issue-837/invoker.properties

@@ -0,0 +1,2 @@
+invoker.goals = ${project.groupId}:${project.artifactId}:${project.version}:update-properties
+invoker.mavenOpts = -DincludeParent=false

versions-maven-plugin/src/it/it-update-properties-issue-837/parent-pom.xml

@@ -0,0 +1,14 @@
+<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>default-group</groupId>
+    <artifactId>parent-artifact</artifactId>
+    <version>1.0.0</version>
+    <packaging>pom</packaging>
+
+    <properties>
+        <artifact-version>1.0</artifact-version>
+    </properties>
+
+</project>

versions-maven-plugin/src/it/it-update-properties-issue-837/pom.xml

@@ -0,0 +1,23 @@
+<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>
+
+    <parent>
+        <groupId>default-group</groupId>
+        <artifactId>parent-artifact</artifactId>
+        <version>1.0.0</version>
+        <relativePath>parent-pom.xml</relativePath>
+    </parent>
+
+    <artifactId>child-artifact</artifactId>
+    <version>1.0.0</version>
+
+    <dependencies>
+        <dependency>
+            <groupId>localhost</groupId>
+            <artifactId>dummy-api</artifactId>
+            <version>${artifact-version}</version>
+        </dependency>
+    </dependencies>
+
+</project>

versions-maven-plugin/src/it/it-update-properties-issue-837/verify.groovy

@@ -0,0 +1 @@
+assert ! ( new File( basedir, "build.log" ).text.contains( 'Property ${artifact-version}' ) )

versions-maven-plugin/src/it/it-update-property-issue-837/invoker.properties

@@ -0,0 +1,2 @@
+invoker.goals = ${project.groupId}:${project.artifactId}:${project.version}:update-property
+invoker.mavenOpts = -DincludeParent=false -Dproperty=artifact-version

versions-maven-plugin/src/it/it-update-property-issue-837/parent-pom.xml

@@ -0,0 +1,14 @@
+<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>default-group</groupId>
+    <artifactId>parent-artifact</artifactId>
+    <version>1.0.0</version>
+    <packaging>pom</packaging>
+
+    <properties>
+        <artifact-version>1.0</artifact-version>
+    </properties>
+
+</project>

versions-maven-plugin/src/it/it-update-property-issue-837/pom.xml

@@ -0,0 +1,23 @@
+<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>
+
+    <parent>
+        <groupId>default-group</groupId>
+        <artifactId>parent-artifact</artifactId>
+        <version>1.0.0</version>
+        <relativePath>parent-pom.xml</relativePath>
+    </parent>
+
+    <artifactId>child-artifact</artifactId>
+    <version>1.0.0</version>
+
+    <dependencies>
+        <dependency>
+            <groupId>localhost</groupId>
+            <artifactId>dummy-api</artifactId>
+            <version>${artifact-version}</version>
+        </dependency>
+    </dependencies>
+
+</project>

versions-maven-plugin/src/it/it-update-property-issue-837/verify.groovy

@@ -0,0 +1,2 @@
+assert ! ( new File( basedir, "build.log" ).text
+        .contains( 'Property ${artifact-version}: Set of valid available versions is [1.0, 1.0.1,' ) )

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

@@ -493,6 +493,20 @@ protected boolean shouldApplyUpdate( Artifact artifact, String currentVersion, A
         return true;
     }
 
+    /**
+     * Attempts to update the property to a newer version, if that exists
+     * @param pom               pom to update
+     * @param property          property to update
+     * @param version           {@link PropertyVersions} object
+     * @param currentVersion    current version
+     * @param allowDowngrade    if downgrades should be allowed if snapshots are not allowed
+     * @param unchangedSegment  most major segment not to be changed
+     * @return new version of the artifact, if the property was updated; {@code null} if there was no update
+     * @throws XMLStreamException thrown from {@link ModifiedPomXMLEventReader} if the update doesn't succeed
+     * @throws InvalidVersionSpecificationException thrown if {@code unchangedSegment} doesn't match the version
+     * @throws InvalidSegmentException thrown if {@code unchangedSegment} is invalid
+     * @throws MojoExecutionException thrown if any other error occurs
+     */
     protected ArtifactVersion updatePropertyToNewestVersion( ModifiedPomXMLEventReader pom, Property property,
                                                              PropertyVersions version, String currentVersion,
                                                              boolean allowDowngrade,
@@ -511,9 +525,10 @@ protected ArtifactVersion updatePropertyToNewestVersion( ModifiedPomXMLEventRead
         else if ( PomHelper.setPropertyVersion( pom, version.getProfileId(), property.getName(), winner.toString() ) )
         {
             getLog().info( "Updated ${" + property.getName() + "} from " + currentVersion + " to " + winner );
+            return winner;
         }
 
-        return winner;
+        return null;
     }
 
     /**

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

@@ -23,41 +23,27 @@
 import javax.xml.stream.XMLStreamException;
 
 import java.util.Map;
-import java.util.Optional;
 
 import org.apache.maven.artifact.manager.WagonManager;
-import org.apache.maven.artifact.versioning.ArtifactVersion;
-import org.apache.maven.artifact.versioning.InvalidVersionSpecificationException;
 import org.apache.maven.plugin.MojoExecutionException;
 import org.apache.maven.plugin.MojoFailureException;
 import org.apache.maven.plugins.annotations.Mojo;
 import org.apache.maven.plugins.annotations.Parameter;
 import org.apache.maven.repository.RepositorySystem;
-import org.codehaus.mojo.versions.api.ArtifactAssociation;
 import org.codehaus.mojo.versions.api.Property;
-import org.codehaus.mojo.versions.api.PropertyVersions;
-import org.codehaus.mojo.versions.api.Segment;
 import org.codehaus.mojo.versions.api.VersionsHelper;
-import org.codehaus.mojo.versions.api.recording.ChangeRecord;
 import org.codehaus.mojo.versions.api.recording.ChangeRecorder;
-import org.codehaus.mojo.versions.ordering.InvalidSegmentException;
-import org.codehaus.mojo.versions.recording.DefaultChangeRecord;
 import org.codehaus.mojo.versions.rewriting.ModifiedPomXMLEventReader;
 
-import static org.codehaus.mojo.versions.utils.SegmentUtils.determineUnchangedSegment;
-
 /**
  * Sets properties to the latest versions of specific artifacts.
  *
  * @author Stephen Connolly
  * @since 1.0-alpha-1
  */
 @Mojo( name = "update-properties", threadSafe = true )
-public class UpdatePropertiesMojo extends AbstractVersionsDependencyUpdaterMojo
+public class UpdatePropertiesMojo extends UpdatePropertiesMojoBase
 {
-
-    // ------------------------------ FIELDS ------------------------------
-
     /**
      * Any restrictions that apply to specific properties.
      *
@@ -82,61 +68,6 @@ public class UpdatePropertiesMojo extends AbstractVersionsDependencyUpdaterMojo
     @Parameter( property = "excludeProperties" )
     private String excludeProperties = null;
 
-    /**
-     * Whether properties linking versions should be auto-detected or not.
-     *
-     * @since 1.0-alpha-2
-     */
-    @Parameter( property = "autoLinkItems",
-                defaultValue = "true" )
-    private boolean autoLinkItems;
-
-    /**
-     * If a property points to a version like <code>1.2.3-SNAPSHOT</code> and your repo contains a version like
-     * <code>1.1.0</code> without settings this to <code>true</code> the property will not being changed.
-     *
-     * @since 2.4
-     */
-    @Parameter( property = "allowDowngrade",
-                defaultValue = "false" )
-    private boolean allowDowngrade;
-
-    /**
-     * Whether to allow the major version number to be changed.
-     *
-     * @since 2.4
-     */
-    @Parameter( property = "allowMajorUpdates",
-                defaultValue = "true" )
-    protected boolean allowMajorUpdates = true;
-
-    /**
-     * <p>Whether to allow the minor version number to be changed.</p>
-     *
-     * <p><b>Note: {@code false} also implies {@linkplain #allowMajorUpdates} {@code false}</b></p>
-     *
-     * @since 2.4
-     */
-    @Parameter( property = "allowMinorUpdates",
-                defaultValue = "true" )
-    protected boolean allowMinorUpdates = true;
-
-    /**
-     * <p>Whether to allow the incremental version number to be changed.</p>
-     *
-     * <p><b>Note: {@code false} also implies {@linkplain #allowMajorUpdates}
-     * and {@linkplain #allowMinorUpdates} {@code false}</b></p>
-     *
-     * @since 2.4
-     */
-    @Parameter( property = "allowIncrementalUpdates",
-                defaultValue = "true" )
-    protected boolean allowIncrementalUpdates = true;
-
-    // -------------------------- STATIC METHODS --------------------------
-
-    // -------------------------- OTHER METHODS --------------------------
-
     @Inject
     public UpdatePropertiesMojo( RepositorySystem repositorySystem,
                                  org.eclipse.aether.RepositorySystem aetherRepositorySystem,
@@ -157,74 +88,15 @@ public UpdatePropertiesMojo( RepositorySystem repositorySystem,
     protected void update( ModifiedPomXMLEventReader pom )
             throws MojoExecutionException, MojoFailureException, XMLStreamException
     {
-        Map<Property, PropertyVersions> propertyVersions = getHelper().getVersionPropertiesMap(
+        update( pom, getHelper().getVersionPropertiesMap(
                 VersionsHelper.VersionPropertiesMapRequest.builder()
                         .withMavenProject( getProject() )
                         .withPropertyDefinitions( properties )
                         .withIncludeProperties( includeProperties )
                         .withExcludeProperties( excludeProperties )
                         .withAutoLinkItems( autoLinkItems )
-                        .build() );
-        for ( Map.Entry<Property, PropertyVersions> entry : propertyVersions.entrySet() )
-        {
-            Property property = entry.getKey();
-            PropertyVersions version = entry.getValue();
-
-            final String currentVersion = getProject().getProperties().getProperty( property.getName() );
-            if ( currentVersion == null )
-            {
-                continue;
-            }
-            boolean canUpdateProperty = true;
-            for ( ArtifactAssociation association : version.getAssociations() )
-            {
-                if ( !( isIncluded( association.getArtifact() ) ) )
-                {
-                    getLog().info(
-                        "Not updating the property ${" + property.getName() + "} because it is used by artifact "
-                            + association.getArtifact().toString()
-                            + " and that artifact is not included in the list of "
-                            + " allowed artifacts to be updated." );
-                    canUpdateProperty = false;
-                    break;
-                }
-            }
-
-            if ( canUpdateProperty )
-            {
-                Optional<Segment> unchangedSegment = determineUnchangedSegment( allowMajorUpdates, allowMinorUpdates,
-                                                         allowIncrementalUpdates, getLog() );
-                try
-                {
-                    ArtifactVersion targetVersion =
-                            updatePropertyToNewestVersion( pom, property, version, currentVersion,
-                                    allowDowngrade, unchangedSegment );
-
-                    if ( targetVersion != null )
-                    {
-                        for ( final ArtifactAssociation association : version.getAssociations() )
-                        {
-                            if ( ( isIncluded( association.getArtifact() ) ) )
-                            {
-                                getChangeRecorder().recordChange( DefaultChangeRecord.builder()
-                                                                      .withKind(
-                                                                          ChangeRecord.ChangeKind.PROPERTY )
-                                                                      .withArtifact( association.getArtifact() )
-                                                                      .withOldVersion( currentVersion )
-                                                                      .withNewVersion( targetVersion.toString() )
-                                                                      .build() );
-                            }
-                        }
-                    }
-                }
-                catch ( InvalidSegmentException | InvalidVersionSpecificationException e )
-                {
-                    getLog().warn( String.format( "Skipping the processing of %s:%s due to: %s", property.getName(),
-                            property.getVersion(), e.getMessage() ) );
-                }
-            }
-
-        }
+                        .withIncludeParent( includeParent )
+                        .build() ) );
     }
 
 }