Merge pull request git-commit-id#192 from Cousnouf/feature/new_parameters

Added includeOnlyProperties options as alternative to a huge list of excludeProperties. Also added project version as output parameter.

Author: TheSnoozer

README.md

@@ -204,6 +204,20 @@ It's really simple to setup this plugin; below is a sample pom that you may base
                       <!-- <excludeProperty>git.user.*</excludeProperty> -->
                     </excludeProperties>
 
+                    <!-- @since 2.1.14 -->
+                    <!--
+                        Can be used to include only certain properties into the resulting file.
+                        Will be overruled by the exclude properties.
+
+                        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 *}).
+                    -->
+                    <includeOnlyProperties>
+                      <!-- <includeOnlyProperty>^git.commit.id$</includeOnlyProperty> -->
+                    </includeOnlyProperties>
+
                     <!-- @since 2.1.10 -->
                     <!-- 
                       false is default here, if set to true it uses native `git` excutable for extracting all data.
@@ -605,6 +619,7 @@ Optional parameters:
 * **skip** - `(default: false)` *(available since v2.1.8)* - Skip the plugin execution completely.
 * **runOnlyOnce** - `(default: false)` *(available since v2.1.12)* - Use with caution! In a multi-module build, only run once. This means that the plugins effects will only execute once, for the parent project. This probably won't "do the right thing" if your project has more than one git repository. Important: If you're using `generateGitPropertiesFile`, setting `runOnlyOnce` will make the plugin only generate the file in the directory where you started your build :warning:. The `git.*` maven properties are available in all modules.
 * **excludeProperties** - `(default: empty)` *(available since v2.1.9)* - Allows to filter out properties that you *don't* want to expose. This feature was implemented in response to [this issue](https://github.com/ktoso/maven-git-commit-id-plugin/issues/91), so if you're curious about the use-case, check that issue.
+* **includeOnlyProperties** - `(default: empty)` *(available since v2.1.14)* - Allows to include only properties that you want to expose. This feature was implemented to avoid big exclude properties tag when we only want very few specific properties.
 * **useNativeGit** - `(default: false)` *(available since v2.1.10)* - Uses the native `git` binary instead of the custom `jgit` implementation shipped with this plugin to obtain all information. Although this should usualy give your build some performance boost, it may randomly break if you upgrade your git version and it decides to print information in a different format suddenly. As rule of thumb, keep using the default `jgit` implementation (keep this option set to `false`) until you notice performance problems within your build (usualy when you have *hundreds* of maven modules).
 * **abbrevLength** - `(default: 7)` *(available since v2.0.4)* - Configure the "git.commit.id.abbrev" property to be at least of length N (see gitDescribe abbrev for special case abbrev = 0).
 

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

@@ -73,6 +73,7 @@ public class GitCommitIdMojo extends AbstractMojo {
   public static final String BUILD_AUTHOR_NAME = "build.user.name";
   public static final String BUILD_AUTHOR_EMAIL = "build.user.email";
   public static final String BUILD_TIME = "build.time";
+  public static final String BUILD_VERSION = "build.version";
   public static final String BUILD_HOST = "build.host";
   public static final String COMMIT_AUTHOR_NAME = "commit.user.name";
   public static final String COMMIT_AUTHOR_EMAIL = "commit.user.email";
@@ -295,6 +296,21 @@ public class GitCommitIdMojo extends AbstractMojo {
   @SuppressWarnings("UnusedDeclaration")
   private List<String> excludeProperties = Collections.emptyList();
 
+  /**
+   * Can be used to include only certain properties into the resulting file.
+   * Will be overruled by the exclude properties.
+   *
+   * 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> includeOnlyProperties = Collections.emptyList();
+
   /**
    * The Maven Session Object
    *
@@ -357,9 +373,10 @@ public void execute() throws MojoExecutionException {
       prefixDot = trimmedPrefix.equals("") ? "" : trimmedPrefix + ".";
 
       loadGitData(properties);
-      loadBuildTimeData(properties);
+      loadBuildVersionAndTimeData(properties);
       loadBuildHostData(properties);
       loadShortDescribe(properties);
+      filter(properties, includeOnlyProperties);
       filterNot(properties, excludeProperties);
       logProperties(properties);
 
@@ -378,7 +395,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 +419,31 @@ 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);
+      }
+    }
+  }
+
   /**
    * 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.
@@ -470,10 +512,11 @@ private boolean isOurProperty(@NotNull String keyString) {
     return keyString.startsWith(prefixDot);
   }
 
-  void loadBuildTimeData(@NotNull Properties properties) {
+  void loadBuildVersionAndTimeData(@NotNull Properties properties) {
     Date buildDate = new Date();
     SimpleDateFormat smf = new SimpleDateFormat(dateFormat);
     put(properties, BUILD_TIME, smf.format(buildDate));
+    put(properties, BUILD_VERSION, project.getVersion());
   }
 
   void loadBuildHostData(@NotNull Properties properties) {
@@ -756,6 +799,10 @@ public void setExcludeProperties(List<String> excludeProperties) {
     this.excludeProperties = excludeProperties;
   }
 
+  public void setIncludeOnlyProperties(List<String> includeOnlyProperties) {
+    this.includeOnlyProperties = includeOnlyProperties;
+  }
+
   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,21 +53,21 @@ 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);
 
 
     mojo.runningTests = true;
     mojo.project = mock(MavenProject.class, RETURNS_MOCKS);
     when(mojo.project.getPackaging()).thenReturn("jar");
+    when(mojo.project.getVersion()).thenReturn("3.3-SNAPSHOT");
 
     jGitProvider = JGitProvider.on(mojo.lookupGitDirectory(), mojo.getLoggerBridge());
   }
@@ -123,6 +123,67 @@ public void shouldExcludeAsConfiguredProperties() throws Exception {
     assertThat(properties).satisfies(new ContainsKeyCondition("git.commit.time"));
   }
 
+  @Test
+  public void shouldIncludeOnlyAsConfiguredProperties() throws Exception {
+    // given
+    mojo.setIncludeOnlyProperties(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.setIncludeOnlyProperties(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 -> overrules include only properties
+    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
   @SuppressWarnings("")
   public void shouldHaveNoPrefixWhenConfiguredPrefixIsEmptyStringAsConfiguredProperties() throws Exception {