use struct for from/to changes

Author: tgauth

dsc/tests/dsc_whatif.tests.ps1

@@ -39,8 +39,9 @@ Describe 'whatif tests' {
         $result.results.Count | Should -Be 1
         $result.results[0].Name | Should -Be 'Registry'
         $result.results[0].type | Should -BeExactly 'Microsoft.Windows/Registry'
-        $result.results[0].result.changes[0]._exist.from | Should -Be 'false'
-        $result.results[0].result.changes[0]._exist.to | Should -Be 'true'
+        $result.results[0].result.changes[0].name | Should -Be '_exist'
+        $result.results[0].result.changes[0].from | Should -Be 'false'
+        $result.results[0].result.changes[0].to | Should -Be 'true'
         $result.metadata.'Microsoft.DSC'.executionType | Should -BeExactly 'WhatIf'
         $LASTEXITCODE | Should -Be 0
     }
@@ -57,7 +58,7 @@ Describe 'whatif tests' {
         $result = $config_yaml | dsc config set -w --format pretty-json | ConvertFrom-Json
         $result.hadErrors | Should -BeFalse
         $result.results.Count | Should -Be 1
-        $result.results[0].result.changes[0] | Should -Be "delete 'Test/Delete' using 'dsctest'"
+        $result.results[0].result.changes | Should -Be "delete 'Test/Delete' using 'dsctest'"
         $LASTEXITCODE | Should -Be 0
     }
 

dsc_lib/src/dscresources/command_resource.rs

@@ -4,7 +4,7 @@
 use jsonschema::JSONSchema;
 use serde_json::Value;
 use std::{collections::HashMap, env, io::{Read, Write}, process::{Command, Stdio}};
-use crate::{dscerror::DscError, dscresources::invoke_result::{ResourceGetResponse, ResourceSetResponse, ResourceSetWhatIfResponse, ResourceTestResponse}};
+use crate::{dscerror::DscError, dscresources::invoke_result::{ResourceGetResponse, ResourceSetResponse, ResourceSetWhatIfResponse, ResourceTestResponse, WhatIfResult}};
 use crate::configure::{config_doc::ExecutionKind, config_result::ResourceGetResult};
 use super::{dscresource::{get_diff, get_diff_what_if}, invoke_result::{ExportResult, GetResult, SetResult, TestResult, ValidateResult}, resource_manifest::{ArgKind, InputKind, Kind, ResourceManifest, ReturnKind, SchemaKind}};
 use tracing::{error, warn, info, debug, trace};
@@ -119,13 +119,13 @@ pub fn invoke_set(resource: &ResourceManifest, cwd: &str, desired: &str, skip_te
             if in_desired_state {
                 debug!("what-if: resource is already in desired state, returning null ResourceWhatIf response");
                 return Ok(SetResult::ResourceWhatIf(ResourceSetWhatIfResponse{
-                    what_if_changes: Vec::new()
+                    what_if_changes: WhatIfResult::Diff(Vec::new())
                 }));
             }
             debug!("what-if: resource is not in desired state, returning diff ResourceWhatIf response");
             let diff_properties = get_diff_what_if( &desired_state, &actual_state);
             return Ok(SetResult::ResourceWhatIf(ResourceSetWhatIfResponse{
-                what_if_changes: vec![Value::from_iter(diff_properties)]
+                what_if_changes: WhatIfResult::Diff(diff_properties)
             }));
         }
         if in_desired_state {
@@ -380,7 +380,7 @@ pub fn invoke_delete(resource: &ResourceManifest, cwd: &str, filter: &str, execu
 
     if execution_type == &ExecutionKind::WhatIf {
         return Ok(Some(SetResult::ResourceWhatIf(ResourceSetWhatIfResponse{
-            what_if_changes: vec![Value::String(format!("delete '{}' using '{}'", &resource.resource_type, &delete.executable))]
+            what_if_changes: WhatIfResult::String(format!("delete '{}' using '{}'", &resource.resource_type, &delete.executable))
         })));
     }
     info!("Invoking delete '{}' using '{}'", &resource.resource_type, &delete.executable);

dsc_lib/src/dscresources/dscresource.rs

@@ -8,7 +8,7 @@ use serde::{Deserialize, Serialize};
 use serde_json::Value;
 use std::collections::HashMap;
 
-use super::{command_resource, dscerror, invoke_result::{ExportResult, GetResult, ResourceTestResponse, SetResult, TestResult, ValidateResult}, resource_manifest::import_manifest};
+use super::{command_resource, dscerror, invoke_result::{ExportResult, GetResult, ResourceTestResponse, SetResult, TestResult, ValidateResult, WhatIfChanges}, resource_manifest::import_manifest};
 
 #[derive(Clone, Debug, Deserialize, Serialize, JsonSchema)]
 #[serde(deny_unknown_fields)]
@@ -358,8 +358,8 @@ pub fn get_diff(expected: &Value, actual: &Value) -> Vec<String> {
 }
 
 #[must_use]
-pub fn get_diff_what_if(expected: &Value, actual: &Value) -> HashMap<String, Value> {
-    let mut diff_properties: HashMap<String, Value> = HashMap::new();
+pub fn get_diff_what_if(expected: &Value, actual: &Value) -> Vec<WhatIfChanges> {
+    let mut diff_properties: Vec<WhatIfChanges> = Vec::new();
     if expected.is_null() {
         return diff_properties;
     }
@@ -405,10 +405,13 @@ pub fn get_diff_what_if(expected: &Value, actual: &Value) -> HashMap<String, Val
                 }
             }
             if is_diff {
-                let mut temp_hashmap = HashMap::new();
-                temp_hashmap.insert("to".to_string(), value.clone());
-                temp_hashmap.insert("from".to_string(), actual[key].clone());
-                diff_properties.insert(key.to_string(), Value::from_iter(temp_hashmap));
+                diff_properties.push(
+                    WhatIfChanges {
+                        name: key.to_string(),
+                        from: actual[key].clone(),
+                        to: value.clone(),
+                    }
+                );
             }
         }
     }

dsc_lib/src/dscresources/invoke_result.rs

@@ -88,7 +88,22 @@ pub struct ResourceSetResponse {
 #[serde(deny_unknown_fields)]
 pub struct ResourceSetWhatIfResponse {
     #[serde(rename = "changes")]
-    pub what_if_changes: Vec<Value>
+    pub what_if_changes: WhatIfResult
+}
+
+#[derive(Debug, Clone, PartialEq, Deserialize, Serialize, JsonSchema)]
+#[serde(untagged)]
+pub enum WhatIfResult {
+    Diff(Vec<WhatIfChanges>),
+    String(String)
+}
+
+#[derive(Debug, Clone, PartialEq, Deserialize, Serialize, JsonSchema)]
+#[serde(deny_unknown_fields)]
+pub struct WhatIfChanges {
+    pub name: String,
+    pub from: Value,
+    pub to: Value
 }
 
 #[derive(Debug, Clone, PartialEq, Deserialize, Serialize, JsonSchema)]