Add test to check PSShouldProcess for recursive calls

Author: Kapil Borle

Tests/Rules/UseShouldProcessCorrectly.tests.ps1

@@ -23,38 +23,101 @@ Describe "UseShouldProcessCorrectly" {
         }
     }
 
-    Context "Where ShouldProcess is called in nested function" {
-        It "finds no violation" {
+    Context "Where ShouldProcess is called by a downstream function" {
+        It "finds no violation for 1 level downstream call" {
             $scriptDef = @'
-function Outer
+function Foo
 {
     [CmdletBinding(SupportsShouldProcess=$true)]
     param()
 
-    Inner
+    Bar
 }
 
-function Inner
+function Bar
 {
     [CmdletBinding(SupportsShouldProcess=$true)]
     param()
 
-    if ($PSCmdlet.ShouldProcess("Inner"))
+    if ($PSCmdlet.ShouldProcess(""))
     {
-        Write-Host "Process!"
+        "Continue normally..."
     }
     else
     {
-        Write-Host "Skipped!"
+        "what would happen..."
     }
 }
 
-Outer -WhatIf
+Foo
 '@
-        $violations = Invoke-ScriptAnalyzer -ScriptDefinition $scriptDef -IncludeRule PSShouldProcess
-        $violations.Count | Should Be 0
+            $violations = Invoke-ScriptAnalyzer -ScriptDefinition $scriptDef -IncludeRule PSShouldProcess
+            $violations.Count | Should Be 0
         }
 
+        It "finds no violation if downstream function does not declare SupportsShouldProcess" {
+              $scriptDef = @'
+function Foo
+{
+    [CmdletBinding(SupportsShouldProcess=$true)]
+    param()
+
+    Bar
+}
+
+function Bar
+{
+    if ($PSCmdlet.ShouldProcess(""))
+    {
+        "Continue normally..."
+    }
+    else
+    {
+        "what would happen..."
+    }
+}
+
+Foo
+'@
+            $violations = Invoke-ScriptAnalyzer -ScriptDefinition $scriptDef -IncludeRule PSShouldProcess
+            $violations.Count | Should Be 0
+        }
+
+        It "finds no violation for 2 level downstream calls" {
+            $scriptDef = @'
+function Foo
+{
+    [CmdletBinding(SupportsShouldProcess=$true)]
+    param()
+
+    Baz
+}
+
+function Baz
+{
+    Bar
+}
+
+function Bar
+{
+    if ($PSCmdlet.ShouldProcess(""))
+    {
+        "Continue normally..."
+    }
+    else
+    {
+        "what would happen..."
+    }
+}
+
+Foo
+'@
+            $violations = Invoke-ScriptAnalyzer -ScriptDefinition $scriptDef -IncludeRule PSShouldProcess
+            $violations.Count | Should Be 0
+        }
+    }
+
+    Context "When downstream function is defined locally in a function scope" {
         It "finds no violation" {
             $scriptDef = @'
 function Foo
@@ -63,19 +126,99 @@ function Foo
    param()
    begin
    {
-       function helper
+       function Bar
        {
            if ($PSCmdlet.ShouldProcess('',''))
            {
 
            }
        }
-       helper
+       bar
    }
 }
 '@
             $violations = Invoke-ScriptAnalyzer -ScriptDefinition $scriptDef -IncludeRule PSShouldProcess
             $violations.Count | Should Be 0
         }
     }
+
+    Context "When a builtin command with SupportsShouldProcess is called" {
+        It "finds no violation for a cmdlet" {
+            $scriptDef = @'
+function Remove-Foo {
+[CmdletBinding(SupportsShouldProcess)]
+    Param(
+        [string] $Path
+    )
+    Write-Verbose "Removing $($path)"
+    Remove-Item -Path $Path
+}
+'@
+            $violations = Invoke-ScriptAnalyzer -ScriptDefinition $scriptDef -IncludeRule PSShouldProcess
+            $violations.Count | Should Be 0
+        }
+
+        It "finds no violation for a function" {
+            $scriptDef = @'
+function Install-Foo {
+[CmdletBinding(SupportsShouldProcess)]
+    Param(
+        [string] $ModuleName
+    )
+    Install-Module $ModuleName
+}
+'@
+            $violations = Invoke-ScriptAnalyzer -ScriptDefinition $scriptDef -IncludeRule PSShouldProcess
+            $violations.Count | Should Be 0
+        }
+
+       It "finds no violation for a function with self reference" {
+            $scriptDef = @'
+function Install-ModuleWithDeps {
+[CmdletBinding(SupportsShouldProcess)]
+    Param(
+        [Parameter(ValueFromPipeline)]
+        [string] $ModuleName
+    )
+    if ($PSCmdlet.ShouldProcess("Install module with dependencies"))
+    {
+        Get-Dependencies $ModuleName | Install-ModuleWithDeps
+        Install-ModuleCustom $ModuleName
+    }
+    else
+    {
+        Get-Dependencies $ModuleName | Install-ModuleWithDeps
+        Write-Host ("Would install module {0}" -f $ModuleName)
+    }
+}
+'@
+            $violations = Invoke-ScriptAnalyzer -ScriptDefinition $scriptDef -IncludeRule PSShouldProcess
+            $violations.Count | Should Be 0
+        }
+
+       It "finds no violation for a function with self reference and implicit call to ShouldProcess" {
+            $scriptDef = @'
+function Install-ModuleWithDeps {
+[CmdletBinding(SupportsShouldProcess)]
+    Param(
+        [Parameter(ValueFromPipeline)]
+        [string] $ModuleName
+    )
+    $deps = Get-Dependencies $ModuleName
+    if ($deps -eq $null)
+    {
+        Install-Module $ModuleName
+    }
+    else
+    {
+        $deps | Install-ModuleWithDeps
+    }
+    Install-Module $ModuleName
+}
+'@
+            $violations = Invoke-ScriptAnalyzer -ScriptDefinition $scriptDef -IncludeRule PSShouldProcess
+            $violations.Count | Should Be 0
+        }
+
+    }
 }