git-commit-id#457: fix an issue with the replacement where it just ge…

…nerates and displays an empty property

maven/docs/using-the-plugin.md

@@ -454,6 +454,14 @@ It's really simple to setup this plugin; below is a sample pom that you may base
                         Please note that the replacement will *only be applied to properties that are being
                         generated by the plugin*. If you want to replace properties that are being generated by
                         other plugins you may want to use the maven-replacer-plugin or any other alternative.
+
+                        Since 4.0.1 the plugin allows to define a `forceValueEvaluation`-switch which forces the
+                        plugin to evaluate the given value on *every* project.
+                        This might come handy if *every* project needs a unique value and a user wants to
+                        project specific variables like `${project.artifactId}`.
+                        Be adviced that this essentially means that the plugin *must* run for every child-project of a
+                        reactor build and thus might cause some overhead (the git properties should be cached).
+                        For a use-case refer to https://github.com/git-commit-id/maven-git-commit-id-plugin/issues/457.
                     -->
                     <replacementProperties>
                       <!--
@@ -466,6 +474,7 @@ It's really simple to setup this plugin; below is a sample pom that you may base
                         <token>^([^\/]*)\/([^\/]*)$</token>
                         <value>$1-$2</value>
                         <regex>true</regex>
+                        <forceValueEvaluation>false</forceValueEvaluation>
                         <transformationRules>
                           <transformationRule>
                             <apply>BEFORE</apply>

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

@@ -28,6 +28,7 @@
 
 import org.apache.maven.execution.MavenSession;
 import org.apache.maven.plugin.AbstractMojo;
+import org.apache.maven.plugin.MojoExecution;
 import org.apache.maven.plugin.MojoExecutionException;
 import org.apache.maven.plugin.PluginParameterExpressionEvaluator;
 import org.apache.maven.plugins.annotations.Component;
@@ -68,6 +69,12 @@ public class GitCommitIdMojo extends AbstractMojo {
   @Parameter(defaultValue = "${reactorProjects}", readonly = true)
   List<MavenProject> reactorProjects;
 
+  /**
+   * The Mojo Execution
+   */
+  @Parameter(defaultValue = "${mojoExecution}", readonly = true)
+  MojoExecution mojoExecution;
+
   /**
    * The Maven Session Object.
    */
@@ -488,10 +495,15 @@ public void execute() throws MojoExecutionException {
 
         loadGitData(properties);
         loadBuildData(properties);
-        PropertiesReplacer propertiesReplacer = new PropertiesReplacer(log, new PluginParameterExpressionEvaluator(session));
-        propertiesReplacer.performReplacement(properties, replacementProperties);
+        // first round of publication and filtering (we need to make variables available for the ParameterExpressionEvaluator
         propertiesFilterer.filter(properties, includeOnlyProperties, this.prefixDot);
         propertiesFilterer.filterNot(properties, excludeProperties, this.prefixDot);
+        publishToAllSystemEnvironments();
+
+        // now run replacements
+        PropertiesReplacer propertiesReplacer = new PropertiesReplacer(
+                log, new PluginParameterExpressionEvaluator(session, mojoExecution));
+        propertiesReplacer.performReplacement(properties, replacementProperties);
 
         logProperties();
 
@@ -500,18 +512,8 @@ public void execute() throws MojoExecutionException {
                   properties, project.getBasedir(), generateGitPropertiesFilename, sourceCharset);
         }
 
-        publishPropertiesInto(project.getProperties());
-        // some plugins rely on the user properties (e.g. flatten-maven-plugin)
-        publishPropertiesInto(session.getUserProperties());
-
-        if (injectAllReactorProjects) {
-          appendPropertiesToReactorProjects();
-        }
-
-        if (injectIntoSysProperties) {
-          publishPropertiesInto(System.getProperties());
-          publishPropertiesInto(session.getSystemProperties());
-        }
+        // publish properties again since we might have new properties gained by the replacement
+        publishToAllSystemEnvironments();
 
       } catch (Exception e) {
         handlePluginFailure(e);
@@ -521,6 +523,22 @@ public void execute() throws MojoExecutionException {
     }
   }
 
