Add tests for rule suppressions

Author: Quoc Truong

Tests/Engine/RuleSuppression.ps1

@@ -0,0 +1,40 @@
+[System.Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSProvideCommentHelp", "", Scope="Function", Target="*")]
+[System.Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSAvoidUsingPositionalParameters", Scope="Function", Target="Test*")]
+Param(
+)
+ 
+function SuppressMe ()
+{
+    [System.Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSProvideVerboseMessage")]
+    [System.Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSAvoidUninitializedVariable", "unused1")]
+    Param([string]$unUsed1, [int] $unUsed2)
+    {
+        Write-Host "I do nothing"
+    }
+
+}
+
+[System.Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSAvoidUsingConvertToSecureStringWithPlainText", "", Scope="Class")]
+[System.Diagnostics.CodeAnalysis.SuppressMessageAttribute("pSAvoidUsingInvokeExpression", "")]
+class TestClass 
+{
+    [void] TestFunction2()
+    {
+        Write-Host "Should not use positional parameters"
+        $a = ConvertTo-SecureString -AsPlainText "Test" -Force
+    }
+
+    [System.Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSAvoidUsingWriteHost", "")]
+    [void] TestFunction()
+    {
+        Write-Host "Should not use write-host!"
+        Invoke-Expression "invoke expression"   
+    }
+
+    [System.Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSAvoidUsingCmdletAliases","")]
+    [bool] Suppress()
+    {
+        gps
+        return $true
+    }
+}

Tests/Engine/RuleSuppression.tests.ps1

@@ -0,0 +1,56 @@
+Import-Module -Verbose PSScriptAnalyzer
+$directory = Split-Path -Parent $MyInvocation.MyCommand.Path
+$violations = Invoke-ScriptAnalyzer $directory\RuleSuppression.ps1
+
+Describe "RuleSuppressionWithoutScope" {
+    Context "Function" {
+        It "Does not raise violations" {
+            $suppression = $violations | Where-Object { $_.RuleName -eq "PSProvideVerboseMessage" }
+            $suppression.Count | Should Be 0
+        }
+    }
+
+    Context "Class" {
+        It "Does not raise violations" {
+            $suppression = $violations | Where-Object {$_.RuleName -eq "PSAvoidUsingInvokeExpression" }
+            $suppression.Count | Should Be 0
+        }
+    }
+
+    Context "FunctionInClass" {
+        It "Does not raise violations" {
+            $suppression = $violations | Where-Object {$_.RuleName -eq "PSAvoidUsingCmdletAliases" }
+            $suppression.Count | Should Be 0
+        }        
+    }
+
+    Context "Script" {
+        It "Does not raise violations" {
+            $suppression = $violations | Where-Object {$_.RuleName -eq "PSProvideCommentHelp" }
+            $suppression.Count | Should Be 0
+        }
+    }
+
+    Context "RuleSuppressionID" {
+        It "Only suppress violations for that ID" {
+            $suppression = $violations | Where-Object {$_.RuleName -eq "PSAvoidUninitializedVariable" }
+            $suppression.Count | Should Be 1
+        }
+    }
+}
+
+Describe "RuleSuppressionWithScope" {
+    Context "FunctionScope" {
+        It "Does not raise violations" {
+            $suppression = $violations | Where-Object {$_.RuleName -eq "PSAvoidUsingPositionalParameters" }
+            $suppression.Count | Should Be 1
+        }
+    }
+
+    Context "ClassScope" {
+        It "Does not raise violations" {
+            $suppression = $violations | Where-Object {$_.RuleName -eq "PSAvoidUsingConvertToSecureStringWithPlainText" }
+            $suppression.Count | Should Be 0
+        }
+    }
+}