Add tests

Author: Gijsreyn

wmi-adapter/Tests/wmi.tests.ps1

@@ -58,4 +58,40 @@ Describe 'WMI adapter resource tests' {
         $res.results[1].result.actualState.result[1].properties.BuildNumber | Should -BeNullOrEmpty
         $res.results[1].result.actualState.result[4].properties.AdapterType | Should -BeLike "Ethernet*"
     }
+
+    It 'Throws error when methodName is missing on set' -Skip:(!$IsWindows) {
+        '{"Name":"wuauserv"}' | dsc -l trace resource set -r 'root.cimv2/Win32_Service' -f - 2> $TestDrive\tracing.txt
+        $LASTEXITCODE | Should -Be 2
+        "$TestDrive/tracing.txt" | Should -FileContentMatch "'methodName' property is required for invoking a WMI/CIM method."
+    }
+
+    It 'Throws error when methodName is set but parameters are missing on set' -Skip:(!$IsWindows) {
+        '{"Name":"wuauserv", "methodName":"StartService"}' | dsc -l trace resource set -r 'root.cimv2/Win32_Service' -f - 2> $TestDrive\tracing.txt
+        $LASTEXITCODE | Should -Be 2
+        "$TestDrive/tracing.txt" | Should -FileContentMatch "'parameters' property is required for invoking a WMI/CIM method."
+    }
+
+    It 'Set works on a WMI resource with methodName and parameters' -Skip:(!$IsWindows) {
+        BeforeAll {
+            $script:service = Get-Service -Name wuauserv -ErrorAction Ignore 
+
+            if ($service -and $service.Status -eq 'Running') {
+                $service.Stop()
+            }
+        }
+        
+
+        $r = '{"Name":"wuauserv", "methodName":"StartService", "parameters":{}}' | dsc resource set -r 'root.cimv2/Win32_Service' -f -
+        $LASTEXITCODE | Should -Be 0
+        
+        $res = '{"Name":"wuauserv", "State": null}' | dsc resource get -r 'root.cimv2/Win32_Service' -f - | ConvertFrom-Json
+        $res.actualState.Name | Should -Be 'wuauserv'
+        $res.actualState.State | Should -Be 'Running'
+
+        AfterAll {
+            if ($service -and $service.Status -eq 'Running') {
+                $service.Stop()
+            }
+        }
+    }
 }

wmi-adapter/wmi.dsc.resource.json

@@ -35,6 +35,19 @@
       ],
       "input": "stdin"
     },
+    "set": {
+      "executable": "powershell",
+      "args": [
+        "-NoLogo",
+        "-NonInteractive",
+        "-NoProfile",
+        "-ExecutionPolicy",
+        "Bypass",
+        "-Command",
+        "$Input | ./wmi.resource.ps1 Set"
+      ],
+      "input": "stdin"
+    },
     "validate": {
         "executable": "powershell",
         "args": [

wmi-adapter/wmiAdapter.psm1

@@ -134,16 +134,20 @@ function GetCimSpace {
             }
             'Set' {
                 $wmi_instance = ValidateCimMethodAndArguments -DesiredState $r
-                InvokeCimMethod -CimInstance $wmi_instance.CimInstance -MethodName $wmi_instance.MethodName -Arguments $wmi_instance.Parameters
+                InvokeCimMethod @wmi_instance
 
-                $result += [PSCustomObject]@{
+                $addToActualState = [dscResourceObject]@{
                     name       = $r.name
                     type       = $r.type
-                    properties = $null # Set operation does not return properties
+                    properties = $null
                 }
+
+                $result += $addToActualState
             }
             'Test' {
                 # TODO: implement test
+                "Test operation is not implemented for WMI/CIM methods." | Write-DscTrace -Operation Error 
+                exit 1
             }
         }
     }
@@ -164,6 +168,12 @@ function ValidateCimMethodAndArguments {
         exit 1
     }
 
+    # This is required for invoking a WMI/CIM method with parameters even if it is empty
+    if (-not ($DesiredState.properties.psobject.properties | Where-Object -Property Name -EQ 'parameters')) {
+        "'parameters' property is required for invoking a WMI/CIM method." | Write-DscTrace -Operation Error
+        exit 1
+    }
+
     $className = $DesiredState.type.Split("/")[-1]
     $namespace = $DesiredState.type.Split("/")[0].Replace(".", "/")
 
@@ -176,6 +186,7 @@ function ValidateCimMethodAndArguments {
 
         foreach ($param in $parameters.psobject.Properties.name) {
             if ($cimClassParameters.Name -notcontains $param) {
+                # Only warn about invalid parameters, do not exit as this allows to action to continue when calling InvokeCimMethod
                 "'$param' is not a valid parameter for method '$methodName' in class '$className'." | Write-DscTrace -Operation Warn
             } else {
                 $arguments += @{
@@ -186,14 +197,15 @@ function ValidateCimMethodAndArguments {
 
         $cimInstance = GetWmiInstance -DesiredState $DesiredState
 
-        $i = [PSCustomObject]@{
+        return @{
             CimInstance = $cimInstance
-            Parameters  = $arguments
+            Arguments   = $arguments
             MethodName  = $methodName
         }
+    } else {
+        "'$className' class not found in namespace '$namespace'." | Write-DscTrace -Operation Error
+        exit 1
     }
-
-    return $i
 }
 
 function InvokeCimMethod