Refactor coverage exclusion logic

pester · Dec 29, 2024 · 53c13ac · 53c13ac
1 parent d1c84df
commit 53c13ac
Showing 1 changed file with 57 additions and 44 deletions.
diff --git a/src/functions/Coverage.ps1 b/src/functions/Coverage.ps1
@@ -292,65 +292,63 @@ function Get-CommandsInFile {
         # "return" is not hit in 5.1 but fixed in a later version. Using "return 123" we get hit on 123 but not return.
         # See https://github.com/pester/Pester/issues/1465#issuecomment-604323645
         $predicate = {
-            if ($args[0] -is [System.Management.Automation.Language.DynamicKeywordStatementAst] -or
-                $args[0] -is [System.Management.Automation.Language.CommandBaseAst] -or
-                $args[0] -is [System.Management.Automation.Language.BreakStatementAst] -or
-                $args[0] -is [System.Management.Automation.Language.ContinueStatementAst] -or
-                $args[0] -is [System.Management.Automation.Language.ExitStatementAst] -or
-                $args[0] -is [System.Management.Automation.Language.ThrowStatementAst]) {
-                if (-not (IsExcludedByAttribute -Ast $args[0])) {
-                    return $true
-                }
-            }
+            $args[0] -is [System.Management.Automation.Language.DynamicKeywordStatementAst] -or
+            $args[0] -is [System.Management.Automation.Language.CommandBaseAst] -or
+            $args[0] -is [System.Management.Automation.Language.BreakStatementAst] -or
+            $args[0] -is [System.Management.Automation.Language.ContinueStatementAst] -or
+            $args[0] -is [System.Management.Automation.Language.ExitStatementAst] -or
+            $args[0] -is [System.Management.Automation.Language.ThrowStatementAst] -and
+            -not (IsExcludedByAttribute -Ast $args[0] -TargetAttribute 'System.Diagnostics.CodeAnalysis.ExcludeFromCodeCoverageAttribute')
         }
     }
     else {
         $predicate = {
-            if ($args[0] -is [System.Management.Automation.Language.CommandBaseAst]) {
-                if (-not (IsExcludedByAttribute -Ast $args[0])) {
-                    return $true
-                }
-            }
+            $args[0] -is [System.Management.Automation.Language.CommandBaseAst] -and
+            -not (IsExcludedByAttribute -Ast $args[0] -TargetAttribute 'System.Diagnostics.CodeAnalysis.ExcludeFromCodeCoverageAttribute')
         }
     }
 
     $searchNestedScriptBlocks = $true
     $ast.FindAll($predicate, $searchNestedScriptBlocks)
 }
 
+
 function IsExcludedByAttribute {
     param (
-        [System.Management.Automation.Language.Ast] $Ast
+        [System.Management.Automation.Language.Ast] $Ast,
+        [string] $TargetAttribute
     )
 
-    $functionParents = @()
     for ($parent = $Ast.Parent; $null -ne $parent; $parent = $parent.Parent) {
         if ($parent -is [System.Management.Automation.Language.FunctionDefinitionAst]) {
-            $functionParents += $parent
+            if (Test-ContainsAttribute -FunctionAst $parent -TargetAttribute $TargetAttribute) {
+                return $true
+            }
         }
     }
 
-    $parentsAttributeNames = @()
-    foreach ($functionParent in $functionParents) {
-        $paramBlock = $functionParent.Body.ParamBlock
-        if ($null -ne $paramBlock -and $paramBlock.Attributes) {
-            $parentsAttributeNames += $paramBlock.Attributes.TypeName.FullName
-        }
-    }
+    return $false
+}
 
-    foreach ($parentAttributeName in $parentsAttributeNames) {
-        if ($parentAttributeName -match 'ExcludeFromCodeCoverageAttribute$') {
-            if ($parentAttributeName -eq 'System.Diagnostics.CodeAnalysis.ExcludeFromCodeCoverageAttribute') {
-                return $true
-            }
+function Test-ContainsAttribute {
+    param (
+        [System.Management.Automation.Language.FunctionDefinitionAst] $FunctionAst,
+        [string] $TargetAttribute
+    )
 
-            $namespaces = Get-NamespacesFromAstTopParent -Ast $Ast
-            if ($namespaces) {
-                foreach ($namespace in $namespaces) {
-                    $fullyQualifiedName = "$namespace.$parentAttributeName"
-                    if ($fullyQualifiedName -eq 'System.Diagnostics.CodeAnalysis.ExcludeFromCodeCoverageAttribute') {
-                        return $true
-                    }
+    $AttributeNames = Get-AttributeNames -FunctionAst $FunctionAst
+
+    foreach ($attributeName in $AttributeNames) {
+        if ($attributeName -eq $TargetAttribute) {
+            return $true
+        }
+
+        if ($attributeName.Split('.')[-1] -eq $TargetAttribute.Split('.')[-1]) {
+            $Namespaces = Get-NamespacesFromAstTopParent -Ast $FunctionAst
+            foreach ($namespace in $Namespaces) {
+                $fullyQualifiedName = "$namespace.$attributeName"
+                if ($fullyQualifiedName -eq $TargetAttribute) {
+                    return $true
                 }
             }
         }
@@ -359,6 +357,19 @@ function IsExcludedByAttribute {
     return $false
 }
 
+function Get-AttributeNames {
+    param (
+        [System.Management.Automation.Language.FunctionDefinitionAst] $FunctionAst
+    )
+
+    $paramBlock = $FunctionAst.Body.ParamBlock
+    if ($null -ne $paramBlock -and $paramBlock.Attributes) {
+        return $paramBlock.Attributes.TypeName.FullName
+    }
+
+    return @()
+}
+
 function Get-NamespacesFromAstTopParent {
     param (
         [System.Management.Automation.Language.Ast] $Ast
@@ -367,14 +378,16 @@ function Get-NamespacesFromAstTopParent {
     $namespaces = @()
     $topParent = Get-AstTopParent -Ast $Ast
 
-    if ($null -ne $topParent) {
-        $usingStatements = $topParent.FindAll({
-                param ($node) $node -is [System.Management.Automation.Language.UsingStatementAst] -and $node.UsingStatementKind -eq 'Namespace'
-            }, $true)
+    if ($null -eq $topParent) {
+        return @()
+    }
 
-        foreach ($usingStatement in $usingStatements) {
-            $namespaces += $usingStatement.Name.Value
-        }
+    $usingStatements = $topParent.FindAll({
+            param ($node) $node -is [System.Management.Automation.Language.UsingStatementAst] -and $node.UsingStatementKind -eq 'Namespace'
+        }, $true)
+
+    foreach ($usingStatement in $usingStatements) {
+        $namespaces += $usingStatement.Name.Value
     }
 
     return $namespaces