#235 add projectVersionPolicyId parameter to support VersionPolicy implementations

stefanseifert · stefanseifert · commit 637c6df72e51 · 2020-05-25T20:43:20.000+02:00
diff --git a/pom.xml b/pom.xml
@@ -256,6 +256,12 @@
             <version>2.5.3</version>
             <scope>compile</scope>
         </dependency>
+        <dependency>
+            <groupId>org.apache.maven.release</groupId>
+            <artifactId>maven-release-oddeven-policy</artifactId>
+            <version>2.5.3</version>
+            <scope>test</scope>
+        </dependency>
         <dependency>
             <groupId>junit</groupId>
             <artifactId>junit</artifactId>
diff --git a/src/main/java/com/amashchenko/maven/plugin/gitflow/AbstractGitFlowMojo.java b/src/main/java/com/amashchenko/maven/plugin/gitflow/AbstractGitFlowMojo.java
@@ -32,6 +32,7 @@
 import org.apache.maven.project.ProjectBuilder;
 import org.apache.maven.project.ProjectBuildingResult;
 import org.apache.maven.settings.Settings;
+import org.apache.maven.shared.release.policy.version.VersionPolicy;
 import org.codehaus.plexus.components.interactivity.Prompter;
 import org.codehaus.plexus.util.StringUtils;
 import org.codehaus.plexus.util.cli.CommandLineException;
