(GH-118) Update to different handling of logging

resolves #118
codecov · Jun 23, 2020 · 856c5d7 · 856c5d7
1 parent 897fbaa
commit 856c5d7
Show file tree

Hide file tree

Showing 12 changed files with 81 additions and 88 deletions.
diff --git a/Source/Codecov.Tests/Coverage/Tool/CoverageTests.cs b/Source/Codecov.Tests/Coverage/Tool/CoverageTests.cs
@@ -1,4 +1,4 @@
-using System;
+using System;
 using System.IO;
 using System.Linq;
 using Codecov.Coverage.Tool;
@@ -15,7 +15,6 @@ public void CoverageReport_Should_Be_Empty_If_The_File_Does_Not_Exits(string fil
         {
             // Given
             var options = Substitute.For<ICoverageOptions>();
-            Logger.Log.Create(false, false);
             options.Files.Returns(new[] { fileData });
             var coverage = new Codecov.Coverage.Tool.Coverage(options);
 

diff --git a/Source/Codecov/Codecov.csproj b/Source/Codecov/Codecov.csproj
@@ -29,8 +29,8 @@
         <PackageReference Include="Glob" Version="1.1.6" />
         <PackageReference Include="JetBrains.Annotations" Version="2020.1.0" />
         <PackageReference Include="Serilog" Version="2.9.0" />
-        <PackageReference Include="Serilog.Sinks.ColoredConsole" Version="3.0.1" />
         <PackageReference Include="Serilog.Sinks.Console" Version="3.1.1" />
+        <PackageReference Include="Serilog.Sinks.Debug" Version="1.0.1" PrivateAssets="all" />
         <PackageReference Include="StyleCop.Analyzers" Version="1.1.118" PrivateAssets="all" />
         <PackageReference Include="System.Diagnostics.Process" Version="4.3.0" />
     </ItemGroup>

diff --git a/Source/Codecov/Coverage/Tool/Coverage.cs b/Source/Codecov/Coverage/Tool/Coverage.cs
@@ -4,6 +4,7 @@
 using System.Linq;
 using Codecov.Exceptions;
 using GlobExpressions;
+using Serilog;
 
 namespace Codecov.Coverage.Tool
 {
@@ -29,7 +30,7 @@ private static bool VerifyReportFileAndExpandGlobPatterns(string path, out IEnum
             expandedPath = expanded;
             if (string.IsNullOrWhiteSpace(path))
             {
-                Logger.Log.Warning("Invalid report path.");
+                Log.Warning("Invalid report path.");
                 return false;
             }
 
@@ -51,7 +52,7 @@ private static bool VerifyReportFileAndExpandGlobPatterns(string path, out IEnum
             }
             else if (!File.Exists(path))
             {
-                Logger.Log.Warning($"The file {path} does not exist.");
+                Log.Warning($"The file {path} does not exist.");
                 return false;
             }
 

diff --git a/Source/Codecov/Logger/Log.cs b/Source/Codecov/Logger/Log.cs
diff --git a/Source/Codecov/Logging/LogConfiguration.cs b/Source/Codecov/Logging/LogConfiguration.cs
@@ -0,0 +1,58 @@
+using System.Diagnostics;
+using Codecov.Program;
+using Serilog;
+using Serilog.Events;
+using Serilog.Sinks.SystemConsole.Themes;
+
+namespace Codecov.Logging
+{
+    internal static class LogConfiguration
+    {
+        private const string ConsoleFullTemplate = "[{Level:u3}] " + ConsoleInfoTemplate;
+        private const string ConsoleInfoTemplate = "{Message:l}{NewLine}{Exception}";
+        private static readonly ConsoleTheme _consoleTheme = AnsiConsoleTheme.Code;
+        private static readonly ConsoleTheme _noColorTheme = ConsoleTheme.None;
+
+        public static void ConfigureLogging(CommandLineOptions options)
+        {
+            var config = new LoggerConfiguration()
+                .MinimumLevel.Verbose();
+
+            CreateDebugLogger(config);
+            CreateConsoleInformationLogger(config, ConsoleInfoTemplate, options);
+            CreateConsoleFullLogger(config, ConsoleFullTemplate, options);
+
+            Log.Logger = config.CreateLogger();
+        }
+
+        private static void CreateConsoleFullLogger(LoggerConfiguration config, string consoleTemplate, CommandLineOptions options)
+        {
+            var color = options.NoColor ? _noColorTheme : _consoleTheme;
+
+            config.WriteTo.Logger((config) => config
+                .Filter.ByExcluding((logEvent) => !options.Verbose && logEvent.Level == LogEventLevel.Verbose)
+                .Filter.ByExcluding((logEvent) => logEvent.Level == LogEventLevel.Information)
+                .WriteTo.Console(
+                    outputTemplate: consoleTemplate,
+                    standardErrorFromLevel: LogEventLevel.Warning,
+                    theme: color));
+        }
+
+        private static void CreateConsoleInformationLogger(LoggerConfiguration config, string consoleTemplate, CommandLineOptions options)
+        {
+            var color = options.NoColor ? _noColorTheme : _consoleTheme;
+
+            config.WriteTo.Logger((config) => config
+                .Filter.ByIncludingOnly((logEvent) => logEvent.Level == LogEventLevel.Information)
+                .WriteTo.Console(
+                    outputTemplate: consoleTemplate,
+                    theme: color));
+        }
+
+        [Conditional("DEBUG")]
+        private static void CreateDebugLogger(LoggerConfiguration config)
+        {
+            config.WriteTo.Debug();
+        }
+    }
+}
diff --git a/Source/Codecov/Program/Run.cs b/Source/Codecov/Program/Run.cs
@@ -1,9 +1,9 @@
-using System;
+using System;
 using System.Collections.Generic;
-using Codecov.Logger;
 using Codecov.Upload;
 using Codecov.Utilities;
 using CommandLine;
+using Serilog;
 
 namespace Codecov.Program
 {
@@ -30,7 +30,7 @@ internal static int Runner(IEnumerable<string> args)
             {
                 // Cleaning up undisposed fields/Properties
                 CodecovUploader.Cleanup();
-                Log.Cleanup();
+                Log.CloseAndFlush();
             }
         }
 
@@ -41,7 +41,7 @@ private static void Init(IEnumerable<string> args)
         {
             ParseAndSetCommandLineArgs(args);
             ConfigureHowProgramExitsOnFail();
-            Log.Create(_commandLineOptions.Verbose, _commandLineOptions.NoColor);
+            Logging.LogConfiguration.ConfigureLogging(_commandLineOptions);
             About.DisplayFiglet();
         }
 

diff --git a/Source/Codecov/Program/UploadFacade.cs b/Source/Codecov/Program/UploadFacade.cs
@@ -7,7 +7,6 @@
 using Codecov.Coverage.SourceCode;
 using Codecov.Coverage.Tool;
 using Codecov.Factories;
-using Codecov.Logger;
 using Codecov.Services;
 using Codecov.Services.ContinuousIntegrationServers;
 using Codecov.Services.VersionControlSystems;
@@ -16,6 +15,7 @@
 using Codecov.Url;
 using Codecov.Utilities;
 using Codecov.Yaml;
+using Serilog;
 
 namespace Codecov.Program
 {
@@ -73,7 +73,7 @@ public void Uploader()
             }
             else if (ci.Equals("TeamCity"))
             {
-                Log.Information("TeamCity detected.");
+                Log.Information($"{ci} detected.");
                 if (string.IsNullOrWhiteSpace(ContinuousIntegrationServer.Branch))
                 {
                     Log.Warning("Teamcity does not automatically make build parameters available as environment variables.\nAdd the following environment parameters to the build configuration.\nenv.TEAMCITY_BUILD_BRANCH = %teamcity.build.branch%.\nenv.TEAMCITY_BUILD_ID = %teamcity.build.id%.\nenv.TEAMCITY_BUILD_URL = %teamcity.serverUrl%/viewLog.html?buildId=%teamcity.build.id%.\nenv.TEAMCITY_BUILD_COMMIT = %system.build.vcs.number%.\nenv.TEAMCITY_BUILD_REPOSITORY = %vcsroot.<YOUR TEAMCITY VCS NAME>.url%.");
@@ -130,7 +130,7 @@ public void Uploader()
             Log.Information($"query: {DisplayUrl}");
 
             var response = Upload.Uploader();
-            Log.Verboase($"response: {response}");
+            Log.Verbose($"response: {response}");
             var splitResponse = response.Split('\n');
             if (splitResponse.Length > 1)
             {

diff --git a/Source/Codecov/Terminal/Terminal.cs b/Source/Codecov/Terminal/Terminal.cs
@@ -2,7 +2,7 @@
 using System.Text;
 using System.Threading;
 using Codecov.Exceptions;
-using Codecov.Logger;
+using Serilog;
 
 namespace Codecov.Terminal
 {
@@ -78,7 +78,7 @@ public virtual string Run(string command, string commandArguments)
             }
             catch (TerminalException ex)
             {
-                Log.VerboaseException(ex);
+                Log.Verbose(ex, "Exception while running the terminal.");
                 return string.Empty;
             }
         }

diff --git a/Source/Codecov/Upload/CodecovFallbackUploader.cs b/Source/Codecov/Upload/CodecovFallbackUploader.cs
@@ -1,8 +1,8 @@
 using System;
 using System.Net.Http;
 using Codecov.Coverage.Report;
-using Codecov.Logger;
 using Codecov.Url;
+using Serilog;
 
 namespace Codecov.Upload
 {

diff --git a/Source/Codecov/Upload/CodecovUploader.cs b/Source/Codecov/Upload/CodecovUploader.cs
@@ -6,8 +6,8 @@
 using System.Reflection;
 using System.Text;
 using Codecov.Coverage.Report;
-using Codecov.Logger;
 using Codecov.Url;
+using Serilog;
 
 namespace Codecov.Upload
 {
@@ -58,7 +58,7 @@ protected virtual HttpResponseMessage CreateResponse(HttpRequestMessage request)
 
         protected override string Post()
         {
-            Log.Verboase("Trying to upload using HttpClient");
+            Log.Verbose("Trying to upload using HttpClient");
             using (var request = new HttpRequestMessage(new HttpMethod("POST"), Url.GetUrl))
             {
                 request.Headers.TryAddWithoutValidation("X-Reduced-Redundancy", "false");

diff --git a/Source/Codecov/Upload/Upload.cs b/Source/Codecov/Upload/Upload.cs
@@ -1,7 +1,7 @@
-using System;
+using System;
 using Codecov.Coverage.Report;
-using Codecov.Logger;
 using Codecov.Url;
+using Serilog;
 
 namespace Codecov.Upload
 {
@@ -28,7 +28,7 @@ public string Uploader()
                 var response = Post();
                 if (string.IsNullOrWhiteSpace(response))
                 {
-                    Log.Verboase("Failed to ping codecov.");
+                    Log.Verbose("Failed to ping codecov.");
                     return string.Empty;
                 }
 
@@ -43,7 +43,7 @@ public string Uploader()
             }
             catch (Exception ex)
             {
-                Log.VerboaseException(ex);
+                Log.Verbose(ex, "Error during uploading.");
                 return string.Empty;
             }
         }

diff --git a/Source/Codecov/Upload/Uploads.cs b/Source/Codecov/Upload/Uploads.cs
@@ -3,8 +3,8 @@
 using System.Linq;
 using Codecov.Coverage.Report;
 using Codecov.Exceptions;
-using Codecov.Logger;
 using Codecov.Url;
+using Serilog;
 
 namespace Codecov.Upload
 {
@@ -29,7 +29,7 @@ public string Uploader()
                     return response;
                 }
 
-                Log.Verboase("Uploader failed.");
+                Log.Verbose("Uploader failed.");
             }
 
             throw new UploadException("Failed to upload the report.");