Merge pull request #384 from ViktorHofer/LogLevel

Add log level option

Author: tonerdo

README.md

@@ -61,6 +61,7 @@ Options:
   -t|--target             Path to the test runner application.
   -a|--targetargs         Arguments to be passed to the test runner.
   -o|--output             Output of the generated coverage report
+  -v|--verbosity          Sets the verbosity level of the command. Allowed values are quiet, minimal, normal, detailed.
   -f|--format             Format of the generated coverage report.
   --threshold             Exits with error if the coverage % is below value.
   --threshold-type        Coverage type to apply the threshold to.
@@ -69,10 +70,10 @@ Options:
   --include               Filter expressions to include specific modules and types.
   --include-directory     Include directories containing additional assemblies to be instrumented.
   --exclude-by-file       Glob patterns specifying source files to exclude.
-  --include-directory     Include directories containing additional assemblies to be instrumented.
   --exclude-by-attribute  Attributes to exclude from code coverage.
   --merge-with            Path to existing coverage result to merge.
   --use-source-link       Specifies whether to use SourceLink URIs in place of file system paths.
+  --single-hit            Specifies whether to limit code coverage hit reporting to a single hit for each location.
 ```
 
 #### Code Coverage

src/coverlet.console/Logging/ConsoleLogger.cs

@@ -7,19 +7,22 @@ namespace Coverlet.Console.Logging
     class ConsoleLogger : ILogger
     {
         private static readonly object _sync = new object();
+        public LogLevel Level { get; set; } = LogLevel.Normal;
 
-        public void LogError(string message) => Log(message, ConsoleColor.Red);
+        public void LogError(string message) => Log(LogLevel.Quiet, message, ConsoleColor.Red);
 
         public void LogError(Exception exception) => LogError(exception.ToString());
 
-        public void LogInformation(string message) => Log(message, ForegroundColor);
+        public void LogInformation(string message, bool important = false) => Log(important ? LogLevel.Minimal : LogLevel.Normal, message, ForegroundColor);
 
-        public void LogVerbose(string message) => throw new NotImplementedException();
+        public void LogVerbose(string message) => Log(LogLevel.Detailed, message, ForegroundColor);
 
-        public void LogWarning(string message) => Log(message, ConsoleColor.Yellow);
+        public void LogWarning(string message) => Log(LogLevel.Quiet, message, ConsoleColor.Yellow);
 
-        private void Log(string message, ConsoleColor color)
+        private void Log(LogLevel level, string message, ConsoleColor color)
         {
+            if (level < Level) return;
+
             lock (_sync)
             {
                 ConsoleColor currentForegroundColor;

src/coverlet.console/Logging/LogLevel.cs

@@ -0,0 +1,30 @@
+namespace Coverlet.Console.Logging
+{
+    /// <summary>
+    /// Defines logging severity levels.
+    /// </summary>
+    enum LogLevel
+    {
+        /// <summary>
+        /// Logs that track the general flow of the application. These logs should have long-term value.
+        /// </summary>
+        Detailed = 0,
+
+        /// <summary>
+        /// Logs that highlight an abnormal or unexpected event in the application flow, but do not otherwise cause the
+        /// application execution to stop.
+        /// </summary>
+        Normal = 1,
+
+        /// <summary>
+        /// Logs that highlight when the current flow of execution is stopped due to a failure. These should indicate a
+        /// failure in the current activity, not an application-wide failure.
+        /// </summary>
+        Minimal = 2,
+
+        /// <summary>
+        /// Not used for writing log messages. Specifies that a logging category should not write any messages except warning and errors.
+        /// </summary>
+        Quiet = 3
+    }
+}

src/coverlet.console/Program.cs

@@ -9,8 +9,7 @@
 using Coverlet.Core;
 using Coverlet.Core.Enums;
 using Coverlet.Core.Reporters;
-
-using Microsoft.Extensions.CommandLineUtils;
+using McMaster.Extensions.CommandLineUtils;
 
 namespace Coverlet.Console
 {
@@ -29,6 +28,7 @@ static int Main(string[] args)
             CommandOption target = app.Option("-t|--target", "Path to the test runner application.", CommandOptionType.SingleValue);
             CommandOption targs = app.Option("-a|--targetargs", "Arguments to be passed to the test runner.", CommandOptionType.SingleValue);
             CommandOption output = app.Option("-o|--output", "Output of the generated coverage report", CommandOptionType.SingleValue);
+            CommandOption<LogLevel> verbosity = app.Option<LogLevel>("-v|--verbosity", "Sets the verbosity level of the command. Allowed values are quiet, minimal, normal, detailed.", CommandOptionType.SingleValue);
             CommandOption formats = app.Option("-f|--format", "Format of the generated coverage report.", CommandOptionType.MultipleValue);
             CommandOption threshold = app.Option("--threshold", "Exits with error if the coverage % is below value.", CommandOptionType.SingleValue);
             CommandOption thresholdTypes = app.Option("--threshold-type", "Coverage type to apply the threshold to.", CommandOptionType.MultipleValue);
@@ -51,6 +51,12 @@ static int Main(string[] args)
                 if (!target.HasValue())
                     throw new CommandParsingException(app, "Target must be specified.");
 
+                if (verbosity.HasValue())
+                {
+                    // Adjust log level based on user input.
+                    logger.Level = verbosity.ParsedValue;
+                }
+
                 Coverage coverage = new Coverage(module.Value,
                     includeFilters.Values.ToArray(),
                     includeDirectories.Values.ToArray(),
@@ -73,7 +79,7 @@ static int Main(string[] args)
                 process.OutputDataReceived += (sender, eventArgs) =>
                 {
                     if (!string.IsNullOrEmpty(eventArgs.Data))
-                        logger.LogInformation(eventArgs.Data);
+                        logger.LogInformation(eventArgs.Data, important: true);
                 };
 
                 process.ErrorDataReceived += (sender, eventArgs) =>
@@ -118,8 +124,8 @@ static int Main(string[] args)
                     if (reporter.OutputType == ReporterOutputType.Console)
                     {
                         // Output to console
-                        logger.LogInformation("  Outputting results to console");
-                        logger.LogInformation(reporter.Report(result));
+                        logger.LogInformation("  Outputting results to console", important: true);
+                        logger.LogInformation(reporter.Report(result), important: true);
                     }
                     else
                     {
@@ -129,7 +135,7 @@ static int Main(string[] args)
                         filename = Path.HasExtension(filename) ? filename : $"{filename}.{reporter.Extension}";
 
                         var report = Path.Combine(directory, filename);
-                        logger.LogInformation($"  Generating report '{report}'");
+                        logger.LogInformation($"  Generating report '{report}'", important: true);
                         File.WriteAllText(report, reporter.Report(result));
                     }
                 }

src/coverlet.console/coverlet.console.csproj

@@ -21,7 +21,7 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="Microsoft.Extensions.CommandLineUtils" Version="1.1.1" />
+    <PackageReference Include="McMaster.Extensions.CommandLineUtils" Version="2.3.4" />
   </ItemGroup>
 
   <ItemGroup>

src/coverlet.core/Coverage.cs

@@ -66,9 +66,9 @@ public void PrepareModules()
             string[] modules = InstrumentationHelper.GetCoverableModules(_module, _includeDirectories, _includeTestAssembly);
             string[] excludes = InstrumentationHelper.GetExcludedFiles(_excludedSourceFiles);
 
-            Array.ForEach(_excludeFilters ?? Array.Empty<string>(), filter => _logger.LogInformation($"Excluded module filter '{filter}'"));
-            Array.ForEach(_includeFilters ?? Array.Empty<string>(), filter => _logger.LogInformation($"Included module filter '{filter}'"));
-            Array.ForEach(excludes ?? Array.Empty<string>(), filter => _logger.LogInformation($"Excluded source files '{filter}'"));
+            Array.ForEach(_excludeFilters ?? Array.Empty<string>(), filter => _logger.LogVerbose($"Excluded module filter '{filter}'"));
+            Array.ForEach(_includeFilters ?? Array.Empty<string>(), filter => _logger.LogVerbose($"Included module filter '{filter}'"));
+            Array.ForEach(excludes ?? Array.Empty<string>(), filter => _logger.LogVerbose($"Excluded source files '{filter}'"));
 
             _excludeFilters = _excludeFilters?.Where(f => InstrumentationHelper.IsValidFilterExpression(f)).ToArray();
             _includeFilters = _includeFilters?.Where(f => InstrumentationHelper.IsValidFilterExpression(f)).ToArray();
@@ -78,7 +78,7 @@ public void PrepareModules()
                 if (InstrumentationHelper.IsModuleExcluded(module, _excludeFilters) ||
                     !InstrumentationHelper.IsModuleIncluded(module, _includeFilters))
                 {
-                    _logger.LogInformation($"Excluded module: '{module}'");
+                    _logger.LogVerbose($"Excluded module: '{module}'");
                     continue;
                 }
 
@@ -92,7 +92,7 @@ public void PrepareModules()
                     {
                         var result = instrumenter.Instrument();
                         _results.Add(result);
-                        _logger.LogInformation($"Instrumented module: '{module}'");
+                        _logger.LogVerbose($"Instrumented module: '{module}'");
                     }
                     catch (Exception ex)
                     {

src/coverlet.core/Instrumentation/Instrumenter.cs

@@ -293,7 +293,7 @@ private void InstrumentMethod(MethodDefinition method)
             var sourceFile = method.DebugInformation.SequencePoints.Select(s => s.Document.Url).FirstOrDefault();
             if (!string.IsNullOrEmpty(sourceFile) && _excludedFiles.Contains(sourceFile))
             {
-                _logger.LogInformation($"Excluded source file: '{sourceFile}'");
+                _logger.LogVerbose($"Excluded source file: '{sourceFile}'");
                 return;
             }
 

src/coverlet.core/Logging/ILogger.cs

@@ -5,7 +5,7 @@ namespace Coverlet.Core.Logging
     public interface ILogger
     {
         void LogVerbose(string message);
-        void LogInformation(string message);
+        void LogInformation(string message, bool important = false);
         void LogWarning(string message);
         void LogError(string message);
         void LogError(Exception exception);

src/coverlet.msbuild.tasks/MSBuildLogger.cs

@@ -16,7 +16,7 @@ class MSBuildLogger : ILogger
         public void LogVerbose(string message) => _log.LogMessage(MessageImportance.Low, $"{LogPrefix}{message}");
 
         // We use `MessageImportance.High` because with `MessageImportance.Normal` doesn't show anything
-        public void LogInformation(string message) => _log.LogMessage(MessageImportance.High, $"{LogPrefix}{message}");
+        public void LogInformation(string message, bool important = false) => _log.LogMessage(MessageImportance.High, $"{LogPrefix}{message}");
 
         public void LogWarning(string message) => _log.LogWarning($"{LogPrefix}{message}");