add unload modules unique specifically for use in coverlet.console

Author: Joseph Sun

src/coverlet.console/Program.cs

@@ -49,7 +49,7 @@ static int Main(string[] args)
       var doesNotReturnAttributes = new Option<string[]>("--does-not-return-attribute", "Attributes that mark methods that do not return") { Arity = ArgumentArity.ZeroOrMore, AllowMultipleArgumentsPerToken = true };
       var excludeAssembliesWithoutSources = new Option<string>("--exclude-assemblies-without-sources", "Specifies behaviour of heuristic to ignore assemblies with missing source documents.") { Arity = ArgumentArity.ZeroOrOne };
       var sourceMappingFile = new Option<string>("--source-mapping-file", "Specifies the path to a SourceRootsMappings file.") { Arity = ArgumentArity.ZeroOrOne };
-      var unloadCoverletModuleOnly = new Option<bool>("--unload-coverlet-module-only", "Specifies Whether or not coverlet will generate a report"){ Arity = ArgumentArity.ZeroOrOne };
+      var unloadCoverletFromModulesOnly = new Option<bool>("--unload-coverlet-from-modules-only", "Specifies Whether or not coverlet will only unload after unit tests are finished"){ Arity = ArgumentArity.ZeroOrOne };
 
       RootCommand rootCommand = new()
       {
@@ -75,7 +75,7 @@ static int Main(string[] args)
         doesNotReturnAttributes,
         excludeAssembliesWithoutSources,
         sourceMappingFile,
-        unloadCoverletModuleOnly
+        unloadCoverletFromModulesOnly
       };
 
       rootCommand.Description = "Cross platform .NET Core code coverage tool";
@@ -104,7 +104,7 @@ static int Main(string[] args)
         string[] doesNotReturnAttributesValue = context.ParseResult.GetValueForOption(doesNotReturnAttributes);
         string excludeAssembliesWithoutSourcesValue = context.ParseResult.GetValueForOption(excludeAssembliesWithoutSources);
         string sourceMappingFileValue = context.ParseResult.GetValueForOption(sourceMappingFile);
-        bool unloadCoverletModuleOnlyBool = context.ParseResult.GetValueForOption(unloadCoverletModuleOnly);
+        bool unloadCoverletFromModulesOnlyBool = context.ParseResult.GetValueForOption(unloadCoverletFromModulesOnly);
 
         if (string.IsNullOrEmpty(moduleOrAppDirectoryValue) || string.IsNullOrWhiteSpace(moduleOrAppDirectoryValue))
           throw new ArgumentException("No test assembly or application directory specified.");
@@ -131,7 +131,7 @@ static int Main(string[] args)
                       doesNotReturnAttributesValue,
                       excludeAssembliesWithoutSourcesValue,
                       sourceMappingFileValue,
-                      unloadCoverletModuleOnlyBool);
+                      unloadCoverletFromModulesOnlyBool);
         context.ExitCode = taskStatus;
 
       });
@@ -159,7 +159,7 @@ private static Task<int> HandleCommand(string moduleOrAppDirectory,
                                                            string[] doesNotReturnAttributes,
                                                            string excludeAssembliesWithoutSources,
                                                            string sourceMappingFile,
-                                                           bool unloadCoverletModuleOnly
+                                                           bool unloadCoverletFromModulesOnly
              )
     {
 
@@ -237,9 +237,9 @@ bool unloadCoverletModuleOnly
 
         string dOutput = output != null ? output : Directory.GetCurrentDirectory() + Path.DirectorySeparatorChar.ToString();
 
-        if (unloadCoverletModuleOnly)
+        if (unloadCoverletFromModulesOnly)
         {
-          int unloadModuleExitCode = coverage.UnloadModule(moduleOrAppDirectory);
+          int unloadModuleExitCode = coverage.UnloadModule();
           return Task.FromResult(unloadModuleExitCode);
         }
 

src/coverlet.core/Coverage.cs

@@ -326,12 +326,39 @@ public CoverageResult GetCoverageResult()
       return coverageResult;
     }
 
+    /// <summary>
+    /// unloads all modules that were instrumented
+    /// </summary>
+    /// <returns> exit code of module unloading </returns>
+    public int UnloadModule()
+    {
+      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) {
+        try
+        {
+          _instrumentationHelper.RestoreOriginalModule(modulePath, Identifier);
+        }
+        catch (Exception e)
+        {
+          _logger.LogVerbose($"{e.InnerException} occured, module unloading aborted.");
+          return -1;
+        }
+      }
+
+      return 0;
+  }
+
     /// <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
     /// </summary>
     /// <param name="modulePath"></param>
-    public int UnloadModule(string modulePath)
+    /// <returns> exist code of unloading modules </returns>
+    public void UnloadModule(string modulePath)
     {
       try
       {
@@ -340,10 +367,7 @@ public int UnloadModule(string modulePath)
       catch (Exception e)
       {
         _logger.LogVerbose($"{e.InnerException} occured, module unloading aborted.");
-        return -1;
       }
-
-      return 0;
     }
 
     private bool BranchInCompilerGeneratedClass(string methodName)