ci: add .NET coverage 🧮 (#6)

Author: timdeschryver

.github/workflows/azure-dev.yml

@@ -1,19 +1,23 @@
-# Run when commits are pushed to main
+name: Default
+
 on:
-  workflow_dispatch:
   pull_request:
     types: [opened, synchronize, reopened, closed]
     branches:
       - main
   push:
     branches:
       - main
+  workflow_dispatch:
+
+run-name: Deploy to ${{ inputs.deploy_target }} by @${{ github.actor }}
 
 # Set up permissions for deploying with secretless Azure federated credentials
 # https://learn.microsoft.com/en-us/azure/developer/github/connect-from-azure?tabs=azure-portal%2Clinux#set-up-azure-login-with-openid-connect-authentication
 permissions:
   id-token: write
   contents: read
+  pull-requests: write
 
 concurrency:
   group: ${{ github.workflow }}-${{ github.ref }}
@@ -47,7 +51,8 @@ jobs:
         run: pnpm install --frozen-lockfile
 
       - name: Install Playwright Browsers
-        run: pnpx playwright install --with-deps
+        run: pnpm exec playwright install --with-deps
+        working-directory: Sandbox.EndToEndTests
 
       - name: Install SOPS
         run: |
@@ -67,7 +72,34 @@ jobs:
         run: dotnet build
 
       - name: Run .NET tests
-        run: dotnet test --no-build
+        run: dotnet test --no-build -- --coverage --coverage-output coverage.xml --coverage-output-format cobertura --coverage-settings "../coverage.config"
+
+      - name: ReportGenerator
+        uses: danielpalme/[email protected]
+        with:
+          reports: '**/coverage.xml'
+          targetdir: 'coveragereport'
+          reporttypes: 'HtmlInline;Cobertura;MarkdownSummaryGithub'
+          tag: '${{ github.run_number }}_${{ github.run_id }}'
+          customSettings: 'minimumCoverageThresholds:lineCoverage=70'
+
+      - name: Upload .NET coverage report artifact
+        uses: actions/upload-artifact@v4
+        if: ${{ !cancelled() }}
+        with:
+          name: CoverageReport
+          path: coveragereport
+
+      - name: Add comment to PR
+        if: github.event_name == 'pull_request'
+        run: gh pr comment $PR_NUMBER --edit-last --create-if-none --body-file coveragereport/SummaryGithub.md
+        env:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          PR_NUMBER: ${{ github.event.number }}
+
+      - name: Publish coverage in build summary
+        run: cat coveragereport/SummaryGithub.md >> $GITHUB_STEP_SUMMARY
+        shell: bash
 
       - name: Build Angular workspace
         run: pnpm --filter="sandbox.angular-workspace" build
@@ -79,17 +111,18 @@ jobs:
         run: pnpm --filter="!sandbox.e2e" test
 
       - name: E2E test frontend projects
-        run: DEBUG=pw:webserver pnpm --filter="sandbox.e2e" test
+        run: pnpm --filter="sandbox.e2e" test
         env:
           PLAYWRIGHT_USERNAME: ${{ secrets.PLAYWRIGHT_USERNAME }}
           PLAYWRIGHT_PASSWORD: ${{ secrets.PLAYWRIGHT_PASSWORD }}
+          APPLICATION_URL: ${{ secrets.APPLICATION_URL }}
 
-      - name: 📦 Upload Test Results Artifact
+      - name: Upload E2E Results Artifact
         uses: actions/upload-artifact@v4
-        if: always()
+        if: ${{ !cancelled() }}
         with:
-          name: playwright-test-results
-          path: playwright-report
+          name: playwright-report
+          path: ./Sandbox.EndToEndTests/playwright-report/
 
   release:
     runs-on: ubuntu-latest

.gitignore

@@ -9,6 +9,7 @@ obj/
 packages/
 .vs/
 TestResults/
+CoverageReport/
 
 # Angular
 node_modules/

.runsettings

@@ -24,7 +24,7 @@ await Types()
             .That()
             .Are(Domain)
             .Should()
-            .OnlyDependOn(Types().That().HaveFullNameMatching("(Domain|StronglyTypedIds|System)"))
+            .OnlyDependOn(Types().That().HaveFullNameMatching("(Domain|StronglyTypedIds|System|Microsoft\\.CodeCoverage)"))
             .Because("Domain layer must only depend on itself")
             .Check(Architecture);
     }

Sandbox.Architectural.Tests/DomainLayerTests.cs

@@ -18,7 +18,7 @@ export default defineConfig({
 	/* Opt out of parallel tests on CI. */
 	workers: process.env.CI ? 1 : undefined,
 	/* Reporter to use. See https://playwright.dev/docs/test-reporters */
-	reporter: process.env.CI || process.env['ASPIRE'] ? 'list' : 'html',
+	reporter: process.env.CI ? [['github'], ['html'], ['dot']] : process.env['ASPIRE'] ? 'list' : 'html',
 	/* Shared settings for all the projects below. See https://playwright.dev/docs/api/class-testoptions. */
 	use: {
 		/* Base URL to use in actions like `await page.goto('/')`. */

Sandbox.EndToEndTests/playwright.config.ts

@@ -11,6 +11,7 @@
 
   <ItemGroup>
     <ProjectReference Include="..\Sandbox.ApiService\Sandbox.ApiService.csproj" />
-    <ProjectReference Include="..\Sandbox.Modules.CustomerManagement\Sandbox.Modules.CustomerManagement.csproj" />
+    <ProjectReference
+      Include="..\Sandbox.Modules.CustomerManagement\Sandbox.Modules.CustomerManagement.csproj" />
   </ItemGroup>
-</Project>
+</Project>

Sandbox.Modules.CustomerManagement.Tests/Sandbox.Modules.CustomerManagement.Tests.csproj

@@ -0,0 +1,24 @@
+<?xml version="1.0" encoding="utf-8"?>
+<Configuration>
+  <IncludeTestAssembly>False</IncludeTestAssembly>
+  <CodeCoverage>
+    <Attributes>
+      <Exclude>
+        <Attribute>^System\.Diagnostics\.DebuggerHiddenAttribute$</Attribute>
+        <Attribute>^System\.Diagnostics\.DebuggerNonUserCodeAttribute$</Attribute>
+        <Attribute>^System\.CodeDom\.Compiler\.GeneratedCodeAttribute$</Attribute>
+        <Attribute>^System\.Diagnostics\.CodeAnalysis\.ExcludeFromCodeCoverageAttribute$</Attribute>
+      </Exclude>
+    </Attributes>
+    <Sources>
+      <Exclude>
+        <Source>.*\\.*\.Generated\.cs$</Source>
+        <Source>.*\\.*\.g\.cs$</Source>
+        <Source>.*\\.*_g\.cs$</Source>
+        <Source>.*\\Sandbox\.Migrations\\.*\.cs$</Source>
+        <Source>.*\\.*\.Tests\\.*\.cs$</Source>
+        <Source>.*\\.*\.IntegrationTests\\.*\.cs$</Source>
+      </Exclude>
+    </Sources>
+  </CodeCoverage>
+</Configuration>