fix nuget package (vstest dependencies) (#1543)

* fix nuget package (vstest dependencies)

* remove unnecessary version strings

* create binlog for test

* update build pipeline steps

* fix typo

* Update publish-coverage-results.yml

remove comment

* fix classfilter

* define more versions for packages with dependencies

* run specific test projects

Author: Bertk

.gitignore

@@ -24,7 +24,7 @@ bld/
 [Bb]in/
 [Oo]bj/
 [Ll]og/
-msbuild.binlog
+*.binlog
 
 # Visual Studio 2015 cache/options directory
 .vs/
@@ -306,3 +306,4 @@ test/coverlet.integration.determisticbuild/*.txt
 test/coverlet.integration.determisticbuild/runsettings
 
 coverage.cobertura.xml
+coverage.opencover.xml

Directory.Build.props

@@ -35,4 +35,18 @@
     <VSTestLogger>@(VSTestLogger)</VSTestLogger>
   </PropertyGroup>
 
+  <PropertyGroup>
+    <!--
+        Do not change versions since we need to support VSTest DataCollectors. We need to load assembly version 1.6.0 to properly work
+        We can check minimum supported package version here https://github.com/Microsoft/vstest/blob/master/src/Microsoft.TestPlatform.ObjectModel/Microsoft.TestPlatform.ObjectModel.csproj#L34
+     -->
+    <!-- VSTest dependency versions -->
+    <!-- https://github.com/microsoft/vstest/blob/fde8bf79d3f0f80e3548f873a56ffb4100c0ae49/eng/Versions.props#L22C1-L54C2 -->
+    <SystemReflectionMetadataVersion>1.6.0</SystemReflectionMetadataVersion>
+    <SystemCollectionsImmutableVersion>1.5.0</SystemCollectionsImmutableVersion>
+    <MicrosoftBuildUtilitiesCorePackageVersion>15.9.20</MicrosoftBuildUtilitiesCorePackageVersion>
+    <MicrosoftExtensionsDependencyModelPackageVersion>3.0.0</MicrosoftExtensionsDependencyModelPackageVersion>
+    <MicrosoftExtensionsFileSystemGlobbingVersion>2.0.0</MicrosoftExtensionsFileSystemGlobbingVersion>
+  </PropertyGroup>
+
 </Project>

Directory.Packages.props

@@ -31,11 +31,11 @@
          vstest 17.8 version
          NuGetFrameworksVersion is defined here https://github.com/microsoft/vstest/blob/9a0c41811637edf4afe0e265e08fdd1cb18109ed/eng/Versions.props#L94C1-L94C1
     -->
-    <PackageVersion Include="NuGet.Frameworks" Version="5.11.5" />
+    <PackageVersion Include="NuGet.Frameworks" Version="6.5.0" />
+    <PackageVersion Include="NuGet.Packaging" Version="6.5.0" />
     <PackageVersion Include="Mono.Cecil" Version="0.11.5" />
     <PackageVersion Include="Moq" Version="4.18.4" />
     <PackageVersion Include="Newtonsoft.Json" Version="13.0.1" />
-    <PackageVersion Include="NuGet.Packaging" Version="6.6.1" />
     <PackageVersion Include="ReportGenerator.Core" Version="5.1.23" />
     <!--For test issue 809 https://github.com/coverlet-coverage/coverlet/issues/809-->
     <PackageVersion Include="LinqKit.Microsoft.EntityFrameworkCore" Version="7.1.4" />
@@ -55,10 +55,10 @@
     System.NotSupportedException : Application is running as testhost, unable to determine parent 'dotnet' process.
     -->
     <PackageVersion Include="Tmds.ExecFunction" Version="0.6.0" />
-    <PackageVersion Include="xunit" Version="2.5.0" />
+    <PackageVersion Include="xunit" Version="2.5.3" />
     <PackageVersion Include="xunit.assemblyfixture" Version="2.2.0" />
-    <PackageVersion Include="xunit.assert" Version="2.5.0" />
-    <PackageVersion Include="xunit.runner.visualstudio" Version="2.5.0"/>
+    <PackageVersion Include="xunit.assert" Version="2.5.3" />
+    <PackageVersion Include="xunit.runner.visualstudio" Version="2.5.3"/>
     <PackageVersion Include="envdte" Version="17.7.37355" />
   </ItemGroup>
 </Project>

eng/build.yml

@@ -12,7 +12,7 @@ steps:
 - script: dotnet restore
   displayName: Restore packages
 
-- script: dotnet build -c $(BuildConfiguration) --no-restore
+- script: dotnet build -c $(BuildConfiguration) --no-restore -bl:build.binlog
   displayName: Build
 
 - script: dotnet pack -c $(BuildConfiguration) --no-restore
@@ -22,7 +22,12 @@ steps:
   displayName: Run tests with coverage
   inputs:
     command: test
-    arguments: -c $(BuildConfiguration) --no-build /p:CollectCoverage=true /p:CoverletOutputFormat=opencover /p:Include="[coverlet.collector]*%2c[coverlet.core]*%2c[coverlet.msbuild.tasks]*" /p:Exclude="[coverlet.core.tests.samples.netstandard]*%2c[coverlet.tests.xunit.extensions]*"
+    projects: |
+         **/coverlet.collector.tests.csproj
+         **/coverlet.core.tests.csproj
+         **/coverlet.integration.tests.csproj
+         **/coverlet.msbuild.tasks.tests.csproj
+    arguments: -c $(BuildConfiguration) --no-build -bl:test.binlog /p:CollectCoverage=true /p:CoverletOutputFormat=opencover /p:Exclude="[coverlet.core.tests.samples.netstandard]*%2c[coverlet.tests.xunit.extensions]*%2c[coverlet.tests.projectsample]*" --diag:"$(Build.SourcesDirectory)\artifacts\log\$(Configuration)\coverlet.test.diag.log;tracelevel=verbose"
     testRunTitle: $(Agent.JobName)
 
 - template: publish-coverlet-result-files.yml
@@ -31,5 +36,5 @@ steps:
   parameters:
     reports: $(Build.SourcesDirectory)/**/coverage.opencover.xml
     condition: and(succeeded(), eq(variables['BuildConfiguration'], 'Debug'))
-    assemblyfilters: '-xunit'
-
+    assemblyfilters: '-xunit;-coverlet.testsubject;-Coverlet.Tests.ProjectSample.*'
+    classfilters: '-[coverlet.core.tests.samples.netstandard]*;-[coverlet.tests.xunit.extensions]*'

eng/publish-coverage-results.yml

@@ -16,19 +16,9 @@ steps:
     targetType: inline
     pwsh: true
     script: |
-      dotnet tool restore
+      dotnet tool restore --add-source https://api.nuget.org/v3/index.json
       dotnet reportgenerator -reports:"${{parameters.reports}}" -targetdir:"$(Build.SourcesDirectory)/artifacts/CoverageReport" -reporttypes:"Html;HtmlInline_AzurePipelines_Dark;Cobertura" -assemblyfilters:"${{parameters.assemblyfilters}}" -classfilters:"${{parameters.classfilters}}" -verbosity:Verbose
 
-# - task: reportgenerator@5
-#   displayName: ReportGenerator
-#   condition: ${{parameters.condition}}
-#   inputs:
-#     reports: ${{parameters.reports}}
-#     targetdir: $(Build.SourcesDirectory)/artifacts/CoverageReport
-#     reporttypes: Html;HtmlInline_AzurePipelines_Dark;Cobertura
-#     verbosity: 'Verbose'
-#     assemblyfilters: ${{parameters.assemblyfilters}}
-
 - publish: '$(Build.SourcesDirectory)/artifacts/CoverageReport'
   displayName: 'Publish CoverageReport Artifact'
   artifact: CoverageResults_$(Agent.Os)_$(BuildConfiguration)

eng/publish-coverlet-result-files.yml

@@ -8,7 +8,6 @@ steps:
     Contents: |
        **/*.trx
        **/*.html
-       **/*.binlog
        **/coverage.opencover.xml
        **/coverage.cobertura.xml
        **/coverage.json
@@ -25,6 +24,14 @@ steps:
     Contents: '**/*.trx'
     TargetFolder: '$(Build.SourcesDirectory)/artifacts/TestLogs'
 
+- task: CopyFiles@2
+  displayName: Copy binlog files
+  condition: always()
+  inputs:
+    SourceFolder: '$(Build.SourcesDirectory)'
+    Contents: '**/*.binlog'
+    TargetFolder: '$(Build.SourcesDirectory)/artifacts/TestLogs/BuildLogs'
+
 - task: PublishPipelineArtifact@1
   displayName: Publish Coverlet logs
   continueOnError: true

src/coverlet.collector/coverlet.collector.csproj

@@ -15,6 +15,7 @@
     <TargetsForTfmSpecificContentInPackage>$(TargetsForTfmSpecificContentInPackage);PackBuildOutputs</TargetsForTfmSpecificContentInPackage>
     <!-- Open issue https://github.com/NuGet/Home/issues/8941 -->
     <NoWarn>$(NoWarn);NU5127</NoWarn>
+    <CentralPackageTransitivePinningEnabled>false</CentralPackageTransitivePinningEnabled>
   </PropertyGroup>
 
   <!-- Nuget package properties https://docs.microsoft.com/en-us/nuget/reference/msbuild-targets -->

src/coverlet.core/coverlet.core.csproj

@@ -7,13 +7,13 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="Microsoft.Extensions.DependencyModel" />
-    <PackageReference Include="Microsoft.Extensions.FileSystemGlobbing" />
-    <PackageReference Include="Microsoft.Extensions.DependencyInjection" />
+    <PackageReference Include="Microsoft.Extensions.DependencyModel" VersionOverride="$(MicrosoftExtensionsDependencyModelPackageVersion)"/>
+    <PackageReference Include="Microsoft.Extensions.FileSystemGlobbing" VersionOverride="$(MicrosoftExtensionsFileSystemGlobbingVersion)" />
+    <PackageReference Include="Microsoft.Extensions.DependencyInjection" VersionOverride="6.0.1"/>
     <PackageReference Include="Mono.Cecil" />
-    <PackageReference Include="System.Collections.Immutable" />
-    <PackageReference Include="System.Reflection.Metadata" />
-    <PackageReference Include="System.Text.Json" />
+    <PackageReference Include="System.Reflection.Metadata" VersionOverride="$(SystemReflectionMetadataVersion)" />
+    <PackageReference Include="System.Collections.Immutable" VersionOverride="$(SystemCollectionsImmutableVersion)"/>
+    <PackageReference Include="System.Text.Json" VersionOverride="6.0.8"/>
   </ItemGroup>
 
 </Project>

src/coverlet.msbuild.tasks/coverlet.msbuild.tasks.csproj

@@ -15,6 +15,7 @@
           If you are packing with NuGet's MSBuild Pack target, you can set <SuppressDependenciesWhenPacking>true</SuppressDependenciesWhenPacking> in any PropertyGroup in your project file.
     -->
     <SuppressDependenciesWhenPacking>true</SuppressDependenciesWhenPacking>
+    <CentralPackageTransitivePinningEnabled>false</CentralPackageTransitivePinningEnabled>
   </PropertyGroup>
 
   <!-- Nuget package properties https://docs.microsoft.com/en-us/nuget/reference/msbuild-targets -->
@@ -36,7 +37,7 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="Microsoft.Build.Utilities.Core" />
+    <PackageReference Include="Microsoft.Build.Utilities.Core" VersionOverride="$(MicrosoftBuildUtilitiesCorePackageVersion)"/>
   </ItemGroup>
 
   <ItemGroup>

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

@@ -94,7 +94,7 @@ private void SetupDataMultipleModule()
             var methods = new Methods();
             string[] methodString = {
                 "System.Void Coverlet.Core.Tests.CoverageSummaryTests::TestCalculateSummary()", // covered
-                "System.Void Coverlet.Core.Tests.CoverageSummaryTests::TestAditionalCalculateSummary()" // not covered
+                "System.Void Coverlet.Core.Tests.CoverageSummaryTests::TestAdditionalCalculateSummary()" // not covered
             };
             methods.Add(methodString[0], new Method());
             methods[methodString[0]].Lines = lines;
@@ -119,7 +119,7 @@ private void SetupDataMultipleModule()
             _averageCalculationMultiModule = new Modules
             {
                 { "module", _averageCalculationSingleModule["module"] },
-                { "aditionalModule", documents }
+                { "additionalModule", documents }
             };
         }
 
