You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by kw...@apache.org on 2025/07/28 12:17:03 UTC

(maven-release) 15/15: MRELEASE-1109 More integration tests, map-version-phase should know about CI Friendly.

This is an automated email from the ASF dual-hosted git repository.

kwin pushed a commit to branch feature/ci-friendly-complex-expressions
in repository https://gitbox.apache.org/repos/asf/maven-release.git

commit 172b90acec68963e79df85ba6d558068b3d5e569
Author: mkolesnikov <mi...@outlook.com>
AuthorDate: Wed Jun 26 15:36:29 2024 +0300

    MRELEASE-1109 More integration tests, map-version-phase should know about CI Friendly.
---
 .gitignore                                         |  4 +-
 .../release/config/ReleaseDescriptorBuilder.java   |  2 +-
 .../release/phase/AbstractMapVersionsPhase.java    | 26 ++++++--
 .../release/phase/AbstractRewritePomsPhase.java    |  7 +-
 .../shared/release/transform/jdom2/JDomModel.java  |  3 +-
 .../shared/release/util/CiFriendlyVersion.java     | 77 +++++++++++-----------
 .../maven/shared/release/util/MavenExpression.java | 19 +++++-
 .../shared/release/phase/MapVersionsPhaseTest.java |  4 +-
 .../ci-friendly-multi-module/invoker.properties    |  4 +-
 .../prepare/ci-friendly-multi-module/pom.xml       |  7 +-
 .../prepare/ci-friendly-multi-module/verify.groovy |  4 +-
 11 files changed, 100 insertions(+), 57 deletions(-)

diff --git a/.gitignore b/.gitignore
index 0e7c2b30..8937ec50 100644
--- a/.gitignore
+++ b/.gitignore
@@ -10,4 +10,6 @@ target
 build
 .checkstyle
 .DS_Store
