Enable coverage report in PRs (#2946)

AzureAD · Oct 30, 2024 · 0b72d1f · 0b72d1f
1 parent 2477877
commit 0b72d1f
Show file tree

Hide file tree

Showing 4 changed files with 40 additions and 4 deletions.
diff --git a/.github/workflows/dotnetcore.yml b/.github/workflows/dotnetcore.yml
@@ -1,5 +1,9 @@
 name: .NET Core
 
+permissions:
+  contents: read
+  pull-requests: write
+
 on:
   push:
     branches:
@@ -30,20 +34,43 @@ jobs:
       uses: actions/setup-dotnet@v4.0.0
       with:
         dotnet-version: 6.0.x
-
     - name: Setup .NET 8.0.x
       uses: actions/setup-dotnet@v4.0.0
       with:
         dotnet-version: 8.0.x
-
     - name: Setup .NET 9.0.x
       uses: actions/setup-dotnet@v4.0.0
       with:
         dotnet-version: 9.0.100-rc.2.24474.11
 
     - name: Run the tests
-      run: dotnet test Wilson.sln
+      run: dotnet test Wilson.sln --collect:"XPlat Code Coverage" --settings:./build/CodeCoverage.runsettings
+
+    - name: Create code coverage report
+      run: |
+        dotnet tool install -g dotnet-reportgenerator-globaltool
+        reportgenerator -reports:./**/coverage.cobertura.xml -targetdir:CodeCoverage -reporttypes:'MarkdownSummaryGithub;Cobertura'
+
+    - name: Write Coverage to Job Summary
+      shell: bash
+      run: |
+        cat CodeCoverage/SummaryGithub.md >> $GITHUB_STEP_SUMMARY
+        echo "COMMENT_CONTENT_ENV_VAR<<EOF" >> $GITHUB_ENV
+        echo $(cat CodeCoverage/SummaryGithub.md) >> $GITHUB_ENV
+        echo "EOF" >> $GITHUB_ENV
+
+    - name: Comment Coverage in PR
+      uses: actions/github-script@v7
+      id: comment
+      with:
+        script: |
+          github.rest.issues.createComment({
+            issue_number: context.issue.number,
+            owner: context.repo.owner,
+            repo: context.repo.repo,
+            body: process.env.COMMENT_CONTENT_ENV_VAR
+          })
 
     # Run baseline package validation
     - name: Pack
-      run: dotnet pack Product.proj --no-restore --no-build
+      run: dotnet pack Product.proj --no-restore --no-build
diff --git a/build/CodeCoverage.runsettings b/build/CodeCoverage.runsettings
@@ -40,6 +40,10 @@ Included items must then not match any entries in the exclude list to remain inc
                                 <ModulePath>.*\microsoft.identitymodel.xml.dll</ModulePath>
                                 <ModulePath>.*\system.identitymodel.tokens.jwt.dll</ModulePath>
                             </Include>
+                            <Exclude>
+                                <ModulePath>.*\\test\\.*</ModulePath>
+                                <ModulePath>.*Test\.dll</ModulePath>
+                            </Exclude>
                         </ModulePaths>
                         <Attributes>
                             <Exclude>

diff --git a/build/commonTest.props b/build/commonTest.props
@@ -39,6 +39,10 @@
   </ItemGroup>
 
   <ItemGroup>
+    <PackageReference Include="coverlet.collector" Version="$(CoverletCollectorVersion)">
+      <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
+      <PrivateAssets>all</PrivateAssets>
+    </PackageReference>
     <PackageReference Include="Microsoft.CodeAnalysis.BannedApiAnalyzers" Version="$(BannedApiAnalyzersVersion)">
       <PrivateAssets>all</PrivateAssets>
       <IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets>

diff --git a/build/dependenciesTest.props b/build/dependenciesTest.props
@@ -1,5 +1,6 @@
 <Project>
   <PropertyGroup>
+    <CoverletCollectorVersion>6.0.2</CoverletCollectorVersion>
     <BannedApiAnalyzersVersion>3.3.4</BannedApiAnalyzersVersion>
     <DotNetCoreAppRuntimeVersion>2.1.30</DotNetCoreAppRuntimeVersion>
     <MicrosoftAzureKeyVaultCryptographyVersion>3.0.5</MicrosoftAzureKeyVaultCryptographyVersion>