Clean up logging

tpaxatb · tpaxatb · commit b08357d33c66 · 2019-03-21T11:04:35.000-04:00
Consolidate all the logging calls that was separated out into the base
Task class rather than confusing multiple locations.
diff --git a/src/GitVersionTask/BuildLogger.cs b/src/GitVersionTask/BuildLogger.cs
diff --git a/src/GitVersionTask/GenerateGitVersionInformation.cs b/src/GitVersionTask/GenerateGitVersionInformation.cs
@@ -8,12 +8,8 @@ namespace GitVersionTask
 
     public class GenerateGitVersionInformation : GitVersionTaskBase
     {
-        TaskLogger logger;
-
         public GenerateGitVersionInformation()
         {
-            logger = new TaskLogger(this);
-            Logger.SetLoggers(this.LogDebug, this.LogInfo, this.LogWarning, s => this.LogError(s));
         }
 
         [Required]
@@ -42,12 +38,12 @@ public override bool Execute()
             }
             catch (WarningException errorException)
             {
-                logger.LogWarning(errorException.Message);
+                this.LogWarning(errorException.Message);
                 return true;
             }
             catch (Exception exception)
             {
-                logger.LogError("Error occurred: " + exception);
+                this.LogError("Error occurred: " + exception);
                 return false;
             }
         }
diff --git a/src/GitVersionTask/GetVersion.cs b/src/GitVersionTask/GetVersion.cs
@@ -7,12 +7,8 @@ namespace GitVersionTask
 
     public class GetVersion : GitVersionTaskBase
     {
-        TaskLogger logger;
-
         public GetVersion()
         {
-            logger = new TaskLogger(this);
-            Logger.SetLoggers(this.LogDebug, this.LogInfo, this.LogWarning, s => this.LogError(s));
         }
 
         [Required]
@@ -128,12 +124,12 @@ public override bool Execute()
             }
             catch (WarningException errorException)
             {
-                logger.LogWarning(errorException.Message);
+                this.LogWarning(errorException.Message);
                 return true;
             }
             catch (Exception exception)
             {
-                logger.LogError("Error occurred: " + exception);
+                this.LogError("Error occurred: " + exception);
                 return false;
             }
         }
diff --git a/src/GitVersionTask/GitVersionTaskBase.cs b/src/GitVersionTask/GitVersionTaskBase.cs
@@ -3,6 +3,7 @@
     using GitVersion;
     using GitVersion.Helpers;
 
+    using Microsoft.Build.Framework;
     using Microsoft.Build.Utilities;
 
     public abstract class GitVersionTaskBase : Task
@@ -13,11 +14,32 @@ protected GitVersionTaskBase()
         {
             var fileSystem = new FileSystem();
             executeCore = new ExecuteCore(fileSystem);
+            GitVersion.Logger.SetLoggers(this.LogDebug, this.LogInfo, this.LogWarning, s => this.LogError(s));
         }
 
         protected ExecuteCore ExecuteCore
         {
             get { return executeCore; }
         }
+
+        public void LogDebug(string message)
+        {
+            this.BuildEngine.LogMessageEvent(new BuildMessageEventArgs(message, string.Empty, "GitVersionTask", MessageImportance.Low));
+        }
+
+        public void LogWarning(string message)
+        {
+            this.BuildEngine.LogWarningEvent(new BuildWarningEventArgs(string.Empty, string.Empty, null, 0, 0, 0, 0, message, string.Empty, "GitVersionTask"));
+        }
+
+        public void LogInfo(string message)
+        {
+            this.BuildEngine.LogMessageEvent(new BuildMessageEventArgs(message, string.Empty, "GitVersionTask", MessageImportance.Normal));
+        }
+
+        public void LogError(string message, string file = null)
+        {
+            this.BuildEngine.LogErrorEvent(new BuildErrorEventArgs(string.Empty, string.Empty, file, 0, 0, 0, 0, message, string.Empty, "GitVersionTask"));
+        }
     }
 }
diff --git a/src/GitVersionTask/TaskLogger.cs b/src/GitVersionTask/TaskLogger.cs
diff --git a/src/GitVersionTask/UpdateAssemblyInfo.cs b/src/GitVersionTask/UpdateAssemblyInfo.cs
@@ -9,12 +9,8 @@ namespace GitVersionTask
 
     public class UpdateAssemblyInfo : GitVersionTaskBase
     {
-        TaskLogger logger;
-
         public UpdateAssemblyInfo()
         {
-            logger = new TaskLogger(this);
-            Logger.SetLoggers(this.LogDebug, this.LogInfo, this.LogWarning, s => this.LogError(s));
         }
 
         [Required]
@@ -46,12 +42,12 @@ public override bool Execute()
             }
             catch (WarningException errorException)
             {
-                logger.LogWarning(errorException.Message);
+                this.LogWarning(errorException.Message);
                 return true;
             }
             catch (Exception exception)
             {
-                logger.LogError("Error occurred: " + exception);
+                this.LogError("Error occurred: " + exception);
                 return false;
             }
         }
