Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Set profiler based CodeCoverage as default #2456

Merged
merged 1 commit into from
May 17, 2024
Merged

Set profiler based CodeCoverage as default #2456

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions src/Pester.RSpec.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -363,10 +363,10 @@ function New-PesterConfiguration {
CoveragePercentTarget: Target percent of code coverage that you want to achieve, default 75%.
Default value: 75

UseBreakpoints: EXPERIMENTAL: When false, use Profiler based tracer to do CodeCoverage instead of using breakpoints.
Default value: $true
UseBreakpoints: When false, use Profiler based tracer to do CodeCoverage instead of using breakpoints.
Default value: $false

SingleHitBreakpoints: Remove breakpoint when it is hit.
SingleHitBreakpoints: Remove breakpoint when it is hit. This increases performance of breakpoint based CodeCoverage.
Default value: $true

TestResult:
Expand Down
4 changes: 2 additions & 2 deletions src/csharp/Pester/CodeCoverageConfiguration.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,9 +47,9 @@ public CodeCoverageConfiguration() : base("CodeCoverage configuration.")
Path = new StringArrayOption("Directories or files to be used for code coverage, by default the Path(s) from general settings are used, unless overridden here.", new string[0]);
ExcludeTests = new BoolOption("Exclude tests from code coverage. This uses the TestFilter from general configuration.", true);
RecursePaths = new BoolOption("Will recurse through directories in the Path option.", true);
UseBreakpoints = new BoolOption("EXPERIMENTAL: When false, use Profiler based tracer to do CodeCoverage instead of using breakpoints.", true);
UseBreakpoints = new BoolOption("When false, use Profiler based tracer to do CodeCoverage instead of using breakpoints.", false);
CoveragePercentTarget = new DecimalOption("Target percent of code coverage that you want to achieve, default 75%.", 75m);
SingleHitBreakpoints = new BoolOption("Remove breakpoint when it is hit.", true);
SingleHitBreakpoints = new BoolOption("Remove breakpoint when it is hit. This increases performance of breakpoint based CodeCoverage.", true);
}

public CodeCoverageConfiguration(IDictionary configuration) : this()
Expand Down
2 changes: 1 addition & 1 deletion src/functions/Coverage.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
[object[]] $CodeCoverage,
[ScriptBlock] $Logger,
[bool] $UseSingleHitBreakpoints = $true,
[bool] $UseBreakpoints = $true
[bool] $UseBreakpoints = $false
)

if ($null -ne $logger) {
Expand Down
28 changes: 18 additions & 10 deletions tst/functions/Coverage.Tests.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -495,7 +495,7 @@ InPesterModuleScope {
@{ UseBreakpoints = $false; Description = "Profiler based cc" }
) {
BeforeAll {
$breakpoints = Enter-CoverageAnalysis -CodeCoverage @{Path = $testScriptPath; Function = 'FunctionTwo' }
$breakpoints = Enter-CoverageAnalysis -CodeCoverage @{Path = $testScriptPath; Function = 'FunctionTwo' } -UseBreakpoints $UseBreakpoints
@($breakpoints).Count | Should -Be 1 -Because "it has the proper number of breakpoints defined"

if ($UseBreakpoints) {
Expand Down Expand Up @@ -543,7 +543,7 @@ InPesterModuleScope {
) {
BeforeAll {

$breakpoints = Enter-CoverageAnalysis -CodeCoverage @{Path = $testScriptPath; Function = 'FunctionOne' }
$breakpoints = Enter-CoverageAnalysis -CodeCoverage @{Path = $testScriptPath; Function = 'FunctionOne' } -UseBreakpoints $UseBreakpoints

@($breakpoints).Count | Should -Be 9 -Because "it has the proper number of breakpoints defined"

Expand Down Expand Up @@ -592,7 +592,7 @@ InPesterModuleScope {
) {
BeforeAll {

$breakpoints = Enter-CoverageAnalysis -CodeCoverage @{Path = $testScriptPath; StartLine = 11; EndLine = 12 }
$breakpoints = Enter-CoverageAnalysis -CodeCoverage @{Path = $testScriptPath; StartLine = 11; EndLine = 12 } -UseBreakpoints $UseBreakpoints

@($breakpoints).Count | Should -Be 2 -Because 'it has the proper number of breakpoints defined'

Expand Down Expand Up @@ -640,7 +640,7 @@ InPesterModuleScope {
@{ UseBreakpoints = $false; Description = "Profiler based cc" }
) {
BeforeAll {
$breakpoints = Enter-CoverageAnalysis -CodeCoverage @{Path = "$(Join-Path -Path $root -ChildPath *.ps1)"; Function = '*' }
$breakpoints = Enter-CoverageAnalysis -CodeCoverage @{Path = "$(Join-Path -Path $root -ChildPath *.ps1)"; Function = '*' } -UseBreakpoints $UseBreakpoints

@($breakpoints).Count | Should -Be 13 -Because 'it has the proper number of breakpoints defined'

Expand Down Expand Up @@ -700,7 +700,7 @@ InPesterModuleScope {
) {
BeforeAll {

$breakpoints = Enter-CoverageAnalysis -CodeCoverage @{Path = $testScriptPath; Class = 'MyClass' }
$breakpoints = Enter-CoverageAnalysis -CodeCoverage @{Path = $testScriptPath; Class = 'MyClass' } -UseBreakpoints $UseBreakpoints

@($breakpoints).Count | Should -Be 3 -Because 'it has the proper number of breakpoints defined'

Expand Down Expand Up @@ -745,7 +745,7 @@ InPesterModuleScope {
) {
BeforeAll {

$breakpoints = Enter-CoverageAnalysis -CodeCoverage @{Path = $testScriptPath; Class = '*' }
$breakpoints = Enter-CoverageAnalysis -CodeCoverage @{Path = $testScriptPath; Class = '*' } -UseBreakpoints $UseBreakpoints

@($breakpoints).Count | Should -Be 3 -Because 'it has the proper number of breakpoints defined'

Expand Down Expand Up @@ -790,12 +790,20 @@ InPesterModuleScope {
) {
BeforeAll {

$breakpoints = Enter-CoverageAnalysis -CodeCoverage @{Path = $testScriptPath; Class = 'MyClass'; Function = 'MethodTwo' }
$breakpoints = Enter-CoverageAnalysis -CodeCoverage @{Path = $testScriptPath; Class = 'MyClass'; Function = 'MethodTwo' } -UseBreakpoints $UseBreakpoints

@($breakpoints).Count | Should -Be 1 -Because 'it has the proper number of breakpoints defined'

$null = & $testScriptPath
$coverageReport = Get-CoverageReport -CommandCoverage $breakpoints
if ($UseBreakpoints) {
& $testScriptPath
}
else {
$patched, $tracer = Start-TraceScript $breakpoints
try { & $testScriptPath } finally { Stop-TraceScript -Patched $patched }
$measure = $tracer.Hits
}

$coverageReport = Get-CoverageReport -CommandCoverage $breakpoints -Measure $measure
}

It 'Reports the proper number of executed commands' {
Expand Down Expand Up @@ -828,7 +836,7 @@ InPesterModuleScope {
) {
BeforeAll {

$breakpoints = Enter-CoverageAnalysis -CodeCoverage @{ Path = $testScriptPath; Class = 'MyClass' }
$breakpoints = Enter-CoverageAnalysis -CodeCoverage @{ Path = $testScriptPath; Class = 'MyClass' } -UseBreakpoints $UseBreakpoints

@($breakpoints).Count | Should -Be 0 -Because 'it has the proper number of breakpoints defined'

Expand Down