Skip to content

Fix incorrect Code Coverage report counters (#1242) #1244

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

Merged
nohwnd merged 3 commits into from
Feb 26, 2019
Merged

Fix incorrect Code Coverage report counters (#1242) #1244

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d748e6f
Fix incorrect Code Coverage report counters when there are multiple p…
tbravo5 Feb 14, 2019
3035866
Updated TestScript3.ps1 subFolder name to get consistent cross-platfo…
tbravo5 Feb 15, 2019
479fffa
Empty commit to tigger builds (#1242)
tbravo5 Feb 15, 2019
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
58 changes: 48 additions & 10 deletions Functions/Coverage.Tests.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,12 @@ InModuleScope Pester {
Describe 'Code Coverage Analysis' {
$root = (Get-PSDrive TestDrive).Root

$rootSubFolder = Join-Path -Path $root -ChildPath TestSubFolder
$null = New-Item -Path $rootSubFolder -ItemType Directory -ErrorAction SilentlyContinue

$testScriptPath = Join-Path -Path $root -ChildPath TestScript.ps1
$testScript2Path = Join-Path -Path $root -ChildPath TestScript2.ps1
$testScript3Path = Join-Path -Path $rootSubFolder -ChildPath TestScript3.ps1

$null = New-Item -Path $testScriptPath -ItemType File -ErrorAction SilentlyContinue

Expand Down Expand Up @@ -109,32 +113,42 @@ InModuleScope Pester {
-f `
'other'

'@

$null = New-Item -Path $testScript3Path -ItemType File -ErrorAction SilentlyContinue

Set-Content -Path $testScript3Path -Value @'
'Some {0} file' `
-f `
'other'

'@

Context 'Entire file' {
$testState = New-PesterState -Path $root

# Path deliberately duplicated to make sure the code doesn't produce multiple breakpoints for the same commands
Enter-CoverageAnalysis -CodeCoverage $testScriptPath, $testScriptPath, $testScript2Path -PesterState $testState
Enter-CoverageAnalysis -CodeCoverage $testScriptPath, $testScriptPath, $testScript2Path, $testScript3Path -PesterState $testState

It 'Has the proper number of breakpoints defined' {
$testState.CommandCoverage.Count | Should -Be 17
$testState.CommandCoverage.Count | Should -Be 18
}

$null = & $testScriptPath
$null = & $testScript2Path
$null = & $testScript3Path
$coverageReport = Get-CoverageReport -PesterState $testState

It 'Reports the proper number of executed commands' {
$coverageReport.NumberOfCommandsExecuted | Should -Be 14
$coverageReport.NumberOfCommandsExecuted | Should -Be 15
}

It 'Reports the proper number of analyzed commands' {
$coverageReport.NumberOfCommandsAnalyzed | Should -Be 17
$coverageReport.NumberOfCommandsAnalyzed | Should -Be 18
}

It 'Reports the proper number of analyzed files' {
$coverageReport.NumberOfFilesAnalyzed | Should -Be 2
$coverageReport.NumberOfFilesAnalyzed | Should -Be 3
}

It 'Reports the proper number of missed commands' {
Expand All @@ -148,7 +162,7 @@ InModuleScope Pester {
}

It 'Reports the proper number of hit commands' {
$coverageReport.HitCommands.Count | Should -Be 14
$coverageReport.HitCommands.Count | Should -Be 15
}

It 'Reports the correct hit command' {
Expand Down Expand Up @@ -273,10 +287,34 @@ InModuleScope Pester {
<counter type="METHOD" missed="2" covered="6" />
<counter type="CLASS" missed="0" covered="2" />
</package>
<counter type="INSTRUCTION" missed="3" covered="14" />
<counter type="LINE" missed="2" covered="13" />
<counter type="METHOD" missed="2" covered="6" />
<counter type="CLASS" missed="0" covered="2" />
<package name="CommonRoot/TestSubFolder">
<class name="CommonRoot/TestSubFolder/TestScript3" sourcefilename="TestScript3.ps1">
<method name="&lt;script&gt;" desc="()" line="1">
<counter type="INSTRUCTION" missed="0" covered="1" />
<counter type="LINE" missed="0" covered="1" />
<counter type="METHOD" missed="0" covered="1" />
</method>
<counter type="INSTRUCTION" missed="0" covered="1" />
<counter type="LINE" missed="0" covered="1" />
<counter type="METHOD" missed="0" covered="1" />
<counter type="CLASS" missed="0" covered="1" />
</class>
<sourcefile name="TestScript3.ps1">
<line nr="1" mi="0" ci="1" />
<counter type="INSTRUCTION" missed="0" covered="1" />
<counter type="LINE" missed="0" covered="1" />
<counter type="METHOD" missed="0" covered="1" />
<counter type="CLASS" missed="0" covered="1" />
</sourcefile>
<counter type="INSTRUCTION" missed="0" covered="1" />
<counter type="LINE" missed="0" covered="1" />
<counter type="METHOD" missed="0" covered="1" />
<counter type="CLASS" missed="0" covered="1" />
</package>
<counter type="INSTRUCTION" missed="3" covered="15" />
<counter type="LINE" missed="2" covered="14" />
<counter type="METHOD" missed="2" covered="7" />
<counter type="CLASS" missed="0" covered="3" />
</report>
')
}
Expand Down
24 changes: 20 additions & 4 deletions Functions/Coverage.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -592,6 +592,13 @@ function Get-JaCoCoReportXml {

$packageList = & $SafeCommands['New-Object'] System.Collections.Generic.List[psobject]

$report = @{
Instruction = @{ Missed = 0; Covered = 0 }
Line = @{ Missed = 0; Covered = 0 }
Method = @{ Missed = 0; Covered = 0 }
Class = @{ Missed = 0; Covered = 0 }
}

foreach ($folderGroup in $folderGroups) {

$package = @{
Expand Down Expand Up @@ -660,6 +667,15 @@ function Get-JaCoCoReportXml {
$package.Classes.$file.Lines.$line.Instruction.Covered += $covered
}

$report.Class.Missed += $package.Class.Missed
$report.Class.Covered += $package.Class.Covered
$report.Method.Missed += $package.Method.Missed
$report.Method.Covered += $package.Method.Covered
$report.Line.Missed += $package.Line.Missed
$report.Line.Covered += $package.Line.Covered
$report.Instruction.Missed += $package.Instruction.Missed
$report.Instruction.Covered += $package.Instruction.Covered

$packageList.Add($package)
}

Expand Down Expand Up @@ -746,10 +762,10 @@ function Get-JaCoCoReportXml {
Add-JaCoCoCounter Class $package $packageElement
}

Add-JaCoCoCounter Instruction $package $reportElement
Add-JaCoCoCounter Line $package $reportElement
Add-JaCoCoCounter Method $package $reportElement
Add-JaCoCoCounter Class $package $reportElement
Add-JaCoCoCounter Instruction $report $reportElement
Add-JaCoCoCounter Line $report $reportElement
Add-JaCoCoCounter Method $report $reportElement
Add-JaCoCoCounter Class $report $reportElement

# There is no pretty way to insert the Doctype, as microsoft has deprecated the DTD stuff.
$jaCoCoReportDocType = '<!DOCTYPE report PUBLIC "-//JACOCO//DTD Report 1.1//EN" "report.dtd">'
Expand Down