@@ -170,6 +171,17 @@ public abstract class AbstractGitFlowMojo extends AbstractMojo {
     @Parameter(property = "gitExecutable")
     private String gitExecutable;
 
+    /**
+     * The role-hint for the {@link org.apache.maven.shared.release.policy.version.VersionPolicy}
+     * implementation used to calculate the project versions.
+     * If a policy is set other parameters controlling the generation of version are ignored
+     * (digitsOnlyDevVersion, versionDigitToIncrement).
+     *
+     * @since 1.15.0
+     */
+    @Parameter(property="projectVersionPolicyId")
+    private String projectVersionPolicyId;
+
     /** Maven session. */
     @Parameter(defaultValue = "${session}", readonly = true)
     protected MavenSession mavenSession;
@@ -183,6 +195,8 @@ public abstract class AbstractGitFlowMojo extends AbstractMojo {
     /** Maven settings. */
     @Parameter(defaultValue = "${settings}", readonly = true)
     protected Settings settings;
+    @Component
+    protected Map<String,VersionPolicy> versionPolicies;
 
     /**
      * Initializes command line executables.
@@ -1223,4 +1237,16 @@ public String getError() {
     public void setArgLine(String argLine) {
         this.argLine = argLine;
     }
+
+    protected VersionPolicy getVersionPolicy() {
+        if (StringUtils.isNotBlank(projectVersionPolicyId)) {
+            VersionPolicy versionPolicy = versionPolicies.get(projectVersionPolicyId);
+            if (versionPolicy == null) {
+                throw new IllegalArgumentException("No implementation found for projectVersionPolicyId: " + projectVersionPolicyId);
+            }
+            return versionPolicy;
+        }
+        return null;
+    }
+
 }
diff --git a/src/main/java/com/amashchenko/maven/plugin/gitflow/GitFlowFeatureStartMojo.java b/src/main/java/com/amashchenko/maven/plugin/gitflow/GitFlowFeatureStartMojo.java
@@ -130,7 +130,7 @@ public void execute() throws MojoExecutionException, MojoFailureException {
                 // get current project version from pom
                 final String currentVersion = getCurrentProjectVersion();
 
-                final String version = new GitFlowVersionInfo(currentVersion)
+                final String version = new GitFlowVersionInfo(currentVersion, getVersionPolicy())
                         .featureVersion(featureBranchName);
 
                 if (StringUtils.isNotBlank(version)) {
diff --git a/src/main/java/com/amashchenko/maven/plugin/gitflow/GitFlowHotfixFinishMojo.java b/src/main/java/com/amashchenko/maven/plugin/gitflow/GitFlowHotfixFinishMojo.java
@@ -272,12 +272,12 @@ public void execute() throws MojoExecutionException, MojoFailureException {
                     }
                 } else if (!skipMergeDevBranch) {
                     GitFlowVersionInfo developVersionInfo = new GitFlowVersionInfo(
-                            currentVersion);
+                            currentVersion, getVersionPolicy());
                     if (notSameProdDevName()) {
                         // git checkout develop
                         gitCheckout(gitFlowConfig.getDevelopmentBranch());
 
-                        developVersionInfo = new GitFlowVersionInfo(getCurrentProjectVersion());
+                        developVersionInfo = new GitFlowVersionInfo(getCurrentProjectVersion(), getVersionPolicy());
 
                         // set version to avoid merge conflict
                         mvnSetVersions(currentVersion);
@@ -291,7 +291,7 @@ public void execute() throws MojoExecutionException, MojoFailureException {
 
                         // which version to increment
                         GitFlowVersionInfo hotfixVersionInfo = new GitFlowVersionInfo(
-                                currentVersion);
+                                currentVersion, getVersionPolicy());
                         if (developVersionInfo
                                 .compareTo(hotfixVersionInfo) < 0) {
                             developVersionInfo = hotfixVersionInfo;
diff --git a/src/main/java/com/amashchenko/maven/plugin/gitflow/GitFlowHotfixStartMojo.java b/src/main/java/com/amashchenko/maven/plugin/gitflow/GitFlowHotfixStartMojo.java
@@ -154,7 +154,7 @@ public void execute() throws MojoExecutionException, MojoFailureException {
             final String currentVersion = getCurrentProjectVersion();
 
             // get default hotfix version
-            final String defaultVersion = new GitFlowVersionInfo(currentVersion)
+            final String defaultVersion = new GitFlowVersionInfo(currentVersion, getVersionPolicy())
                     .hotfixVersion(tychoBuild);
 
             if (defaultVersion == null) {
diff --git a/src/main/java/com/amashchenko/maven/plugin/gitflow/GitFlowReleaseFinishMojo.java b/src/main/java/com/amashchenko/maven/plugin/gitflow/GitFlowReleaseFinishMojo.java
@@ -321,7 +321,7 @@ public void execute() throws MojoExecutionException, MojoFailureException {
                     nextSnapshotVersion = developmentVersion;
                 } else {
                     GitFlowVersionInfo versionInfo = new GitFlowVersionInfo(
-                            currentVersion);
+                            currentVersion, getVersionPolicy());
                     if (digitsOnlyDevVersion) {
                         versionInfo = versionInfo.digitsVersionInfo();
                     }
diff --git a/src/main/java/com/amashchenko/maven/plugin/gitflow/GitFlowReleaseMojo.java b/src/main/java/com/amashchenko/maven/plugin/gitflow/GitFlowReleaseMojo.java
@@ -208,7 +208,7 @@ public void execute() throws MojoExecutionException, MojoFailureException {
                 defaultVersion = currentVersion;
             } else {
                 // get default release version
-                defaultVersion = new GitFlowVersionInfo(currentVersion)
+                defaultVersion = new GitFlowVersionInfo(currentVersion, getVersionPolicy())
                         .getReleaseVersionString();
             }
 
@@ -296,7 +296,7 @@ public void execute() throws MojoExecutionException, MojoFailureException {
                     && StringUtils.isNotBlank(developmentVersion)) {
                 nextSnapshotVersion = developmentVersion;
             } else {
-                GitFlowVersionInfo versionInfo = new GitFlowVersionInfo(version);
+                GitFlowVersionInfo versionInfo = new GitFlowVersionInfo(version, getVersionPolicy());
                 if (digitsOnlyDevVersion) {
                     versionInfo = versionInfo.digitsVersionInfo();
                 }
diff --git a/src/main/java/com/amashchenko/maven/plugin/gitflow/GitFlowReleaseStartMojo.java b/src/main/java/com/amashchenko/maven/plugin/gitflow/GitFlowReleaseStartMojo.java
@@ -267,7 +267,7 @@ private String getNextSnapshotVersion(String currentVersion) throws MojoFailureE
             nextSnapshotVersion = developmentVersion;
         } else {
             GitFlowVersionInfo versionInfo = new GitFlowVersionInfo(
-                    currentVersion);
+                    currentVersion, getVersionPolicy());
             if (digitsOnlyDevVersion) {
                 versionInfo = versionInfo.digitsVersionInfo();
             }
@@ -292,7 +292,7 @@ private String getReleaseVersion() throws MojoFailureException, VersionParseExce
             defaultVersion = currentVersion;
         } else {
             // get default release version
-            defaultVersion = new GitFlowVersionInfo(currentVersion)
+            defaultVersion = new GitFlowVersionInfo(currentVersion, getVersionPolicy())
                     .getReleaseVersionString();
         }
 
diff --git a/src/main/java/com/amashchenko/maven/plugin/gitflow/GitFlowVersionInfo.java b/src/main/java/com/amashchenko/maven/plugin/gitflow/GitFlowVersionInfo.java
@@ -18,8 +18,10 @@
 import java.util.List;
 
 import org.apache.maven.artifact.Artifact;
+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.versions.DefaultVersionInfo;
-import org.apache.maven.shared.release.versions.VersionInfo;
 import org.apache.maven.shared.release.versions.VersionParseException;
 import org.codehaus.plexus.util.StringUtils;
 
@@ -28,10 +30,13 @@
  * 
  */
 public class GitFlowVersionInfo extends DefaultVersionInfo {
+    
+    private final VersionPolicy versionPolicy;
 
-    public GitFlowVersionInfo(final String version)
+    public GitFlowVersionInfo(final String version, final VersionPolicy versionPolicy)
             throws VersionParseException {
         super(version);
+        this.versionPolicy = versionPolicy;
     }
 
     /**
@@ -41,7 +46,7 @@ public GitFlowVersionInfo(final String version)
      * @throws VersionParseException
      */
     public GitFlowVersionInfo digitsVersionInfo() throws VersionParseException {
-        return new GitFlowVersionInfo(joinDigitString(getDigits()));
+        return new GitFlowVersionInfo(joinDigitString(getDigits()), versionPolicy);
     }
 
     /**
@@ -58,6 +63,21 @@ public static boolean isValidVersion(final String version) {
                         .matcher(version).matches());
     }
 
+    @Override
+    public String getReleaseVersionString() {
+        if (versionPolicy != null) {
+            try {
+                VersionPolicyRequest request = new VersionPolicyRequest().setVersion(this.toString());
+                return versionPolicy.getReleaseVersion(request).getVersion();
+            } catch (PolicyException ex) {
+                throw new RuntimeException("Unable to get release version from policy.", ex);
+            } catch (VersionParseException ex) {
+                throw new RuntimeException("Unable to get release version from policy.", ex);
+            }
+        }
+        return super.getReleaseVersionString();
+    }
+
     /**
      * Gets next SNAPSHOT version.
      * 
@@ -76,6 +96,17 @@ public String nextSnapshotVersion() {
      * @return Next SNAPSHOT version.
      */
     public String nextSnapshotVersion(final Integer index) {
+        if (versionPolicy != null) {
+            try {
+                VersionPolicyRequest request = new VersionPolicyRequest().setVersion(this.toString());
+                return versionPolicy.getDevelopmentVersion(request).getVersion();
+            } catch (PolicyException ex) {
+                throw new RuntimeException("Unable to get development version from policy.", ex);
+            } catch (VersionParseException ex) {
+                throw new RuntimeException("Unable to get development version from policy.", ex);
+            }
+        }
+
         List<String> digits = getDigits();
 
         String nextVersion = null;
diff --git a/src/test/java/com/amashchenko/maven/plugin/gitflow/FeatureVersionTest.java b/src/test/java/com/amashchenko/maven/plugin/gitflow/FeatureVersionTest.java
@@ -51,6 +51,6 @@ public static Collection<Object[]> data() {
     @Test
     public void testFeatureVersion() throws Exception {
         Assert.assertEquals(expectedVersion,
-                new GitFlowVersionInfo(version).featureVersion(featureName));
+                new GitFlowVersionInfo(version, null).featureVersion(featureName));
     }
 }
diff --git a/src/test/java/com/amashchenko/maven/plugin/gitflow/GitFlowVersionInfoTest.java b/src/test/java/com/amashchenko/maven/plugin/gitflow/GitFlowVersionInfoTest.java
@@ -15,6 +15,7 @@
  */
 package com.amashchenko.maven.plugin.gitflow;
 
+import org.apache.maven.shared.release.policy.oddeven.OddEvenVersionPolicy;
 import org.apache.maven.shared.release.versions.VersionParseException;
 import org.junit.Assert;
 import org.junit.Test;
@@ -23,14 +24,14 @@ public class GitFlowVersionInfoTest {
     @Test
     public void testCreating() throws Exception {
         final String version = "0.9";
-        GitFlowVersionInfo info = new GitFlowVersionInfo(version);
+        GitFlowVersionInfo info = new GitFlowVersionInfo(version, null);
         Assert.assertNotNull(info);
         Assert.assertEquals(version, info.toString());
     }
 
     @Test(expected = VersionParseException.class)
     public void testVersionParseException() throws Exception {
-        new GitFlowVersionInfo("");
+        new GitFlowVersionInfo("", null);
     }
 
     @Test
@@ -49,48 +50,72 @@ public void testIsValidVersion() throws Exception {
 
     @Test
     public void testHotfixVersion() throws Exception {
-        GitFlowVersionInfo info = new GitFlowVersionInfo("0.9");
+        GitFlowVersionInfo info = new GitFlowVersionInfo("0.9", null);
         Assert.assertNotNull(info);
         Assert.assertEquals("0.10", info.hotfixVersion(false));
     }
 
     @Test
     public void testHotfixVersion2() throws Exception {
-        GitFlowVersionInfo info = new GitFlowVersionInfo("0.9-SNAPSHOT");
+        GitFlowVersionInfo info = new GitFlowVersionInfo("0.9-SNAPSHOT", null);
         Assert.assertNotNull(info);
         Assert.assertEquals("0.10", info.hotfixVersion(false));
     }
 
     @Test
     public void testHotfixVersion3() throws Exception {
-        GitFlowVersionInfo info = new GitFlowVersionInfo("0.9");
+        GitFlowVersionInfo info = new GitFlowVersionInfo("0.9", null);
         Assert.assertNotNull(info);
         Assert.assertEquals("0.10", info.hotfixVersion(true));
     }
 
     @Test
     public void testHotfixVersion4() throws Exception {
-        GitFlowVersionInfo info = new GitFlowVersionInfo("0.9-SNAPSHOT");
+        GitFlowVersionInfo info = new GitFlowVersionInfo("0.9-SNAPSHOT", null);
         Assert.assertNotNull(info);
         Assert.assertEquals("0.10-SNAPSHOT", info.hotfixVersion(true));
     }
 
     @Test
     public void testDigitsVersionInfo() throws Exception {
-        GitFlowVersionInfo info = new GitFlowVersionInfo("0.9");
+        GitFlowVersionInfo info = new GitFlowVersionInfo("0.9", null);
         Assert.assertNotNull(info);
         info = info.digitsVersionInfo();
         Assert.assertNotNull(info);
-        Assert.assertEquals(new GitFlowVersionInfo("0.9"), info);
+        Assert.assertEquals(new GitFlowVersionInfo("0.9", null), info);
     }
 
     @Test
     public void testDigitsVersionInfo2() throws Exception {
         GitFlowVersionInfo info = new GitFlowVersionInfo(
-                "0.9-RC3-feature-SNAPSHOT");
+                "0.9-RC3-feature-SNAPSHOT", null);
         Assert.assertNotNull(info);
         info = info.digitsVersionInfo();
         Assert.assertNotNull(info);
-        Assert.assertEquals(new GitFlowVersionInfo("0.9"), info);
+        Assert.assertEquals(new GitFlowVersionInfo("0.9", null), info);
     }
+
+    @Test
+    public void testWithoutVersionPolicy() throws Exception {
+        GitFlowVersionInfo info1 = new GitFlowVersionInfo("1.0.0-SNAPSHOT", null);
+        Assert.assertEquals("1.0.0", info1.getReleaseVersionString());
+        Assert.assertEquals("1.0.1-SNAPSHOT", info1.nextSnapshotVersion());
+
+        GitFlowVersionInfo info2 = new GitFlowVersionInfo("1.0.1-SNAPSHOT", null);
+        Assert.assertEquals("1.0.1", info2.getReleaseVersionString());
+        Assert.assertEquals("1.0.2-SNAPSHOT", info2.nextSnapshotVersion());
+    }
+
+    @Test
+    public void testWithVersionPolicy() throws Exception {
+        GitFlowVersionInfo info1 = new GitFlowVersionInfo("1.0.0-SNAPSHOT", new OddEvenVersionPolicy());
+        Assert.assertEquals("1.0.0", info1.getReleaseVersionString());
+        Assert.assertEquals("1.0.1-SNAPSHOT", info1.nextSnapshotVersion());
+
+
+        GitFlowVersionInfo info2 = new GitFlowVersionInfo("1.0.1-SNAPSHOT", new OddEvenVersionPolicy());
+        Assert.assertEquals("1.0.2", info2.getReleaseVersionString());
+        Assert.assertEquals("1.0.3-SNAPSHOT", info2.nextSnapshotVersion());
+    }
+
 }
diff --git a/src/test/java/com/amashchenko/maven/plugin/gitflow/NextSnapshotVersionTest.java b/src/test/java/com/amashchenko/maven/plugin/gitflow/NextSnapshotVersionTest.java
@@ -67,6 +67,6 @@ public static Collection<Object[]> data() {
     @Test
     public void testNextSnapshotVersion() throws Exception {
         Assert.assertEquals(expectedVersion,
-                new GitFlowVersionInfo(version).nextSnapshotVersion(index));
+                new GitFlowVersionInfo(version, null).nextSnapshotVersion(index));
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -321,7 +321,7 @@ public void execute() throws MojoExecutionException, MojoFailureException {`
`321`	`321`	`nextSnapshotVersion = developmentVersion;`
`322`	`322`	`} else {`
`323`	`323`	`GitFlowVersionInfo versionInfo = new GitFlowVersionInfo(`
`324`		`- currentVersion);`
	`324`	`+ currentVersion, getVersionPolicy());`
`325`	`325`	`if (digitsOnlyDevVersion) {`
`326`	`326`	`versionInfo = versionInfo.digitsVersionInfo();`
`327`	`327`	`}`
Original file line number	Diff line number	Diff line change
`@@ -51,6 +51,6 @@ public static Collection<Object[]> data() {`
`51`	`51`	`@Test`
`52`	`52`	`public void testFeatureVersion() throws Exception {`
`53`	`53`	`Assert.assertEquals(expectedVersion,`
`54`		`- new GitFlowVersionInfo(version).featureVersion(featureName));`
	`54`	`+ new GitFlowVersionInfo(version, null).featureVersion(featureName));`
`55`	`55`	`}`
`56`	`56`	`}`