When there is an unexpected exception dump the commit graph for debugging purposes

Author: JakeGinnivan

GitVersionCore.Tests/Helpers/GitTestExtensions.cs

@@ -1,42 +1,13 @@
 using System;
-using System.Diagnostics;
 using System.IO;
 using System.Linq;
-using System.Text;
 using GitVersion;
-using GitVersion.Helpers;
 using LibGit2Sharp;
 
 public static class GitTestExtensions
 {
     static int pad = 1;
 
-    public static void DumpGraph(this IRepository repository)
-    {
-        var output = new StringBuilder();
-
-        try
-        {
-            ProcessHelper.Run(
-                o => output.AppendLine(o),
-                e => output.AppendLineFormat("ERROR: {0}", e),
-                null,
-                "git",
-                @"log --graph --abbrev-commit --decorate --date=relative --all --remotes=*",
-                repository.Info.Path);
-        }
-        catch (FileNotFoundException exception)
-        {
-            if (exception.FileName != "git")
-                throw;
-
-            output.AppendLine("Could not execute 'git log' due to the following error:");
-            output.AppendLine(exception.ToString());
-        }
-
-        Trace.Write(output.ToString());
-    }
-
     public static Commit MakeACommit(this IRepository repository)
     {
         return CreateFileAndCommit(repository, Guid.NewGuid().ToString());

GitVersionCore/LibGitExtensions.cs

@@ -2,8 +2,11 @@ namespace GitVersion
 {
     using System;
     using System.Collections.Generic;
+    using System.Diagnostics;
     using System.IO;
     using System.Linq;
+    using System.Text;
+    using GitVersion.Helpers;
     using LibGit2Sharp;
 
     static class LibGitExtensions
@@ -174,5 +177,40 @@ public static void CheckoutFilesIfExist(this IRepository repository, params stri
                 }
             }
         }
+
+        public static void DumpGraph(this IRepository repository, Action<string> writer = null, int? maxCommits = null)
+        {
+            DumpGraph(repository.Info.Path, writer, maxCommits);
+        }
+
+        public static void DumpGraph(string workingDirectory, Action<string> writer = null, int? maxCommits = null)
+        {
+            var output = new StringBuilder();
+
+            try
+            {
+                ProcessHelper.Run(
+                    o => output.AppendLine(o),
+                    e => output.AppendLineFormat("ERROR: {0}", e),
+                    null,
+                    "git",
+                    @"log --graph --format=""%h %cr %d"" --decorate --date=relative --all --remotes=*" + (maxCommits != null ? string.Format(" -n {0}", maxCommits) : null),
+                    //@"log --graph --abbrev-commit --decorate --date=relative --all --remotes=*",
+                    workingDirectory);
+            }
+            catch (FileNotFoundException exception)
+            {
+                if (exception.FileName != "git")
+                {
+                    throw;
+                }
+
+                output.AppendLine("Could not execute 'git log' due to the following error:");
+                output.AppendLine(exception.ToString());
+            }
+
+            if (writer != null) writer(output.ToString());
+            else Trace.Write(output.ToString());
+        }
     }
 }

GitVersionExe/Program.cs

@@ -32,11 +32,11 @@ static void Main()
 
         static int VerifyArgumentsAndRun()
         {
+            Arguments arguments = null;
             try
             {
                 var fileSystem = new FileSystem();
 
-                Arguments arguments;
                 var argumentsWithoutExeName = GetArgumentsWithoutExeName();
                 try
                 {
@@ -99,6 +99,14 @@ static int VerifyArgumentsAndRun()
             {
                 var error = string.Format("An unexpected error occurred:\r\n{0}", exception);
                 Logger.WriteError(error);
+
+                if (arguments != null)
+                {
+                    Logger.WriteInfo(string.Empty);
+                    Logger.WriteInfo("Here is the current git graph (please include in issue): ");
+                    Logger.WriteInfo("Showing max of 100 commits");
+                    LibGitExtensions.DumpGraph(arguments.TargetPath, Logger.WriteInfo, 100);
+                }
                 return 1;
             }