Do not trigger UseShouldProcessForStateChangingFunctions rule for workflows (#923)

* Workflows do not allow SupportsShouldProcess -> do not trigger UseShouldProcessForStateChangingFunctions

* correct typo

* Workflows are not supported in PowerShell 6.0 -> do not run test in this case

Author: bergmeister

Rules/UseShouldProcessForStateChangingFunctions.cs

@@ -1,26 +1,17 @@
-// Copyright (c) Microsoft Corporation.
-//
-// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-// THE SOFTWARE.
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
 
 using System;
 using System.Collections.Generic;
 #if !CORECLR
 using System.ComponentModel.Composition;
 #endif
-using System.Management.Automation;
 using System.Management.Automation.Language;
 using System.Globalization;
-using System.Linq;
 using Microsoft.Windows.PowerShell.ScriptAnalyzer.Generic;
 
 namespace Microsoft.Windows.PowerShell.ScriptAnalyzer.BuiltinRules
-{   
+{
     /// <summary>
     /// UseShouldProcessForStateChangingFunctions: Analyzes the ast to check if ShouldProcess is included in Advanced functions if the Verb of the function could change system state.
     /// </summary>
@@ -61,7 +52,8 @@ public IEnumerable<DiagnosticRecord> AnalyzeScript(Ast ast, string fileName)
         private bool IsStateChangingFunctionWithNoShouldProcessAttribute(Ast ast)
         {
             var funcDefAst = ast as FunctionDefinitionAst;
-            if (funcDefAst == null)
+            // SupportsShouldProcess is not supported in workflows
+            if (funcDefAst == null || funcDefAst.IsWorkflow)
             {
                 return false;
             }

Tests/Rules/UseShouldProcessForStateChangingFunctions.tests.ps1

@@ -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" -Skip:$IsCoreCLR {
+            $violations = Invoke-ScriptAnalyzer -ScriptDefinition 'workflow Set-Something {[CmdletBinding()]Param($Param1)}' | Where-Object {
+                $_.RuleName -eq 'PSUseShouldProcessForStateChangingFunctions' }
+            $violations.Count | Should -Be 0
+        }
     }
 }