Add comprehensive test coverage reporting infrastructure #33

jbrinkman · 2025-08-18T16:13:31Z

Summary

Implements comprehensive test coverage reporting infrastructure for the C# Valkey GLIDE client project as requested in issue #27. This PR adds automated coverage collection, report generation, and CI/CD integration.

Changes Made

🔧 Task-based Build System (`Taskfile.yml`)

New Taskfile.yml: Comprehensive task definitions for coverage workflows
Coverage tasks: coverage, coverage:unit, coverage:integration
Granular control: Separate tasks for unit tests, integration tests, and combined coverage
Report generation: Automated HTML report generation using ReportGenerator
Coverage merging: Smart merging of multiple coverage files from different test projects
Summary display: JSON-based coverage summary extraction and display

🚀 GitHub Actions Workflow (`.github/workflows/test-coverage.yml`)

Automated PR coverage: Runs coverage analysis on all pull requests
Multi-framework support: Tests both .NET 6.0 and 8.0 targets
Coverage comments: Automatically posts coverage summary as PR comments
Visual indicators: Color-coded coverage status (🟢 Good, 🟡 Moderate, 🔴 Low)
Artifact uploads: Coverage reports and test results uploaded as downloadable artifacts
Coverage thresholds: Built-in quality gates (80%+ line, 70%+ branch = good)

📝 Git Configuration (`.gitignore`)

Reports exclusion: Added [Rr]eports/ to exclude generated coverage reports
Clean repository: Prevents coverage artifacts from being committed

🎯 Features

Coverage Collection

# Run all tests with coverage
task coverage

# Unit tests only  
task coverage:unit

# Integration tests only
task coverage:integration

Report Generation

HTML reports: Rich, interactive coverage reports with drill-down capability
JSON summaries: Machine-readable coverage metrics for automation
Multi-format support: Cobertura XML format for external tool integration

CI/CD Integration

Automatic execution: Coverage runs on every PR
Smart commenting: Updates existing coverage comments rather than creating duplicates
Quality gates: Visual feedback on coverage quality with emoji indicators
Artifact storage: 30-day retention of coverage reports and test results

🔍 Technical Implementation

Coverage Pipeline

Clean environment: Removes old results and creates fresh directories
Tool installation: Automatically installs ReportGenerator if not present
Test execution: Runs tests with Coverlet coverage collection
File merging: Intelligently merges multiple coverage files from different frameworks
Report generation: Creates comprehensive HTML reports and JSON summaries
Summary display: Extracts and displays key coverage metrics

Quality Features

Assembly filtering: Focuses on Valkey.Glide* assemblies only
Test exclusion: Excludes test projects from coverage metrics
Framework support: Works with both net6.0 and net8.0 simultaneously
Cross-platform: Runs on Ubuntu (CI) and supports local development on any OS

📊 Acceptance Criteria ✅

Coverage data collection: ✅ For both unit and integration tests
HTML report generation: ✅ Rich interactive reports with drill-down
Line and branch coverage: ✅ Both metrics tracked and displayed
Multi-framework support: ✅ net6.0 and net8.0 both supported
Performance: ✅ Minimal impact on test execution time
CI/CD integration: ✅ Automated GitHub Actions workflow

🎉 Usage Examples

Local Development

# Quick coverage check
task coverage:unit

# Full coverage report  
task coverage
open reports/index.html  # View detailed HTML report

CI/CD

Coverage automatically runs on PRs
Results posted as PR comments
Reports available as downloadable artifacts

Advanced Usage

# Clean and rebuild
task clean build

# Just run tests (no coverage)
task test:unit

# Coverage summary only
task coverage:summary

🔗 Integration Ready

The coverage data is output in standard formats, making it ready for integration with:

SonarQube: Cobertura XML format support
Codecov.io: Direct XML file upload
Azure DevOps: Native coverage report integration
Other tools: JSON summaries for custom integrations

Fixes #27

Signed-off-by: jbrinkman <[email protected]>

.github/workflows/test-coverage.yml

.gitignore

Yury-Fridlyand · 2025-08-18T17:28:05Z

Taskfile.yml

Please update dev guide

Wanted to have a discussion about taskfile usage as we have a lot of details in the developer guide that probably could move into the taskfile. Didn't want to do that until we discussed.

…rk parameter support- Remove separate test-coverage.yml workflow- Add conditional coverage steps to tests.yml workflow using coverage-check output- Add framework parameter support to Taskfile.yml- Coverage now runs only on Ubuntu x64 with .NET 8.0.x to optimize CI resources- Add .NET 9.0.x support to test workflows for C# language feature compatibility Signed-off-by: jbrinkman <[email protected]>

.github/workflows/tests.yml

Taskfile.yml

Yury-Fridlyand · 2025-08-18T20:26:51Z

Taskfile.yml

+
+vars:
+    TEST_RESULTS_DIR: testresults
+    REPORTS_DIR: reports


Consider updating CI - it stores the report in the project root

Not sure what you want here. All reports are getting uploaded as artifacts correctly. I don't see anything to fix here.

See CI job lines 97-99

…orkflow Signed-off-by: jbrinkman <[email protected]>

Signed-off-by: jbrinkman <[email protected]>

…iggers Signed-off-by: jbrinkman <[email protected]>

…frameworks Signed-off-by: jbrinkman <[email protected]>

Yury-Fridlyand · 2025-08-19T17:08:28Z

Taskfile.yml

