Rule for presence of deprecated WMIObject cmdlets

Author: raghushantha

Rules/AvoidUsingWMIObjectCmdlet.cs

@@ -0,0 +1,127 @@
+//
+// Copyright (c) Microsoft Corporation.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+// THE SOFTWARE.
+//
+
+using System;
+using System.Collections.ObjectModel;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+using System.Management.Automation;
+using System.Management.Automation.Language;
+using Microsoft.Windows.Powershell.ScriptAnalyzer.Generic;
+using System.ComponentModel.Composition;
+using System.Resources;
+using System.Globalization;
+using System.Threading;
+using System.Reflection;
+
+namespace Microsoft.Windows.Powershell.ScriptAnalyzer.BuiltinRules
+{
+    /// <summary>
+    /// AvoidUsingWMIObjectCmdlet: Verify that Get-WMIObject, Remove-WMIObject are not used
+    /// </summary>
+    [Export(typeof(IScriptRule))]
+    public class AvoidUsingWMIObjectCmdlet : IScriptRule
+    {
+        /// <summary>
+        /// AnalyzeScript: Verify that Get-WMIObject, Remove-WMIObject are not used
+        /// </summary>
+        public IEnumerable<DiagnosticRecord> AnalyzeScript(Ast ast, string fileName)
+        {
+            if (ast == null) throw new ArgumentNullException(Strings.NullAstErrorMessage);
+
+            // Rule is applicable only when PowerShell Version is < 3.0, since Get-CIMInstance was introduced in 3.0
+            int majorPSVersion = GetPSMajorVersion(ast);
+            if (!(3 > majorPSVersion && 0 < majorPSVersion))
+            {
+                // Finds all CommandAsts.
+                IEnumerable<Ast> commandAsts = ast.FindAll(testAst => testAst is CommandAst, true);
+
+                // Iterate all CommandAsts and check the command name
+                foreach (CommandAst cmdAst in commandAsts)
+                {
+                    if (cmdAst.GetCommandName() != null && (String.Equals(cmdAst.GetCommandName(), "get-wmiobject", StringComparison.OrdinalIgnoreCase) || String.Equals(cmdAst.GetCommandName(), "remove-wmiobject", StringComparison.OrdinalIgnoreCase)))
+                    {
+                        yield return new DiagnosticRecord(String.Format(CultureInfo.CurrentCulture, Strings.AvoidUsingWMIObjectCmdletError, System.IO.Path.GetFileName(fileName)),
+                            cmdAst.Extent, GetName(), DiagnosticSeverity.Warning, fileName);
+                    }
+                }
+            }
+        }
+
+        /// <summary>
+        /// GetPSMajorVersion: Retrieves Major PowerShell Version when supplied using #requires keyword in the script
+        /// </summary>
+        /// <returns>The name of this rule</returns>
+        private int GetPSMajorVersion(Ast ast)
+        {
+            if (ast == null) throw new ArgumentNullException(Strings.NullAstErrorMessage);
+
+            IEnumerable<Ast> scriptBlockAsts = ast.FindAll(testAst => testAst is ScriptBlockAst, true);
+            
+            foreach (ScriptBlockAst scriptBlockAst in scriptBlockAsts)
+            {
+                if (null != scriptBlockAst.ScriptRequirements && null != scriptBlockAst.ScriptRequirements.RequiredPSVersion)
+                {
+                    return scriptBlockAst.ScriptRequirements.RequiredPSVersion.Major;
+                }
+            }
+
+            // return a non valid Major version if #requires -Version is not supplied in the Script
+            return -1;
+        }
+
+        /// <summary>
+        /// GetName: Retrieves the name of this rule.
+        /// </summary>
+        /// <returns>The name of this rule</returns>
+        public string GetName()
+        {
+            return string.Format(CultureInfo.CurrentCulture, Strings.NameSpaceFormat, GetSourceName(), Strings.AvoidUsingWMIObjectCmdletName);
+        }
+
+        /// <summary>
+        /// GetCommonName: Retrieves the common name of this rule.
+        /// </summary>
+        /// <returns>The common name of this rule</returns>
+        public string GetCommonName()
+        {
+            return string.Format(CultureInfo.CurrentCulture, Strings.AvoidUsingWMIObjectCmdletCommonName);
+        }
+
+        /// <summary>
+        /// GetDescription: Retrieves the description of this rule.
+        /// </summary>
+        /// <returns>The description of this rule</returns>
+        public string GetDescription()
+        {
+            return string.Format(CultureInfo.CurrentCulture, Strings.AvoidUsingWMIObjectCmdletDescription);
+        }
+
+        /// <summary>
+        /// GetSourceType: Retrieves the type of the rule: builtin, managed or module.
+        /// </summary>
+        public SourceType GetSourceType()
+        {
+            return SourceType.Builtin;
+        }
+
+        /// <summary>
+        /// GetSourceName: Retrieves the module/assembly name the rule is from.
+        /// </summary>
+        public string GetSourceName()
+        {
+            return string.Format(CultureInfo.CurrentCulture, Strings.SourceName);
+        }
+    }
+}

