Use VSTest integration for Coverlet

Fixes #15231. Relates to #14427.
Azure · Nov 17, 2020 · e3ed72c · e3ed72c
1 parent e16d1ff
commit e3ed72c
Show file tree

Hide file tree

Showing 5 changed files with 39 additions and 8 deletions.
diff --git a/eng/CodeCoverage.runsettings b/eng/CodeCoverage.runsettings
@@ -0,0 +1,16 @@
+<?xml version="1.0"?>
+<RunSettings>
+  <DataCollectionRunSettings>
+    <DataCollectors>
+      <DataCollector friendlyName="XPlat code coverage">
+        <Configuration>
+          <Format>cobertura</Format>
+          <ExcludeByAttribute>CompilerGeneratedAttribute,ExcludeFromCodeCoverage,GeneratedCodeAttribute,Obsolete</ExcludeByAttribute>
+          <SingleHit>false</SingleHit>
+          <IncludeTestAssembly>false</IncludeTestAssembly>
+          <SkipAutoProps>true</SkipAutoProps>
+        </Configuration>
+      </DataCollector>
+    </DataCollectors>
+  </DataCollectionRunSettings>
+</RunSettings>
diff --git a/eng/CodeCoverage.targets b/eng/CodeCoverage.targets
@@ -1,13 +1,15 @@
 <Project>
   <ItemGroup Condition="'$(IsTestProject)' == 'true'">
-    <PackageReference Include="coverlet.msbuild">
+    <PackageReference Include="coverlet.collector">
       <PrivateAssets>all</PrivateAssets>
       <IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets>
     </PackageReference>
   </ItemGroup>
 
-<!-- Allows Collection of Code Coverage for Deterministic Builds 
-    https://github.com/coverlet-coverage/coverlet/blob/master/Documentation/DeterministicBuild.md -->
+  <!--
+    Allows Collection of Code Coverage for Deterministic Builds
+    https://github.com/coverlet-coverage/coverlet/blob/master/Documentation/DeterministicBuild.md
+  -->
   <ItemGroup>
     <SourceRoot Include="$(NuGetPackageRoot)" />
   </ItemGroup>
@@ -20,4 +22,4 @@
       <_LocalTopLevelSourceRoot Include="@(SourceRoot)" Condition="'%(SourceRoot.NestedRoot)' == ''"/>
     </ItemGroup>
   </Target>
-</Project>
+</Project>
diff --git a/eng/Directory.Build.Data.props b/eng/Directory.Build.Data.props
@@ -51,7 +51,6 @@
     <GenerateAPIListing Condition="'$(IsShippingClientLibrary)' == 'true'">true</GenerateAPIListing>
     <UpdateSourceOnBuild Condition="'$(UpdateSourceOnBuild)' == ''">$(AZURE_DEV_UPDATESOURCESONBUILD)</UpdateSourceOnBuild>
     <PowerShellExe Condition="'$(PowerShellExe)' == ''">pwsh</PowerShellExe>
-    <CoverletOutputFormat Condition="'$(CoverletOutputFormat)' == '' and '$(CollectCoverage)' == 'true'">cobertura</CoverletOutputFormat>
   </PropertyGroup>
 
   <PropertyGroup Condition="'$(IsShippingClientLibrary)' == 'true' and '$(TF_BUILD)' == 'true'">
@@ -73,6 +72,18 @@
     <CodeAnalysisRuleSet>$(RepoEngPath)\CodeAnalysis.ruleset</CodeAnalysisRuleSet>
   </PropertyGroup>
 
+  <!--
+    Code Coverage
+    Enable using MSBuild integration since it's easier to use in build pipelines
+    and likely easier to remember than the VSTest platform integration.
+    Also: https://github.com/coverlet-coverage/coverlet/blob/master/Documentation/KnownIssues.md#1-vstest-stops-process-execution-earlydotnet-test
+  -->
+  <PropertyGroup Condition="'$(CollectCoverage)' == 'true'">
+    <VSTestCollect Condition="'$(VSTestCollect)' == ''">XPlat Code Coverage</VSTestCollect>
+    <!-- Override this property in your projects' or solutions' Directory.Build.props to further customize code coverage. -->
+    <VSTestSetting Condition="'$(VSTestSetting)' == ''">$(MSBuildThisFileDirectory)CodeCoverage.runsettings</VSTestSetting>
+  </PropertyGroup>
+
   <!-- TargetFramework default properties -->
   <PropertyGroup>
     <!-- Client libraries are moving forward to NS 2.0 and Net 4.6.1 as the min supported versions -->

diff --git a/eng/Packages.Data.props b/eng/Packages.Data.props
@@ -32,7 +32,7 @@
     <PackageReference Update="Azure.Storage.Blobs.ChangeFeed" Version="12.0.0-preview.1" />
     <PackageReference Update="BenchmarkDotNet" Version="0.11.5" />
     <PackageReference Update="Castle.Core" Version="4.4.0" />
-    <PackageReference Update="coverlet.msbuild" Version="2.9.0" />
+    <PackageReference Update="coverlet.collector" Version="1.3.0" />
     <PackageReference Update="FluentAssertions" Version="5.10.3" />
     <PackageReference Update="FsCheck.Xunit" Version="2.14.0" />
     <PackageReference Update="Microsoft.Azure.Amqp" Version="2.4.8" />
@@ -69,7 +69,7 @@
     <PackageReference Update="Microsoft.IdentityModel.Clients.ActiveDirectory" Version="4.5.1" />
     <PackageReference Update="Microsoft.Identity.Client" Version="4.22.0" />
     <PackageReference Update="Microsoft.Identity.Client.Extensions.Msal" Version="2.16.5" />
-    <PackageReference Update="Microsoft.NET.Test.Sdk" Version="16.1.0" />
+    <PackageReference Update="Microsoft.NET.Test.Sdk" Version="16.8.0" />
     <PackageReference Update="Microsoft.NETCore.Platforms" Version="2.2.1" />
     <PackageReference Update="Microsoft.NETFramework.ReferenceAssemblies" Version="1.0.0" />
     <PackageReference Update="Microsoft.Rest.ClientRuntime.Azure.Authentication" Version="[2.4.0]" />

diff --git a/eng/pipelines/templates/jobs/archetype-sdk-client.yml b/eng/pipelines/templates/jobs/archetype-sdk-client.yml
@@ -119,6 +119,8 @@ jobs:
         Windows_NetCoreApp:
           OSVmImage: "windows-2019"
           TestTargetFramework: netcoreapp2.1
+          ${{ if eq(variables['System.TeamProject'], 'internal') }}:
+            CollectCoverage: true
         Windows_NetCoreApp_ProjectReferences:
           OSVmImage: "windows-2019"
           TestTargetFramework: netcoreapp2.1
@@ -163,7 +165,7 @@ jobs:
         condition: and(succeeded(), eq(variables['CollectCoverage'], 'true'))
         displayName: ReportGenerator
         inputs:
-          reports: '**/*coverage.netcoreapp2.1.cobertura.xml'
+          reports: 'sdk/**/coverage.cobertura.xml'
           targetdir: '$(Build.SourcesDirectory)'
           reporttypes: Cobertura
       - task: PublishCodeCoverageResults@1