Put test cases for disabled rule in a separate folder

Author: quoctruong

Tests/Disabled Rules/AvoidOneChar.tests.ps1

@@ -0,0 +1,24 @@
+Import-Module PSScriptAnalyzer
+$oneCharMessage = "The cmdlet name O only has one character."
+$oneCharName = "PSOneChar"
+$directory = Split-Path -Parent $MyInvocation.MyCommand.Path
+$invoke = Invoke-ScriptAnalyzer $directory\AvoidUsingReservedCharOneCharNames.ps1 | Where-Object {$_.RuleName -eq $oneCharName}
+$noViolations = Invoke-ScriptAnalyzer $directory\GoodCmdlet.ps1 | Where-Object {$_.RuleName -eq $oneCharName}
+
+Describe "Avoid Using One Char" {
+    Context "When there are violations" {
+        It "has 1 One Char Violation" {
+            $oneCharViolations.Count | Should Be 1
+        }
+
+        It "has the correct description message" {
+            $oneCharViolations[0].Message | Should Match $oneCharMessage
+        }
+    }
+
+    Context "When there are no violations" {
+        It "has no violations" {
+            $noReservedCharViolations.Count | Should Be 0
+        }
+    }
+}

Tests/Disabled Rules/AvoidUnloadableModule.tests.ps1

@@ -0,0 +1,24 @@
+Import-Module PSScriptAnalyzer 
+$unloadableMessage = [regex]::Escape("Cannot load the module TestBadModule that the file TestBadModule.psd1 is in.")
+$unloadableName = "PSAvoidUnloadableModule"
+$directory = Split-Path -Parent $MyInvocation.MyCommand.Path
+$violations = Invoke-ScriptAnalyzer $directory\TestBadModule\TestBadModule.psd1 | Where-Object {$_.RuleName -eq $unloadableName}
+$noViolations = Invoke-ScriptAnalyzer $directory\TestGoodModule\TestGoodModule.psd1 | Where-Object {$_.RuleName -eq $unloadableName}
+
+Describe "AvoidUnloadableModule" {
+    Context "When there are violations" {
+        It "has 1 unloadable module violation" {
+            $violations.Count | Should Be 1
+        }
+
+        It "has the correct description message" {
+            $violations.Message | Should Match $unloadableMessage
+        }
+    }
+
+    Context "When there are no violations" {
+        It "returns no violations" {
+            $noViolations.Count | Should Be 0
+        }
+    }
+}

Tests/Rules/AvoidUsingClearHostWriteHost.ps1 renamed to Tests/Disabled Rules/AvoidUsingClearHost.ps1

@@ -0,0 +1,25 @@
+Import-Module PSScriptAnalyzer
+Set-Alias ctss ConvertTo-SecureString
+$clearHostMessage = "File 'AvoidUsingClearHostWriteHost.ps1' uses Clear-Host. This is not recommended because it may not work in some hosts or there may even be no hosts at all."
+$clearHostName = "PSAvoidUsingClearHost"
+$directory = Split-Path -Parent $MyInvocation.MyCommand.Path
+$violations = Invoke-ScriptAnalyzer $directory\AvoidUsingClearHost.ps1 | Where-Object {$_.RuleName -eq $clearHostName}
+$noViolations = Invoke-ScriptAnalyzer $directory\AvoidUsingClearHostNoViolations.ps1 | Where-Object {$_.RuleName -eq $writeHostName}
+
+Describe "AvoidUsingClearHost" {
+    Context "When there are violations" {
+        It "has 3 Clear-Host violations" {
+            $violations.Count | Should Be 3
+        }
+
+        It "has the correct description message for Clear-Host" {
+            $violations[0].Message | Should Match $clearHostMessage
+        }
+    }
+
+    Context "When there are no violations" {
+        It "returns no violations" {
+            $noViolations.Count | Should Be 0
+        }
+    }
+}

Tests/Disabled Rules/AvoidUsingClearHost.tests.ps1

@@ -1,48 +1,24 @@
 Import-Module PSScriptAnalyzer 
 $missingMessage = "The member 'ModuleVersion' is not present in the module manifest."
 $missingName = "PSMissingModuleManifestField"
-$unloadableMessage = [regex]::Escape("Cannot load the module TestBadModule that the file TestBadModule.psd1 is in.")
-$unloadableName = "PSAvoidUnloadableModule"
 $directory = Split-Path -Parent $MyInvocation.MyCommand.Path
