Add main-only code coverage job that runs dotCover and uploads to SonarCloud, and restore the coverage badge in README

Author: tjementum

.github/workflows/code-style.yml

@@ -236,6 +236,7 @@ jobs:
 
   sonarcloud:
     name: SonarCloud Analysis
+    if: false # TEMP: disabled while verifying the coverage job; restore to `github.ref != 'refs/heads/main'` before merge.
     needs: detect-scope
     runs-on: ubuntu-24.04
 
@@ -305,3 +306,71 @@ jobs:
           dotnet test account/Account.slnf --no-build &&
           dotnet test main/Main.slnf --no-build &&
           dotnet sonarscanner end
+
+  coverage:
+    name: Code Coverage
+    needs: detect-scope
+    runs-on: ubuntu-24.04
+
+    steps:
+      - name: Checkout Code
+        uses: actions/checkout@v6
+
+      - name: Setup Node.js Environment
+        uses: actions/setup-node@v6
+        with:
+          node-version: 24
+
+      - name: Install Node Modules
+        working-directory: application
+        run: npm ci
+
+      - name: Setup .NET Core SDK
+        uses: actions/setup-dotnet@v5
+        with:
+          global-json-file: application/global.json
+
+      - name: Restore .NET Tools
+        working-directory: application
+        run: dotnet tool restore
+
+      - name: Restore .NET Dependencies
+        working-directory: application
+        run: dotnet restore
+
+      - name: Generate and Set User Secret for Token Signing Key
+        working-directory: application/shared-kernel/SharedKernel
+        run: |
+          # Extract UserSecretsId from the .csproj file
+          USER_SECRETS_ID=$(grep -oP '(?<=<UserSecretsId>).*?(?=</UserSecretsId>)' SharedKernel.csproj)
+
+          # Generate a 512-bit key and set it as a user secret that can be use for token signing when running tests
+          dotnet user-secrets set "authentication-token-signing-key" "$(openssl rand -base64 64)" --id $USER_SECRETS_ID
+
+      - name: Setup Java JDK for SonarScanner
+        uses: actions/setup-java@v5
+        with:
+          distribution: "microsoft"
+          java-version: "17"
+
+      - name: Build Email Templates
+        working-directory: application
+        run: npx turbo run build --filter=@repo/emails
+
+      - name: Run dotCover and Upload to SonarCloud
+        working-directory: application
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
+        run: |
+          if [[ "${{ vars.SONAR_PROJECT_KEY }}" == "" ]] || [[ "${{ vars.SONAR_ORGANIZATION }}" == "" ]] || [[ "${{ secrets.SONAR_TOKEN }}" == "" ]]; then
+            echo "SonarCloud is not enabled. Skipping coverage upload."
+            exit 0
+          fi
+
+          dotnet sonarscanner begin /k:"${{ vars.SONAR_PROJECT_KEY }}" /o:"${{ vars.SONAR_ORGANIZATION }}" /d:sonar.host.url="https://sonarcloud.io" /d:sonar.cs.dotcover.reportsPaths="coverage/*.html" /d:sonar.coverage.exclusions="**/*.ts,**/*.tsx,**/*.js,**/*.jsx,**/Tests/**,**/*.Tests/**" &&
+          dotnet build PlatformPlatform.slnx --no-restore &&
+          dotnet dotcover test account/Account.slnf --no-build --dcOutput=coverage/account.html --dcReportType=HTML --dcFilters="+:Account*;+:SharedKernel;-:*.Tests;-:type=*.AppHost.*" &&
+          dotnet dotcover test main/Main.slnf --no-build --dcOutput=coverage/main.html --dcReportType=HTML --dcFilters="+:Main*;+:SharedKernel;-:*.Tests;-:type=*.AppHost.*" &&
+          dotnet dotcover test AppGateway.Tests/AppGateway.Tests.csproj --no-build --dcOutput=coverage/app-gateway.html --dcReportType=HTML --dcFilters="+:AppGateway*;+:SharedKernel;-:*.Tests;-:type=*.AppHost.*" &&
+          dotnet sonarscanner end

README.md

@@ -11,6 +11,7 @@
 [![GitHub issues with roadmap label](https://img.shields.io/github/issues-raw/platformplatform/PlatformPlatform/roadmap?label=roadmap&logo=github&color=%23006B75)](https://github.com/orgs/PlatformPlatform/projects/2/views/2?filterQuery=is%3Aopen+label%3Aroadmap)
 [![GitHub issues with bug label](https://img.shields.io/github/issues-raw/platformplatform/PlatformPlatform/bug?label=bugs&logo=github&color=red)](https://github.com/platformplatform/PlatformPlatform/issues?q=is%3Aissue+is%3Aopen+label%3Abug)
 
+<a href="https://sonarcloud.io/component_measures?id=PlatformPlatform_platformplatform&metric=coverage" target="_blank" rel="noopener noreferrer"><img src="https://sonarcloud.io/api/project_badges/measure?project=PlatformPlatform_platformplatform&metric=coverage" alt="Coverage" /></a>
 <a href="https://sonarcloud.io/summary/overall?id=PlatformPlatform_platformplatform" target="_blank" rel="noopener noreferrer"><img src="https://sonarcloud.io/api/project_badges/measure?project=PlatformPlatform_platformplatform&metric=alert_status" alt="Quality Gate Status" /></a>
 <a href="https://sonarcloud.io/component_measures?id=PlatformPlatform_platformplatform&metric=Security" target="_blank" rel="noopener noreferrer"><img src="https://sonarcloud.io/api/project_badges/measure?project=PlatformPlatform_platformplatform&metric=security_rating" alt="Security Rating" /></a>
 <a href="https://sonarcloud.io/component_measures?id=PlatformPlatform_platformplatform&metric=Reliability" target="_blank" rel="noopener noreferrer"><img src="https://sonarcloud.io/api/project_badges/measure?project=PlatformPlatform_platformplatform&metric=reliability_rating" alt="Reliability Rating" /></a>