Do not trigger UseShouldProcessForStateChangingFunctions rule for workflows #923
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…uldProcessForStateChangingFunctions
bergmeister
added
in progress
Area - Rules
Issue - Enhancement
and removed
in progress
labels
bergmeister
changed the title
JamesWTruher
suggested changes
Mar 5, 2018
| @@ -42,5 +42,11 @@ Function New-{0} () {{ }} | |||
| It "returns no violations" { | |||
| $noViolations.Count | Should -Be 0 | |||
| } | |||
|
|
|||
| It "Workflows should not trigger a warning because they do not allow SupportsShouldProcess" { | |||
There was a problem hiding this comment.
I think we need to protect this from execution on core, where workflow is not supported. Add '-skip:$IsCore' I think.
There was a problem hiding this comment.
PS> Invoke-ScriptAnalyzer -ScriptDefinition "workflow foo { 'zap' }"
Invoke-ScriptAnalyzer : Parse error in script definition: Workflow is not supported in PowerShell Core at line 1 column 1.
At line:1 char:1
+ Invoke-ScriptAnalyzer -ScriptDefinition "workflow foo { 'zap' }"
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+ CategoryInfo : ParserError: (WorkflowNotSupportedInPowerShellCore:String) [Invoke-ScriptAnalyzer], ParseException
+ FullyQualifiedErrorId : Parse error in script definition: Workflow is not supported in PowerShell Core at line 1 column 1.,Microsoft.Windows.PowerShell.ScriptAnalyzer.Commands.InvokeScriptAnalyzerCommand
There was a problem hiding this comment.
Good catch, thanks, I should've run the test suite in PSCore as well.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
PR Summary
Fixes #922
Workflows do not allow SupportsShouldProcess (the parser does not even allow it), therefore do not trigger UseShouldProcessForStateChangingFunctions
As part of this I also update the copyright header and tidied up unused using statements.
PR Checklist
Note: Tick the boxes below that apply to this pull request by putting an
xbetween the square brackets. Please mark anything not applicable to this PRNA.WIP:to the beginning of the title and remove the prefix when the PR is ready