PowerShell / PowerShell/PSScriptAnalyzer

PSShouldProcess rule ignores ShouldContinue

Aperta
#1,304 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Area - Rules Issue - Bug
Lingua principale
C#
Stelle
2.2k
Fork
414
Merge medio
13h 1m
PR unite (30g)
2

Descrizione

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

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Inizia con la regola PSShouldProcess e riproduci l'avviso usando C:\temp\Invoke-MVP.ps1 tramite Invoke-ScriptAnalyzer. Traccia il modo in cui la regola rileva le chiamate a ShouldProcess e ShouldContinue; il lavoro è completato quando la funzione fornita non produce più un avviso PSShouldProcess quando chiama ShouldContinue.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
csharp, powershell
Ambito
tooling
Tipo di issue
Bug
Difficoltà
3/5
Tempo stimato
1-2 giorni
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
45/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.