migration to .net 6.0 (#1473)

Co-authored-by: Marco Rossignoli <[email protected]>
coverlet-coverage · May 16, 2023 · 98b84d2 · 98b84d2
1 parent d936138
commit 98b84d2
Show file tree

Hide file tree

Showing 19 changed files with 88 additions and 74 deletions.
diff --git a/Directory.Build.targets b/Directory.Build.targets
@@ -6,7 +6,7 @@
     <PackageReference Update="Microsoft.Extensions.DependencyModel" Version="2.1.0" />
     <PackageReference Update="Microsoft.Extensions.DependencyInjection" Version="6.0.1" />
     <PackageReference Update="Microsoft.Extensions.FileSystemGlobbing" Version="2.0.1" />
-    <PackageReference Update="Microsoft.NET.Test.Sdk" Version="16.5.0" />
+    <PackageReference Update="Microsoft.NET.Test.Sdk" Version="17.5.0" />
     <!-- https://github.com/coverlet-coverage/coverlet/issues/1042 -->
     <PackageReference Update="Microsoft.TestPlatform.ObjectModel" Version="16.9.1" />
     <PackageReference Update="Mono.Cecil" Version="0.11.1" />
@@ -21,8 +21,8 @@
         We can check minimum supported package version here https://github.com/Microsoft/vstest/blob/master/src/Microsoft.TestPlatform.ObjectModel/Microsoft.TestPlatform.ObjectModel.csproj#L37
      -->
     <PackageReference Update="System.Reflection.Metadata" Version="1.5.0" />
-    <PackageReference Update="xunit" Version="2.4.1" />
-    <PackageReference Update="xunit.assert" Version="2.4.1" />
+    <PackageReference Update="xunit" Version="2.4.2" />
+    <PackageReference Update="xunit.assert" Version="2.4.2" />
     <PackageReference Update="xunit.runner.visualstudio" Version="2.4.1"/>
     <PackageReference Update="Tmds.ExecFunction" Version="0.4.0" />
   </ItemGroup>

diff --git a/Documentation/Changelog.md b/Documentation/Changelog.md
@@ -14,6 +14,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 -Allign published nuget package version to github release version [#1413](https://github.com/coverlet-coverage/coverlet/issues/1413)  
 -Sync nuget and github release versions [#1122](https://github.com/coverlet-coverage/coverlet/issues/1122)  
 
+### Improvements 
+-Migration of the project to .NET 6.0 [#1473](https://github.com/coverlet-coverage/coverlet/pull/1473)
+
 ### Breaking changes
 - New parameter `ExcludeAssembliesWithoutSources` to control automatic assembly exclusion [1164](https://github.com/coverlet-coverage/coverlet/issues/1164). The parameter `InstrumentModulesWithoutLocalSources` has been removed. since it can be handled by setting `ExcludeAssembliesWithoutSources` to `None`.
 - The default heuristics for determining whether to instrument an assembly has been changed. In previous versions any missing source file was taken as a signal that it was a third-party project that shouldn't be instrumented, with exceptions for some common file name patterns for source generators. Now only assemblies where no source files at all can be found are excluded from instrumentation, and the code for detecting source generator files have been removed. To get back to the behaviour that at least one missing file is sufficient to exclude an assembly, set `ExcludeAssembliesWithoutSources` to `MissingAny`, or use assembly exclusion filters for more fine-grained control.

diff --git a/eng/build.yml b/eng/build.yml
@@ -9,6 +9,16 @@ steps:
     version: 5.0.401
   displayName: Install .NET Core SDK 5.0.401
 
+- task: UseDotNet@2
+  inputs:
+    version: 6.0.408
+  displayName: Install .NET Core SDK 6.0.408
+
+- task: UseDotNet@2
+  inputs:
+    version: 7.0.203
+  displayName: Install .NET Core SDK 7.0.203
+
 - script: dotnet restore
   displayName: Restore packages
 

diff --git a/global.json b/global.json
@@ -1,6 +1,6 @@
 {
   "sdk": {
-    "version": "5.0.401",
+    "version": "6.0.408",
     "rollForward": "latestMajor"
   }
 }
diff --git a/src/coverlet.console/coverlet.console.csproj b/src/coverlet.console/coverlet.console.csproj
@@ -1,8 +1,8 @@
-<Project Sdk="Microsoft.NET.Sdk">
+<Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
     <OutputType>Exe</OutputType>
-    <TargetFramework>net5.0</TargetFramework>
+    <TargetFramework>net6.0</TargetFramework>
     <ToolCommandName>coverlet</ToolCommandName>
     <PackAsTool>true</PackAsTool>
     <AssemblyTitle>coverlet.console</AssemblyTitle>

diff --git a/src/coverlet.core/Helpers/InstrumentationHelper.cs b/src/coverlet.core/Helpers/InstrumentationHelper.cs
@@ -125,20 +125,18 @@ public bool HasPdb(string module, out bool embedded)
 
         public bool EmbeddedPortablePdbHasLocalSource(string module, AssemblySearchType excludeAssembliesWithoutSources)
         {
-            using (Stream moduleStream = _fileSystem.OpenRead(module))
-            using (var peReader = new PEReader(moduleStream))
+            using Stream moduleStream = _fileSystem.OpenRead(module);
+            using var peReader = new PEReader(moduleStream);
+            foreach (DebugDirectoryEntry entry in peReader.ReadDebugDirectory())
             {
-                foreach (DebugDirectoryEntry entry in peReader.ReadDebugDirectory())
+                if (entry.Type == DebugDirectoryEntryType.EmbeddedPortablePdb)
                 {
-                    if (entry.Type == DebugDirectoryEntryType.EmbeddedPortablePdb)
-                    {
-                        using MetadataReaderProvider embeddedMetadataProvider = peReader.ReadEmbeddedPortablePdbDebugDirectoryData(entry);
-                        MetadataReader metadataReader = embeddedMetadataProvider.GetMetadataReader();
+                    using MetadataReaderProvider embeddedMetadataProvider = peReader.ReadEmbeddedPortablePdbDebugDirectoryData(entry);
+                    MetadataReader metadataReader = embeddedMetadataProvider.GetMetadataReader();
 
-                        if (!MatchDocumentsWithSources(module, excludeAssembliesWithoutSources, metadataReader))
-                        {
-                            return false;
-                        }
+                    if (!MatchDocumentsWithSources(module, excludeAssembliesWithoutSources, metadataReader))
+                    {
+                        return false;
                     }
                 }
             }
@@ -150,31 +148,29 @@ public bool EmbeddedPortablePdbHasLocalSource(string module, AssemblySearchType
 
         public bool PortablePdbHasLocalSource(string module, AssemblySearchType excludeAssembliesWithoutSources)
         {
-            using (Stream moduleStream = _fileSystem.OpenRead(module))
-            using (var peReader = new PEReader(moduleStream))
+            using Stream moduleStream = _fileSystem.OpenRead(module);
+            using var peReader = new PEReader(moduleStream);
+            foreach (DebugDirectoryEntry entry in peReader.ReadDebugDirectory())
             {
-                foreach (DebugDirectoryEntry entry in peReader.ReadDebugDirectory())
+                if (entry.Type == DebugDirectoryEntryType.CodeView)
                 {
-                    if (entry.Type == DebugDirectoryEntryType.CodeView)
+                    CodeViewDebugDirectoryData codeViewData = peReader.ReadCodeViewDebugDirectoryData(entry);
+                    using Stream pdbStream = _fileSystem.OpenRead(_sourceRootTranslator.ResolveFilePath(codeViewData.Path));
+                    using var metadataReaderProvider = MetadataReaderProvider.FromPortablePdbStream(pdbStream);
+                    MetadataReader metadataReader = null;
+                    try
+                    {
+                        metadataReader = metadataReaderProvider.GetMetadataReader();
+                    }
+                    catch (BadImageFormatException)
+                    {
+                        _logger.LogWarning($"{nameof(BadImageFormatException)} during MetadataReaderProvider.FromPortablePdbStream in InstrumentationHelper.PortablePdbHasLocalSource, unable to check if module has got local source.");
+                        return true;
+                    }
+
+                    if (!MatchDocumentsWithSources(module, excludeAssembliesWithoutSources, metadataReader))
                     {
-                        CodeViewDebugDirectoryData codeViewData = peReader.ReadCodeViewDebugDirectoryData(entry);
-                        using Stream pdbStream = _fileSystem.OpenRead(_sourceRootTranslator.ResolveFilePath(codeViewData.Path));
-                        using var metadataReaderProvider = MetadataReaderProvider.FromPortablePdbStream(pdbStream);
-                        MetadataReader metadataReader = null;
-                        try
-                        {
-                            metadataReader = metadataReaderProvider.GetMetadataReader();
-                        }
-                        catch (BadImageFormatException)
-                        {
-                            _logger.LogWarning($"{nameof(BadImageFormatException)} during MetadataReaderProvider.FromPortablePdbStream in InstrumentationHelper.PortablePdbHasLocalSource, unable to check if module has got local source.");
-                            return true;
-                        }
-
-                        if (!MatchDocumentsWithSources(module, excludeAssembliesWithoutSources, metadataReader))
-                        {
-                            return false;
-                        }
+                        return false;
                     }
                 }
             }

diff --git a/test/coverlet.collector.tests/coverlet.collector.tests.csproj b/test/coverlet.collector.tests/coverlet.collector.tests.csproj
@@ -2,7 +2,7 @@
   <Import Project="$(RepoRoot)src\coverlet.msbuild.tasks\coverlet.msbuild.props" />
 
   <PropertyGroup>
-    <TargetFramework>net5.0</TargetFramework>
+    <TargetFramework>net6.0</TargetFramework>
     <IsPackable>false</IsPackable>
   </PropertyGroup>
 

diff --git a/test/coverlet.core.performancetest/coverlet.core.performancetest.csproj b/test/coverlet.core.performancetest/coverlet.core.performancetest.csproj
@@ -2,13 +2,14 @@
   <Import Project="$(RepoRoot)src\coverlet.msbuild.tasks\coverlet.msbuild.props" />
 
   <PropertyGroup>
-    <TargetFramework>net5.0</TargetFramework>
+    <TargetFramework>net6.0</TargetFramework>
     <IsPackable>false</IsPackable>
   </PropertyGroup>
 
   <ItemGroup>
     <PackageReference Include="xunit" />
     <PackageReference Include="xunit.runner.visualstudio" />
+    <PackageReference Include="Microsoft.NET.Test.Sdk" />
   </ItemGroup>
 
   <ItemGroup>

diff --git a/test/coverlet.core.tests/Instrumentation/InstrumenterTests.cs b/test/coverlet.core.tests/Instrumentation/InstrumenterTests.cs
@@ -514,11 +514,11 @@ public void CanInstrumentFSharpAssemblyWithAnonymousRecord()
             string sample = Directory.GetFiles(Directory.GetCurrentDirectory(), "coverlet.tests.projectsample.fsharp.dll").First();
             var instrumentationHelper =
                 new InstrumentationHelper(new ProcessExitHandler(), new RetryHelper(), new FileSystem(), new Mock<ILogger>().Object,
-                    new SourceRootTranslator(sample, new Mock<ILogger>().Object, new FileSystem(), new AssemblyAdapter()));
+                    new SourceRootTranslator(Assembly.GetExecutingAssembly().Location, new Mock<ILogger>().Object, new FileSystem(), new AssemblyAdapter()));
 
             var instrumenter = new Instrumenter(sample, "_coverlet_tests_projectsample_fsharp", new CoverageParameters(), loggerMock.Object, instrumentationHelper,
-                new FileSystem(), new SourceRootTranslator(sample, loggerMock.Object, new FileSystem(), new AssemblyAdapter()), new CecilSymbolHelper());
-
+                new FileSystem(), new SourceRootTranslator(Assembly.GetExecutingAssembly().Location, loggerMock.Object, new FileSystem(), new AssemblyAdapter()), new CecilSymbolHelper());
+            
             Assert.True(instrumentationHelper.HasPdb(sample, out bool embedded));
             Assert.False(embedded);
             Assert.True(instrumenter.CanInstrument());

diff --git a/test/coverlet.core.tests/coverlet.core.tests.csproj b/test/coverlet.core.tests/coverlet.core.tests.csproj
@@ -2,7 +2,7 @@
   <Import Project="$(RepoRoot)src\coverlet.msbuild.tasks\coverlet.msbuild.props" />
 
   <PropertyGroup>
-    <TargetFramework>net5.0</TargetFramework>
+    <TargetFramework>net6.0</TargetFramework>
     <IsPackable>false</IsPackable>
     <NoWarn>$(NoWarn);CS8002</NoWarn>
     <MSBuildWarningsAsMessages>NU1702</MSBuildWarningsAsMessages>

diff --git a/test/coverlet.integration.determisticbuild/coverlet.integration.determisticbuild.csproj b/test/coverlet.integration.determisticbuild/coverlet.integration.determisticbuild.csproj
@@ -3,7 +3,7 @@
   <Import Project="$(MSBuildThisFileDirectory)\DeterministicTest.props" />
 
   <PropertyGroup>
-    <TargetFramework>net5.0</TargetFramework>
+    <TargetFramework>net6.0</TargetFramework>
     <IsPackable>false</IsPackable>
     <AssemblyName>coverletsample.integration.determisticbuild</AssemblyName>
     <RestoreSources>

diff --git a/test/coverlet.integration.template/coverlet.integration.template.csproj b/test/coverlet.integration.template/coverlet.integration.template.csproj
@@ -1,7 +1,7 @@
 <Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
-    <TargetFramework>net5.0</TargetFramework>
+    <TargetFramework>net6.0</TargetFramework>
     <IsPackable>false</IsPackable>
     <AssemblyName>coverletsamplelib.integration.template</AssemblyName>
     <IsTestProject>false</IsTestProject>
@@ -10,8 +10,8 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="xunit" Version="2.4.1" />
-    <PackageReference Include="xunit.runner.visualstudio" Version="2.4.1"/>
+	  <PackageReference Include="xunit" Version="2.4.1" />
+	  <PackageReference Include="xunit.runner.visualstudio" Version="2.4.1"/>
   </ItemGroup>
 
 </Project>
diff --git a/test/coverlet.integration.tests/BaseTest.cs b/test/coverlet.integration.tests/BaseTest.cs
@@ -65,7 +65,7 @@ private protected string GetPackageVersion(string filter)
             }
         }
 
-        private protected ClonedTemplateProject CloneTemplateProject(bool cleanupOnDispose = true, string testSDKVersion = "16.5.0")
+        private protected ClonedTemplateProject CloneTemplateProject(bool cleanupOnDispose = true, string testSDKVersion = "17.5.0")
         {
             DirectoryInfo finalRoot = Directory.CreateDirectory($"{Guid.NewGuid().ToString("N")[..6]}{Interlocked.Increment(ref s_folderSuffix)}");
             foreach (string file in (Directory.GetFiles($"../../../../coverlet.integration.template", "*.cs")
@@ -248,12 +248,14 @@ private protected void AssertCoverage(ClonedTemplateProject clonedTemplateProjec
                 bool coverageChecked = false;
                 foreach (string coverageFile in clonedTemplateProject.GetFiles(filter))
                 {
-                    JsonConvert.DeserializeObject<Modules>(File.ReadAllText(coverageFile))
-                    .Document("DeepThought.cs")
-                    .Class("Coverlet.Integration.Template.DeepThought")
-                    .Method("System.Int32 Coverlet.Integration.Template.DeepThought::AnswerToTheUltimateQuestionOfLifeTheUniverseAndEverything()")
-                    .AssertLinesCovered((6, 1), (7, 1), (8, 1));
-                    coverageChecked = true;
+                    Classes? document = JsonConvert.DeserializeObject<Modules>(File.ReadAllText(coverageFile))?.Document("DeepThought.cs");
+                    if (document != null)
+                    {
+                        document.Class("Coverlet.Integration.Template.DeepThought")
+                            .Method("System.Int32 Coverlet.Integration.Template.DeepThought::AnswerToTheUltimateQuestionOfLifeTheUniverseAndEverything()")
+                            .AssertLinesCovered((6, 1), (7, 1), (8, 1));
+                        coverageChecked = true;
+                    }
                 }
 
                 Assert.True(coverageChecked, $"Coverage check fail\n{standardOutput}");

diff --git a/test/coverlet.integration.tests/DeterministicBuild.cs b/test/coverlet.integration.tests/DeterministicBuild.cs
@@ -45,13 +45,15 @@ private protected void AssertCoverage(string standardOutput = "", bool checkDete
                 string reportFilePath = "";
                 foreach (string coverageFile in Directory.GetFiles(_testProjectPath, "coverage.json", SearchOption.AllDirectories))
                 {
-                    JsonConvert.DeserializeObject<Modules>(File.ReadAllText(coverageFile))
-                    .Document("DeepThought.cs")
-                    .Class("Coverlet.Integration.DeterministicBuild.DeepThought")
-                    .Method("System.Int32 Coverlet.Integration.DeterministicBuild.DeepThought::AnswerToTheUltimateQuestionOfLifeTheUniverseAndEverything()")
-                    .AssertLinesCovered((6, 1), (7, 1), (8, 1));
-                    coverageChecked = true;
-                    reportFilePath = coverageFile;
+                    Classes? document = JsonConvert.DeserializeObject<Modules>(File.ReadAllText(coverageFile))?.Document("DeepThought.cs");
+                    if (document != null)
+                    {
+                        document.Class("Coverlet.Integration.DeterministicBuild.DeepThought")
+                            .Method("System.Int32 Coverlet.Integration.DeterministicBuild.DeepThought::AnswerToTheUltimateQuestionOfLifeTheUniverseAndEverything()")
+                            .AssertLinesCovered((6, 1), (7, 1), (8, 1));
+                        coverageChecked = true;
+                        reportFilePath = coverageFile;
+                    }
                 }
                 Assert.True(coverageChecked, $"Coverage check fail\n{standardOutput}");
                 File.Delete(reportFilePath);