+  private void publishToAllSystemEnvironments() {
+    publishPropertiesInto(project.getProperties());
+    // some plugins rely on the user properties (e.g. flatten-maven-plugin)
+    publishPropertiesInto(session.getUserProperties());
+
+    if (injectAllReactorProjects) {
+      appendPropertiesToReactorProjects();
+    }
+
+    if (injectIntoSysProperties) {
+      publishPropertiesInto(System.getProperties());
+      publishPropertiesInto(session.getSystemProperties());
+      publishPropertiesInto(session.getRequest().getSystemProperties());
+    }
+  }
+
   @Nullable
   private Properties getContextProperties(MavenProject project) {
     Object stored = project.getContextValue(CONTEXT_KEY);

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

@@ -81,9 +81,15 @@ private void performReplacementOnSingleProperty(Properties properties, Replaceme
   }
 
   private String performReplacement(ReplacementProperty replacementProperty, String content) {
+    String evaluationContent = content;
+    if (evaluationContent == null || evaluationContent.isEmpty() || replacementProperty.isForceValueEvaluation()) {
+      evaluationContent = replacementProperty.getValue();
+    }
     String result = "";
     try {
-      result = Optional.ofNullable(expressionEvaluator.evaluate(content)).map(x -> x.toString()).orElse("");
+      result = Optional
+              .ofNullable(expressionEvaluator.evaluate(evaluationContent))
+              .map(x -> x.toString()).orElse(evaluationContent);
     } catch (Exception e) {
       log.error("Something went wrong performing the replacement.", e);
     }

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

@@ -68,6 +68,16 @@ public class ReplacementProperty {
   @Parameter(defaultValue = "true")
   private boolean regex = true;
 
+  /**
+   * Forces the plugin to evaluate the value on *every* project.
+   * Note that this essentially means that the plugin *must* run for every child-project of a reactor
+   * build and thus might cause some overhead (the git properties should be cached).
+   *
+   * For a use-case refer to https://github.com/git-commit-id/maven-git-commit-id-plugin/issues/457.
+   */
+  @Parameter(defaultValue = "false")
+  private boolean forceValueEvaluation = false;
+
   /**
    * @since 2.2.4
    * Provides the ability to perform certain string transformations before regex evaluation or after.
@@ -78,12 +88,13 @@ public class ReplacementProperty {
   public ReplacementProperty() {
   }
 
-  public ReplacementProperty(String property, String propertyOutputSuffix, String token, String value, boolean regex, List<TransformationRule> transformationRules) {
+  public ReplacementProperty(String property, String propertyOutputSuffix, String token, String value, boolean regex, boolean forceValueEvaluation, List<TransformationRule> transformationRules) {
     this.property = property;
     this.propertyOutputSuffix = propertyOutputSuffix;
     this.token = token;
     this.value = value;
     this.regex = regex;
+    this.forceValueEvaluation = forceValueEvaluation;
     this.transformationRules = transformationRules;
   }
 
@@ -127,6 +138,15 @@ public void setRegex(boolean regex) {
     this.regex = regex;
   }
 
+
+  public boolean isForceValueEvaluation() {
+    return forceValueEvaluation;
+  }
+
+  public void setForceValueEvaluation(boolean forceValueEvaluation) {
+    this.forceValueEvaluation = forceValueEvaluation;
+  }
+
   public List<TransformationRule> getTransformationRules() {
     return transformationRules;
   }

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

@@ -69,7 +69,7 @@ public void testPerformReplacementWithInvalidReplacement(boolean regex) throws I
     Properties actualProperties = build("key1", "value1", "key2", "value2");
 
     List<ReplacementProperty> replacementProperties = new ArrayList<>();
-    replacementProperties.add(new ReplacementProperty("key1", null, null, null, regex, null));
+    replacementProperties.add(new ReplacementProperty("key1", null, null, null, regex, false, null));
 
     propertiesReplacer.performReplacement(actualProperties, replacementProperties);
   }
@@ -80,7 +80,7 @@ public void testPerformReplacementWithSingleProperty(boolean regex) throws IOExc
     Properties actualProperties = build("key1", "value1", "key2", "value2");
 
     List<ReplacementProperty> replacementProperties = new ArrayList<>();
-    replacementProperties.add(new ReplacementProperty("key1", null, "value", "another", regex, null));
+    replacementProperties.add(new ReplacementProperty("key1", null, "value", "another", regex, false, null));
 
     propertiesReplacer.performReplacement(actualProperties, replacementProperties);
 
@@ -94,7 +94,7 @@ public void testPerformReplacementWithSinglePropertyEmptyValue(boolean regex) th
     Properties actualProperties = build("key1", "value1", "key2", "value2");
 
     List<ReplacementProperty> replacementProperties = new ArrayList<>();
-    replacementProperties.add(new ReplacementProperty("key1", null, "value", null, regex, null));
+    replacementProperties.add(new ReplacementProperty("key1", null, "value", null, regex, false, null));
 
     propertiesReplacer.performReplacement(actualProperties, replacementProperties);
 
@@ -108,7 +108,7 @@ public void testPerformReplacementWithMultipleProperties(boolean regex) throws I
     Properties actualProperties = build("key1", "value1", "key2", "value2");
 
     List<ReplacementProperty> replacementProperties = new ArrayList<>();
-    replacementProperties.add(new ReplacementProperty(null, null, "value", "another", regex, null));
+    replacementProperties.add(new ReplacementProperty(null, null, "value", "another", regex, false, null));
 
     propertiesReplacer.performReplacement(actualProperties, replacementProperties);
 
@@ -122,7 +122,7 @@ public void testPerformReplacementWithMultiplePropertiesEmptyValue(boolean regex
     Properties actualProperties = build("key1", "value1", "key2", "value2");
 
     List<ReplacementProperty> replacementProperties = new ArrayList<>();
-    replacementProperties.add(new ReplacementProperty(null, null, "value", null, regex, null));
+    replacementProperties.add(new ReplacementProperty(null, null, "value", null, regex, false, null));
 
     propertiesReplacer.performReplacement(actualProperties, replacementProperties);
 
@@ -135,7 +135,7 @@ public void testPerformReplacementWithPatternGroupAndMatching() throws IOExcepti
     Properties actualProperties = build("git.branch", "feature/feature_name", "git.commit.author", "author/name");
 
     List<ReplacementProperty> replacementProperties = new ArrayList<>();
-    replacementProperties.add(new ReplacementProperty("git.branch", null, "^([^\\/]*)\\/([^\\/]*)$", "$1-$2", true, null));
+    replacementProperties.add(new ReplacementProperty("git.branch", null, "^([^\\/]*)\\/([^\\/]*)$", "$1-$2", true, false, null));
 
     propertiesReplacer.performReplacement(actualProperties, replacementProperties);
 
@@ -148,7 +148,7 @@ public void testPerformReplacementWithPatternGroupAndNoMatch() throws IOExceptio
     Properties actualProperties = build("git.branch", "feature#feature_name", "git.commit.author", "author#");
 
     List<ReplacementProperty> replacementProperties = new ArrayList<>();
-    replacementProperties.add(new ReplacementProperty("git.branch", null, "^([^\\/]*)\\/([^\\/]*)$", "$1-$2", true, null));
+    replacementProperties.add(new ReplacementProperty("git.branch", null, "^([^\\/]*)\\/([^\\/]*)$", "$1-$2", true, false, null));
 
     propertiesReplacer.performReplacement(actualProperties, replacementProperties);
 
@@ -161,7 +161,7 @@ public void testPerformReplacementOnSinglePropertyAndExpectNewPropertyGenerated(
     Properties actualProperties = build("git.branch", "feature/feature_name", "git.commit.author", "author#");
 
     List<ReplacementProperty> replacementProperties = new ArrayList<>();
-    replacementProperties.add(new ReplacementProperty("git.branch", "something", "^([^\\/]*)\\/([^\\/]*)$", "$1-$2", true, null));
+    replacementProperties.add(new ReplacementProperty("git.branch", "something", "^([^\\/]*)\\/([^\\/]*)$", "$1-$2", true, false, null));
 
     propertiesReplacer.performReplacement(actualProperties, replacementProperties);
 
@@ -174,7 +174,7 @@ public void testPerformReplacementOnEveryPropertyAndExpectNewPropertyGenerated()
     Properties actualProperties = build("git.branch", "feature/feature_name", "git.commit.author", "author#");
 
     List<ReplacementProperty> replacementProperties = new ArrayList<>();
-    replacementProperties.add(new ReplacementProperty(null, "something", "^([^\\/]*)\\/([^\\/]*)$", "$1-$2", true, null));
+    replacementProperties.add(new ReplacementProperty(null, "something", "^([^\\/]*)\\/([^\\/]*)$", "$1-$2", true, false, null));
 
     propertiesReplacer.performReplacement(actualProperties, replacementProperties);
 
@@ -200,7 +200,7 @@ public void runTransformationTestHelper(String input, String regex, Transformati
     transformationRules.add(new TransformationRule(applyRule, actionRule));
 
     List<ReplacementProperty> replacementProperties = new ArrayList<>();
-    replacementProperties.add(new ReplacementProperty(null, null, regex, "-", true, transformationRules));
+    replacementProperties.add(new ReplacementProperty(null, null, regex, "-", true, false, transformationRules));
 
     propertiesReplacer.performReplacement(actualProperties, replacementProperties);