Rules/ScriptAnalyzerBuiltinRules.csproj

@@ -66,6 +66,7 @@
     <Compile Include="AvoidUsingInternalURLs.cs" />
     <Compile Include="AvoidUsingInvokeExpression.cs" />
     <Compile Include="AvoidUsingPlainTextForPassword.cs" />
+    <Compile Include="AvoidUsingWMIObjectCmdlet.cs" />
     <Compile Include="AvoidUsingWriteHost.cs" />
     <Compile Include="MissingModuleManifestField.cs" />
     <Compile Include="PossibleIncorrectComparisonWithNull.cs" />

Rules/Strings.Designer.cs

@@ -666,4 +666,16 @@
   <data name="UseShouldProcessForStateChangingFunctionsName" xml:space="preserve">
     <value>UseShouldProcessForStateChangingFunctions</value>
   </data>
+  <data name="AvoidUsingWMIObjectCmdletCommonName" xml:space="preserve">
+    <value>Avoid Using Get-WMIObject, Remove-WMIObject</value>
+  </data>
+  <data name="AvoidUsingWMIObjectCmdletDescription" xml:space="preserve">
+    <value>Depricated. Starting in Windows PowerShell 3.0, these cmdlets have been superseded by CimInstance cmdlets.</value>
+  </data>
+  <data name="AvoidUsingWMIObjectCmdletError" xml:space="preserve">
+    <value>File '{0}' uses WMIObject cmdlet. For PowerShell 3.0 and above, this is not recommended because the cmdlet is based on a non-standard DCOM protocol. Use CIMInstance cmdlet instead. This is CIM and WS-Man standards compliant and works in a heterogeneous environment.</value>
+  </data>
+  <data name="AvoidUsingWMIObjectCmdletName" xml:space="preserve">
+    <value>AvoidUsingWMIObjectCmdlet</value>
+  </data>
 </root>

Rules/Strings.resx

@@ -0,0 +1,13 @@
+#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
+
+}
+
+TestFunction
+
+Remove-WmiObject -Class Win32_OperatingSystem -Verbose

Tests/Rules/AvoidUsingWMIObjectCmdlet.ps1

@@ -0,0 +1,24 @@
+Import-Module PSScriptAnalyzer
+$wmiObjectRuleName = "PSAvoidUsingWMIObjectCmdlet"
+$violationMessage = "File 'AvoidUsingWMIObjectCmdlet.ps1' uses WMIObject cmdlet. For PowerShell 3.0 and above, this is not recommended because the cmdlet is based on a non-standard DCOM protocol. Use CIMInstance cmdlet instead. This is CIM and WS-Man standards compliant and works in a heterogeneous environment."
+$directory = Split-Path -Parent $MyInvocation.MyCommand.Path
+$violations = Invoke-ScriptAnalyzer $directory\AvoidUsingWMIObjectCmdlet.ps1 | Where-Object {$_.RuleName -eq $wmiObjectRuleName}
+$noViolations = Invoke-ScriptAnalyzer $directory\AvoidUsingWMIObjectCmdletNoViolations.ps1 | Where-Object {$_.RuleName -eq $wmiObjectRuleName}
+
+Describe "AvoidUsingWMIObjectCmdlet" {
+    Context "Script contains references to WMIObject cmdlets - Violation" {
+        It "Have 2 WMIObject cmdlet Violations" {
+            $violations.Count | Should Be 2
+        }
+
+        It "has the correct description message for WMIObject rule violation" {
+            $violations[0].Message | Should Match $violationMessage
+        }
+    }
+
+    Context "Script contains no calls to WMIObject cmdlet - No violation" {
+        It "results in no rule violations" {
+            $noViolations.Count | Should Be 0
+        }
+    }
+}

Tests/Rules/AvoidUsingWMIObjectCmdlet.tests.ps1

@@ -0,0 +1,14 @@
+# 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
+
+function TestFunction
+{
+    Remove-WmiObject -Class Win32_ComputerSystem
+
+}
+
+TestFunction
+
+Get-WmiObject -Class Win32_OperatingSystem -Verbose