Merge pull request #311 from cbuschka/issue_310_cbuschka_project_props_removed

#310: Only properties created by maven-git-commit-id-plugin are being filtered now otherwise the git-commit-id-plugin would remove project properties generated by other plugins

Author: TheSnoozer

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

@@ -36,7 +36,6 @@
 import java.util.Map;
 import java.util.Properties;
 import java.util.TimeZone;
-import java.util.regex.Pattern;
 
 import org.apache.maven.execution.MavenSession;
 import org.apache.maven.plugin.AbstractMojo;
@@ -51,10 +50,6 @@
 import com.fasterxml.jackson.core.type.TypeReference;
 import com.fasterxml.jackson.databind.ObjectMapper;
 import com.google.common.annotations.VisibleForTesting;
-import com.google.common.base.Function;
-import com.google.common.base.Predicate;
-import com.google.common.base.Predicates;
-import com.google.common.collect.Lists;
 import com.google.common.io.Closeables;
 import com.google.common.io.Files;
 import java.io.OutputStream;
@@ -294,7 +289,7 @@ public class GitCommitIdMojo extends AbstractMojo {
    * @since 2.2.3
    */
   @Parameter
-  private List<ReplacementProperty> replacementProperties;
+  @VisibleForTesting List<ReplacementProperty> replacementProperties;
 
   /**
    * The properties we store our data in and then expose them.
@@ -309,6 +304,11 @@ public class GitCommitIdMojo extends AbstractMojo {
   @NotNull
   private final LoggerBridge log = new MavenLoggerBridge(this, false);
 
+  @NotNull
+  private PropertiesFilterer propertiesFilterer = new PropertiesFilterer(log);
+
+  @NotNull @VisibleForTesting PropertiesReplacer propertiesReplacer = new PropertiesReplacer(log);
+
   @Override
   public void execute() throws MojoExecutionException {
     try {
@@ -364,7 +364,7 @@ public void execute() throws MojoExecutionException {
           commitIdGenerationModeEnum = CommitIdGenerationMode.FLAT;
         }
 
-        properties = initProperties();
+        properties = new Properties();
 
         String trimmedPrefix = prefix.trim();
         prefixDot = trimmedPrefix.equals("") ? "" : trimmedPrefix + ".";
@@ -373,18 +373,18 @@ public void execute() throws MojoExecutionException {
         loadBuildVersionAndTimeData(properties);
         loadBuildHostData(properties);
         loadShortDescribe(properties);
-        performReplacement(properties, replacementProperties);
-        filter(properties, includeOnlyProperties);
-        filterNot(properties, excludeProperties);
-        logProperties(properties);
+        propertiesReplacer.performReplacement(properties, replacementProperties);
+        propertiesFilterer.filter(properties, includeOnlyProperties, this.prefixDot);
+        propertiesFilterer.filterNot(properties, excludeProperties, this.prefixDot);
+        logProperties();
 
         if (generateGitPropertiesFile) {
           maybeGeneratePropertiesFile(properties, project.getBasedir(), generateGitPropertiesFilename);
-          project.getProperties().putAll(properties); // add to maven project properties also when file is generated
         }
+        publishPropertiesInto(project);
 
         if (injectAllReactorProjects) {
-          appendPropertiesToReactorProjects(properties, prefixDot);
+          appendPropertiesToReactorProjects();
         }
       } catch (Exception e) {
         handlePluginFailure(e);
@@ -394,105 +394,8 @@ public void execute() throws MojoExecutionException {
     }
   }
 
-  @VisibleForTesting void performReplacement(Properties properties, List<ReplacementProperty> replacementProperties) {
-    if((replacementProperties != null) && (properties != null)) {
-      for(ReplacementProperty replacementProperty: replacementProperties) {
-        String propertyKey = replacementProperty.getProperty();
-        if(propertyKey == null) {
-          for (Map.Entry<Object, Object> entry : properties.entrySet()) {
-            String key = (String)entry.getKey();
-            String content = (String)entry.getValue();
-            String result = performReplacement(replacementProperty, content);
-            entry.setValue(result);
-            log.info("apply replace on property " + key + ": original value '" + content + "' with '" + result + "'");
-          }
-        } else {
-          String content = properties.getProperty(propertyKey);
-          String result = performReplacement(replacementProperty, content);
-          properties.setProperty(propertyKey, result);
-          log.info("apply replace on property " + propertyKey + ": original value '" + content + "' with '" + result + "'");
-        }
-      }
-    }
-  }
-
-  private String performReplacement(ReplacementProperty replacementProperty, String content) {
-    String result = content;
-    if(replacementProperty != null) {
-      if(replacementProperty.isRegex()) {
-        result = replaceRegex(content, replacementProperty.getToken(), replacementProperty.getValue());
-      } else {
-        result = replaceNonRegex(content, replacementProperty.getToken(), replacementProperty.getValue());
-      }
-    }
-    return result;
-  }
-
-  private String replaceRegex(String content, String token, String value) {
-    if((token == null) || (value == null)) {
-      log.error("found replacementProperty without required token or value.");
-      return content;
-    }
-    final Pattern compiledPattern = Pattern.compile(token);
-    return compiledPattern.matcher(content).replaceAll(value);
-  }
-
-  private String replaceNonRegex(String content, String token, String value) {
-    if((token == null) || (value == null)) {
-      log.error("found replacementProperty without required token or value.");
-      return content;
-    }
-    return content.replace(token, value);
-  }
-
-  private void filterNot(Properties properties, @Nullable List<String> exclusions) {
-    if (exclusions == null || exclusions.isEmpty()) {
-      return;
-    }
-
-    List<Predicate<CharSequence>> excludePredicates = Lists.transform(exclusions, new Function<String, Predicate<CharSequence>>() {
-      @Override
-      public Predicate<CharSequence> apply(String exclude) {
-        return Predicates.containsPattern(exclude);
-      }
-    });
-
-    Predicate<CharSequence> shouldExclude = Predicates.alwaysFalse();
-    for (Predicate<CharSequence> predicate : excludePredicates) {
-      shouldExclude = Predicates.or(shouldExclude, predicate);
-    }
-
-    for (String key : properties.stringPropertyNames()) {
-      if (shouldExclude.apply(key)) {
-        log.debug("shouldExclude.apply({}) = {}", key, shouldExclude.apply(key));
-        properties.remove(key);
-      }
-    }
-  }
-
-  private void filter(Properties properties, @Nullable List<String> inclusions) {
-    if (inclusions == null || inclusions.isEmpty()) {
-      return;
-    }
-
-    List<Predicate<CharSequence>> includePredicates = Lists.transform(inclusions, new Function<String, Predicate<CharSequence>>() {
-      @Override
-      public Predicate<CharSequence> apply(String exclude) {
-        return Predicates.containsPattern(exclude);
-      }
-    });
-
-    Predicate<CharSequence> shouldInclude = Predicates.alwaysFalse();
-    for (Predicate<CharSequence> predicate : includePredicates) {
-      shouldInclude = Predicates.or(shouldInclude, predicate);
-    }
-
-    for (String key : properties.stringPropertyNames()) {
-      if (!shouldInclude.apply(key)) {
-        log.debug("!shouldInclude.apply({}) = {}", key, shouldInclude.apply(key));
-        properties.remove(key);
-      }
-    }
+  private void publishPropertiesInto(MavenProject target) {
+    target.getProperties().putAll(properties);
   }
 
   /**
@@ -510,18 +413,13 @@ private void handlePluginFailure(Exception e) throws GitCommitIdExecutionExcepti
     }
   }
 
-  private void appendPropertiesToReactorProjects(@NotNull Properties properties, @NotNull String trimmedPrefixWithDot) {
+  private void appendPropertiesToReactorProjects() {
     for (MavenProject mavenProject : reactorProjects) {
-      Properties mavenProperties = mavenProject.getProperties();
 
       // TODO check message
       log.info("{}] project {}", mavenProject.getName(), mavenProject.getName());
 
-      for (Object key : properties.keySet()) {
-        if (key.toString().startsWith(trimmedPrefixWithDot)) {
-            mavenProperties.put(key, properties.get(key));
-        }
-      }
+      publishPropertiesInto(mavenProject);
     }
   }
 
@@ -535,27 +433,13 @@ private void appendPropertiesToReactorProjects(@NotNull Properties properties, @
     return new GitDirLocator(project, reactorProjects).lookupGitDirectory(dotGitDirectory);
   }
 
-  private Properties initProperties() throws GitCommitIdExecutionException {
-    if (generateGitPropertiesFile) {
-      return properties = new Properties();
-    } else {
-      return properties = project.getProperties();
-    }
-  }
-
-  private void logProperties(@NotNull Properties properties) {
+  private void logProperties() {
     for (Object key : properties.keySet()) {
       String keyString = key.toString();
-      if (isOurProperty(keyString)) {
-        log.info("found property {}", keyString);
-      }
+      log.info("found property {}", keyString);
     }
   }
 
-  private boolean isOurProperty(@NotNull String keyString) {
-    return keyString.startsWith(prefixDot);
-  }
-
   void loadBuildVersionAndTimeData(@NotNull Properties properties) {
     Date buildDate = new Date();
     SimpleDateFormat smf = new SimpleDateFormat(dateFormat);

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

@@ -0,0 +1,93 @@
+/*
+ * This file is part of git-commit-id-plugin by Konrad 'ktoso' Malawski <konrad.malawski@java.pl>
+ *
+ * git-commit-id-plugin is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * git-commit-id-plugin is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with git-commit-id-plugin.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+package pl.project13.maven.git;
+
+import java.util.List;
+import java.util.Properties;
+
+import org.jetbrains.annotations.Nullable;
+
+import com.google.common.base.Function;
+import com.google.common.base.Predicate;
+import com.google.common.base.Predicates;
+import com.google.common.collect.Lists;
+
+import pl.project13.maven.git.log.LoggerBridge;
+
+public class PropertiesFilterer {
+
+    private LoggerBridge log;
+
+    public PropertiesFilterer(LoggerBridge log) {
+        this.log = log;
+    }
+
+    public void filterNot(Properties properties, @Nullable List<String> exclusions, String prefixDot) {
+        if (exclusions == null || exclusions.isEmpty()) {
+            return;
+        }
+
+        List<Predicate<CharSequence>> excludePredicates = Lists.transform(exclusions, new Function<String, Predicate<CharSequence>>() {
+            @Override
+            public Predicate<CharSequence> apply(String exclude) {
+                return Predicates.containsPattern(exclude);
+            }
+        });
+
+        Predicate<CharSequence> shouldExclude = Predicates.alwaysFalse();
+        for (Predicate<CharSequence> predicate : excludePredicates) {
+            shouldExclude = Predicates.or(shouldExclude, predicate);
+        }
+
+        for (String key : properties.stringPropertyNames()) {
+            if (isOurProperty(key, prefixDot) && shouldExclude.apply(key)) {
+                log.debug("shouldExclude.apply({}) = {}", key, shouldExclude.apply(key));
+                properties.remove(key);
+            }
+        }
+    }
+
+    public void filter(Properties properties, @Nullable List<String> inclusions, String prefixDot) {
+        if (inclusions == null || inclusions.isEmpty()) {
+            return;
+        }
+
+        List<Predicate<CharSequence>> includePredicates = Lists.transform(inclusions, new Function<String, Predicate<CharSequence>>() {
+            @Override
+            public Predicate<CharSequence> apply(String exclude) {
+                return Predicates.containsPattern(exclude);
+            }
+        });
+
+        Predicate<CharSequence> shouldInclude = Predicates.alwaysFalse();
+        for (Predicate<CharSequence> predicate : includePredicates) {
+            shouldInclude = Predicates.or(shouldInclude, predicate);
+        }
+
+        for (String key : properties.stringPropertyNames()) {
+            if (isOurProperty(key, prefixDot) && !shouldInclude.apply(key)) {
+                log.debug("!shouldInclude.apply({}) = {}", key, shouldInclude.apply(key));
+                properties.remove(key);
+            }
+        }
+    }
+
+    private boolean isOurProperty(String key, String prefixDot) {
+        return key.startsWith(prefixDot);
+    }
+}