PowerShell / PowerShell/PSScriptAnalyzer

PSShouldProcess rule ignores ShouldContinue

Open
#1,304 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Area - Rules Issue - Bug
Dominant language
C#
Stars
2.2k
Forks
414
Avg merge
13h 1m
Merged PRs (30d)
2

Description

Steps to reproduce

# File: c:\temp\Invoke-MVP.ps1
function Invoke-MVP {
    [CmdletBinding(SupportsShouldProcess = $true)] # This line shows an exception
    [OutputType('System.String')]
    Param (
        [Parameter()]
        [switch]$Force # just to hide PSAvoidShouldContinueWithoutForce for this MVP
    )
    {
        if ($PSCmdlet.ShouldContinue('Should I continue','Should I continue')) {
            'I continued'
        }
    }
}

Invoke-ScriptAnalyzer -Path 'C:\temp\Invoke-MVP.ps1'

Expected behavior

No error; using ShouldContinue should be equivalent to using ShouldProcess (for which we don't see this issue).

Actual behavior


RuleName                            Severity     ScriptName      Line  Message                                                     
--------                            --------     --------------  ----  -------                                                     
PSShouldProcess                     Warning      Invoke-MVP.ps1 2     'Invoke-POC' has the ShouldProcess attribute but does not   
                                                                  call ShouldProcess/ShouldContinue.                          

Environment data

> $PSVersionTable

Name                           Value                                                                                                                                                                                                             
----                           -----                                                                                                                                                                                                             
PSVersion                      5.1.14409.1018                                                                                                                                                                                                    
PSEdition                      Desktop                                                                                                                                                                                                           
PSCompatibleVersions           {1.0, 2.0, 3.0, 4.0...}                                                                                                                                                                                           
BuildVersion                   10.0.14409.1018                                                                                                                                                                                                   
CLRVersion                     4.0.30319.42000                                                                                                                                                                                                   
WSManStackVersion              3.0                                                                                                                                                                                                               
PSRemotingProtocolVersion      2.3                                                                                                                                                                                                               
SerializationVersion           1.1.0.1           
> (Get-Module -ListAvailable PSScriptAnalyzer).Version | ForEach-Object { $_.ToString() }
1.18.1

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the PSShouldProcess rule and reproduce the warning using C:\temp\Invoke-MVP.ps1 through Invoke-ScriptAnalyzer. Trace how the rule detects ShouldProcess and ShouldContinue calls; done means the supplied function no longer produces a PSShouldProcess warning when it calls ShouldContinue.

Written by the indexing model from the issue text.

Assessment

Tech stack
csharp, powershell
Domain
tooling
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.