Merge pull request #946 from Gijsreyn/wmi-set-operation

Add WMI set capability

Author: SteveL-MSFT

wmi-adapter/Tests/wmi.tests.ps1

@@ -52,10 +52,60 @@ Describe 'WMI adapter resource tests' {
         $LASTEXITCODE | Should -Be 0
         $r | Should -Not -BeNullOrEmpty
         $res = $r | ConvertFrom-Json
+
         $res.results[1].result.actualState.result[0].properties.Name | Should -Not -BeNullOrEmpty
         $res.results[1].result.actualState.result[0].properties.BootupState | Should -BeNullOrEmpty
         $res.results[1].result.actualState.result[1].properties.Caption | Should -Not -BeNullOrEmpty
         $res.results[1].result.actualState.result[1].properties.BuildNumber | Should -BeNullOrEmpty
-        $res.results[1].result.actualState.result[4].properties.AdapterType | Should -BeLike "Ethernet*"
+        $res.results[1].result.actualState.result[4].properties.Name | Should -Not -BeNullOrEmpty
+    }
+
+    It 'Set does not work without input for resource' -Skip:(!$IsWindows) {
+        $out = dsc resource set --resource root.cimv2/Win32_Environment --input '{}' 2>$TestDrive/error.log
+        $out | Should -BeNullOrEmpty
+        (Get-Content $TestDrive/error.log -Raw) | Should -BeLike "*No valid properties found in the CIM class 'Win32_Environment' for the provided properties.*"
+    }
+
+    It 'Set does not work without a key property' -Skip:(!$IsWindows) {
+        $i = @{
+            VariableValue = "TestValue"
+            UserName = ("{0}\{1}" -f $env:USERDOMAIN, $env:USERNAME) # Read-only property is key, but we require a key property to be set
+        } | ConvertTo-Json
+        
+        $out = dsc resource set -r root.cimv2/Win32_Environment -i $i 2>$TestDrive/error2.log
+        $out | Should -BeNullOrEmpty
+        (Get-Content $TestDrive/error2.log -Raw) | Should -BeLike "*All properties specified in the CIM class 'Win32_Environment' are read-only, which is not supported.*"
+    }
+
+    It 'Set works on a WMI resource' -Skip:(!$IsWindows) {
+        $i = @{
+            UserName = ("{0}\{1}" -f $env:USERDOMAIN, $env:USERNAME) # Read-only key property required
+            Name = 'test'
+            VariableValue = 'test'
+        } | ConvertTo-Json
+        
+        $r = dsc resource set -r root.cimv2/Win32_Environment -i $i
+        $LASTEXITCODE | Should -Be 0 
+
+        $res = $r | ConvertFrom-Json
+        $res.afterState.Name | Should -Be 'test'
+        $res.afterState.VariableValue | Should -Be 'test'
+        $res.afterState.UserName | Should -Be ("{0}\{1}" -f $env:USERDOMAIN, $env:USERNAME)
+    }
+
+    It 'Update works on a WMI resource' -Skip:(!$IsWindows) {
+        $i = @{
+            UserName = ("{0}\{1}" -f $env:USERDOMAIN, $env:USERNAME) # Read-only key property required
+            Name = 'test'
+            VariableValue = 'update'
+        } | ConvertTo-Json
+        
+        $r = dsc resource set -r root.cimv2/Win32_Environment -i $i
+        $LASTEXITCODE | Should -Be 0 
+
+        $res = $r | ConvertFrom-Json
+        $res.afterState.Name | Should -Be 'test'
+        $res.afterState.VariableValue | Should -Be 'update'
+        $res.afterState.UserName | Should -Be ("{0}\{1}" -f $env:USERDOMAIN, $env:USERNAME)
     }
 }

wmi-adapter/wmi.dsc.resource.json

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

wmi-adapter/wmi.resource.ps1

@@ -10,7 +10,7 @@ param(
 )
 
 # Import private functions
-$wmiAdapter = Import-Module "$PSScriptRoot/wmiAdapter.psm1" -Force -PassThru
+$wmiAdapter = Import-Module "$PSScriptRoot\wmiAdapter.psm1" -Force -PassThru
 
 if ('Validate' -ne $Operation) {
     # initialize OUTPUT as array