Add unit tests to new methods

Author: Joseph Sun

src/coverlet.console/Program.cs

@@ -239,7 +239,7 @@ bool unloadCoverletFromModulesOnly
 
         if (unloadCoverletFromModulesOnly)
         {
-          int unloadModuleExitCode = coverage.UnloadModule();
+          int unloadModuleExitCode = coverage.UnloadModules();
           return Task.FromResult(unloadModuleExitCode);
         }
 

src/coverlet.core/Coverage.cs

@@ -330,17 +330,19 @@ public CoverageResult GetCoverageResult()
     /// unloads all modules that were instrumented
     /// </summary>
     /// <returns> exit code of module unloading </returns>
-    public int UnloadModule()
+    public int UnloadModules()
     {
       string[] modules = _instrumentationHelper.GetCoverableModules(_moduleOrAppDirectory,
         _parameters.IncludeDirectories, _parameters.IncludeTestAssembly);
 
-      IReadOnlyList<string> validModules = _instrumentationHelper
-        .SelectModules(modules, _parameters.IncludeFilters, _parameters.ExcludeFilters).ToList();
-      foreach (string modulePath in validModules) {
+      var validModules = _instrumentationHelper
+        .SelectModules(modules, _parameters.IncludeFilters, _parameters.ExcludeFilters);
+      var validModulesAsList = validModules.ToList();
+      foreach (string modulePath in validModulesAsList) {
         try
         {
           _instrumentationHelper.RestoreOriginalModule(modulePath, Identifier);
+          _logger.LogVerbose("All Modules unloaded.");
         }
         catch (Exception e)
         {
@@ -353,8 +355,7 @@ public int UnloadModule()
   }
 
     /// <summary>
-    /// Invoke the unloading of modules and restoration of the original assembly files, made public to allow unloading
-    /// of instrumentation in large scale testing utilising parallelization
+    /// Invoke the unloading of modules and restoration of the original assembly files
     /// </summary>
     /// <param name="modulePath"></param>
     /// <returns> exist code of unloading modules </returns>
@@ -363,6 +364,7 @@ public void UnloadModule(string modulePath)
       try
       {
         _instrumentationHelper.RestoreOriginalModule(modulePath, Identifier);
+        _logger.LogVerbose($"Module at {modulePath} is unloaded.");
       }
       catch (Exception e)
       {

test/coverlet.core.tests/Coverage/CoverageTests.cs

@@ -177,6 +177,77 @@ public void TestCoverageMergeWithWrongParameter()
 
       directory.Delete(true);
     }
+
+    [Fact]
+    public void TestCoverageUnloadWithParameters()
+    {
+      string module = GetType().Assembly.Location;
+      string pdb = Path.Combine(Path.GetDirectoryName(module), Path.GetFileNameWithoutExtension(module) + ".pdb");
+
+      DirectoryInfo directory = Directory.CreateDirectory(Path.Combine(Path.GetTempPath(), Guid.NewGuid().ToString()));
+
+      File.Copy(module, Path.Combine(directory.FullName, Path.GetFileName(module)), true);
+      File.Copy(pdb, Path.Combine(directory.FullName, Path.GetFileName(pdb)), true);
+
+      var mockInstrumentationHelper = new Mock<IInstrumentationHelper>();
+
+      var parameters = new CoverageParameters
+      {
+        IncludeFilters = new string[] { "[coverlet.tests.projectsample.excludedbyattribute*]*" },
+        IncludeDirectories = Array.Empty<string>(),
+        ExcludeFilters = Array.Empty<string>(),
+        ExcludedSourceFiles = Array.Empty<string>(),
+        ExcludeAttributes = Array.Empty<string>(),
+        IncludeTestAssembly = false,
+        SingleHit = false,
+        MergeWith = string.Empty,
+        UseSourceLink = false
+      };
+
+      var coverage = new Coverage(Path.Combine(directory.FullName, Path.GetFileName(module)), parameters, _mockLogger.Object, mockInstrumentationHelper.Object, new FileSystem(), new SourceRootTranslator(_mockLogger.Object, new FileSystem()), new CecilSymbolHelper());
+      coverage.PrepareModules();
+      coverage.UnloadModule(Path.Combine(directory.FullName, Path.GetFileName(module)));
+
+      mockInstrumentationHelper.Verify(i => i.RestoreOriginalModule(It.Is<string>(v => v.Equals(Path.Combine(directory.FullName, Path.GetFileName(module)))), It.IsAny<string>()), Times.Once);
+      _mockLogger.Verify(l => l.LogVerbose(It.Is<string>(v => v.Equals($"Module at {Path.Combine(directory.FullName, Path.GetFileName(module))} is unloaded."))), Times.Once);
+    }
+
+    [Fact]
+    public void TestCoverageUnloadWithNoParameters()
+    {
+      string module = GetType().Assembly.Location;
+      string pdb = Path.Combine(Path.GetDirectoryName(module), Path.GetFileNameWithoutExtension(module) + ".pdb");
+
+      DirectoryInfo directory = Directory.CreateDirectory(Path.Combine(Path.GetTempPath(), Guid.NewGuid().ToString()));
+
+      File.Copy(module, Path.Combine(directory.FullName, Path.GetFileName(module)), true);
+      File.Copy(pdb, Path.Combine(directory.FullName, Path.GetFileName(pdb)), true);
+
+      var mockInstrumentationHelper = new Mock<IInstrumentationHelper>();
+        mockInstrumentationHelper
+          .Setup(x => x.SelectModules(It.IsAny<IEnumerable<string>>(), It.IsAny<string[]>(), It.IsAny<string[]>()))
+          .Returns(new List<string>(){"ModuleX"});
+
+      var parameters = new CoverageParameters
+      {
+        IncludeFilters = new string[] { "[coverlet.tests.projectsample.excludedbyattribute*]*" },
+        IncludeDirectories = Array.Empty<string>(),
+        ExcludeFilters = Array.Empty<string>(),
+        ExcludedSourceFiles = Array.Empty<string>(),
+        ExcludeAttributes = Array.Empty<string>(),
+        IncludeTestAssembly = false,
+        SingleHit = false,
+        MergeWith = string.Empty,
+        UseSourceLink = false
+      };
+
+      var coverage = new Coverage(Path.Combine(directory.FullName, Path.GetFileName(module)), parameters, _mockLogger.Object, mockInstrumentationHelper.Object, new FileSystem(), new SourceRootTranslator(_mockLogger.Object, new FileSystem()), new CecilSymbolHelper());
+      coverage.PrepareModules();
+      coverage.UnloadModules();
+
+      mockInstrumentationHelper.Verify(i => i.RestoreOriginalModule(It.Is<string>(v => v.Equals("ModuleX")), It.IsAny<string>()), Times.Once);
+      _mockLogger.Verify(l => l.LogVerbose(It.Is<string>(v => v.Equals("All Modules unloaded."))), Times.Once);
+    }
   }
 }