Merge pull request #93 from ADI10HERO/version-ambiguity

feat: add version mismatch handler

Author: ADI10HERO

src/main/java/io/jenkins/plugins/conventionalcommits/NextVersionStep.java

@@ -233,7 +233,10 @@ protected String run() throws Exception {
           }
         }
 
-        Version currentVersion = new CurrentVersion().getCurrentVersion(dir, latestTag);
+        Version currentVersion =
+            new CurrentVersion()
+                .getCurrentVersion(
+                    dir, latestTag, getContext().get(TaskListener.class).getLogger());
 
         String commitMessagesString = null;
         if (latestTag.isEmpty()) {

src/main/java/io/jenkins/plugins/conventionalcommits/utils/CurrentVersion.java

@@ -5,6 +5,7 @@
 import io.jenkins.plugins.conventionalcommits.process.ProcessHelper;
 import java.io.File;
 import java.io.IOException;
+import java.io.PrintStream;
 
 /** This class focus on getting the current version (latest release version) of a project. */
 public class CurrentVersion {
@@ -19,6 +20,32 @@ private Version getCurrentVersionTag(String latestTag) {
     return Version.valueOf(latestTag.isEmpty() ? "0.0.0" : latestTag);
   }
 
+  /**
+   * Compares read version with .
+   *
+   * @param currentVersion Project's current version read from the configuration file.
+   * @param latestTag The last tagged version.
+   * @param logger Jenkins logger.
+   * @return The latest version as the new current version (based on Semver).
+   */
+  private Version checkCurrentVersion(
+      Version currentVersion, String latestTag, PrintStream logger) {
+
+    Version tagVersion = Version.valueOf(latestTag);
+
+    if (tagVersion.greaterThan(currentVersion)) {
+      String message =
+          "[WARNING]: Version mismatch found between the configuration file and the latest tag. "
+              + "Using the later version: "
+              + "%1$s as the base version to calculate the next version.%n";
+      logger.format(message, latestTag);
+      logger.flush();
+      currentVersion = tagVersion;
+    }
+
+    return currentVersion;
+  }
+
   /**
    * Return the next version of the version attribute.
    *
@@ -28,7 +55,7 @@ private Version getCurrentVersionTag(String latestTag) {
    * @throws IOException If an error occur reading files.
    * @throws InterruptedException If an error occurs while executing command using processHelper.
    */
-  public Version getCurrentVersion(File directory, String latestTag)
+  public Version getCurrentVersion(File directory, String latestTag, PrintStream logger)
       throws IOException, InterruptedException {
 
     Version currentVersion;
@@ -43,6 +70,10 @@ public Version getCurrentVersion(File directory, String latestTag)
       currentVersion = getCurrentVersionTag(latestTag);
     }
 
+    if (!latestTag.isEmpty()) {
+      currentVersion = checkCurrentVersion(currentVersion, latestTag, logger);
+    }
+
     return currentVersion;
   }
 }

src/test/java/io/jenkins/plugins/conventionalcommits/utils/CurrentVersionTest.java

@@ -9,9 +9,7 @@
 import org.mockito.Mock;
 import org.mockito.junit.MockitoJUnitRunner;
 
-import java.io.File;
-import java.io.FileWriter;
-import java.io.IOException;
+import java.io.*;
 import java.util.Arrays;
 import java.util.List;
 
