Added includeProperties and additionalProperties as mojo parameters.

Author: Cousnouf

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

@@ -295,6 +295,35 @@ public class GitCommitIdMojo extends AbstractMojo {
   @SuppressWarnings("UnusedDeclaration")
   private List<String> excludeProperties = Collections.emptyList();
 
+  /**
+   * Can be used to exclude certain properties from being emited into the resulting file.
+   * May be useful when you want to hide {@code git.remote.origin.url} (maybe because it contains your repo password?),
+   * or the email of the committer etc.
+   *
+   * Each value may be globbing, that is, you can write {@code git.commit.user.*} to include both, the {@code name},
+   * as well as {@code email} properties into the resulting files.
+   *
+   * Please note that the strings here are Java regexes ({@code .*} is globbing, not plain {@code *}).
+   *
+   * @parameter
+   * @since 2.1.14
+   */
+  @SuppressWarnings("UnusedDeclaration")
+  private List<String> includeProperties = Collections.emptyList();
+
+  /**
+   * Can be used to add some properties in order to gather everything in the same file.
+   *
+   * For instance, you can set the maven project version or any dependency information.
+   *
+   * The key is the property name, the value is the value.
+   *
+   * @parameter
+   * @since 2.1.14
+   */
+  @SuppressWarnings("UnusedDeclaration")
+  private Map<String, String> additionalProperties = Collections.emptyMap();
+
   /**
    * The Maven Session Object
    *
@@ -360,7 +389,9 @@ public void execute() throws MojoExecutionException {
       loadBuildTimeData(properties);
       loadBuildHostData(properties);
       loadShortDescribe(properties);
+      filter(properties, includeProperties);
       filterNot(properties, excludeProperties);
+      addAdditionalProperties(properties, additionalProperties);
       logProperties(properties);
 
       if (generateGitPropertiesFile) {
@@ -378,7 +409,7 @@ public void execute() throws MojoExecutionException {
   }
 
   private void filterNot(Properties properties, @Nullable List<String> exclusions) {
-    if (exclusions == null) {
+    if (exclusions == null || exclusions.isEmpty()) {
       return;
     }
 
@@ -402,6 +433,37 @@ public Predicate<CharSequence> apply(String exclude) {
     }
   }
 
+  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)) {
+        loggerBridge.debug("!shouldInclude.apply(" + key + ") = " + shouldInclude.apply(key));
+        properties.remove(key);
+      }
+    }
+  }
+
+  private void addAdditionalProperties(Properties properties, Map<String, String> additionalProperties) {
+    for (Map.Entry<String, String> additionalProperty : additionalProperties.entrySet()) {
+      properties.put(additionalProperty.getKey(), additionalProperty.getValue());
+    }
+  }
+
   /**
    * Reacts to an exception based on the {@code failOnUnableToExtractRepoInfo} setting.
    * If it's true, an MojoExecutionException will be throw, otherwise we just log an error message.
@@ -756,6 +818,14 @@ public void setExcludeProperties(List<String> excludeProperties) {
     this.excludeProperties = excludeProperties;
   }
 
+  public void setIncludeProperties(List<String> includeProperties) {
+    this.includeProperties = includeProperties;
+  }
+
+  public void setAdditionalProperties(Map<String, String> additionalProperties) {
+    this.additionalProperties = additionalProperties;
+  }
+
   public void useNativeGit(boolean useNativeGit) {
     this.useNativeGit = useNativeGit;
   }

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

@@ -18,12 +18,12 @@
 package pl.project13.maven.git;
 
 import com.google.common.collect.ImmutableList;
+import com.google.common.collect.ImmutableMap;
 import com.google.common.collect.Maps;
 import org.apache.maven.project.MavenProject;
 import org.eclipse.jgit.lib.Repository;
 import org.junit.Before;
 import org.junit.Test;
-import pl.project13.maven.git.log.StdOutLoggerBridge;
 
 import java.io.File;
 import java.io.IOException;
@@ -53,14 +53,13 @@ public void setUp() throws Exception {
     String prefix = "git";
     int abbrevLength = 7;
     String dateFormat = "dd.MM.yyyy '@' HH:mm:ss z";
-    boolean verbose = true;
 
     mojo = new GitCommitIdMojo();
     mojo.setDotGitDirectory(dotGitDirectory);
     mojo.setPrefix(prefix);
     mojo.setAbbrevLength(abbrevLength);
     mojo.setDateFormat(dateFormat);
-    mojo.setVerbose(verbose);
+    mojo.setVerbose(true);
     mojo.useNativeGit(false);
     mojo.setGitDescribe(gitDescribeConfig);
 
@@ -123,6 +122,89 @@ public void shouldExcludeAsConfiguredProperties() throws Exception {
     assertThat(properties).satisfies(new ContainsKeyCondition("git.commit.time"));
   }
 
+  @Test
+  public void shouldIncludeAsConfiguredProperties() throws Exception {
+    // given
+    mojo.setIncludeProperties(ImmutableList.of("git.remote.origin.url", ".*.user.*", "^git.commit.id$"));
+
+    // when
+    mojo.execute();
+
+    // then
+    Properties properties = mojo.getProperties();
+
+    // explicitly included
+    assertThat(properties).satisfies(new ContainsKeyCondition("git.remote.origin.url"));
+
+    // glob included
+    assertThat(properties).satisfies(new ContainsKeyCondition("git.build.user.name"));
+    assertThat(properties).satisfies(new ContainsKeyCondition("git.build.user.email"));
+    assertThat(properties).satisfies(new ContainsKeyCondition("git.commit.id"));
+    assertThat(properties).satisfies(new ContainsKeyCondition("git.commit.user.name"));
+    assertThat(properties).satisfies(new ContainsKeyCondition("git.commit.user.email"));
+
+    // these excluded
+    assertThat(properties).satisfies(new DoesNotContainKeyCondition("git.branch"));
+    assertThat(properties).satisfies(new DoesNotContainKeyCondition("git.commit.id.abbrev"));
+    assertThat(properties).satisfies(new DoesNotContainKeyCondition("git.commit.message.full"));
+    assertThat(properties).satisfies(new DoesNotContainKeyCondition("git.commit.message.short"));
+    assertThat(properties).satisfies(new DoesNotContainKeyCondition("git.commit.time"));
+  }
+
+  @Test
+  public void shouldExcludeAndIncludeAsConfiguredProperties() throws Exception {
+    // given
+    mojo.setIncludeProperties(ImmutableList.of("git.remote.origin.url", ".*.user.*"));
+    mojo.setExcludeProperties(ImmutableList.of("git.build.user.email"));
+
+    // when
+    mojo.execute();
+
+    // then
+    Properties properties = mojo.getProperties();
+
+    // explicitly included
+    assertThat(properties).satisfies(new ContainsKeyCondition("git.remote.origin.url"));
+
+    // explicitly excluded
+    assertThat(properties).satisfies(new DoesNotContainKeyCondition("git.build.user.email"));
+
+    // glob included
+    assertThat(properties).satisfies(new ContainsKeyCondition("git.build.user.name"));
+    assertThat(properties).satisfies(new ContainsKeyCondition("git.commit.user.name"));
+    assertThat(properties).satisfies(new ContainsKeyCondition("git.commit.user.email"));
+
+    // these excluded
+    assertThat(properties).satisfies(new DoesNotContainKeyCondition("git.branch"));
+    assertThat(properties).satisfies(new DoesNotContainKeyCondition("git.commit.id"));
+    assertThat(properties).satisfies(new DoesNotContainKeyCondition("git.commit.id.abbrev"));
+    assertThat(properties).satisfies(new DoesNotContainKeyCondition("git.commit.message.full"));
+    assertThat(properties).satisfies(new DoesNotContainKeyCondition("git.commit.message.short"));
+    assertThat(properties).satisfies(new DoesNotContainKeyCondition("git.commit.time"));
+  }
+
+  @Test
+  public void shouldAddAdditionalProperties() throws Exception {
+    // given
+    String buildVersionKey = "build.version";
+    String ExpectedBuildVersion = "2.0.14";
+    String jGitVersionKey = "jgit.version";
+    String expectedJGitVersion = "3.7.0.201502260915-r";
+    mojo.setAdditionalProperties(ImmutableMap.of(buildVersionKey, ExpectedBuildVersion, jGitVersionKey, expectedJGitVersion));
+
+    // when
+    mojo.execute();
+
+    // then
+    Properties properties = mojo.getProperties();
+
+    // added properties
+    assertThat(properties).satisfies(new ContainsKeyCondition(buildVersionKey));
+    assertThat(properties).satisfies(new ContainsKeyCondition(jGitVersionKey));
+    assertThat(properties.get(buildVersionKey)).isEqualTo(ExpectedBuildVersion);
+    assertThat(properties.get(jGitVersionKey)).isEqualTo(expectedJGitVersion);
+  }
+
   @Test
   @SuppressWarnings("")
   public void shouldHaveNoPrefixWhenConfiguredPrefixIsEmptyStringAsConfiguredProperties() throws Exception {