add [coverlet] prefix to logs

Author: MarcoRossignoli

src/coverlet.core/Coverage.cs

@@ -79,7 +79,7 @@ public void PrepareModules()
                     continue;
                 }
 
-                var instrumenter = new Instrumenter(module, _identifier, _excludeFilters, _includeFilters, excludes, _excludeAttributes, _singleHit);
+                var instrumenter = new Instrumenter(module, _identifier, _excludeFilters, _includeFilters, excludes, _excludeAttributes, _singleHit, _logger);
                 if (instrumenter.CanInstrument())
                 {
                     InstrumentationHelper.BackupOriginalModule(module, _identifier);

src/coverlet.core/Instrumentation/Instrumenter.cs

@@ -7,6 +7,7 @@
 
 using Coverlet.Core.Attributes;
 using Coverlet.Core.Helpers;
+using Coverlet.Core.Logging;
 using Coverlet.Core.Symbols;
 
 using Mono.Cecil;
@@ -25,6 +26,7 @@ internal class Instrumenter
         private readonly string[] _excludedAttributes;
         private readonly bool _singleHit;
         private readonly bool _isCoreLibrary;
+        private readonly ILogger _logger;
         private InstrumenterResult _result;
         private FieldDefinition _customTrackerHitsArray;
         private FieldDefinition _customTrackerHitsFilePath;
@@ -35,7 +37,7 @@ internal class Instrumenter
         private MethodReference _customTrackerRecordHitMethod;
         private List<string> _asyncMachineStateMethod;
 
-        public Instrumenter(string module, string identifier, string[] excludeFilters, string[] includeFilters, string[] excludedFiles, string[] excludedAttributes, bool singleHit)
+        public Instrumenter(string module, string identifier, string[] excludeFilters, string[] includeFilters, string[] excludedFiles, string[] excludedAttributes, bool singleHit, ILogger logger)
         {
             _module = module;
             _identifier = identifier;
@@ -44,8 +46,8 @@ public Instrumenter(string module, string identifier, string[] excludeFilters, s
             _excludedFiles = excludedFiles ?? Array.Empty<string>();
             _excludedAttributes = excludedAttributes;
             _singleHit = singleHit;
-
             _isCoreLibrary = Path.GetFileNameWithoutExtension(_module) == "System.Private.CoreLib";
+            _logger = logger;
         }
 
         public bool CanInstrument() => InstrumentationHelper.HasPdb(_module);
@@ -279,7 +281,10 @@ 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}'");
                 return;
+            }
 
             var methodBody = GetMethodBody(method);
             if (methodBody == null)

src/coverlet.msbuild.tasks/MSBuildLogger.cs

@@ -7,19 +7,21 @@ namespace Coverlet.MSbuild.Tasks
 {
     class MSBuildLogger : ILogger
     {
+        private const string LogPrefix = "[coverlet]";
+
         private readonly TaskLoggingHelper _log;
 
         public MSBuildLogger(TaskLoggingHelper log) => _log = log;
 
-        public void LogVerbose(string message) => _log.LogMessage(MessageImportance.Low, message);
+        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, message);
+        public void LogInformation(string message)=> _log.LogMessage(MessageImportance.High, $"{LogPrefix}{message}");
 
-        public void LogWarning(string message) => _log.LogWarning(message);
+        public void LogWarning(string message) => _log.LogWarning($"{LogPrefix}{message}");
 
-        public void LogError(string message) => _log.LogError(message);
+        public void LogError(string message) => _log.LogError($"{LogPrefix}{message}");
 
-        public void LogError(Exception exception) => _log.LogErrorFromException(exception);
+        public void LogError(Exception exception) => _log.LogErrorFromException(exception, true);
     }
 }

test/coverlet.core.tests/CoverageTests.cs

@@ -20,11 +20,9 @@ public void TestCoverage()
             File.Copy(module, Path.Combine(directory.FullName, Path.GetFileName(module)), true);
             File.Copy(pdb, Path.Combine(directory.FullName, Path.GetFileName(pdb)), true);
 
-            var logger = Mock.Of<ILogger>();
-
             // TODO: Find a way to mimick hits
 
-            var coverage = new Coverage(Path.Combine(directory.FullName, Path.GetFileName(module)), Array.Empty<string>(), Array.Empty<string>(), Array.Empty<string>(), Array.Empty<string>(), Array.Empty<string>(), false, string.Empty, false, logger);
+            var coverage = new Coverage(Path.Combine(directory.FullName, Path.GetFileName(module)), Array.Empty<string>(), Array.Empty<string>(), Array.Empty<string>(), Array.Empty<string>(), Array.Empty<string>(), false, string.Empty, false, new Mock<ILogger>().Object);
             coverage.PrepareModules();
 
             var result = coverage.GetCoverageResult();

test/coverlet.core.tests/Instrumentation/InstrumenterTests.cs

@@ -2,8 +2,10 @@
 using System.IO;
 using System.Linq;
 using Xunit;
-using Coverlet.Core.Instrumentation;
+
 using Coverlet.Core.Samples.Tests;
+using Moq;
+using Coverlet.Core.Logging;
 
 namespace Coverlet.Core.Instrumentation.Tests
 {
@@ -27,7 +29,7 @@ public void TestCoreLibInstrumentation()
             foreach (var file in files)
                 File.Copy(Path.Combine(OriginalFilesDir, file), Path.Combine(TestFilesDir, file), overwrite: true);
 
-            Instrumenter instrumenter = new Instrumenter(Path.Combine(TestFilesDir, files[0]), "_coverlet_instrumented", Array.Empty<string>(), Array.Empty<string>(), Array.Empty<string>(), Array.Empty<string>(), false);
+            Instrumenter instrumenter = new Instrumenter(Path.Combine(TestFilesDir, files[0]), "_coverlet_instrumented", Array.Empty<string>(), Array.Empty<string>(), Array.Empty<string>(), Array.Empty<string>(), false, new Mock<ILogger>().Object);
             Assert.True(instrumenter.CanInstrument());
             var result = instrumenter.Instrument();
             Assert.NotNull(result);
@@ -119,7 +121,7 @@ private InstrumenterTest CreateInstrumentor(bool fakeCoreLibModule = false, stri
             File.Copy(pdb, Path.Combine(directory.FullName, destPdb), true);
 
             module = Path.Combine(directory.FullName, destModule);
-            Instrumenter instrumenter = new Instrumenter(module, identifier, Array.Empty<string>(), Array.Empty<string>(), Array.Empty<string>(), attributesToIgnore, false);
+            Instrumenter instrumenter = new Instrumenter(module, identifier, Array.Empty<string>(), Array.Empty<string>(), Array.Empty<string>(), attributesToIgnore, false, new Mock<ILogger>().Object);
             return new InstrumenterTest
             {
                 Instrumenter = instrumenter,