@@ -27,6 +25,8 @@ public class CurrentVersionTest {
 
   @Mock private ProcessHelper processHelper;
 
+  @Mock private PrintStream mockedLogger;
+
   @Test
   public void testMavenProjectVersion() throws IOException, InterruptedException {
 
@@ -63,7 +63,7 @@ public void testMavenProjectVersion() throws IOException, InterruptedException {
     CurrentVersion currentVersion = new CurrentVersion();
     currentVersion.setProcessHelper(processHelper);
 
-    Version testCurrentVersion = currentVersion.getCurrentVersion(mavenDir, "");
+    Version testCurrentVersion = currentVersion.getCurrentVersion(mavenDir, "", mockedLogger);
 
     assertThat(testCurrentVersion, is(notNullValue()));
     assertThat(actualCurrentVersion, is(testCurrentVersion));
@@ -105,7 +105,7 @@ public void testGradleProjectVersion() throws IOException, InterruptedException
     CurrentVersion currentVersion = new CurrentVersion();
     currentVersion.setProcessHelper(processHelper);
 
-    Version testCurrentVersion = currentVersion.getCurrentVersion(gradleDir, "");
+    Version testCurrentVersion = currentVersion.getCurrentVersion(gradleDir, "", mockedLogger);
 
     assertThat(testCurrentVersion, is(notNullValue()));
     assertThat(actualCurrentVersion, is(testCurrentVersion));
@@ -126,7 +126,7 @@ public void testMakeProjectVersion() throws IOException, InterruptedException {
 
     Version actualCurrentVersion = Version.valueOf("1.10.0");
     CurrentVersion currentVersion = new CurrentVersion();
-    Version testCurrentVersion = currentVersion.getCurrentVersion(makeDir, "");
+    Version testCurrentVersion = currentVersion.getCurrentVersion(makeDir, "", mockedLogger);
 
     assertThat(testCurrentVersion, is(notNullValue()));
     assertThat(actualCurrentVersion, is(testCurrentVersion));
@@ -149,7 +149,7 @@ public void testNpmProjectVersion() throws IOException, InterruptedException {
 
     Version actualCurrentVersion = Version.valueOf("1.0.0");
     CurrentVersion currentVersion = new CurrentVersion();
-    Version testCurrentVersion = currentVersion.getCurrentVersion(npmDir, "");
+    Version testCurrentVersion = currentVersion.getCurrentVersion(npmDir, "", mockedLogger);
 
     assertThat(testCurrentVersion, is(notNullValue()));
     assertThat(actualCurrentVersion, is(testCurrentVersion));
@@ -191,7 +191,7 @@ public void testPythonProjectVersionSetupPyExists() throws IOException, Interrup
     CurrentVersion currentVersion = new CurrentVersion();
     currentVersion.setProcessHelper(processHelper);
 
-    Version testCurrentVersion = currentVersion.getCurrentVersion(pyDir, "");
+    Version testCurrentVersion = currentVersion.getCurrentVersion(pyDir, "", mockedLogger);
 
     assertThat(testCurrentVersion, is(notNullValue()));
     assertThat(actualCurrentVersion, is(testCurrentVersion));
@@ -212,7 +212,7 @@ public void testPythonProjectVersionSetupCfgExists() throws IOException, Interru
 
     Version actualCurrentVersion = Version.valueOf("0.1.0");
     CurrentVersion currentVersion = new CurrentVersion();
-    Version testCurrentVersion = currentVersion.getCurrentVersion(pyDir, "");
+    Version testCurrentVersion = currentVersion.getCurrentVersion(pyDir, "", mockedLogger);
 
     assertThat(testCurrentVersion, is(notNullValue()));
     assertThat(actualCurrentVersion, is(testCurrentVersion));
@@ -241,7 +241,7 @@ public void shouldReadHelmChartCurrentVersion() throws IOException, InterruptedE
 
     Version actualCurrentVersion = Version.valueOf("1.0.0");
     CurrentVersion currentVersion = new CurrentVersion();
-    Version testCurrentVersion = currentVersion.getCurrentVersion(helmDir, "");
+    Version testCurrentVersion = currentVersion.getCurrentVersion(helmDir, "", mockedLogger);
     assertThat(testCurrentVersion, is(notNullValue()));
     assertThat(actualCurrentVersion, is(testCurrentVersion));
   }
@@ -266,7 +266,7 @@ public void testPythonProjectVersionPyProjectTOMLExists()
 
     Version actualCurrentVersion = Version.valueOf("1.0.0");
     CurrentVersion currentVersion = new CurrentVersion();
-    Version testCurrentVersion = currentVersion.getCurrentVersion(pyDir, "");
+    Version testCurrentVersion = currentVersion.getCurrentVersion(pyDir, "", mockedLogger);
 
     assertThat(testCurrentVersion, is(notNullValue()));
     assertThat(actualCurrentVersion, is(testCurrentVersion));
@@ -279,7 +279,7 @@ public void CurrentVersion_NoProjectWithTag() throws IOException, InterruptedExc
     Version actualCurrentVersion = Version.valueOf("0.1.0");
 
     CurrentVersion currentVersion = new CurrentVersion();
-    Version testCurrentVersion = currentVersion.getCurrentVersion(testDir, "0.1.0");
+    Version testCurrentVersion = currentVersion.getCurrentVersion(testDir, "0.1.0", mockedLogger);
 
     assertThat(testCurrentVersion, is(notNullValue()));
     assertThat(actualCurrentVersion, is(testCurrentVersion));
@@ -292,9 +292,43 @@ public void CurrentVersion_NoProjectNoTag() throws IOException, InterruptedExcep
     Version actualCurrentVersion = Version.valueOf("0.0.0");
 
     CurrentVersion currentVersion = new CurrentVersion();
-    Version testCurrentVersion = currentVersion.getCurrentVersion(testDir, "");
+    Version testCurrentVersion = currentVersion.getCurrentVersion(testDir, "", mockedLogger);
 
     assertThat(testCurrentVersion, is(notNullValue()));
     assertThat(actualCurrentVersion, is(testCurrentVersion));
   }
+
+  @Test
+  public void CurrentVersionMismatchWithTag() throws IOException, InterruptedException {
+
+    File testDir = rootFolder.newFolder("SampleProject");
+    Version actualCurrentVersion = Version.valueOf("0.3.0");
+
+    CurrentVersion currentVersion = new CurrentVersion();
+    Version testCurrentVersion = currentVersion.getCurrentVersion(testDir, "0.3.0", mockedLogger);
+
+    assertThat(testCurrentVersion, is(notNullValue()));
+    assertThat(testCurrentVersion, is(actualCurrentVersion));
+  }
+
+  @Test
+  public void testPythonProjectVersionMismatchWithTag() throws IOException, InterruptedException {
+
+    File pyDir = rootFolder.newFolder("SamplePythonProject");
+    File setupCfg = rootFolder.newFile(pyDir.getName() + File.separator + "setup.cfg");
+
+    String setupCfgContent =
+        "[metadata]\n" + "name = sample\n" + "version = 0.1.0\n" + "author = Sample Author";
+
+    FileWriter setupCfgWriter = new FileWriter(setupCfg);
+    setupCfgWriter.write(setupCfgContent);
+    setupCfgWriter.close();
+
+    Version actualCurrentVersion = Version.valueOf("0.4.0");
+    CurrentVersion currentVersion = new CurrentVersion();
+    Version testCurrentVersion = currentVersion.getCurrentVersion(pyDir, "0.4.0", mockedLogger);
+
+    assertThat(testCurrentVersion, is(notNullValue()));
+    assertThat(testCurrentVersion, is(actualCurrentVersion));
+  }
 }