Merge pull request #142 from abatkin/master

add boolean property: 'files.dirty' if working dir is dirty

Author: ktoso

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

@@ -59,6 +59,7 @@ public class GitCommitIdMojo extends AbstractMojo {
   public static final String BRANCH = "branch";
   public static final String COMMIT_ID = "commit.id";
   public static final String COMMIT_ID_ABBREV = "commit.id.abbrev";
+  public static final String FILES_DIRTY = "commit.files.dirty";
   public static final String COMMIT_DESCRIBE = "commit.id.describe";
   public static final String COMMIT_SHORT_DESCRIBE = "commit.id.describe-short";
   public static final String BUILD_AUTHOR_NAME = "build.user.name";

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

@@ -37,6 +37,7 @@ public abstract class GitDataProvider {
   protected abstract String getGitDescribe() throws MojoExecutionException;
   protected abstract String getCommitId();
   protected abstract String getAbbrevCommitId() throws MojoExecutionException;
+  protected abstract boolean isDirty() throws MojoExecutionException;
   protected abstract String getCommitAuthorName();
   protected abstract String getCommitAuthorEmail();
   protected abstract String getCommitMessageFull();
@@ -65,6 +66,8 @@ public void loadGitData(@NotNull Properties properties) throws IOException, Mojo
       put(properties, GitCommitIdMojo.COMMIT_ID, getCommitId());
       // git.commit.id.abbrev      
       put(properties, GitCommitIdMojo.COMMIT_ID_ABBREV, getAbbrevCommitId());
+      // git.files.dirty
+      put(properties, GitCommitIdMojo.FILES_DIRTY, Boolean.toString(isDirty()));
       // git.commit.author.name
       put(properties, GitCommitIdMojo.COMMIT_AUTHOR_NAME, getCommitAuthorName());
       // git.commit.author.email

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

@@ -135,6 +135,16 @@ protected String getAbbrevCommitId() throws MojoExecutionException {
     return abbrevCommitId;
   }
 
+  @Override
+  protected boolean isDirty() throws MojoExecutionException {
+    Git gitObject = Git.wrap(git);
+    try {
+      return !gitObject.status().call().isClean();
+    } catch (GitAPIException e) {
+      throw new MojoExecutionException("Failed to get git status: " + e.getMessage(), e);
+    }
+  }
+
   @Override
   protected String getCommitAuthorName() {
     String commitAuthor = headCommit.getAuthorIdent().getName();

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

@@ -175,6 +175,12 @@ protected String getAbbrevCommitId() throws MojoExecutionException {
     return abbrevCommitId;
   }
 
+  @Override
+  protected boolean isDirty() throws MojoExecutionException {
+    String output = tryToRunGitCommand(canonical, "status --porcelain");
+    return !output.trim().isEmpty();
+  }
+
   @Override
   protected String getCommitAuthorName() {
     return tryToRunGitCommand(canonical, "log -1 --pretty=format:\"%cn\"");

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

@@ -25,6 +25,8 @@ public enum AvailableGitTestRepo {
   WITH_ONE_COMMIT("src/test/resources/_git_one_commit"),
   WITH_ONE_COMMIT_DIRTY("src/test/resources/_git_one_commit_dirty"),
   GIT_COMMIT_ID("src/test/resources/_git_of_git_commit_id"),
+  GIT_WITH_NO_CHANGES("src/test/resources/_git_with_no_changes/_git_dir"),
+  GIT_WITH_CHANGES("src/test/resources/_git_with_changes/_git_dir"),
   ON_A_TAG("src/test/resources/_git_on_a_tag"),
   /**
    * <pre>

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

@@ -0,0 +1,103 @@
+/*
+ * This file is part of git-commit-id-plugin by Konrad 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 com.google.common.collect.ImmutableList;
+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 java.io.File;
+import java.io.IOException;
+import java.util.Map;
+import java.util.Properties;
+
+import static org.fest.assertions.Assertions.assertThat;
+import static org.mockito.Mockito.*;
+
+/**
+ * @author Adam Batkin
+ */
+public class GitCommitIdMojoDirtyFilesTest {
+
+  @Test
+  public void testDetectCleanWorkingDirectory() throws Exception {
+    File dotGitDirectory = AvailableGitTestRepo.GIT_WITH_NO_CHANGES.getDir();
+    GitDescribeConfig gitDescribeConfig = new GitDescribeConfig();
+    gitDescribeConfig.setSkip(false);
+
+    String prefix = "git";
+    int abbrevLength = 7;
+    String dateFormat = "dd.MM.yyyy '@' HH:mm:ss z";
+    boolean verbose = true;
+
+    GitCommitIdMojo mojo = new GitCommitIdMojo();
+    mojo.setDotGitDirectory(dotGitDirectory);
+    mojo.setPrefix(prefix);
+    mojo.setAbbrevLength(abbrevLength);
+    mojo.setDateFormat(dateFormat);
+    mojo.setVerbose(verbose);
+    mojo.useNativeGit(false);
+    mojo.setGitDescribe(gitDescribeConfig);
+
+
+    mojo.runningTests = true;
+    mojo.project = mock(MavenProject.class, RETURNS_MOCKS);
+    when(mojo.project.getPackaging()).thenReturn("jar");
+
+    mojo.execute();
+
+    Properties properties = mojo.getProperties();
+
+    assertThat(properties.get("git.commit.files.dirty")).isEqualTo("false");
+  }
+
+  @Test
+  public void testDetectDirtyWorkingDirectory() throws Exception {
+    File dotGitDirectory = AvailableGitTestRepo.GIT_WITH_CHANGES.getDir();
+    GitDescribeConfig gitDescribeConfig = new GitDescribeConfig();
+    gitDescribeConfig.setSkip(false);
+
+    String prefix = "git";
+    int abbrevLength = 7;
+    String dateFormat = "dd.MM.yyyy '@' HH:mm:ss z";
+    boolean verbose = true;
+
+    GitCommitIdMojo mojo = new GitCommitIdMojo();
+    mojo.setDotGitDirectory(dotGitDirectory);
+    mojo.setPrefix(prefix);
+    mojo.setAbbrevLength(abbrevLength);
+    mojo.setDateFormat(dateFormat);
+    mojo.setVerbose(verbose);
+    mojo.useNativeGit(false);
+    mojo.setGitDescribe(gitDescribeConfig);
+
+
+    mojo.runningTests = true;
+    mojo.project = mock(MavenProject.class, RETURNS_MOCKS);
+    when(mojo.project.getPackaging()).thenReturn("jar");
+
+    mojo.execute();
+
+    Properties properties = mojo.getProperties();
+
+    assertThat(properties.get("git.commit.files.dirty")).isEqualTo("true");
+  }
+}

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

@@ -81,6 +81,7 @@ public void shouldIncludeExpectedProperties() throws Exception {
     assertThat(properties).satisfies(new ContainsKeyCondition("git.branch"));
     assertThat(properties).satisfies(new ContainsKeyCondition("git.commit.id"));
     assertThat(properties).satisfies(new ContainsKeyCondition("git.commit.id.abbrev"));
+    assertThat(properties).satisfies(new ContainsKeyCondition("git.commit.files.dirty"));
     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.user.name"));

src/test/resources/_git_with_changes/_git_dir/COMMIT_EDITMSG

@@ -0,0 +1 @@
+add file.txt

src/test/resources/_git_with_changes/_git_dir/HEAD

@@ -0,0 +1 @@
+ref: refs/heads/master

src/test/resources/_git_with_changes/_git_dir/ORIG_HEAD

@@ -0,0 +1 @@
+79c5c38ca494525c1d2d3127af13476f9759957d