@@ -159,7 +159,7 @@ public void TestCalculateLineCoverage_MultiModule()
         {
             var summary = new CoverageSummary();
             Documents documentsFirstModule = _averageCalculationMultiModule["module"];
-            Documents documentsSecondModule = _averageCalculationMultiModule["aditionalModule"];
+            Documents documentsSecondModule = _averageCalculationMultiModule["additionalModule"];
 
             Assert.Equal(37.5, summary.CalculateLineCoverage(_averageCalculationMultiModule).AverageModulePercent);
             Assert.Equal(50, summary.CalculateLineCoverage(documentsFirstModule.First().Value).Percent);
@@ -191,7 +191,7 @@ public void TestCalculateBranchCoverage_MultiModule()
         {
             var summary = new CoverageSummary();
             Documents documentsFirstModule = _averageCalculationMultiModule["module"];
-            Documents documentsSecondModule = _averageCalculationMultiModule["aditionalModule"];
+            Documents documentsSecondModule = _averageCalculationMultiModule["additionalModule"];
 
             Assert.Equal(83.33, summary.CalculateBranchCoverage(_averageCalculationMultiModule).AverageModulePercent);
             Assert.Equal(100, summary.CalculateBranchCoverage(documentsFirstModule.First().Value).Percent);
@@ -220,7 +220,7 @@ public void TestCalculateMethodCoverage_MultiModule()
         {
             var summary = new CoverageSummary();
             Documents documentsFirstModule = _averageCalculationMultiModule["module"];
-            Documents documentsSecondModule = _averageCalculationMultiModule["aditionalModule"];
+            Documents documentsSecondModule = _averageCalculationMultiModule["additionalModule"];
 
             Assert.Equal(75, summary.CalculateMethodCoverage(_averageCalculationMultiModule).AverageModulePercent);
             Assert.Equal(100, summary.CalculateMethodCoverage(documentsFirstModule.First().Value).Percent);