Fix PSUseShouldProcessForStateChangingFunctions rule (#634)

* Add "start" to state changing verbs

UseShouldProcessForStateChanging did not check for start-* in a function name. This commit adds "start-" to the list of state changing verbs. Also, updates and makes the rule documentation consistent with the implmentation.

* Add tests for each state changing verb

Author: Kapil Borle

Engine/Helper.cs

@@ -1555,13 +1555,14 @@ public bool IsStateChangingFunctionName(string functionName)
             // Array of verbs that can potentially change the state of a system
             string[] stateChangingVerbs =
             {
-                "Restart-",
-                "Stop-",
                 "New-",
                 "Set-",
-                "Update-",
+                "Remove-",
+                "Start-",
+                "Stop-",
+                "Restart-",
                 "Reset-",
-                "Remove-"
+                "Update-"
             };
             foreach (var verb in stateChangingVerbs)
             {

RuleDocumentation/UseShouldProcessForStateChangingFunctions.md

@@ -6,11 +6,13 @@ Functions whose verbs change system state should support `ShouldProcess`.
 
 Verbs that should support `ShouldProcess`:
 * `New`
-* `Reset`
-* `Restart`
 * `Set`
+* `Remove`
 * `Start`
 * `Stop`
+* `Restart`
+* `Reset`
+* `Update`
 
 ##How to Fix
 Include the attribute `SupportsShouldProcess`, in the `CmdletBindingBinding`.

Tests/Rules/UseShouldProcessForStateChangingFunctions.tests.ps1

@@ -6,6 +6,23 @@ $violations = Invoke-ScriptAnalyzer $directory\UseShouldProcessForStateChangingF
 $noViolations = Invoke-ScriptAnalyzer $directory\UseShouldProcessForStateChangingFunctionsNoViolations.ps1 | Where-Object {$_.RuleName -eq $violationName}
 
 Describe "It checks UseShouldProcess is enabled when there are state changing verbs in the function names" {
+    Context "When function name has state changing verb" {
+
+        Function Test-Verb([string] $verb)
+        {
+            $scriptDefinitionGeneric = @'
+Function New-{0} () {{ }}
+'@
+            $scriptDef = $scriptDefinitionGeneric -f $verb
+            It ('finds "{0}" verb in function name' -f $verb) {
+                $violations = Invoke-ScriptAnalyzer -ScriptDefinition $scriptDef -IncludeRule $violationName
+                $violations.Count | Should Be 1
+            }
+        }
+
+        $verbs = @('New', 'Set', 'Remove', 'Start', 'Stop', 'Restart', 'Reset', 'Update')
+        $verbs | ForEach-Object {Test-Verb $_}
+    }
     Context "When there are violations" {
     	$numViolations = 5
         It ("has {0} violations where ShouldProcess is not supported" -f $numViolations) {
@@ -16,9 +33,9 @@ Describe "It checks UseShouldProcess is enabled when there are state changing ve
             $violations[0].Message | Should Match $violationMessage
         }
 
-	It "has the correct extent" {
-	   $violations[0].Extent.Text | Should Be "Set-MyObject"
-	}
+        It "has the correct extent" {
+        $violations[0].Extent.Text | Should Be "Set-MyObject"
+        }
     }
 
     Context "When there are no violations" {