Fixes CoverletSourceRootsMapping issue (#1456)

Author: daveMueller

Documentation/Changelog.md

@@ -7,6 +7,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ## Unreleased
 
 ### Fixed
+-Could not write lines to file CoverletSourceRootsMapping - in use by another process [#1155](https://github.com/coverlet-coverage/coverlet/issues/1155)
 -Incorrect coverage for methods returning IAsyncEnumerable in generic classes [#1383](https://github.com/coverlet-coverage/coverlet/issues/1383)
 -Wrong branch coverage for async methods .NET Standard 1.x [#1376](https://github.com/coverlet-coverage/coverlet/issues/1376) 
 -Empty path exception in visual basic projects [#775](https://github.com/coverlet-coverage/coverlet/issues/775)

Documentation/Examples/VSTest/DeterministicBuild/HowTo.md

@@ -59,7 +59,7 @@ Add collectors package version generated to `"..\Documentation\Examples\VSTest\D
 Go to test project folder and run
 ```
 C:\git\coverlet\Documentation\Examples\VSTest\DeterministicBuild (detbuilddocs -> origin)
-λ dotnet test --collect:"XPlat Code Coverage" /p:DeterministicSourcePaths=true
+λ dotnet test --collect:"XPlat Code Coverage" /p:DeterministicSourcePaths=true -- DataCollectionRunSettings.DataCollectors.DataCollector.Configuration.DeterministicReport=true
 Test run for C:\git\coverlet\Documentation\Examples\VSTest\DeterministicBuild\XUnitTestProject1\bin\Debug\netcoreapp3.1\XUnitTestProject1.dll(.NETCoreApp,Version=v3.1)
 Microsoft (R) Test Execution Command Line Tool Version 16.5.0
 Copyright (c) Microsoft Corporation.  All rights reserved.
@@ -78,5 +78,5 @@ Total tests: 1
 You should see on output folder the coverlet source root mapping file generated.  
 This is the confirmation that you're running coverage on deterministic build.
 ```
-Documentation\Examples\VSTest\DeterministicBuild\XUnitTestProject1\bin\Debug\netcoreapp3.1\CoverletSourceRootsMapping
+Documentation\Examples\VSTest\DeterministicBuild\XUnitTestProject1\bin\Debug\netcoreapp3.1\CoverletSourceRootsMapping_XUnitTestProject1
 ```

src/coverlet.collector/DataCollection/CoverletCoverageCollector.cs

@@ -224,11 +224,13 @@ private static IServiceCollection GetDefaultServiceCollection(TestPlatformEqtTra
             serviceCollection.AddTransient<IRetryHelper, RetryHelper>();
             serviceCollection.AddTransient<IProcessExitHandler, ProcessExitHandler>();
             serviceCollection.AddTransient<IFileSystem, FileSystem>();
+            serviceCollection.AddTransient<IAssemblyAdapter, AssemblyAdapter>();
             serviceCollection.AddTransient<ILogger, CoverletLogger>(_ => new CoverletLogger(eqtTrace, logger));
             // We need to keep singleton/static semantics
             serviceCollection.AddSingleton<IInstrumentationHelper, InstrumentationHelper>();
             // We cache resolutions
-            serviceCollection.AddSingleton<ISourceRootTranslator, SourceRootTranslator>(serviceProvider => new SourceRootTranslator(testModule, serviceProvider.GetRequiredService<ILogger>(), serviceProvider.GetRequiredService<IFileSystem>()));
+            serviceCollection.AddSingleton<ISourceRootTranslator, SourceRootTranslator>(serviceProvider =>
+                new SourceRootTranslator(testModule, serviceProvider.GetRequiredService<ILogger>(), serviceProvider.GetRequiredService<IFileSystem>(), serviceProvider.GetRequiredService<IAssemblyAdapter>()));
             serviceCollection.AddSingleton<ICecilSymbolHelper, CecilSymbolHelper>();
             return serviceCollection;
         }

src/coverlet.collector/build/netstandard1.0/coverlet.collector.targets

@@ -44,7 +44,7 @@ WARNING:  DO NOT MODIFY this file unless you are knowledgeable about MSBuild and
       <_mapping Include="@(_byProject->'%(Identity)|%(OriginalPath)=%(MappedPath)')" />
     </ItemGroup>
     <PropertyGroup>
-      <_sourceRootMappingFilePath>$([MSBuild]::EnsureTrailingSlash('$(OutputPath)'))CoverletSourceRootsMapping</_sourceRootMappingFilePath>
+      <_sourceRootMappingFilePath>$([MSBuild]::EnsureTrailingSlash('$(OutputPath)'))CoverletSourceRootsMapping_$(AssemblyName)</_sourceRootMappingFilePath>
     </PropertyGroup>
     <WriteLinesToFile File="$(_sourceRootMappingFilePath)" Lines="@(_mapping)"
                       Overwrite="true" Encoding="Unicode"

src/coverlet.core/Abstractions/IAssemblyAdapter.cs

@@ -0,0 +1,10 @@
+// Copyright (c) Toni Solarin-Sodara
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+namespace Coverlet.Core.Abstractions
+{
+    internal interface IAssemblyAdapter
+    {
+        string GetAssemblyName(string assemblyPath);
+    }
+}

src/coverlet.core/Helpers/AssemblyAdapter.cs

@@ -0,0 +1,16 @@
+// Copyright (c) Toni Solarin-Sodara
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+using System.Reflection;
+using Coverlet.Core.Abstractions;
+
+namespace Coverlet.Core.Helpers
+{
+    internal class AssemblyAdapter : IAssemblyAdapter
+    {
+        public string GetAssemblyName(string assemblyPath)
+        {
+            return AssemblyName.GetAssemblyName(assemblyPath).Name;
+        }
+    }
+}

src/coverlet.core/Helpers/SourceRootTranslator.cs

@@ -22,7 +22,7 @@ internal class SourceRootTranslator : ISourceRootTranslator
         private readonly IFileSystem _fileSystem;
         private readonly Dictionary<string, List<SourceRootMapping>> _sourceRootMapping;
         private readonly Dictionary<string, List<string>> _sourceToDeterministicPathMapping;
-        private const string MappingFileName = "CoverletSourceRootsMapping";
+        private readonly string _mappingFileName;
         private Dictionary<string, string> _resolutionCacheFiles;
 
         public SourceRootTranslator(ILogger logger, IFileSystem fileSystem)
@@ -32,7 +32,7 @@ public SourceRootTranslator(ILogger logger, IFileSystem fileSystem)
             _sourceRootMapping = new Dictionary<string, List<SourceRootMapping>>();
         }
 
-        public SourceRootTranslator(string moduleTestPath, ILogger logger, IFileSystem fileSystem)
+        public SourceRootTranslator(string moduleTestPath, ILogger logger, IFileSystem fileSystem, IAssemblyAdapter assemblyAdapter)
         {
             _logger = logger ?? throw new ArgumentNullException(nameof(logger));
             _fileSystem = fileSystem ?? throw new ArgumentNullException(nameof(fileSystem));
@@ -44,6 +44,10 @@ public SourceRootTranslator(string moduleTestPath, ILogger logger, IFileSystem f
             {
                 throw new FileNotFoundException($"Module test path '{moduleTestPath}' not found", moduleTestPath);
             }
+
+            string assemblyName = assemblyAdapter.GetAssemblyName(moduleTestPath);
+            _mappingFileName = $"CoverletSourceRootsMapping_{assemblyName}";
+
             _sourceRootMapping = LoadSourceRootMapping(Path.GetDirectoryName(moduleTestPath));
             _sourceToDeterministicPathMapping = LoadSourceToDeterministicPathMapping(_sourceRootMapping);
         }
@@ -75,7 +79,7 @@ private Dictionary<string, List<SourceRootMapping>> LoadSourceRootMapping(string
         {
             var mapping = new Dictionary<string, List<SourceRootMapping>>();
 
-            string mappingFilePath = Path.Combine(directory, MappingFileName);
+            string mappingFilePath = Path.Combine(directory, _mappingFileName);
             if (!_fileSystem.Exists(mappingFilePath))
             {
                 return mapping;

src/coverlet.msbuild.tasks/InstrumentationTask.cs

@@ -73,11 +73,13 @@ public override bool Execute()
             IServiceCollection serviceCollection = new ServiceCollection();
             serviceCollection.AddTransient<IProcessExitHandler, ProcessExitHandler>();
             serviceCollection.AddTransient<IFileSystem, FileSystem>();
+            serviceCollection.AddTransient<IAssemblyAdapter, AssemblyAdapter>();
             serviceCollection.AddTransient<IConsole, SystemConsole>();
             serviceCollection.AddTransient<ILogger, MSBuildLogger>(_ => _logger);
             serviceCollection.AddTransient<IRetryHelper, RetryHelper>();
             // We cache resolutions
-            serviceCollection.AddSingleton<ISourceRootTranslator, SourceRootTranslator>(serviceProvider => new SourceRootTranslator(Path, serviceProvider.GetRequiredService<ILogger>(), serviceProvider.GetRequiredService<IFileSystem>()));
+            serviceCollection.AddSingleton<ISourceRootTranslator, SourceRootTranslator>(serviceProvider =>
+                new SourceRootTranslator(Path, serviceProvider.GetRequiredService<ILogger>(), serviceProvider.GetRequiredService<IFileSystem>(), serviceProvider.GetRequiredService<IAssemblyAdapter>()));
             // We need to keep singleton/static semantics
             serviceCollection.AddSingleton<IInstrumentationHelper, InstrumentationHelper>();
             serviceCollection.AddSingleton<ICecilSymbolHelper, CecilSymbolHelper>();

src/coverlet.msbuild.tasks/coverlet.msbuild.targets

@@ -24,7 +24,7 @@
       <_mapping Include="@(_byProject->'%(Identity)|%(OriginalPath)=%(MappedPath)')" />
     </ItemGroup>
     <PropertyGroup>
-      <_sourceRootMappingFilePath>$([MSBuild]::EnsureTrailingSlash('$(OutputPath)'))CoverletSourceRootsMapping</_sourceRootMappingFilePath>
+      <_sourceRootMappingFilePath>$([MSBuild]::EnsureTrailingSlash('$(OutputPath)'))CoverletSourceRootsMapping_$(AssemblyName)</_sourceRootMappingFilePath>
     </PropertyGroup>
     <WriteLinesToFile File="$(_sourceRootMappingFilePath)" Lines="@(_mapping)"
                       Overwrite="true" Encoding="Unicode"