Merge branch 'NewRule' into BugFixes

Author: yutingc

RuleDocumentation/UseShouldProcessForStateChangingFunctions.md

@@ -0,0 +1,30 @@
+#UseShouldProcessForStateChangingFunctions
+**Severity Level: Warning**
+
+##Description
+
+Functions that have verbs like New, Start, Stop, Set, Reset that change system state should support 'ShouldProcess'
+
+##How to Fix
+
+To fix a violation of this rule, please add attribute SupportsShouldProcess. eg: [CmdletBinding(SupportsShouldProcess = $true)] to the function.
+
+##Example
+
+Wrong:
+```
+	function Set-ServiceObject
+	{
+	    [CmdletBinding()]
+    	    param ([string]$c)
+	}
+```
+
+Correct: 
+```
+	function Set-ServiceObject
+	{
+	    [CmdletBinding(SupportsShouldProcess = $true)]
+	    param ([string]$c)
+	}
+```

Rules/Strings.Designer.cs

@@ -658,7 +658,7 @@
     <value>Use ShouldProcess For State Changing Functions</value>
   </data>
   <data name="UseShouldProcessForStateChangingFunctionsDescrption" xml:space="preserve">
-    <value>Functions that have verbs like New, Start, Stop, Set, Reset that change system state should support 'ShouldProcess'.</value>
+    <value>Functions that have verbs like New, Start, Stop, Set, Reset, Restart that change system state should support 'ShouldProcess'.</value>
   </data>
   <data name="UseShouldProcessForStateChangingFunctionsError" xml:space="preserve">
     <value>Function ’{0}’ has verb that could change system state. Therefore, the function has to support 'ShouldProcess'.</value>

Rules/Strings.resx

@@ -44,7 +44,7 @@ public IEnumerable<DiagnosticRecord> AnalyzeScript(Ast ast, string fileName)
                 string funcName = funcDefAst.Name;
                 bool hasShouldProcessAttribute = false;
 
-                if (funcName.StartsWith("Get-", StringComparison.OrdinalIgnoreCase) ||
+                if (funcName.StartsWith("Restart-", StringComparison.OrdinalIgnoreCase) ||
                     funcName.StartsWith("Stop-", StringComparison.OrdinalIgnoreCase)||
                     funcName.StartsWith("New-", StringComparison.OrdinalIgnoreCase) ||
                     funcName.StartsWith("Set-", StringComparison.OrdinalIgnoreCase) ||
@@ -76,7 +76,7 @@ public IEnumerable<DiagnosticRecord> AnalyzeScript(Ast ast, string fileName)
                         if (!hasShouldProcessAttribute)
                         {
                             yield return
-                                new DiagnosticRecord(string.Format(CultureInfo.CurrentCulture,Strings.UseShouldProcessForStateChangingFunctionsError, funcName),funcDefAst.Extent, GetName(), DiagnosticSeverity.Warning, fileName);
+                                 new DiagnosticRecord(string.Format(CultureInfo.CurrentCulture,Strings.UseShouldProcessForStateChangingFunctionsError, funcName),funcDefAst.Extent, GetName(), DiagnosticSeverity.Warning, fileName);
                         }
                     }
                 }

Rules/UseShouldProcessForStateChangingFunctions.cs

@@ -0,0 +1,11 @@
+function Get-Service
+{
+    param ([string]$c)
+}
+
+function Get-MyObject{ 
+    [CmdletBinding(SupportsShouldProcess = $false)]
+    param([string]$c, [int]$d) 
+
+} 
+

Tests/Rules/UseShouldProcessForStateChangingFunctions.ps1

@@ -0,0 +1,25 @@
+Import-Module PSScriptAnalyzer
+$violationMessage = "Function ’Get-Service’ has verb that could change system state. Therefore, the function has to support 'ShouldProcess'"
+$violationName = "PSUseShouldProcessForStateChangingFunctions"
+$violationName = "PS.UseShouldProcessForStateChangingFunctions"
+$directory = Split-Path -Parent $MyInvocation.MyCommand.Path
+$violations = Invoke-ScriptAnalyzer $directory\UseShouldProcessForStateChangingFunctions.ps1 | Where-Object {$_.RuleName -eq $violationName}
+$noViolations = Invoke-ScriptAnalyzer $directory\UseShouldProcessForStateChangingFunctionsNoViolations.ps1 | Where-Object {$_.RuleName -eq $violationName}
+
+Describe "" {
+    Context "When there are violations" {
+        It "has 2 violations where ShouldProcess is not supported" {
+            $violations.Count | Should Be 3
+        }
+
+        It "has the correct description message" {
+            $violations[0].Message | Should Match $violationMessage
+        }
+    }
+
+    Context "When there are no violations" {
+        It "returns no violations" {
+            $noViolations.Count | Should Be 0
+        }
+    }
+}

Tests/Rules/UseShouldProcessForStateChangingFunctions.tests.ps1

@@ -0,0 +1,12 @@
+function Get-Service
+{
+    [CmdletBinding(SupportShouldSuppress= $false)]
+    param ([string]$c)
+}
+
+function Test-GetMyObject{ 
+    
+    param([string]$c, [int]$d) 
+
+} 
+