-.factorypath
\ No newline at end of file
+.factorypath
+.mvn/
+mvnw
diff --git a/maven-release-manager/src/main/java/org/apache/maven/shared/release/config/ReleaseDescriptorBuilder.java b/maven-release-manager/src/main/java/org/apache/maven/shared/release/config/ReleaseDescriptorBuilder.java
index a2afc729..6a04f2b7 100644
--- a/maven-release-manager/src/main/java/org/apache/maven/shared/release/config/ReleaseDescriptorBuilder.java
+++ b/maven-release-manager/src/main/java/org/apache/maven/shared/release/config/ReleaseDescriptorBuilder.java
@@ -34,7 +34,7 @@ import org.slf4j.LoggerFactory;
  * @since 3.0.0-M5
  */
 public class ReleaseDescriptorBuilder {
-    private static final Pattern PROPERTY_PATTERN = Pattern.compile("\\$\\{[^}]+}");
+    private static final Pattern PROPERTY_PATTERN = Pattern.compile("\\$\\{[^}]+?}");
 
     private final Logger logger;
 
diff --git a/maven-release-manager/src/main/java/org/apache/maven/shared/release/phase/AbstractMapVersionsPhase.java b/maven-release-manager/src/main/java/org/apache/maven/shared/release/phase/AbstractMapVersionsPhase.java
index 1615d1bf..55cb9d05 100644
--- a/maven-release-manager/src/main/java/org/apache/maven/shared/release/phase/AbstractMapVersionsPhase.java
+++ b/maven-release-manager/src/main/java/org/apache/maven/shared/release/phase/AbstractMapVersionsPhase.java
@@ -39,6 +39,7 @@ import org.apache.maven.shared.release.policy.PolicyException;
 import org.apache.maven.shared.release.policy.version.VersionPolicy;
 import org.apache.maven.shared.release.policy.version.VersionPolicyRequest;
 import org.apache.maven.shared.release.scm.ScmRepositoryConfigurator;
+import org.apache.maven.shared.release.util.CiFriendlyVersion;
 import org.apache.maven.shared.release.util.ReleaseUtil;
 import org.apache.maven.shared.release.versions.VersionParseException;
 import org.codehaus.plexus.components.interactivity.Prompter;
@@ -259,12 +260,12 @@ public abstract class AbstractMapVersionsPhase extends AbstractReleasePhase {
 
                     try {
                         try {
-                            suggestedVersion =
-                                    resolveSuggestedVersion(baseVersion, releaseDescriptor, releaseEnvironment);
+                            suggestedVersion = resolveSuggestedVersion(
+                                    project, baseVersion, releaseDescriptor, releaseEnvironment);
                         } catch (VersionParseException e) {
                             if (releaseDescriptor.isInteractive()) {
                                 suggestedVersion =
-                                        resolveSuggestedVersion("1.0", releaseDescriptor, releaseEnvironment);
+                                        resolveSuggestedVersion(project, "1.0", releaseDescriptor, releaseEnvironment);
                             } else {
                                 throw new ReleaseExecutionException(
                                         "Error parsing version, cannot determine next " + "version: " + e.getMessage(),
@@ -313,7 +314,10 @@ public abstract class AbstractMapVersionsPhase extends AbstractReleasePhase {
     }
 
     private String resolveSuggestedVersion(
-            String baseVersion, ReleaseDescriptor releaseDescriptor, ReleaseEnvironment releaseEnvironment)
+            MavenProject project,
+            String baseVersion,
+            ReleaseDescriptor releaseDescriptor,
+            ReleaseEnvironment releaseEnvironment)
             throws PolicyException, VersionParseException {
         String policyId = releaseDescriptor.getProjectVersionPolicyId();
         VersionPolicy policy = versionPolicies.get(policyId);
@@ -328,6 +332,11 @@ public abstract class AbstractMapVersionsPhase extends AbstractReleasePhase {
         }
         request.setWorkingDirectory(releaseDescriptor.getWorkingDirectory());
 
+        if (CiFriendlyVersion.isCiFriendlyVersion(getOriginalVersion(project))) {
+            String sha1 = CiFriendlyVersion.resolveSha1Property(project.getProperties(), releaseDescriptor);
+            request.setVersion(baseVersion.replace(sha1, ""));
+        }
+
         if (scmRepositoryConfigurator != null && releaseDescriptor.getScmSourceUrl() != null) {
             try {
                 ScmRepository repository = scmRepositoryConfigurator.getConfiguredRepository(
@@ -353,6 +362,15 @@ public abstract class AbstractMapVersionsPhase extends AbstractReleasePhase {
                 : policy.getReleaseVersion(request).getVersion();
     }
 
+    private static String getOriginalVersion(MavenProject project) {
+        String version = null;
+        while (version == null && project != null) {
+            version = project.getOriginalModel().getVersion();
+            project = project.getParent();
+        }
+        return version;
+    }
+
     private String getDevelopmentVersion(String projectId, ReleaseDescriptor releaseDescriptor) {
         String projectVersion = releaseDescriptor.getProjectDevelopmentVersion(projectId);
 
diff --git a/maven-release-manager/src/main/java/org/apache/maven/shared/release/phase/AbstractRewritePomsPhase.java b/maven-release-manager/src/main/java/org/apache/maven/shared/release/phase/AbstractRewritePomsPhase.java
index 4b9f0c73..85f2b18e 100644
--- a/maven-release-manager/src/main/java/org/apache/maven/shared/release/phase/AbstractRewritePomsPhase.java
+++ b/maven-release-manager/src/main/java/org/apache/maven/shared/release/phase/AbstractRewritePomsPhase.java
@@ -64,6 +64,7 @@ import org.apache.maven.shared.release.transform.ModelETLFactory;
 import org.apache.maven.shared.release.transform.ModelETLRequest;
 import org.apache.maven.shared.release.transform.jdom2.JDomModelETLFactory;
 import org.apache.maven.shared.release.util.CiFriendlyVersion;
+import org.apache.maven.shared.release.util.MavenExpression;
 import org.apache.maven.shared.release.util.ReleaseUtil;
 import org.codehaus.plexus.util.StringUtils;
 
@@ -573,8 +574,12 @@ public abstract class AbstractRewritePomsPhase extends AbstractReleasePhase impl
                     logInfo(result, "  Updating " + artifactId + " to " + mappedVersion);
                     coordinate.setVersion(mappedVersion);
                 } else {
+<<<<<<< Upstream, based on master
                     String property = CiFriendlyVersion.extractPropertyFromExpression(rawVersion);
                     logInfo(result, "CI Friendly property " + property + " and rawVersion is " + rawVersion);
+=======
+                    String property = MavenExpression.extractPropertyFromExpression(rawVersion);
+>>>>>>> 491ee0d MRELEASE-1109 More integration tests, map-version-phase should know about CI Friendly.
                     if (property != null) {
                         if (property.startsWith("project.")
                                 || property.startsWith("pom.")
@@ -619,7 +624,7 @@ public abstract class AbstractRewritePomsPhase extends AbstractReleasePhase impl
                                     }
                                 }
                             } else {
-                                if (CiFriendlyVersion.containsCiFriendlyProperties(property)) {
+                                if (CiFriendlyVersion.isCiFriendlyProperty(property)) {
                                     // the parent's pom revision is set inside
                                     // org.apache.maven.shared.release.transform.jdom2.JDomModel.setVersion
                                     logInfo(
diff --git a/maven-release-manager/src/main/java/org/apache/maven/shared/release/transform/jdom2/JDomModel.java b/maven-release-manager/src/main/java/org/apache/maven/shared/release/transform/jdom2/JDomModel.java
index 20ee8433..4b14e82d 100644
--- a/maven-release-manager/src/main/java/org/apache/maven/shared/release/transform/jdom2/JDomModel.java
+++ b/maven-release-manager/src/main/java/org/apache/maven/shared/release/transform/jdom2/JDomModel.java
@@ -202,8 +202,7 @@ public class JDomModel extends Model {
         } else {
             if (CiFriendlyVersion.isCiFriendlyVersion(versionElement.getTextNormalize())) {
                 // try to rewrite property if CI friendly expression is used
-                CiFriendlyVersion.rewriteVersionAndProperties(
-                        version, versionElement.getTextNormalize(), getProperties(), releaseDescriptor);
+                CiFriendlyVersion.rewriteVersionAndProperties(version, getProperties(), releaseDescriptor);
             } else {
                 JDomUtils.rewriteValue(versionElement, version);
             }
diff --git a/maven-release-manager/src/main/java/org/apache/maven/shared/release/util/CiFriendlyVersion.java b/maven-release-manager/src/main/java/org/apache/maven/shared/release/util/CiFriendlyVersion.java
index 6b812a40..d5cc3662 100644
--- a/maven-release-manager/src/main/java/org/apache/maven/shared/release/util/CiFriendlyVersion.java
+++ b/maven-release-manager/src/main/java/org/apache/maven/shared/release/util/CiFriendlyVersion.java
@@ -22,94 +22,91 @@ import java.util.Arrays;
 import java.util.HashSet;
 import java.util.Properties;
 import java.util.Set;
-import java.util.regex.Matcher;
-import java.util.regex.Pattern;
 
+import org.apache.commons.lang3.StringUtils;
 import org.apache.maven.artifact.ArtifactUtils;
 import org.apache.maven.shared.release.config.ReleaseDescriptor;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 
 public class CiFriendlyVersion {
-
-    /**
-     * Regular expression pattern matching Maven expressions (i.e. references to Maven properties).
-     * The first group selects the property name the expression refers to.
-     */
-    private static final Pattern EXPRESSION_PATTERN = Pattern.compile("\\$\\{(.+?)\\}");
+    private static final Logger LOGGER = LoggerFactory.getLogger(CiFriendlyVersion.class);
 
     /**
      * All Maven properties allowed to be referenced in parent versions via expressions
      * @see <a href="https://maven.apache.org/maven-ci-friendly.html">CI-Friendly Versions</a>
      */
-    private static final String REVISION = "revision";
+    public static final String REVISION = "revision";
+
+    public static final String SHA1 = "sha1";
+    public static final String CHANGELIST = "changelist";
 
-    private static final String SHA1 = "sha1";
-    private static final String CHANGELIST = "changelist";
     private static final Set<String> CI_FRIENDLY_PROPERTIES = new HashSet<>(Arrays.asList(REVISION, SHA1, CHANGELIST));
 
     private static final String SNAPSHOT = "-SNAPSHOT";
 
     private CiFriendlyVersion() {}
 
-    /**
-     * Extracts the Maven property name from a given expression.
-     * @param expression the expression
-     * @return either {@code null} if value is no expression otherwise the property referenced in the expression
-     */
-    public static String extractPropertyFromExpression(String expression) {
-        Matcher matcher = EXPRESSION_PATTERN.matcher(expression);
-        if (!matcher.find()) {
-            return null;
-        }
-        return matcher.group(1);
-    }
-
     public static boolean isCiFriendlyVersion(String version) {
-        return containsCiFriendlyProperties(extractPropertyFromExpression(version));
+        if (StringUtils.isEmpty(version)) {
+            return false;
+        }
+        return isCiFriendlyProperty(MavenExpression.extractPropertyFromExpression(version));
     }
 
-    public static boolean containsCiFriendlyProperties(String property) {
+    public static boolean isCiFriendlyProperty(String property) {
         return CI_FRIENDLY_PROPERTIES.contains(property);
     }
 
     public static void rewriteVersionAndProperties(
-            String version, String versionElement, Properties properties, ReleaseDescriptor releaseDescriptor) {
+            String version, Properties properties, ReleaseDescriptor releaseDescriptor) {
         // try to rewrite property if CI friendly expression is used
-        String ciFriendlyPropertyName = extractPropertyFromExpression(versionElement);
         if (properties != null) {
-            String sha1 = resolveSha1Property(releaseDescriptor);
+            String sha1 = resolveSha1Property(properties, releaseDescriptor);
             // assume that everybody follows the example and properties are simply chained
             //  and the changelist can only be '-SNAPSHOT'
             if (ArtifactUtils.isSnapshot(version)) {
                 if (properties.containsKey(CHANGELIST)) {
-                    properties.setProperty(
-                            ciFriendlyPropertyName, version.replace(sha1, "").replace(SNAPSHOT, ""));
-                    properties.setProperty(CHANGELIST, SNAPSHOT);
+                    String revision = version.replace(sha1, "").replace(SNAPSHOT, "");
+                    setAndLogPropertyChange(properties, REVISION, revision);
+                    setAndLogPropertyChange(properties, CHANGELIST, SNAPSHOT);
                 } else {
-                    properties.setProperty(ciFriendlyPropertyName, version.replace(sha1, ""));
+                    String revision = version.replace(sha1, "");
+                    setAndLogPropertyChange(properties, REVISION, revision);
                 }
                 if (properties.containsKey(SHA1)) {
                     // drop the value for the next version
-                    properties.setProperty(SHA1, "");
+                    setAndLogPropertyChange(properties, SHA1, "");
                 }
             } else {
-                properties.setProperty(
-                        ciFriendlyPropertyName, version.replace(sha1, "").replace(SNAPSHOT, ""));
+                properties.setProperty(REVISION, version.replace(sha1, ""));
                 if (properties.containsKey(CHANGELIST)) {
-                    properties.setProperty(CHANGELIST, "");
+                    setAndLogPropertyChange(properties, CHANGELIST, "");
                 }
                 if (properties.containsKey(SHA1) && !sha1.isEmpty()) {
                     // we need this to restore the revision for the next development
                     // or release:prepare should provide sha1 after a commit
                     // or a user should provide it as an additional `arguments` in plugin configuration
                     // see maven-release-plugin/src/it/projects/prepare/ci-friendly-multi-module
-                    properties.setProperty(SHA1, sha1);
+                    setAndLogPropertyChange(properties, SHA1, sha1);
                 }
             }
         }
     }
 
-    private static String resolveSha1Property(ReleaseDescriptor releaseDescriptor) {
+    private static void setAndLogPropertyChange(Properties properties, String key, String value) {
+        LOGGER.info("Updating {} property to {}", key, value);
+        properties.setProperty(key, value);
+    }
+
+    public static String resolveSha1Property(Properties properties, ReleaseDescriptor releaseDescriptor) {
+        String sha1 = properties.getProperty(SHA1);
         String scmVersion = releaseDescriptor.getScmReleasedPomRevision();
-        return System.getProperty(SHA1, scmVersion == null ? "" : scmVersion);
+        String systemSha1 = System.getProperty(SHA1);
+        String result = StringUtils.isNotEmpty(systemSha1)
+                ? systemSha1
+                : StringUtils.isNotEmpty(sha1) ? sha1 : scmVersion != null ? scmVersion : "";
+        LOGGER.info("Resolved SHA1 property value {}", result);
+        return result;
     }
 }
diff --git a/maven-release-manager/src/main/java/org/apache/maven/shared/release/util/MavenExpression.java b/maven-release-manager/src/main/java/org/apache/maven/shared/release/util/MavenExpression.java
index 4976efb1..f832c092 100644
--- a/maven-release-manager/src/main/java/org/apache/maven/shared/release/util/MavenExpression.java
+++ b/maven-release-manager/src/main/java/org/apache/maven/shared/release/util/MavenExpression.java
@@ -26,7 +26,11 @@ import java.util.regex.Pattern;
  * @author <a href="mailto:mikhail_kolesnikov@outlook.com">Mikhail Kolesnikov</a>
  */
 public class MavenExpression {
-    public static final Pattern EXPRESSION_PATTERN = Pattern.compile("\\$\\{(.+?)\\}");
+    /**
+     * Regular expression pattern matching Maven expressions (i.e. references to Maven properties).
+     * The first group selects the property name the expression refers to.
+     */
+    private static final Pattern EXPRESSION_PATTERN = Pattern.compile("\\$\\{(.+?)}");
 
     private MavenExpression() {}
 
@@ -41,4 +45,17 @@ public class MavenExpression {
         }
         return result.toString();
     }
+
+    /**
+     * Extracts the Maven property name from a given expression.
+     * @param expression the expression
+     * @return either {@code null} if value is no expression otherwise the property referenced in the expression
+     */
+    public static String extractPropertyFromExpression(String expression) {
+        Matcher matcher = EXPRESSION_PATTERN.matcher(expression);
+        if (!matcher.find()) {
+            return null;
+        }
+        return matcher.group(1);
+    }
 }
diff --git a/maven-release-manager/src/test/java/org/apache/maven/shared/release/phase/MapVersionsPhaseTest.java b/maven-release-manager/src/test/java/org/apache/maven/shared/release/phase/MapVersionsPhaseTest.java
index 75f41215..4fb8b527 100644
--- a/maven-release-manager/src/test/java/org/apache/maven/shared/release/phase/MapVersionsPhaseTest.java
+++ b/maven-release-manager/src/test/java/org/apache/maven/shared/release/phase/MapVersionsPhaseTest.java
@@ -2502,7 +2502,9 @@ public class MapVersionsPhaseTest extends PlexusJUnit4TestCase {
         model.setGroupId("groupId");
         model.setArtifactId(artifactId);
         model.setVersion(version);
-        return new MavenProject(model);
+        MavenProject mavenProject = new MavenProject(model);
+        mavenProject.setOriginalModel(model);
+        return mavenProject;
     }
 
     private static MavenProject createProjectWithPomFile(String artifactId, String version, String pathName) {
diff --git a/maven-release-plugin/src/it/projects/prepare/ci-friendly-multi-module/invoker.properties b/maven-release-plugin/src/it/projects/prepare/ci-friendly-multi-module/invoker.properties
index c8e7f246..50eda560 100644
--- a/maven-release-plugin/src/it/projects/prepare/ci-friendly-multi-module/invoker.properties
+++ b/maven-release-plugin/src/it/projects/prepare/ci-friendly-multi-module/invoker.properties
@@ -15,5 +15,5 @@
 # specific language governing permissions and limitations
 # under the License.
 
-invoker.goals=release:clean release:prepare
-invoker.mavenOpts=-Dsha1=-abcdef12
\ No newline at end of file
+invoker.goals=release:clean release:prepare -Dsha1=-abcdef12
+#invoker.mavenOpts=-agentlib:jdwp=transport=dt_socket,server=y,suspend=y,address=*:5005
\ No newline at end of file
diff --git a/maven-release-plugin/src/it/projects/prepare/ci-friendly-multi-module/pom.xml b/maven-release-plugin/src/it/projects/prepare/ci-friendly-multi-module/pom.xml
index 8d140e27..e6c05b91 100644
--- a/maven-release-plugin/src/it/projects/prepare/ci-friendly-multi-module/pom.xml
+++ b/maven-release-plugin/src/it/projects/prepare/ci-friendly-multi-module/pom.xml
@@ -32,8 +32,8 @@
   </scm>
   
   <properties>
-    <revision>1.0</revision>
-    <sha1/>
+    <revision>1.0.0</revision>
+    <sha1></sha1>
     <changelist>-SNAPSHOT</changelist>
     <maven.compiler.source>@maven.compiler.source@</maven.compiler.source>
     <maven.compiler.target>@maven.compiler.target@</maven.compiler.target>
@@ -46,6 +46,9 @@
           <groupId>org.apache.maven.plugins</groupId>
           <artifactId>maven-release-plugin</artifactId>
           <version>@project.version@</version>
+          <configuration>
+            <arguments>-Dsha1=${sha1}</arguments>
+          </configuration>
           <dependencies>
             <dependency>
               <groupId>org.apache.maven.its.release</groupId>
diff --git a/maven-release-plugin/src/it/projects/prepare/ci-friendly-multi-module/verify.groovy b/maven-release-plugin/src/it/projects/prepare/ci-friendly-multi-module/verify.groovy
index febfa0ce..2b83f5f9 100644
--- a/maven-release-plugin/src/it/projects/prepare/ci-friendly-multi-module/verify.groovy
+++ b/maven-release-plugin/src/it/projects/prepare/ci-friendly-multi-module/verify.groovy
@@ -25,7 +25,7 @@ assert buildLog.exists()
 // tag versions
 def projectRootTag = new XmlSlurper().parse( new File( basedir, 'pom.xml.tag' ) )
 assert projectRootTag.version.text() == '${revision}${sha1}${changelist}'
-assert projectRootTag.properties.revision.text() == "1.0"
+assert projectRootTag.properties.revision.text() == "1.0.0"
 assert projectRootTag.properties.sha1.text() == "-abcdef12"
 assert projectRootTag.properties.changelist.text() == ""
 
@@ -39,7 +39,7 @@ assert projectBTag.parent.version.text() == '${revision}${sha1}${changelist}'
 // next development versions
 def projectRoot = new XmlSlurper().parse( new File( basedir, 'pom.xml.next' ) )
 assert projectRoot.version.text() == '${revision}${sha1}${changelist}'
-assert projectRoot.properties.revision.text() == "1.1"
+assert projectRoot.properties.revision.text() == "1.0.1"
 assert projectRoot.properties.sha1.text() == ""
 assert projectRoot.properties.changelist.text() == "-SNAPSHOT"