From efd3c4c7d0c12af213b7ca0a65c490f38f0f75c6 Mon Sep 17 00:00:00 2001
From: Benjamin Fuchs <email@benjaminfuchs.de>
Date: Mon, 13 Jan 2025 00:23:53 +0100
Subject: [PATCH] Updating tests

---
 tst/functions/Coverage.Tests.ps1 | 219 ++++++++++++++++++++-----------
 1 file changed, 142 insertions(+), 77 deletions(-)

diff --git a/tst/functions/Coverage.Tests.ps1 b/tst/functions/Coverage.Tests.ps1
index d801f4463..378b876ae 100644
--- a/tst/functions/Coverage.Tests.ps1
+++ b/tst/functions/Coverage.Tests.ps1
@@ -23,8 +23,6 @@ InPesterModuleScope {
             $null = New-Item -Path $testScriptPath -ItemType File -ErrorAction SilentlyContinue
 
             Set-Content -Path $testScriptPath -Value @'
-                using namespace System.Diagnostics.CodeAnalysis
-
                 function FunctionOne
                 {
                     function NestedFunction
@@ -49,14 +47,6 @@ InPesterModuleScope {
                     'I am function two. I never get called.'
                 }
 
-                function FunctionThree
-                {
-                    [ExcludeFromCodeCoverageAttribute(Justification = 'I am not covered')]
-                    param ()
-
-                    'I am function three. I never get called.'
-                }
-
                 FunctionOne
 
 '@
@@ -298,42 +288,42 @@ InPesterModuleScope {
                     <sessioninfo id="this" start="" dump="" />
                     <package name="CommonRoot">
                         <class name="CommonRoot/TestScript" sourcefilename="TestScript.ps1">
-                            <method name="NestedFunction" desc="()" line="7">
+                            <method name="NestedFunction" desc="()" line="5">
                                 <counter type="INSTRUCTION" missed="0" covered="2" />
                                 <counter type="LINE" missed="0" covered="2" />
                                 <counter type="METHOD" missed="0" covered="1" />
                             </method>
-                            <method name="FunctionOne" desc="()" line="11">
+                            <method name="FunctionOne" desc="()" line="9">
                                 <counter type="INSTRUCTION" missed="1" covered="6" />
                                 <counter type="LINE" missed="0" covered="5" />
                                 <counter type="METHOD" missed="0" covered="1" />
                             </method>
-                            <method name="FunctionTwo" desc="()" line="24">
+                            <method name="FunctionTwo" desc="()" line="22">
                                 <counter type="INSTRUCTION" missed="1" covered="0" />
                                 <counter type="LINE" missed="1" covered="0" />
                                 <counter type="METHOD" missed="1" covered="0" />
                             </method>
-                            <method name="&lt;script&gt;" desc="()" line="35">
+                            <method name="&lt;script&gt;" desc="()" line="25">
                                 <counter type="INSTRUCTION" missed="0" covered="3" />
                                 <counter type="LINE" missed="0" covered="3" />
                                 <counter type="METHOD" missed="0" covered="1" />
                             </method>
-                            <method name="MyBaseClass" desc="()" line="41">
+                            <method name="MyBaseClass" desc="()" line="31">
                                 <counter type="INSTRUCTION" missed="0" covered="1" />
                                 <counter type="LINE" missed="0" covered="1" />
                                 <counter type="METHOD" missed="0" covered="1" />
                             </method>
-                            <method name="MyClass" desc="()" line="49">
+                            <method name="MyClass" desc="()" line="39">
                                 <counter type="INSTRUCTION" missed="0" covered="1" />
                                 <counter type="LINE" missed="0" covered="1" />
                                 <counter type="METHOD" missed="0" covered="1" />
                             </method>
-                            <method name="MethodOne" desc="()" line="54">
+                            <method name="MethodOne" desc="()" line="44">
                                 <counter type="INSTRUCTION" missed="0" covered="1" />
                                 <counter type="LINE" missed="0" covered="1" />
                                 <counter type="METHOD" missed="0" covered="1" />
                             </method>
-                            <method name="MethodTwo" desc="()" line="59">
+                            <method name="MethodTwo" desc="()" line="49">
                                 <counter type="INSTRUCTION" missed="1" covered="0" />
                                 <counter type="LINE" missed="1" covered="0" />
                                 <counter type="METHOD" missed="1" covered="0" />
@@ -377,21 +367,21 @@ InPesterModuleScope {
                             <counter type="CLASS" missed="0" covered="1" />
                         </class>
                         <sourcefile name="TestScript.ps1">
-                            <line nr="7" mi="0" ci="1" mb="0" cb="0" />
-                            <line nr="8" mi="0" ci="1" mb="0" cb="0" />
+                            <line nr="5" mi="0" ci="1" mb="0" cb="0" />
+                            <line nr="6" mi="0" ci="1" mb="0" cb="0" />
+                            <line nr="9" mi="0" ci="1" mb="0" cb="0" />
                             <line nr="11" mi="0" ci="1" mb="0" cb="0" />
-                            <line nr="13" mi="0" ci="1" mb="0" cb="0" />
-                            <line nr="14" mi="0" ci="1" mb="0" cb="0" />
-                            <line nr="17" mi="1" ci="1" mb="0" cb="0" />
-                            <line nr="19" mi="0" ci="2" mb="0" cb="0" />
-                            <line nr="24" mi="1" ci="0" mb="0" cb="0" />
-                            <line nr="35" mi="0" ci="1" mb="0" cb="0" />
-                            <line nr="41" mi="0" ci="1" mb="0" cb="0" />
-                            <line nr="49" mi="0" ci="1" mb="0" cb="0" />
+                            <line nr="12" mi="0" ci="1" mb="0" cb="0" />
+                            <line nr="15" mi="1" ci="1" mb="0" cb="0" />
+                            <line nr="17" mi="0" ci="2" mb="0" cb="0" />
+                            <line nr="22" mi="1" ci="0" mb="0" cb="0" />
+                            <line nr="25" mi="0" ci="1" mb="0" cb="0" />
+                            <line nr="31" mi="0" ci="1" mb="0" cb="0" />
+                            <line nr="39" mi="0" ci="1" mb="0" cb="0" />
+                            <line nr="44" mi="0" ci="1" mb="0" cb="0" />
+                            <line nr="49" mi="1" ci="0" mb="0" cb="0" />
+                            <line nr="53" mi="0" ci="1" mb="0" cb="0" />
                             <line nr="54" mi="0" ci="1" mb="0" cb="0" />
-                            <line nr="59" mi="1" ci="0" mb="0" cb="0" />
-                            <line nr="63" mi="0" ci="1" mb="0" cb="0" />
-                            <line nr="64" mi="0" ci="1" mb="0" cb="0" />
                             <counter type="INSTRUCTION" missed="3" covered="14" />
                             <counter type="LINE" missed="2" covered="13" />
                             <counter type="METHOD" missed="2" covered="6" />
@@ -490,42 +480,42 @@ InPesterModuleScope {
                     <sessioninfo id="this" start="" dump="" />
                     <package name=".">
                         <class name="TestScript" sourcefilename="TestScript.ps1">
-                            <method name="NestedFunction" desc="()" line="7">
+                            <method name="NestedFunction" desc="()" line="5">
                                 <counter type="INSTRUCTION" missed="0" covered="2" />
                                 <counter type="LINE" missed="0" covered="2" />
                                 <counter type="METHOD" missed="0" covered="1" />
                             </method>
-                            <method name="FunctionOne" desc="()" line="11">
+                            <method name="FunctionOne" desc="()" line="9">
                                 <counter type="INSTRUCTION" missed="1" covered="6" />
                                 <counter type="LINE" missed="0" covered="5" />
                                 <counter type="METHOD" missed="0" covered="1" />
                             </method>
-                            <method name="FunctionTwo" desc="()" line="24">
+                            <method name="FunctionTwo" desc="()" line="22">
                                 <counter type="INSTRUCTION" missed="1" covered="0" />
                                 <counter type="LINE" missed="1" covered="0" />
                                 <counter type="METHOD" missed="1" covered="0" />
                             </method>
-                            <method name="&lt;script&gt;" desc="()" line="35">
+                            <method name="&lt;script&gt;" desc="()" line="25">
                                 <counter type="INSTRUCTION" missed="0" covered="3" />
                                 <counter type="LINE" missed="0" covered="3" />
                                 <counter type="METHOD" missed="0" covered="1" />
                             </method>
-                            <method name="MyBaseClass" desc="()" line="41">
+                            <method name="MyBaseClass" desc="()" line="31">
                                 <counter type="INSTRUCTION" missed="0" covered="1" />
                                 <counter type="LINE" missed="0" covered="1" />
                                 <counter type="METHOD" missed="0" covered="1" />
                             </method>
-                            <method name="MyClass" desc="()" line="49">
+                            <method name="MyClass" desc="()" line="39">
                                 <counter type="INSTRUCTION" missed="0" covered="1" />
                                 <counter type="LINE" missed="0" covered="1" />
                                 <counter type="METHOD" missed="0" covered="1" />
                             </method>
-                            <method name="MethodOne" desc="()" line="54">
+                            <method name="MethodOne" desc="()" line="44">
                                 <counter type="INSTRUCTION" missed="0" covered="1" />
                                 <counter type="LINE" missed="0" covered="1" />
                                 <counter type="METHOD" missed="0" covered="1" />
                             </method>
-                            <method name="MethodTwo" desc="()" line="59">
+                            <method name="MethodTwo" desc="()" line="49">
                                 <counter type="INSTRUCTION" missed="1" covered="0" />
                                 <counter type="LINE" missed="1" covered="0" />
                                 <counter type="METHOD" missed="1" covered="0" />
@@ -569,21 +559,21 @@ InPesterModuleScope {
                             <counter type="CLASS" missed="0" covered="1" />
                         </class>
                         <sourcefile name="TestScript.ps1">
-                            <line nr="7" mi="0" ci="1" mb="0" cb="0" />
-                            <line nr="8" mi="0" ci="1" mb="0" cb="0" />
+                            <line nr="5" mi="0" ci="1" mb="0" cb="0" />
+                            <line nr="6" mi="0" ci="1" mb="0" cb="0" />
+                            <line nr="9" mi="0" ci="1" mb="0" cb="0" />
                             <line nr="11" mi="0" ci="1" mb="0" cb="0" />
-                            <line nr="13" mi="0" ci="1" mb="0" cb="0" />
-                            <line nr="14" mi="0" ci="1" mb="0" cb="0" />
-                            <line nr="17" mi="1" ci="1" mb="0" cb="0" />
-                            <line nr="19" mi="0" ci="2" mb="0" cb="0" />
-                            <line nr="24" mi="1" ci="0" mb="0" cb="0" />
-                            <line nr="35" mi="0" ci="1" mb="0" cb="0" />
-                            <line nr="41" mi="0" ci="1" mb="0" cb="0" />
-                            <line nr="49" mi="0" ci="1" mb="0" cb="0" />
+                            <line nr="12" mi="0" ci="1" mb="0" cb="0" />
+                            <line nr="15" mi="1" ci="1" mb="0" cb="0" />
+                            <line nr="17" mi="0" ci="2" mb="0" cb="0" />
+                            <line nr="22" mi="1" ci="0" mb="0" cb="0" />
+                            <line nr="25" mi="0" ci="1" mb="0" cb="0" />
+                            <line nr="31" mi="0" ci="1" mb="0" cb="0" />
+                            <line nr="39" mi="0" ci="1" mb="0" cb="0" />
+                            <line nr="44" mi="0" ci="1" mb="0" cb="0" />
+                            <line nr="49" mi="1" ci="0" mb="0" cb="0" />
+                            <line nr="53" mi="0" ci="1" mb="0" cb="0" />
                             <line nr="54" mi="0" ci="1" mb="0" cb="0" />
-                            <line nr="59" mi="1" ci="0" mb="0" cb="0" />
-                            <line nr="63" mi="0" ci="1" mb="0" cb="0" />
-                            <line nr="64" mi="0" ci="1" mb="0" cb="0" />
                             <counter type="INSTRUCTION" missed="3" covered="14" />
                             <counter type="LINE" missed="2" covered="13" />
                             <counter type="METHOD" missed="2" covered="6" />
@@ -685,61 +675,61 @@ InPesterModuleScope {
                                     <methods>
                                         <method name="FunctionOne" signature="()">
                                             <lines>
+                                                <line number="9" hits="1" />
                                                 <line number="11" hits="1" />
-                                                <line number="13" hits="1" />
-                                                <line number="14" hits="1" />
-                                                <line number="17" hits="1" />
-                                                <line number="19" hits="2" />
+                                                <line number="12" hits="1" />
+                                                <line number="15" hits="1" />
+                                                <line number="17" hits="2" />
                                             </lines>
                                         </method>
                                         <method name="FunctionTwo" signature="()">
                                             <lines>
-                                                <line number="24" hits="0" />
+                                                <line number="22" hits="0" />
                                             </lines>
                                         </method>
                                         <method name="MethodOne" signature="()">
                                             <lines>
-                                                <line number="54" hits="1" />
+                                                <line number="44" hits="1" />
                                             </lines>
                                         </method>
                                         <method name="MethodTwo" signature="()">
                                             <lines>
-                                                <line number="59" hits="0" />
+                                                <line number="49" hits="0" />
                                             </lines>
                                         </method>
                                         <method name="MyBaseClass" signature="()">
                                             <lines>
-                                                <line number="41" hits="1" />
+                                                <line number="31" hits="1" />
                                             </lines>
                                         </method>
                                         <method name="MyClass" signature="()">
                                             <lines>
-                                                <line number="49" hits="1" />
+                                                <line number="39" hits="1" />
                                             </lines>
                                         </method>
                                         <method name="NestedFunction" signature="()">
                                             <lines>
-                                                <line number="7" hits="1" />
-                                                <line number="8" hits="1" />
+                                                <line number="5" hits="1" />
+                                                <line number="6" hits="1" />
                                             </lines>
                                         </method>
                                     </methods>
                                     <lines>
-                                        <line number="7" hits="1" />
-                                        <line number="8" hits="1" />
+                                        <line number="5" hits="1" />
+                                        <line number="6" hits="1" />
+                                        <line number="9" hits="1" />
                                         <line number="11" hits="1" />
-                                        <line number="13" hits="1" />
-                                        <line number="14" hits="1" />
-                                        <line number="17" hits="1" />
-                                        <line number="19" hits="2" />
-                                        <line number="24" hits="0" />
-                                        <line number="35" hits="1" />
-                                        <line number="41" hits="1" />
-                                        <line number="49" hits="1" />
+                                        <line number="12" hits="1" />
+                                        <line number="15" hits="1" />
+                                        <line number="17" hits="2" />
+                                        <line number="22" hits="0" />
+                                        <line number="25" hits="1" />
+                                        <line number="31" hits="1" />
+                                        <line number="39" hits="1" />
+                                        <line number="44" hits="1" />
+                                        <line number="49" hits="0" />
+                                        <line number="53" hits="1" />
                                         <line number="54" hits="1" />
-                                        <line number="59" hits="0" />
-                                        <line number="63" hits="1" />
-                                        <line number="64" hits="1" />
                                     </lines>
                                 </class>
                                 <class name="TestScript2.ps1" filename="TestScript2.ps1" line-rate="1"
@@ -931,7 +921,7 @@ InPesterModuleScope {
         ) {
             BeforeAll {
 
-                $breakpoints = Enter-CoverageAnalysis -CodeCoverage @{Path = $testScriptPath; StartLine = 13; EndLine = 14 } -UseBreakpoints $UseBreakpoints
+                $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'
 
@@ -1294,6 +1284,81 @@ InPesterModuleScope {
         }
     }
 
+    Describe 'CoverageLocationVisitor test' {
+        BeforeAll {
+            $testScript = @'
+            using namespace System.Diagnostics.CodeAnalysis
+
+            function FunctionOne {
+                Write-Host "I am functionOne"       # 1 location
+            }
+
+            function FunctionTwo {
+                [ExcludeFromCodeCoverageAttribute()]
+                param()
+
+                Write-Debug "I am functionTwo"       # not collected
+            }
+'@
+
+            $tokens = $null
+            $errors = $null
+            $ast = [System.Management.Automation.Language.Parser]::ParseInput($testScript, [ref]$tokens, [ref]$errors)
+        }
+
+        Context 'VisitScriptBlock' {
+            It 'Skips children with ExcludeFromCodeCoverageAttribute' {
+                $visitor = [Pester.CoverageLocationVisitor]::new()
+                $ast.Visit($visitor)
+
+                $excludedCommand = $visitor.CoverageLocations | Where-Object {
+                    $_ -is [System.Management.Automation.Language.CommandAst] -and
+                    $_.CommandElements[0].Value -eq "Write-Debug"
+                }
+
+                $excludedCommand | Should -BeNullOrEmpty -Because "Commands with the ExcludeFromCodeCoverageAttribute should be skipped."
+            }
+
+            It 'Processes children without ExcludeFromCodeCoverageAttribute' {
+                $visitor = [Pester.CoverageLocationVisitor]::new()
+                $ast.Visit($visitor)
+
+                $includedCommand = $visitor.CoverageLocations | Where-Object {
+                    $_ -is [System.Management.Automation.Language.CommandAst] -and
+                    $_.CommandElements[0].Value -eq "Write-Host"
+                }
+
+                $includedCommand.Count | Should -Be 1 -Because "Commands without the attribute should be included."
+            }
+        }
+
+        Context 'Visit Other AST Types' {
+            It 'Collects Break, Continue, Exit, and Throw statements' {
+                $script = @'
+    foreach ($i in 1..10) { # 1 location
+        break               # 1 location
+        continue            # 1 location
+        if ($i -eq 5) {     # 1 location
+            throw           # 1 location
+        }
+        if ($i -eq 7) {     # 1 location
+            exit            # 1 location
+        }
+        return              # not collected
+    }
+'@
+                $tokens = $null
+                $errors = $null
+                $ast = [System.Management.Automation.Language.Parser]::ParseInput($script, [ref]$tokens, [ref]$errors)
+
+                $visitor = [Pester.CoverageLocationVisitor]::new()
+                $ast.Visit($visitor)
+
+                $visitor.CoverageLocations.Count | Should -Be 7 -Because "Break, Continue, Throw, and Exit statements should be collected."
+            }
+        }
+    }
+
     #     Describe 'Stripping common parent paths' {
 
     #         If ( (& $SafeCommands['Get-Variable'] -Name IsLinux -Scope Global -ErrorAction SilentlyContinue) -or