diff --git a/src/GitVersionTask/WriteVersionInfoToBuildLog.cs b/src/GitVersionTask/WriteVersionInfoToBuildLog.cs
@@ -7,12 +7,8 @@ namespace GitVersionTask
 
     public class WriteVersionInfoToBuildLog : GitVersionTaskBase
     {
-        readonly TaskLogger logger;
-
         public WriteVersionInfoToBuildLog()
         {
-            logger = new TaskLogger(this);
-            Logger.SetLoggers(this.LogDebug, this.LogInfo, this.LogWarning, s => this.LogError(s));
         }
 
         [Required]
@@ -29,12 +25,12 @@ public override bool Execute()
             }
             catch (WarningException errorException)
             {
-                logger.LogWarning(errorException.Message);
+                this.LogWarning(errorException.Message);
                 return true;
             }
             catch (Exception exception)
             {
-                logger.LogError("Error occurred: " + exception);
+                this.LogError("Error occurred: " + exception);
                 return false;
             }
         }
@@ -54,12 +50,12 @@ void WriteIntegrationParameters(IEnumerable<IBuildServer> applicableBuildServers
         {
             foreach (var buildServer in applicableBuildServers)
             {
-                logger.LogInfo(string.Format("Executing GenerateSetVersionMessage for '{0}'.", buildServer.GetType().Name));
-                logger.LogInfo(buildServer.GenerateSetVersionMessage(variables));
-                logger.LogInfo(string.Format("Executing GenerateBuildLogOutput for '{0}'.", buildServer.GetType().Name));
+                this.LogInfo(string.Format("Executing GenerateSetVersionMessage for '{0}'.", buildServer.GetType().Name));
+                this.LogInfo(buildServer.GenerateSetVersionMessage(variables));
+                this.LogInfo(string.Format("Executing GenerateBuildLogOutput for '{0}'.", buildServer.GetType().Name));
                 foreach (var buildParameter in BuildOutputFormatter.GenerateBuildLogOutput(buildServer, variables))
                 {
-                    logger.LogInfo(buildParameter);
+                    this.LogInfo(buildParameter);
                 }
             }
         }

Original file line number	Diff line number	Diff line change
`@@ -8,12 +8,8 @@ namespace GitVersionTask`
`8`	`8`
`9`	`9`	`public class GenerateGitVersionInformation : GitVersionTaskBase`
`10`	`10`	`{`
`11`		`- TaskLogger logger;`
`12`		`-`
`13`	`11`	`public GenerateGitVersionInformation()`
`14`	`12`	`{`
`15`		`- logger = new TaskLogger(this);`
`16`		`- Logger.SetLoggers(this.LogDebug, this.LogInfo, this.LogWarning, s => this.LogError(s));`
`17`	`13`	`}`
`18`	`14`
`19`	`15`	`[Required]`
`@@ -42,12 +38,12 @@ public override bool Execute()`
`42`	`38`	`}`
`43`	`39`	`catch (WarningException errorException)`
`44`	`40`	`{`
`45`		`- logger.LogWarning(errorException.Message);`
	`41`	`+ this.LogWarning(errorException.Message);`
`46`	`42`	`return true;`
`47`	`43`	`}`
`48`	`44`	`catch (Exception exception)`
`49`	`45`	`{`
`50`		`- logger.LogError("Error occurred: " + exception);`
	`46`	`+ this.LogError("Error occurred: " + exception);`
`51`	`47`	`return false;`
`52`	`48`	`}`
`53`	`49`	`}`
Original file line number	Diff line number	Diff line change
`@@ -7,12 +7,8 @@ namespace GitVersionTask`
`7`	`7`
`8`	`8`	`public class GetVersion : GitVersionTaskBase`
`9`	`9`	`{`
`10`		`- TaskLogger logger;`
`11`		`-`
`12`	`10`	`public GetVersion()`
`13`	`11`	`{`
`14`		`- logger = new TaskLogger(this);`
`15`		`- Logger.SetLoggers(this.LogDebug, this.LogInfo, this.LogWarning, s => this.LogError(s));`
`16`	`12`	`}`
`17`	`13`
`18`	`14`	`[Required]`
`@@ -128,12 +124,12 @@ public override bool Execute()`
`128`	`124`	`}`
`129`	`125`	`catch (WarningException errorException)`
`130`	`126`	`{`
`131`		`- logger.LogWarning(errorException.Message);`
	`127`	`+ this.LogWarning(errorException.Message);`
`132`	`128`	`return true;`
`133`	`129`	`}`
`134`	`130`	`catch (Exception exception)`
`135`	`131`	`{`
`136`		`- logger.LogError("Error occurred: " + exception);`
	`132`	`+ this.LogError("Error occurred: " + exception);`
`137`	`133`	`return false;`
`138`	`134`	`}`
`139`	`135`	`}`
Original file line number	Diff line number	Diff line change
`@@ -9,12 +9,8 @@ namespace GitVersionTask`
`9`	`9`
`10`	`10`	`public class UpdateAssemblyInfo : GitVersionTaskBase`
`11`	`11`	`{`
`12`		`- TaskLogger logger;`
`13`		`-`
`14`	`12`	`public UpdateAssemblyInfo()`
`15`	`13`	`{`
`16`		`- logger = new TaskLogger(this);`
`17`		`- Logger.SetLoggers(this.LogDebug, this.LogInfo, this.LogWarning, s => this.LogError(s));`
`18`	`14`	`}`
`19`	`15`
`20`	`16`	`[Required]`
`@@ -46,12 +42,12 @@ public override bool Execute()`
`46`	`42`	`}`
`47`	`43`	`catch (WarningException errorException)`
`48`	`44`	`{`
`49`		`- logger.LogWarning(errorException.Message);`
	`45`	`+ this.LogWarning(errorException.Message);`
`50`	`46`	`return true;`
`51`	`47`	`}`
`52`	`48`	`catch (Exception exception)`
`53`	`49`	`{`
`54`		`- logger.LogError("Error occurred: " + exception);`
	`50`	`+ this.LogError("Error occurred: " + exception);`
`55`	`51`	`return false;`
`56`	`52`	`}`
`57`	`53`	`}`
Original file line number	Diff line number	Diff line change
`@@ -7,12 +7,8 @@ namespace GitVersionTask`
`7`	`7`
`8`	`8`	`public class WriteVersionInfoToBuildLog : GitVersionTaskBase`
`9`	`9`	`{`
`10`		`- readonly TaskLogger logger;`
`11`		`-`
`12`	`10`	`public WriteVersionInfoToBuildLog()`
`13`	`11`	`{`
`14`		`- logger = new TaskLogger(this);`
`15`		`- Logger.SetLoggers(this.LogDebug, this.LogInfo, this.LogWarning, s => this.LogError(s));`
`16`	`12`	`}`
`17`	`13`
`18`	`14`	`[Required]`
`@@ -29,12 +25,12 @@ public override bool Execute()`
`29`	`25`	`}`
`30`	`26`	`catch (WarningException errorException)`
`31`	`27`	`{`
`32`		`- logger.LogWarning(errorException.Message);`
	`28`	`+ this.LogWarning(errorException.Message);`
`33`	`29`	`return true;`
`34`	`30`	`}`
`35`	`31`	`catch (Exception exception)`
`36`	`32`	`{`
`37`		`- logger.LogError("Error occurred: " + exception);`
	`33`	`+ this.LogError("Error occurred: " + exception);`
`38`	`34`	`return false;`
`39`	`35`	`}`
`40`	`36`	`}`
`@@ -54,12 +50,12 @@ void WriteIntegrationParameters(IEnumerable<IBuildServer> applicableBuildServers`
`54`	`50`	`{`
`55`	`51`	`foreach (var buildServer in applicableBuildServers)`
`56`	`52`	`{`
`57`		`- logger.LogInfo(string.Format("Executing GenerateSetVersionMessage for '{0}'.", buildServer.GetType().Name));`
`58`		`- logger.LogInfo(buildServer.GenerateSetVersionMessage(variables));`
`59`		`- logger.LogInfo(string.Format("Executing GenerateBuildLogOutput for '{0}'.", buildServer.GetType().Name));`
	`53`	`+ this.LogInfo(string.Format("Executing GenerateSetVersionMessage for '{0}'.", buildServer.GetType().Name));`
	`54`	`+ this.LogInfo(buildServer.GenerateSetVersionMessage(variables));`
	`55`	`+ this.LogInfo(string.Format("Executing GenerateBuildLogOutput for '{0}'.", buildServer.GetType().Name));`
`60`	`56`	`foreach (var buildParameter in BuildOutputFormatter.GenerateBuildLogOutput(buildServer, variables))`
`61`	`57`	`{`
`62`		`- logger.LogInfo(buildParameter);`
	`58`	`+ this.LogInfo(buildParameter);`
`63`	`59`	`}`
`64`	`60`	`}`
`65`	`61`	`}`