Tasks/CodeQuality/CodeCoverage.ps1
|
<# .SYNOPSIS Validates code coverage is over the configured minimum for each file tested. .DESCRIPTION Uses the Pester unit test result and fails when any covered file reports a coverage percentage below the configured minimum. .GROUP CodeQuality .CONFIGURATION `Tasks.CodeCoverage.Minimum` controls the minimum acceptable coverage percentage. The default is `75`. ### Example ```powershell . (Get-PlumberTaskLoader) -Config @{ ModuleManifest = 'MyModule.psd1' Tasks = @{ CodeCoverage = @{ Minimum = 85 } } } ``` .RUN ```powershell Invoke-Plumber -Task CodeCoverage ``` .PASS ```text Covered file reports coverage greater than or equal to the configured minimum. ``` .FAIL ```text Covered file reports coverage lower than the configured minimum. ``` #> Add-BuildTask -Name CodeCoverage -Jobs ?PesterUnit, { if (-not $script:pesterResult) { Write-Build Yellow 'No Pester unit test results found' return } $script:pesterResult | ForEach-Object { $file = $_.Containers[0].Name $percent = $_.CodeCoverage.CoveragePercent if ($percent -lt $script:PlumberConfig.Tasks.CodeCoverage.Minimum) { Write-Error "$percent% coverage for $file" } } } |