Code coverage

[spetersenms]

Code Coverage Support for AL-Go

This adds Code coverage support to AL-Go for GitHub.

Overview

I use a modified version of the internal test runner, somewhat similar to the one in container helper, which support code coverage. On top of that, I have made a custom parser from the raw csv format we get from BC to the industry standard Cobertura XML format. There is also new action to create a visual overview in builds. The raw data, including the Cobertura xml is included in artifacts so the user can further analyze in 3rd party tools.

As AL-Go currently relies on container helper to run tests, this feature currently uses the test override to use the modified test runner. In the future when we move away from container helper, this test runner should completely replace the old one.

As this is a pretty large feature, it is not turned on by default. I also could not test all possible cases, so there might be some situations where tests do not work on the new runner, in which case the old one should be used.

Key Components

Test Runner Module

The .Modules/TestRunner module has been added as a complete package for handling test running and code coverage generation.

Core Modules:

• BCCoverageParser.psm1 - Parses Business Central coverage files (CSV and XML formats from XMLport 130470/130471/130007)
• ALSourceParser.psm1 - Analyzes AL source code to identify objects, procedures, and executable lines
• CoverageProcessor.psm1 - Orchestrates the coverage processing pipeline
• CoberturaFormatter.psm1 - Converts BC coverage data to Cobertura XML format
• CoberturaMerger.psm1 - Merges multiple Cobertura reports
• CoverageReportGenerator.psm1 - Generates markdown summaries
• ALTestRunner.psm1 - Executes AL test suites with optional coverage collection

Actions

• RunPipeline - Enhanced to support coverage collection during test execution
• BuildCodeCoverageSummary - Generates coverage reports and artifacts
• MergeCoverageSummaries - Combines coverage from multiple projects or test runs

Settings

Two new settings control the feature:

{
  "enableCodeCoverage": false,
  "codeCoverageSetup": {
    "trackingType": "PerRun",
    "produceCodeCoverageMap": "PerCodeunit",
    "excludeFilesPattern": ["*.Test.al", *PermissionSet*]
  }
}

The feature is opt-in and disabled by default to avoid impact on existing workflows.

Technical Details

Breaking Changes

None. The feature is opt-in. Do note however, that the feature is not currently not supported if test override is already used.

Related to issue: #

✅ Checklist

• Add tests (E2E, unit tests)
• Update RELEASENOTES.md
• Update documentation (e.g. for new settings or scenarios)
• Add telemetry