Skip to content

Commit d936138

Browse files
daveMuellerdaveMueller
authored
Fixes CoverletSourceRootsMapping issue (#1456)
1 parent 3bbe502 commit d936138

File tree

18 files changed

+113
-60
lines changed

18 files changed

+113
-60
lines changed

‎Documentation/Changelog.md

+1
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
77
## Unreleased
88

99
### Fixed
10+
-Could not write lines to file CoverletSourceRootsMapping - in use by another process [#1155](https://github.com/coverlet-coverage/coverlet/issues/1155)
1011
-Incorrect coverage for methods returning IAsyncEnumerable in generic classes [#1383](https://github.com/coverlet-coverage/coverlet/issues/1383)
1112
-Wrong branch coverage for async methods .NET Standard 1.x [#1376](https://github.com/coverlet-coverage/coverlet/issues/1376)
1213
-Empty path exception in visual basic projects [#775](https://github.com/coverlet-coverage/coverlet/issues/775)

‎Documentation/Examples/VSTest/DeterministicBuild/HowTo.md

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

‎src/coverlet.collector/DataCollection/CoverletCoverageCollector.cs

+3-1
Original file line numberDiff line numberDiff line change
@@ -224,11 +224,13 @@ private static IServiceCollection GetDefaultServiceCollection(TestPlatformEqtTra
224224
serviceCollection.AddTransient<IRetryHelper, RetryHelper>();
225225
serviceCollection.AddTransient<IProcessExitHandler, ProcessExitHandler>();
226226
serviceCollection.AddTransient<IFileSystem, FileSystem>();
227+
serviceCollection.AddTransient<IAssemblyAdapter, AssemblyAdapter>();
227228
serviceCollection.AddTransient<ILogger, CoverletLogger>(_ => new CoverletLogger(eqtTrace, logger));
228229
// We need to keep singleton/static semantics
229230
serviceCollection.AddSingleton<IInstrumentationHelper, InstrumentationHelper>();
230231
// We cache resolutions
231-
serviceCollection.AddSingleton<ISourceRootTranslator, SourceRootTranslator>(serviceProvider => new SourceRootTranslator(testModule, serviceProvider.GetRequiredService<ILogger>(), serviceProvider.GetRequiredService<IFileSystem>()));
232+
serviceCollection.AddSingleton<ISourceRootTranslator, SourceRootTranslator>(serviceProvider =>
233+
new SourceRootTranslator(testModule, serviceProvider.GetRequiredService<ILogger>(), serviceProvider.GetRequiredService<IFileSystem>(), serviceProvider.GetRequiredService<IAssemblyAdapter>()));
232234
serviceCollection.AddSingleton<ICecilSymbolHelper, CecilSymbolHelper>();
233235
return serviceCollection;
234236
}

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

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

‎src/coverlet.core/Abstractions/IAssemblyAdapter.cs

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
// Copyright (c) Toni Solarin-Sodara
2+
// Licensed under the MIT license. See LICENSE file in the project root for full license information.
3+
4+
namespace Coverlet.Core.Abstractions
5+
{
6+
internal interface IAssemblyAdapter
7+
{
8+
string GetAssemblyName(string assemblyPath);
9+
}
10+
}

‎src/coverlet.core/Helpers/AssemblyAdapter.cs

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
// Copyright (c) Toni Solarin-Sodara
2+
// Licensed under the MIT license. See LICENSE file in the project root for full license information.
3+
4+
using System.Reflection;
5+
using Coverlet.Core.Abstractions;
6+
7+
namespace Coverlet.Core.Helpers
8+
{
9+
internal class AssemblyAdapter : IAssemblyAdapter
10+
{
11+
public string GetAssemblyName(string assemblyPath)
12+
{
13+
return AssemblyName.GetAssemblyName(assemblyPath).Name;
14+
}
15+
}
16+
}

‎src/coverlet.core/Helpers/SourceRootTranslator.cs

+7-3
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ internal class SourceRootTranslator : ISourceRootTranslator
2222
private readonly IFileSystem _fileSystem;
2323
private readonly Dictionary<string, List<SourceRootMapping>> _sourceRootMapping;
2424
private readonly Dictionary<string, List<string>> _sourceToDeterministicPathMapping;
25-
private const string MappingFileName = "CoverletSourceRootsMapping";
25+
private readonly string _mappingFileName;
2626
private Dictionary<string, string> _resolutionCacheFiles;
2727

2828
public SourceRootTranslator(ILogger logger, IFileSystem fileSystem)
@@ -32,7 +32,7 @@ public SourceRootTranslator(ILogger logger, IFileSystem fileSystem)
3232
_sourceRootMapping = new Dictionary<string, List<SourceRootMapping>>();
3333
}
3434

35-
public SourceRootTranslator(string moduleTestPath, ILogger logger, IFileSystem fileSystem)
35+
public SourceRootTranslator(string moduleTestPath, ILogger logger, IFileSystem fileSystem, IAssemblyAdapter assemblyAdapter)
3636
{
3737
_logger = logger ?? throw new ArgumentNullException(nameof(logger));
3838
_fileSystem = fileSystem ?? throw new ArgumentNullException(nameof(fileSystem));
@@ -44,6 +44,10 @@ public SourceRootTranslator(string moduleTestPath, ILogger logger, IFileSystem f
4444
{
4545
throw new FileNotFoundException($"Module test path '{moduleTestPath}' not found", moduleTestPath);
4646
}
47+
48+
string assemblyName = assemblyAdapter.GetAssemblyName(moduleTestPath);
49+
_mappingFileName = $"CoverletSourceRootsMapping_{assemblyName}";
50+
4751
_sourceRootMapping = LoadSourceRootMapping(Path.GetDirectoryName(moduleTestPath));
4852
_sourceToDeterministicPathMapping = LoadSourceToDeterministicPathMapping(_sourceRootMapping);
4953
}
@@ -75,7 +79,7 @@ private Dictionary<string, List<SourceRootMapping>> LoadSourceRootMapping(string
7579
{
7680
var mapping = new Dictionary<string, List<SourceRootMapping>>();
7781

78-
string mappingFilePath = Path.Combine(directory, MappingFileName);
82+
string mappingFilePath = Path.Combine(directory, _mappingFileName);
7983
if (!_fileSystem.Exists(mappingFilePath))
8084
{
8185
return mapping;

‎src/coverlet.msbuild.tasks/InstrumentationTask.cs

+3-1
Original file line numberDiff line numberDiff line change
@@ -73,11 +73,13 @@ public override bool Execute()
7373
IServiceCollection serviceCollection = new ServiceCollection();
7474
serviceCollection.AddTransient<IProcessExitHandler, ProcessExitHandler>();
7575
serviceCollection.AddTransient<IFileSystem, FileSystem>();
76+
serviceCollection.AddTransient<IAssemblyAdapter, AssemblyAdapter>();
7677
serviceCollection.AddTransient<IConsole, SystemConsole>();
7778
serviceCollection.AddTransient<ILogger, MSBuildLogger>(_ => _logger);
7879
serviceCollection.AddTransient<IRetryHelper, RetryHelper>();
7980
// We cache resolutions
80-
serviceCollection.AddSingleton<ISourceRootTranslator, SourceRootTranslator>(serviceProvider => new SourceRootTranslator(Path, serviceProvider.GetRequiredService<ILogger>(), serviceProvider.GetRequiredService<IFileSystem>()));
81+
serviceCollection.AddSingleton<ISourceRootTranslator, SourceRootTranslator>(serviceProvider =>
82+
new SourceRootTranslator(Path, serviceProvider.GetRequiredService<ILogger>(), serviceProvider.GetRequiredService<IFileSystem>(), serviceProvider.GetRequiredService<IAssemblyAdapter>()));
8183
// We need to keep singleton/static semantics
8284
serviceCollection.AddSingleton<IInstrumentationHelper, InstrumentationHelper>();
8385
serviceCollection.AddSingleton<ICecilSymbolHelper, CecilSymbolHelper>();

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@
2424
<_mapping Include="@(_byProject->'%(Identity)|%(OriginalPath)=%(MappedPath)')" />
2525
</ItemGroup>
2626
<PropertyGroup>
27-
<_sourceRootMappingFilePath>$([MSBuild]::EnsureTrailingSlash('$(OutputPath)'))CoverletSourceRootsMapping</_sourceRootMappingFilePath>
27+
<_sourceRootMappingFilePath>$([MSBuild]::EnsureTrailingSlash('$(OutputPath)'))CoverletSourceRootsMapping_$(AssemblyName)</_sourceRootMappingFilePath>
2828
</PropertyGroup>
2929
<WriteLinesToFile File="$(_sourceRootMappingFilePath)" Lines="@(_mapping)"
3030
Overwrite="true" Encoding="Unicode"

0 commit comments

Comments
 (0)