#211 : add a switch to generate the git.commit.id the "old" way

Author: S L

src/main/java/pl/project13/maven/git/GitCommitIdMojo.java

@@ -66,7 +66,11 @@ public class GitCommitIdMojo extends AbstractMojo {
   // these properties will be exposed to maven
   public static final String BRANCH = "branch";
   public static final String DIRTY = "dirty";
-  public static final String COMMIT_ID = "commit.id.full";
+  @Deprecated
+  public static final String COMMIT_ID_OLD = "commit.id";
+  public static final String COMMIT_ID_NEW = "commit.id.full";
+  public static String COMMIT_ID = COMMIT_ID_NEW;
+
   public static final String COMMIT_ID_ABBREV = "commit.id.abbrev";
   public static final String COMMIT_DESCRIBE = "commit.id.describe";
   public static final String COMMIT_SHORT_DESCRIBE = "commit.id.describe-short";
@@ -327,6 +331,21 @@ public class GitCommitIdMojo extends AbstractMojo {
   @SuppressWarnings("UnusedDeclaration")
   private List<String> includeOnlyProperties = Collections.emptyList();
 
+  /**
+   * The option can be used to tell the plugin how it should generate the formerly known property 'git.commit.id'. Due to some naming issues when exporting the properties as an json-object (https://github.com/ktoso/maven-git-commit-id-plugin/issues/122) we needed to change the export of the property from 'git.commit.id' to 'git.commit.id.full'.
+   * However, due to the fact that this is one of the major properties the plugin is exporting we just don't want to change the exporting mechanism and somehow throw the backwards compatibility away.
+   * That's the point where this switch comes into place!
+   * By default it is set to 'true' and will generate the formerly known property 'git.commit.id' as it was in the previous versions of the plugin. With keeping the switch set to 'true' the plugin will print a warning that using this switch set to 'true' is deprecated and may be removed in a future release. However keeping it to 'true' by default preserve backwards compatibility and allows to migrate to the new properties when it's convenient.
+   * If you set this switch to 'false' the plugin will export the formerly known property 'git.commit.id' to 'git.commit.id.full'.
+   *
+   * Note: Depending on your plugin configuration you obviously can choose the 'prefix' of your properties by setting the accordingly in the plugin's configuration. As a result this is therefore only an illustration what the switch means when 'prefix' is set to it's default value.
+   *
+   * @parameter default-value="true"
+   * @since 2.2.0
+   */
+  @Deprecated
+  private boolean generateCommitIdOldFashioned;
+
   /**
    * The Maven Session Object
    *
@@ -383,6 +402,15 @@ public void execute() throws MojoExecutionException {
     }
 
     try {
+      if(generateCommitIdOldFashioned){
+        loggerBridge.warn("Using the property 'generateCommitIdOldFashioned' set to 'true' is deprecated and may be removed in a future release! Please refer to the readme on this issue.");
+        COMMIT_ID = COMMIT_ID_OLD;
+      }else{
+        // need to have this for the tests due the fact that they are switching back and forth
+        // for the end-user setting this shouldn't perform any changes (it's set to COMMIT_ID_NEW by default)
+        COMMIT_ID = COMMIT_ID_NEW;
+      }
+
       properties = initProperties();
 
       String trimmedPrefix = prefix.trim();

src/main/java/pl/project13/maven/git/log/LoggerBridge.java

@@ -20,6 +20,7 @@
 public interface LoggerBridge {
   void log(Object... parts);
   void error(Object... parts);
+  void warn(Object... parts);
   void debug(Object... parts);
   void setVerbose(boolean verbose);
 }

src/main/java/pl/project13/maven/git/log/MavenLoggerBridge.java

@@ -61,6 +61,13 @@ public void error(Object... parts) {
     }
   }
 
+  @Override
+  public void warn(Object... parts) {
+    if (verbose) {
+      logger.warn(Joiner.on(" ").useForNull("null").join(parts));
+    }
+  }
+
   @Override
   public void debug(Object... parts) {
     if (verbose) {

src/main/java/pl/project13/maven/git/log/StdOutLoggerBridge.java

@@ -40,6 +40,13 @@ public void error(Object... parts) {
       System.out.println("ERR: " + Joiner.on(" ").join(parts));
     }
   }
+
+  @Override
+  public void warn(Object... parts) {
+    if(verbose) {
+      System.out.println("WRN: " + Joiner.on(" ").join(parts));
+    }
+  }
 
   @Override
   public void debug(Object... parts) {

src/test/java/pl/project13/maven/git/GitCommitIdMojoIntegrationTest.java

@@ -792,6 +792,30 @@ public void shouldUseDateFormatTimeZone(boolean useNativeGit) throws Exception {
     TimeZone.setDefault(currentDefaultTimeZone);
   }
 
+  @Test
+  @Parameters(method = "useNativeGit")
+  public void shouldGenerateCommitIdOldFashioned(boolean useNativeGit) throws Exception {
+    // given
+    mavenSandbox.withParentProject("my-pom-project", "pom")
+                .withChildProject("my-jar-module", "jar")
+                .withGitRepoInChild(AvailableGitTestRepo.ON_A_TAG_DIRTY)
+                .create(CleanUp.CLEANUP_FIRST);
+    MavenProject targetProject = mavenSandbox.getChildProject();
+
+    setProjectToExecuteMojoIn(targetProject);
+
+    alterMojoSettings("useNativeGit", useNativeGit);
+    alterMojoSettings("generateCommitIdOldFashioned", true);
+
+    // when
+    mojo.execute();
+
+    // then
+    Properties properties = targetProject.getProperties();
+    assertThat(properties.stringPropertyNames()).contains("git.commit.id");
+    assertThat(properties.stringPropertyNames()).excludes("git.commit.id.full");
+  }
+
   private GitDescribeConfig createGitDescribeConfig(boolean forceLongFormat, int abbrev) {
     GitDescribeConfig gitDescribeConfig = new GitDescribeConfig();
     gitDescribeConfig.setTags(true);

src/test/java/pl/project13/maven/git/GitIntegrationTest.java

@@ -76,6 +76,7 @@ public static void initializeMojoWithDefaults(GitCommitIdMojo mojo) {
     mojoDefaults.put("dateFormat", "dd.MM.yyyy '@' HH:mm:ss z");
     mojoDefaults.put("failOnNoGitDirectory", true);
     mojoDefaults.put("useNativeGit", false);
+    mojoDefaults.put("generateCommitIdOldFashioned", false);
     for (Map.Entry<String, Object> entry : mojoDefaults.entrySet()) {
       setInternalState(mojo, entry.getKey(), entry.getValue());
     }