-$violations = Invoke-ScriptAnalyzer $directory\TestBadModule\TestBadModule.psd1
-$missingViolations = $violations | Where-Object {$_.RuleName -eq $missingName}
-$unloadableViolations = $violations | Where-Object {$_.RuleName -eq $unloadableName}
-$noViolations = Invoke-ScriptAnalyzer $directory\TestGoodModule\TestGoodModule.psd1
-$noMissingViolations = $noViolations | Where-Object {$_.RuleName -eq $missingName}
-$noUnloadableViolations = $noViolations | Where-Object {$_.RuleName -eq $unloadableName}
-
-Describe "AvoidUnloadableModule" {
-    Context "When there are violations" {
-        It "has 1 unloadable module violation" {
-            $unloadableViolations.Count | Should Be 1
-        }
-
-        It "has the correct description message" {
-            $unloadableViolations.Message | Should Match $unloadableMessage
-        }
-    }
-
-    Context "When there are no violations" {
-        It "returns no violations" {
-            $noUnloadableViolations.Count | Should Be 0
-        }
-    }
-}
+$violations = Invoke-ScriptAnalyzer $directory\TestBadModule\TestBadModule.psd1 | Where-Object {$_.RuleName -eq $missingName}
+$noViolations = Invoke-ScriptAnalyzer $directory\TestGoodModule\TestGoodModule.psd1 | Where-Object {$_.RuleName -eq $missingName}
 
 Describe "MissingRequiredFieldModuleManifest" {
     Context "When there are violations" {
         It "has 1 missing required field module manifest violation" {
-            $missingViolations.Count | Should Be 1
+            $violations.Count | Should Be 1
         }
 
         It "has the correct description message" {
-            $missingViolations.Message | Should Match $missingMessage
+            $violations.Message | Should Match $missingMessage
         }
     }
 
     Context "When there are no violations" {
         It "returns no violations" {
-            $noMissingViolations.Count | Should Be 0
+            $noViolations.Count | Should Be 0
         }
     }
 }

Tests/Rules/AvoidUsingClearHostWriteHostNoViolations.ps1 renamed to Tests/Disabled Rules/AvoidUsingClearHostNoViolations.ps1

@@ -0,0 +1,24 @@
+Import-Module PSScriptAnalyzer
+$reservedCharMessage = "The cmdlet 'Use-#Reserved' uses a reserved char in its name."
+$reservedCharName = "PSReservedCmdletChar"
+$directory = Split-Path -Parent $MyInvocation.MyCommand.Path
+$violations = Invoke-ScriptAnalyzer $directory\AvoidUsingReservedCharNames.ps1 | Where-Object {$_.RuleName -eq $reservedCharName}
+$noViolations = Invoke-ScriptAnalyzer $directory\GoodCmdlet.ps1 | Where-Object {$_.RuleName -eq $reservedCharName}
+
+Describe "Avoid Using Reserved Char" {
+    Context "When there are violations" {
+        It "has 1 Reserved Char Violation" {
+            $violations.Count | Should Be 1
+        }
+
+        It "has the correct description message" {
+            $violations[0].Message | Should Match $reservedCharMessage
+        }
+    }
+
+    Context "When there are no violations" {
+        It "has no violations" {
+            $noViolations.Count | Should Be 0
+        }
+    }
+}

Tests/Rules/AvoidUsingFilePath.ps1 renamed to Tests/Disabled Rules/AvoidUsingFilePath.ps1

@@ -0,0 +1,6 @@
+Clear-Host
+cls
+Write-Host "aaa"
+clear
+[System.Console]::Write("abcdefg");
+[System.Console]::WriteLine("No console.writeline plz!");

Tests/Rules/AvoidUsingFilePath.tests.ps1 renamed to Tests/Disabled Rules/AvoidUsingFilePath.tests.ps1

@@ -0,0 +1,25 @@
+Import-Module PSScriptAnalyzer
+Set-Alias ctss ConvertTo-SecureString
+$writeHostMessage = [Regex]::Escape("File 'AvoidUsingWriteHost.ps1' uses Write-Host. This is not recommended because it may not work in some hosts or there may even be no hosts at all. Use Write-Output instead.")
+$writeHostName = "PSAvoidUsingWriteHost"
+$directory = Split-Path -Parent $MyInvocation.MyCommand.Path
+$violations = Invoke-ScriptAnalyzer $directory\AvoidUsingWriteHost.ps1 | Where-Object {$_.RuleName -eq $writeHostName}
+$noViolations = Invoke-ScriptAnalyzer $directory\AvoidUsingWriteHostNoViolations.ps1 | Where-Object {$_.RuleName -eq $clearHostName}
+
+Describe "AvoidUsingWriteHost" {
+    Context "When there are violations" {
+        It "has 3 Write-Host violations" {
+            $violations.Count | Should Be 3
+        }
+
+        It "has the correct description message for Write-Host" {
+            $violations[0].Message | Should Match $writeHostMessage
+        }
+    }
+
+    Context "When there are no violations" {
+        It "returns no violations" {
+            $noViolations.Count | Should Be 0
+        }
+    }
+}

Tests/Rules/AvoidUsingFilePathNoViolations.ps1 renamed to Tests/Disabled Rules/AvoidUsingFilePathNoViolations.ps1

@@ -0,0 +1 @@
+Write-Output "This is the correct way to write output"