Merge pull request #155 from hgschmie/git-output-fix

Fix differences in the output of native and jgit

Author: ktoso

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

@@ -3,8 +3,10 @@
 import com.google.common.annotations.VisibleForTesting;
 import com.google.common.base.Function;
 import com.google.common.base.Joiner;
+import com.google.common.base.Objects;
 import com.google.common.base.Predicate;
 import com.google.common.collect.Collections2;
+
 import org.apache.maven.plugin.MojoExecutionException;
 import org.eclipse.jgit.api.Git;
 import org.eclipse.jgit.api.errors.GitAPIException;
@@ -18,6 +20,7 @@
 import org.eclipse.jgit.revwalk.RevWalk;
 import org.eclipse.jgit.storage.file.FileRepositoryBuilder;
 import org.jetbrains.annotations.NotNull;
+
 import pl.project13.jgit.DescribeCommand;
 import pl.project13.jgit.DescribeResult;
 import pl.project13.maven.git.log.LoggerBridge;
@@ -66,13 +69,13 @@ protected void init() throws MojoExecutionException {
   @Override
   protected String getBuildAuthorName() {
     String userName = git.getConfig().getString("user", null, "name");
-    return userName;
+    return Objects.firstNonNull(userName, "");
   }
 
   @Override
   protected String getBuildAuthorEmail() {
     String userEmail = git.getConfig().getString("user", null, "email");
-    return userEmail;
+    return Objects.firstNonNull(userEmail, "");
   }
 
   @Override
@@ -142,13 +145,13 @@ protected String getCommitAuthorEmail() {
   @Override
   protected String getCommitMessageFull() {
     String fullMessage = headCommit.getFullMessage();
-    return fullMessage;
+    return fullMessage.trim();
   }
 
   @Override
   protected String getCommitMessageShort() {
     String shortMessage = headCommit.getShortMessage();
-    return shortMessage;
+    return shortMessage.trim();
   }
 
   @Override

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

@@ -1,18 +1,18 @@
 package pl.project13.maven.git;
 
-import com.google.common.base.Function;
-import com.google.common.base.Joiner;
-import com.google.common.base.Predicate;
+import static java.lang.String.format;
+
 import com.google.common.base.Splitter;
-import com.google.common.collect.FluentIterable;
-import com.google.common.collect.ImmutableList;
+import com.google.common.base.Throwables;
 import com.google.common.collect.Lists;
+
 import org.apache.maven.plugin.MojoExecutionException;
 import org.jetbrains.annotations.NotNull;
+
 import pl.project13.maven.git.log.LoggerBridge;
 
 import java.io.*;
-import java.util.Arrays;
+import java.text.SimpleDateFormat;
 
 
 public class NativeGitProvider extends GitDataProvider {
@@ -55,12 +55,26 @@ protected void init() throws MojoExecutionException {
 
   @Override
   protected String getBuildAuthorName() {
-    return tryToRunGitCommand(canonical, "log -1 --pretty=format:\"%an\"");
+    try {
+      return runGitCommand(canonical, "config --get user.name");
+    } catch (NativeCommandException e) {
+      if (e.getExitCode() == 1) { // No config file found
+        return "";
+      }
+      throw Throwables.propagate(e);
+    }
   }
 
   @Override
   protected String getBuildAuthorEmail() {
-    return tryToRunGitCommand(canonical, "log -1 --pretty=format:\"%ae\"");
+    try {
+      return runGitCommand(canonical, "config --get user.email");
+    } catch (NativeCommandException e) {
+      if (e.getExitCode() == 1) { // No config file found
+        return "";
+      }
+      throw Throwables.propagate(e);
+    }
   }
 
   @Override
@@ -75,21 +89,26 @@ protected String getBranchName() throws IOException {
   private String getBranch(File canonical) {
     String branch = null;
     try{
-      branch = tryToRunGitCommand(canonical, "symbolic-ref HEAD");
+      branch = runGitCommand(canonical, "symbolic-ref HEAD");
       if (branch != null) {
         branch = branch.replace("refs/heads/", "");
       }
-    }catch(RuntimeException e){
+    } catch(NativeCommandException e) {
       // it seems that git repro is in 'DETACHED HEAD'-State, using Commid-Id as Branch
-      branch = getCommitId();
+      String err = e.getStderr();
+      if (err != null && err.contains("ref HEAD is not a symbolic ref")) {
+        branch = getCommitId();
+      } else {
+        throw Throwables.propagate(e);
+      }
     }
     return branch;
   }
 
   @Override
-  protected String getGitDescribe() throws MojoExecutionException {
+  protected String getGitDescribe() {
     final String argumentsForGitDescribe = getArgumentsForGitDescribe(gitDescribe);
-    final String gitDescribe = tryToRunGitCommand(canonical, "describe" + argumentsForGitDescribe);
+    final String gitDescribe = runQuietGitCommand(canonical, "describe" + argumentsForGitDescribe);
     return gitDescribe;
   }
 
@@ -126,11 +145,11 @@ private String getArgumentsForGitDescribe(GitDescribeConfig describeConfig) {
 
   @Override
   protected String getCommitId() {
-    return tryToRunGitCommand(canonical, "rev-parse HEAD");
+    return runQuietGitCommand(canonical, "rev-parse HEAD");
   }
 
   @Override
-  protected String getAbbrevCommitId() throws MojoExecutionException {
+  protected String getAbbrevCommitId() {
     // we could run: tryToRunGitCommand(canonical, "rev-parse --short="+abbrevLength+" HEAD");
     // but minimum length for --short is 4, our abbrevLength could be 2
     String commitId = getCommitId();
@@ -150,58 +169,35 @@ protected boolean isDirty() throws MojoExecutionException {
 
   @Override
   protected String getCommitAuthorName() {
-    return tryToRunGitCommand(canonical, "log -1 --pretty=format:\"%cn\"");
+    return runQuietGitCommand(canonical, "log -1 --pretty=format:%an");
   }
 
   @Override
   protected String getCommitAuthorEmail() {
-    return tryToRunGitCommand(canonical, "log -1 --pretty=format:\"%ce\"");
+    return runQuietGitCommand(canonical, "log -1 --pretty=format:%ae");
   }
 
   @Override
   protected String getCommitMessageFull() {
-    return tryToRunGitCommand(canonical, "log -1 --pretty=format:\"%B\"");
+    return runQuietGitCommand(canonical, "log -1 --pretty=format:%B");
   }
 
   @Override
   protected String getCommitMessageShort() {
-    return tryToRunGitCommand(canonical, "log -1 --pretty=format:\"%s\"");
+    return runQuietGitCommand(canonical, "log -1 --pretty=format:%s");
   }
 
   @Override
   protected String getCommitTime() {
-    return tryToRunGitCommand(canonical, "log -1 --pretty=format:\"%ci\"");
+    String value =  runQuietGitCommand(canonical, "log -1 --pretty=format:%ct");
+    SimpleDateFormat smf = new SimpleDateFormat(dateFormat);
+    return smf.format(Long.parseLong(value)*1000L);
   }
 
   @Override
-  protected String getTags() throws MojoExecutionException {
-    final String branch = tryToRunGitCommand(canonical, "rev-parse --abbrev-ref HEAD");
-
-    String out = tryToRunGitCommand(canonical, "log -n 1 --pretty=format:'%d'");
-    String[] nms = out
-      .replaceAll("HEAD", "")
-      .replaceAll("\\)", "")
-      .replaceAll("\\(", "")
-      .replaceAll("'", "")
-      .replaceAll("tag: ", "")
-      .replaceAll(",", "")
-      .trim()
-      .split(" ");
-
-
-    ImmutableList<String> cleanTags = FluentIterable.from(Arrays.asList(nms)).
-      transform(new Function<String, String>() {
-        @Override public String apply(String input) {
-          return input.trim();
-        }
-      }).
-      filter(new Predicate<String>() {
-        @Override public boolean apply(String input) {
-          return !input.equals(branch);
-        }
-      }).toList();
-
-    return Joiner.on(",").join(cleanTags);
+  protected String getTags() {
+    final String result = runQuietGitCommand(canonical, "tag --contains");
+    return result.replace('\n', ',');
   }
 
   @Override
@@ -215,70 +211,67 @@ protected void finalCleanUp() {
 
   private String getOriginRemote(File directory) throws MojoExecutionException {
     String remoteUrl = null;
-    try {
-      String remotes = runGitCommand(directory, "remote -v");
+    String remotes = runQuietGitCommand(directory, "remote -v");
 
-      // welcome to text output parsing hell! - no `\n` is not enough
-      for (String line : Splitter.onPattern("\\((fetch|push)\\)?").split(remotes)) {
-        String trimmed = line.trim();
+    // welcome to text output parsing hell! - no `\n` is not enough
+    for (String line : Splitter.onPattern("\\((fetch|push)\\)?").split(remotes)) {
+      String trimmed = line.trim();
 
-        if (trimmed.startsWith("origin")) {
-          String[] splited = trimmed.split("\\s+");
-          if (splited.length != REMOTE_COLS - 1) { // because (fetch/push) was trimmed
-            throw new MojoExecutionException("Unsupported GIT output (verbose remote address): " + line);
-          }
-          remoteUrl = splited[1];
+      if (trimmed.startsWith("origin")) {
+        String[] splited = trimmed.split("\\s+");
+        if (splited.length != REMOTE_COLS - 1) { // because (fetch/push) was trimmed
+          throw new MojoExecutionException("Unsupported GIT output (verbose remote address): " + line);
         }
+        remoteUrl = splited[1];
       }
-    } catch (Exception e) {
-      throw new MojoExecutionException("Error while obtaining origin remote", e);
     }
     return remoteUrl;
   }
 
-  private String tryToRunGitCommand(File directory, String gitCommand) {
-    String retValue = "";
-    try {
-      retValue = runGitCommand(directory, gitCommand);
-    } catch (MojoExecutionException ex) {
-      // do nothing
-    }
-    return retValue;
-  }
-
   /**
    * Runs a maven command and returns {@code true} if output was non empty.
    * Can be used to short cut reading output from command when we know it may be a rather long one.
-   * */
+   *
+   * Return true if the result is empty.
+   *
+   **/
   private boolean tryCheckEmptyRunGitCommand(File directory, String gitCommand) {
     try {
       String env = System.getenv("GIT_PATH");
       String exec = (env == null) ? "git" : env;
       String command = String.format("%s %s", exec, gitCommand);
 
-      boolean empty = getRunner().runEmpty(directory, command);
-      return !empty;
+      return getRunner().runEmpty(directory, command);
     } catch (IOException ex) {
+        // Error means "non-empty"
       return false;
       // do nothing...
     }
   }
 
-  private String runGitCommand(File directory, String gitCommand) throws MojoExecutionException {
+  private String runQuietGitCommand(File directory, String gitCommand) {
+    final String env = System.getenv("GIT_PATH");
+    final String exec = (env == null) ? "git" : env;
+    final String command = String.format("%s %s", exec, gitCommand);
+
     try {
-      final String env = System.getenv("GIT_PATH");
-      final String exec = (env == null) ? "git" : env;
-      final String command = String.format("%s %s", exec, gitCommand);
+      return getRunner().run(directory, command.trim()).trim();
+    } catch (IOException e) {
+      throw Throwables.propagate(e);
+    }
+  }
 
-      final String result = getRunner().run(directory, command.trim()).trim();
-      return result;
-    } catch (IOException ex) {
-      if (ex.getMessage().contains("exited with invalid status")) {
-        throw new RuntimeException("Failed to execute git command (`git " + gitCommand + "` @ " + directory +")!", ex);
-      } else {
-        throw new MojoExecutionException("Could not run GIT command - GIT is not installed or not exists in system path? " +
-                                           "Tried to run: 'git " + gitCommand + "'", ex);
-      }
+  private String runGitCommand(File directory, String gitCommand) throws NativeCommandException {
+    final String env = System.getenv("GIT_PATH");
+    final String exec = (env == null) ? "git" : env;
+    final String command = String.format("%s %s", exec, gitCommand);
+
+    try {
+      return getRunner().run(directory, command.trim()).trim();
+    } catch (NativeCommandException e) {
+      throw e;
+    } catch (IOException e) {
+      throw Throwables.propagate(e);
     }
   }
 
@@ -296,6 +289,52 @@ public interface ProcessRunner {
     boolean runEmpty(File directory, String command) throws IOException;
   }
 
+  public static class NativeCommandException extends IOException
+  {
+    private final int exitCode;
+    private final String command;
+    private final File directory;
+    private final String stdout;
+    private final String stderr;
+
+    public NativeCommandException(int exitCode,
+                                  String command,
+                                  File directory,
+                                  String stdout,
+                                  String stderr) {
+      this.exitCode = exitCode;
+      this.command = command;
+      this.directory = directory;
+      this.stdout = stdout;
+      this.stderr = stderr;
+    }
+
+    public int getExitCode() {
+      return exitCode;
+    }
+
+    public String getCommand() {
+      return command;
+    }
+
+    public File getDirectory() {
+      return directory;
+    }
+
+    public String getStdout() {
+      return stdout;
+    }
+
+    public String getStderr() {
+      return stderr;
+    }
+
+    @Override
+    public String getMessage() {
+      return format("Git command exited with invalid status [%d]: stdout: `%s`, stderr: `%s`", exitCode, stdout, stderr);
+    }
+  }
+
   protected static class JavaProcessRunner implements ProcessRunner {
     @Override
         public String run(File directory, String command) throws IOException {
@@ -311,14 +350,12 @@ public String run(File directory, String command) throws IOException {
             final StringBuilder commandResult = new StringBuilder();
             String line;
             while ((line = reader.readLine()) != null) {
-              commandResult.append(line);
+              commandResult.append(line).append("\n");
             }
 
             if (proc.exitValue() != 0) {
               final StringBuilder errMsg = readStderr(err);
-
-              final String message = String.format("Git command exited with invalid status [%d]: stdout: `%s`, stderr: `%s`", proc.exitValue(), output, errMsg.toString());
-              throw new IOException(message);
+              throw new NativeCommandException(proc.exitValue(), command, directory, output, errMsg.toString());
             }
             output = commandResult.toString();
           } catch (InterruptedException ex) {