Tests for [AvoidUsingWMICmdlet Rule

Author: raghushantha

Tests/Rules/AvoidUsingWMICmdlet.ps1

@@ -0,0 +1,18 @@
+#Script violates the rule because Get-CIMInstance is available on PS 3.0 and needs to use that
+
+#requires -version 3.0
+
+function TestFunction
+{
+    Get-WmiObject -Class Win32_ComputerSystem
+
+    Invoke-WMIMethod -Path Win32_Process -Name Create -ArgumentList notepad.exe
+
+    Register-WMIEvent -Class Win32_ProcessStartTrace -SourceIdentifier "ProcessStarted"
+
+    Set-WMIInstance -Class Win32_Environment -Argument @{Name='MyEnvVar';VariableValue='VarValue';UserName='<SYSTEM>'}
+}
+
+TestFunction
+
+Remove-WmiObject -Class Win32_OperatingSystem -Verbose

Tests/Rules/AvoidUsingWMICmdlet.tests.ps1

@@ -0,0 +1,24 @@
+Import-Module PSScriptAnalyzer
+$WMIRuleName = "PSAvoidUsingWMICmdlet"
+$violationMessage = "File 'AvoidUsingWMICmdlet.ps1' uses WMI cmdlet. For PowerShell 3.0 and above, use CIM cmdlet which perform the same tasks as the WMI cmdlets. The CIM cmdlets comply with WS-Management (WSMan) standards and with the Common Information Model (CIM) standard, which enables the cmdlets to use the same techniques to manage Windows computers and those running other operating systems."
+$directory = Split-Path -Parent $MyInvocation.MyCommand.Path
+$violations = Invoke-ScriptAnalyzer $directory\AvoidUsingWMICmdlet.ps1 -IncludeRule $WMIRuleName
+$noViolations = Invoke-ScriptAnalyzer $directory\AvoidUsingWMICmdletNoViolations.ps1 -IncludeRule $WMIRuleName
+
+Describe "AvoidUsingWMICmdlet" {
+    Context "Script contains references to WMI cmdlets - Violation" {
+        It "Have 5 WMI cmdlet Violations" {
+            $violations.Count | Should Be 5
+        }
+
+        It "has the correct description message for WMI rule violation" {
+            $violations[0].Message | Should Be $violationMessage            
+        }
+    }
+
+    Context "Script contains no calls to WMI cmdlet - No violation" {
+        It "results in no rule violations" {
+            $noViolations.Count | Should Be 0
+        }
+    }
+}

Tests/Rules/AvoidUsingWMICmdletNoViolations.ps1

@@ -0,0 +1,19 @@
+# No Rule violations since this script requires PS 2.0 and Get-CIMInstance is not available for this version
+# So using Get-WMIObject is OK
+
+#requires -Version 2.0
+
+Invoke-WMIMethod -Path Win32_Process -Name Create -ArgumentList notepad.exe
+
+function TestFunction
+{
+    Get-WmiObject -Class Win32_ComputerSystem  
+
+    Register-WMIEvent -Class Win32_ProcessStartTrace -SourceIdentifier "ProcessStarted"
+
+    Set-WMIInstance -Class Win32_Environment -Argument @{Name='MyEnvVar';VariableValue='VarValue';UserName='<SYSTEM>'}
+}
+
+TestFunction
+
+Remove-WmiObject -Class Win32_OperatingSystem -Verbose