+                  ./install_and_test.sh -no-tls -minimal -only-glide -data 1 -tasks 10 -csharp -dotnet-framework net8.0
+                  ./install_and_test.sh -no-tls -minimal -only-glide -data 1 -tasks 10 -csharp -dotnet-framework net6.0


Suggested change

./install_and_test.sh -no-tls -minimal -only-glide -data 1 -tasks 10 -csharp -dotnet-framework net8.0

./install_and_test.sh -no-tls -minimal -only-glide -data 1 -tasks 10 -csharp -dotnet-framework net6.0

./install_and_test.sh -no-tls -minimal -only-glide -data 1 -tasks 10 -csharp

Probably this works too

Taskfile.yml

…k validation Signed-off-by: jbrinkman <[email protected]>

Yury-Fridlyand · 2025-08-20T16:56:39Z

.github/workflows/tests.yml

@@ -109,6 +107,10 @@ jobs:
                  redis-server --save "" --daemonize "yes"
                  ./install_and_test.sh -no-tls -minimal -only-glide -data 1 -tasks 10 -csharp -dotnet-framework net${{ matrix.dotnet }}

+            - name: Run coverage


This runs all tests second time. I propose to add a condition (like else) for test step (lines 97-99)

Yury-Fridlyand · 2025-08-20T16:57:03Z

Taskfile.yml

+
+vars:
+    TEST_RESULTS_DIR: testresults
+    REPORTS_DIR: reports


See CI job lines 97-99

Yury-Fridlyand · 2025-08-20T17:00:59Z

Taskfile.yml

+                  echo "Line Coverage: ${LINE_COVERAGE}%"
+                  echo "Branch Coverage: ${BRANCH_COVERAGE}%"
+                else
+                  echo "No coverage summary found. Run 'task coverage:report' first."


Suggested change

echo "No coverage summary found. Run 'task coverage:report' first."

echo "No coverage summary found. Run 'task coverage:report' first."

exit 1

Taskfile.yml

.github/workflows/run-coverage/action.yml

Co-authored-by: Yury-Fridlyand <[email protected]> Signed-off-by: Joseph Brinkman <[email protected]>

jbrinkman requested a review from a team as a code owner August 18, 2025 16:13

feat: add code coverage reporting

e6ba8b4

Signed-off-by: jbrinkman <[email protected]>

jbrinkman force-pushed the jbrinkman/code-coverage-report branch from 02b0910 to e6ba8b4 Compare August 18, 2025 16:15

ci: add dotnet 9 to pipeline for C#12 syntax

8c8c086

Signed-off-by: jbrinkman <[email protected]>

Yury-Fridlyand reviewed Aug 18, 2025

View reviewed changes

jbrinkman added 6 commits August 18, 2025 16:42

fix: update .NET 8 version check and coverage task parameters in CI w…

820f1c2

…orkflow Signed-off-by: jbrinkman <[email protected]>

ci: only run coverage on .NET 8.0 with Ubuntu x64 and server version 8.1

10946d3

Signed-off-by: jbrinkman <[email protected]>

refactor: extract coverage steps into reusable GitHub action

65690df

Signed-off-by: jbrinkman <[email protected]>

style: standardize quotation marks in coverage workflow action

769aba9

Signed-off-by: jbrinkman <[email protected]>

ci: enable HTML test reports and remove path filters from workflow tr…

e33d67d

…iggers Signed-off-by: jbrinkman <[email protected]>

feat: add benchmark task with Redis server support for multiple .NET …

7d5ec90

…frameworks Signed-off-by: jbrinkman <[email protected]>

Yury-Fridlyand reviewed Aug 19, 2025

View reviewed changes

feat: create benchmark task with detailed results tables and framewor…

37deab5

…k validation Signed-off-by: jbrinkman <[email protected]>

Yury-Fridlyand reviewed Aug 20, 2025

View reviewed changes

jbrinkman and others added 2 commits August 20, 2025 15:32

Update Taskfile.yml

6bfd589

Co-authored-by: Yury-Fridlyand <[email protected]> Signed-off-by: Joseph Brinkman <[email protected]>

Update .github/workflows/run-coverage/action.yml

a265a6b

Co-authored-by: Yury-Fridlyand <[email protected]> Signed-off-by: Joseph Brinkman <[email protected]>

		./install_and_test.sh -no-tls -minimal -only-glide -data 1 -tasks 10 -csharp -dotnet-framework net8.0
		./install_and_test.sh -no-tls -minimal -only-glide -data 1 -tasks 10 -csharp -dotnet-framework net6.0

	echo "No coverage summary found. Run 'task coverage:report' first."
	echo "No coverage summary found. Run 'task coverage:report' first."
	exit 1

Add comprehensive test coverage reporting infrastructure #33

Are you sure you want to change the base?

Add comprehensive test coverage reporting infrastructure #33

Uh oh!

Conversation

jbrinkman commented Aug 18, 2025

Summary

Changes Made

🔧 Task-based Build System (Taskfile.yml)

🚀 GitHub Actions Workflow (.github/workflows/test-coverage.yml)

📝 Git Configuration (.gitignore)

🎯 Features

Coverage Collection

Report Generation

CI/CD Integration

🔍 Technical Implementation

Coverage Pipeline

Quality Features

📊 Acceptance Criteria ✅

🎉 Usage Examples

Local Development

CI/CD

Advanced Usage

🔗 Integration Ready

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

🔧 Task-based Build System (`Taskfile.yml`)

🚀 GitHub Actions Workflow (`.github/workflows/test-coverage.yml`)

📝 Git Configuration (`.gitignore`)