Merge pull request #684 from SteveL-MSFT/empty-reg-value

Fix `registry` resource to allow setting value with no data

Author: SteveL-MSFT

build.ps1

@@ -354,6 +354,7 @@ if (!$SkipBuild) {
 
             if ($IsWindows) {
                 Copy-Item "$path/$binary.exe" $target -ErrorAction Ignore -Verbose
+                Copy-Item "$path/$binary.pdb" $target -ErrorAction Ignore -Verbose
             }
             else {
                 Copy-Item "$path/$binary" $target -ErrorAction Ignore -Verbose

registry/locales/en-us.toml

@@ -44,9 +44,9 @@ unsupportedValueDataType = "Unsupported registry value data type"
 tracingInitError = "Unable to set global default tracing subscriber. Tracing is disabled."
 debugAttach = "attach debugger to pid %{pid} and press any key to continue"
 debugEventReadError = "Error: Failed to read event: %{err}"
-debugEventUnexpectedError = "Unexpected event: %{e:?}"
+debugEventUnexpectedError = "Unexpected event: %{e}"
 
 [registry_helper]
-whatIfCreateKey = "key: %{subkey} not found, would create it"
+whatIfCreateKey = "Key '%{subkey}' not found, would create it"
 removeErrorKeyNotExist = "Key already does not exist"
 removeDeletingSubKey = "Deleting subkey '%{name}' using %{parent}"

registry/src/config.rs

@@ -12,6 +12,7 @@ pub enum RegistryValueData {
     DWord(u32),
     MultiString(Vec<String>),
     QWord(u64),
+    None,
 }
 
 #[derive(Debug, Default, Clone, PartialEq, Eq, Hash, Serialize, Deserialize, JsonSchema)]

registry/src/registry_helper.rs

@@ -72,7 +72,7 @@ impl RegistryHelper {
             Ok(Registry {
                 key_path: self.config.key_path.clone(),
                 value_name: Some(value_name.clone()),
-                value_data: Some(convert_reg_value(&value)?),
+                value_data: convert_reg_value(&value)?,
                 ..Default::default()
             })
         } else {
@@ -100,7 +100,7 @@ impl RegistryHelper {
                     };
 
                     if self.what_if {
-                        what_if_metadata.push(t!("registry_helper.whatIfCreateKey", "subkey" => subkey).to_string());
+                        what_if_metadata.push(t!("registry_helper.whatIfCreateKey", subkey = subkey).to_string());
                     }
                     else {
                         reg_key = reg_key.create(path, Security::CreateSubKey)?;
@@ -116,8 +116,13 @@ impl RegistryHelper {
             Err(e) => return self.handle_error_or_what_if(e)
         };
 
-        if let Some(value_data) = &self.config.value_data {
-            let Ok(value_name) = U16CString::from_str(self.config.value_name.as_ref().unwrap()) else {
+        if let Some(value_name) = &self.config.value_name {
+            let value_data = match &self.config.value_data {
+                Some(value_data) => value_data,
+                None => &RegistryValueData::None,
+            };
+
+            let Ok(value_name) = U16CString::from_str(value_name) else {
                 return self.handle_error_or_what_if(RegistryError::Utf16Conversion("valueName".to_string()));
             };
 
@@ -153,12 +158,15 @@ impl RegistryHelper {
                 RegistryValueData::QWord(q) => {
                     Data::U64(*q)
                 },
+                RegistryValueData::None => {
+                    Data::None
+                },
             };
 
             if self.what_if {
                 return Ok(Some(Registry {
                     key_path: self.config.key_path.clone(),
-                    value_data: Some(convert_reg_value(&data)?),
+                    value_data: convert_reg_value(&data)?,
                     value_name: self.config.value_name.clone(),
                     metadata: if what_if_metadata.is_empty() { None } else { Some(Metadata { what_if: Some(what_if_metadata) })},
                     ..Default::default()
@@ -222,8 +230,12 @@ impl RegistryHelper {
         let parent_key: RegKey;
         let mut subkeys: Vec<&str> = Vec::new();
         let parent_key_path = get_parent_key_path(&self.subkey);
-        let subkey_name = &self.subkey[parent_key_path.len() + 1..];
-        subkeys.push(subkey_name);
+        let subkey_name = if parent_key_path.is_empty() { &self.subkey } else {
+            &self.subkey[parent_key_path.len() + 1..]
+        };
+        if !subkey_name.is_empty() {
+            subkeys.push(subkey_name);
+        }
         let mut current_key_path = parent_key_path;
 
         loop {
@@ -305,17 +317,18 @@ fn get_parent_key_path(key_path: &str) -> &str {
     }
 }
 
-fn convert_reg_value(value: &Data) -> Result<RegistryValueData, RegistryError> {
+fn convert_reg_value(value: &Data) -> Result<Option<RegistryValueData>, RegistryError> {
     match value {
-        Data::String(s) => Ok(RegistryValueData::String(s.to_string_lossy())),
-        Data::ExpandString(s) => Ok(RegistryValueData::ExpandString(s.to_string_lossy())),
-        Data::Binary(b) => Ok(RegistryValueData::Binary(b.clone())),
-        Data::U32(d) => Ok(RegistryValueData::DWord(*d)),
+        Data::String(s) => Ok(Some(RegistryValueData::String(s.to_string_lossy()))),
+        Data::ExpandString(s) => Ok(Some(RegistryValueData::ExpandString(s.to_string_lossy()))),
+        Data::Binary(b) => Ok(Some(RegistryValueData::Binary(b.clone()))),
+        Data::U32(d) => Ok(Some(RegistryValueData::DWord(*d))),
         Data::MultiString(m) => {
             let m: Vec<String> = m.iter().map(|s| s.to_string_lossy()).collect();
-            Ok(RegistryValueData::MultiString(m))
+            Ok(Some(RegistryValueData::MultiString(m)))
         },
-        Data::U64(q) => Ok(RegistryValueData::QWord(*q)),
+        Data::U64(q) => Ok(Some(RegistryValueData::QWord(*q))),
+        Data::None => Ok(None),
         _ => Err(RegistryError::UnsupportedValueDataType)
     }
 }

registry/tests/registry.config.set.tests.ps1

@@ -72,4 +72,31 @@ Describe 'registry config set tests' {
 
         Get-Item -Path 'HKCU:\1\2' -ErrorAction Ignore | Should -BeNullOrEmpty
     }
+
+    It 'Can set value without data' -Skip:(!$IsWindows) {
+        $configYaml = @'
+            $schema: https://aka.ms/dsc/schemas/v3/bundled/config/document.json
+            resources:
+            - name: Key
+              type: Microsoft.Windows/Registry
+              properties:
+                keyPath: 'HKCU\1'
+                valueName: Test
+                _exist: true            
+'@
+
+        $out = dsc config set -i $configYaml | ConvertFrom-Json
+        $LASTEXITCODE | Should -Be 0
+        $out.results[0].result.afterState.keyPath | Should -BeExactly 'HKCU\1'
+        $out.results[0].result.afterState.valueName | Should -BeExactly 'Test'
+        $out.results[0].result.afterState.valueData | Should -BeNullOrEmpty
+
+        $out = dsc config get -i $configYaml | ConvertFrom-Json
+        $LASTEXITCODE | Should -Be 0
+        $out.results[0].result.actualState.keyPath | Should -BeExactly 'HKCU\1'
+        $out.results[0].result.actualState.valueName | Should -BeExactly 'Test'
+        $out.results[0].result.actualState.valueData | Should -BeNullOrEmpty
+
+        Remove-Item -Path 'HKCU:\1' -Recurse -ErrorAction Ignore
+    }
 }