-
Notifications
You must be signed in to change notification settings - Fork 280
Enforce minimum code coverage threshold in CI pipeline #7188
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
vhvb1989
wants to merge
5
commits into
main
Choose a base branch
from
enforce-coverage-threshold
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+83
−0
Open
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
a38ca5c
Enforce minimum code coverage threshold in CI pipeline
vhvb1989 b925633
Fix coverage threshold step to use PowerShell task directly
vhvb1989 e4499e1
Fix PowerShell variable interpolation in go tool cover argument
vhvb1989 6bfa342
Set workingDirectory to cli/azd for go tool cover module resolution
vhvb1989 46d8df8
Address PR review feedback
vhvb1989 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,68 @@ | ||
| #!/usr/bin/env pwsh | ||
|
|
||
| <# | ||
| .SYNOPSIS | ||
| Checks that code coverage meets a minimum threshold. | ||
|
|
||
| .DESCRIPTION | ||
| Parses a Go coverage profile using 'go tool cover -func' to extract the | ||
| total statement coverage percentage, then fails if it is below the | ||
| specified minimum. | ||
|
|
||
| .PARAMETER CoverageFile | ||
| Path to the Go coverage profile (typically cover.out). | ||
|
|
||
| .PARAMETER MinimumCoveragePercent | ||
| The minimum acceptable coverage percentage (0-100). The script exits | ||
| with a non-zero code when coverage is below this value. | ||
|
|
||
| .EXAMPLE | ||
| ./Test-CodeCoverageThreshold.ps1 -CoverageFile cover.out -MinimumCoveragePercent 48 | ||
| #> | ||
|
|
||
| param( | ||
| [Parameter(Mandatory = $true)] | ||
| [string]$CoverageFile, | ||
|
|
||
| [Parameter(Mandatory = $true)] | ||
| [ValidateRange(0, 100)] | ||
| [double]$MinimumCoveragePercent | ||
| ) | ||
|
|
||
| $ErrorActionPreference = 'Stop' | ||
|
|
||
| if (-not (Test-Path $CoverageFile)) { | ||
| throw "Coverage file '$CoverageFile' not found" | ||
| } | ||
|
|
||
| Write-Host "Checking code coverage threshold (minimum: $MinimumCoveragePercent%)..." | ||
|
|
||
| # Use 'go tool cover -func' to get per-function coverage and the total line. | ||
| $output = & go tool cover "-func=$CoverageFile" 2>&1 | ||
| if ($LASTEXITCODE -ne 0) { | ||
| throw "go tool cover -func failed: $output" | ||
| } | ||
|
|
||
| # Find the "total:" summary line, which looks like: "total: (statements) 48.3%" | ||
| $totalLine = $output | Where-Object { $_ -match '^\s*total:' } | Select-Object -Last 1 | ||
|
|
||
| if (-not $totalLine) { | ||
| throw "Could not find 'total:' line in 'go tool cover -func' output" | ||
| } | ||
|
|
||
| # Match both integer (100%) and decimal (48.3%) percentages using invariant culture | ||
| if ($totalLine -match '(\d+(?:\.\d+)?)%') { | ||
| $coveragePercent = [double]::Parse($matches[1], [System.Globalization.CultureInfo]::InvariantCulture) | ||
| } else { | ||
| throw "Could not parse coverage percentage from: $totalLine" | ||
| } | ||
|
|
||
| Write-Host "Total statement coverage: $coveragePercent%" | ||
|
|
||
| if ($coveragePercent -lt $MinimumCoveragePercent) { | ||
| Write-Host "##vso[task.logissue type=error]Code coverage $coveragePercent% is below the minimum threshold of $MinimumCoveragePercent%." | ||
| Write-Host "##vso[task.complete result=Failed;]Coverage threshold not met." | ||
| exit 1 | ||
| } | ||
|
|
||
| Write-Host "Coverage $coveragePercent% meets the minimum threshold of $MinimumCoveragePercent%. ✓" | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.