add test GetTestModules_LogsCorrectInfoMessage

Author: Bertk

src/coverlet.collector/DataCollection/Abstractions/ITestPlatformEqtTrace.cs

@@ -0,0 +1,14 @@
+// Copyright (c) Toni Solarin-Sodara
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+namespace Coverlet.Collector.DataCollection.Abstractions
+{
+  internal interface ITestPlatformEqtTrace
+  {
+    bool IsInfoEnabled { get; }
+    void Info(string format, params object[] args);
+    void Verbose(string format, params object[] args);
+    void Warning(string format, params object[] args);
+    void Error(string format, params object[] args);
+  }
+}

src/coverlet.collector/DataCollection/CoverletCoverageCollector.cs

@@ -6,6 +6,7 @@
 using System.Diagnostics;
 using System.Linq;
 using System.Xml;
+using Coverlet.Collector.DataCollection.Abstractions;
 using Coverlet.Collector.Utilities;
 using Coverlet.Collector.Utilities.Interfaces;
 using Coverlet.Core.Abstractions;
@@ -23,7 +24,8 @@ namespace Coverlet.Collector.DataCollection
   [DataCollectorFriendlyName(CoverletConstants.FriendlyName)]
   public class CoverletCoverageCollector : DataCollector
   {
-    private readonly TestPlatformEqtTrace _eqtTrace;
+    private readonly ITestPlatformEqtTrace _eqtTrace;
+    //private readonly TestPlatformEqtTrace _eqtTrace;
     private readonly ICoverageWrapper _coverageWrapper;
     private readonly ICountDownEventFactory _countDownEventFactory;
     private readonly Func<TestPlatformEqtTrace, TestPlatformLogger, string, IServiceCollection> _serviceCollectionFactory;
@@ -40,7 +42,7 @@ public class CoverletCoverageCollector : DataCollector
     {
     }
 
-    internal CoverletCoverageCollector(TestPlatformEqtTrace eqtTrace, ICoverageWrapper coverageWrapper, ICountDownEventFactory countDownEventFactory, Func<TestPlatformEqtTrace, TestPlatformLogger, string, IServiceCollection> serviceCollectionFactory) : base()
+    internal CoverletCoverageCollector(ITestPlatformEqtTrace eqtTrace, ICoverageWrapper coverageWrapper, ICountDownEventFactory countDownEventFactory, Func<TestPlatformEqtTrace, TestPlatformLogger, string, IServiceCollection> serviceCollectionFactory) : base()
     {
       _eqtTrace = eqtTrace;
       _coverageWrapper = coverageWrapper;
@@ -128,14 +130,14 @@ private void OnSessionStart(object sender, SessionStartEventArgs sessionStartEve
       {
         // Get coverlet settings
         IEnumerable<string> testModules = GetTestModules(sessionStartEventArgs);
-        var coverletSettingsParser = new CoverletSettingsParser(_eqtTrace);
+        var coverletSettingsParser = new CoverletSettingsParser((TestPlatformEqtTrace)_eqtTrace);
         CoverletSettings coverletSettings = coverletSettingsParser.Parse(_configurationElement, testModules);
 
         // Build services container
-        _serviceProvider = _serviceCollectionFactory(_eqtTrace, _logger, coverletSettings.TestModule).BuildServiceProvider();
+        _serviceProvider = _serviceCollectionFactory((TestPlatformEqtTrace)_eqtTrace, _logger, coverletSettings.TestModule).BuildServiceProvider();
 
         // Get coverage and attachment managers
-        _coverageManager = new CoverageManager(coverletSettings, _eqtTrace, _logger, _coverageWrapper,
+        _coverageManager = new CoverageManager(coverletSettings, (TestPlatformEqtTrace)_eqtTrace, _logger, _coverageWrapper,
                                                 _serviceProvider.GetRequiredService<IInstrumentationHelper>(), _serviceProvider.GetRequiredService<IFileSystem>(),
                                                 _serviceProvider.GetRequiredService<ISourceRootTranslator>(), _serviceProvider.GetRequiredService<ICecilSymbolHelper>());
 
@@ -166,7 +168,7 @@ private void OnSessionEnd(object sender, SessionEndEventArgs e)
         if (coverageReports != null && coverageReports.Any())
         {
           // Send result attachments to test platform.
-          using var attachmentManager = new AttachmentManager(_dataSink, _dataCollectionContext, _logger, _eqtTrace, _countDownEventFactory.Create(coverageReports.Count(), TimeSpan.FromSeconds(30)));
+          using var attachmentManager = new AttachmentManager(_dataSink, _dataCollectionContext, _logger, (TestPlatformEqtTrace)_eqtTrace, _countDownEventFactory.Create(coverageReports.Count(), TimeSpan.FromSeconds(30)));
           foreach ((string report, string fileName) in coverageReports)
           {
             attachmentManager.SendCoverageReport(report, fileName);

src/coverlet.collector/Utilities/TestPlatformEqtTrace.cs

@@ -1,16 +1,18 @@
 // Copyright (c) Toni Solarin-Sodara
 // Licensed under the MIT license. See LICENSE file in the project root for full license information.
 
+using Coverlet.Collector.DataCollection.Abstractions;
 using Microsoft.VisualStudio.TestPlatform.ObjectModel;
 
 namespace Coverlet.Collector.Utilities
 {
   /// <summary>
   /// Test platform eqttrace
   /// </summary>
-  internal class TestPlatformEqtTrace
+  internal class TestPlatformEqtTrace : ITestPlatformEqtTrace
   {
-    public bool IsInfoEnabled => EqtTrace.IsInfoEnabled;
+    public bool IsInfoEnabled { get; }
+    //public bool IsInfoEnabled => EqtTrace.IsInfoEnabled;
     public bool IsVerboseEnabled => EqtTrace.IsVerboseEnabled;
 
     /// <summary>

test/coverlet.collector.tests/CoverletCoverageDataCollectorTests.cs

@@ -7,6 +7,7 @@
 using System.Linq;
 using System.Xml;
 using Coverlet.Collector.DataCollection;
+using Coverlet.Collector.DataCollection.Abstractions;
 using Coverlet.Collector.Utilities;
 using Coverlet.Collector.Utilities.Interfaces;
 using Coverlet.Core;
@@ -278,5 +279,59 @@ public void OnSessionStartShouldLogWarningIfInstrumentationFailed()
       _mockLogger.Verify(x => x.LogWarning(_dataCollectionContext,
           It.Is<string>(y => y.Contains("CoverletDataCollectorException"))));
     }
+
+    [Fact]
+    public void GetTestModules_LogsCorrectInfoMessage()
+    {
+      // Arrange
+      var mockEqtTrace = new Mock<ITestPlatformEqtTrace>();
+      mockEqtTrace.Setup(x => x.IsInfoEnabled).Returns(true);
+      var testModules = new List<string> { "module1.dll", "module2.dll" };
+
+      _coverletCoverageDataCollector = new CoverletCoverageCollector(
+          mockEqtTrace.Object,
+          _mockCoverageWrapper.Object,
+          _mockCountDownEventFactory.Object,
+          GetDefaultServiceCollection);
+
+      _coverletCoverageDataCollector.Initialize(
+          _configurationElement,
+          _mockDataCollectionEvents.Object,
+          _mockDataCollectionSink.Object,
+          _mockLogger.Object,
+          _context);
+
+      var sessionStartProperties = new Dictionary<string, object>
+    {
+        { CoverletConstants.TestSourcesPropertyName, testModules }
+    };
+
+      // Act
+      _mockDataCollectionEvents.Raise(x => x.SessionStart += null, new SessionStartEventArgs(sessionStartProperties));
+
+      // Assert
+      mockEqtTrace.Verify(x => x.Info(
+          "{0}: TestModules: '{1}'",
+          CoverletConstants.DataCollectorName,
+          "module1.dll,module2.dll"),
+          Times.Once);
+    }
+
+    private static IServiceCollection GetDefaultServiceCollection(TestPlatformEqtTrace eqtTrace, TestPlatformLogger logger, string testModule)
+    {
+      IServiceCollection serviceCollection = new ServiceCollection();
+      var fileSystem = new Mock<IFileSystem>();
+      fileSystem.Setup(f => f.Exists(It.IsAny<string>())).Returns(true);
+
+      serviceCollection.AddTransient(_ => fileSystem.Object);
+      serviceCollection.AddTransient<IRetryHelper, RetryHelper>();
+      serviceCollection.AddTransient<IProcessExitHandler, ProcessExitHandler>();
+      serviceCollection.AddTransient<ILogger, CoverletLogger>(_ => new CoverletLogger(eqtTrace, logger));
+      serviceCollection.AddSingleton<IInstrumentationHelper, InstrumentationHelper>();
+      serviceCollection.AddSingleton<ISourceRootTranslator, SourceRootTranslator>();
+      serviceCollection.AddSingleton<ICecilSymbolHelper, CecilSymbolHelper>();
+
+      return serviceCollection;
+    }
   }
 }