Fix when resource test returns '_inDesiredState', that takes precedence

Author: SteveL-MSFT

dsc/tests/dsc_config_test.tests.ps1

@@ -32,4 +32,31 @@ Describe 'dsc config test tests' {
             $out.results[0].result.differingProperties | Should -Contain 'resources'
         }
     }
+
+    It '_inDesiredState returned is used when: <inDesiredState>' -TestCases @(
+        @{ inDesiredState = $true }
+        @{ inDesiredState = $false }
+    ) {
+        param($inDesiredState)
+
+        $configYaml = @"
+  `$schema: https://aka.ms/dsc/schemas/v3/bundled/config/document.json
+  resources:
+    - name: Test
+      type: Test/InDesiredState
+      properties:
+        _inDesiredState: $inDesiredState
+        value: Hello
+"@
+
+        $out = dsc config test -i $configYaml | ConvertFrom-Json
+        $LASTEXITCODE | Should -Be 0
+        $out.results[0].result.inDesiredState | Should -Be $inDesiredState
+        if ($inDesiredState) {
+            $out.results[0].result.differingProperties | Should -BeNullOrEmpty
+        }
+        else {
+            $out.results[0].result.differingProperties | Should -Contain 'value'
+        }
+    }
 }

dsc_lib/locales/en-us.toml

@@ -99,7 +99,7 @@ setUnexpectedOutput = "Command did not return expected actual output"
 setUnexpectedDiff = "Command did not return expected diff output"
 invokeTest = "Invoking test for '%{resource}'"
 testSyntheticTest = "Resource '%{resource}' does not implement test, performing synthetic test"
-invokeTestUsing = "Invoking test on '%{resource}' using '{executable}'"
+invokeTestUsing = "Invoking test on '%{resource}' using '%{executable}'"
 testVerifyOutput = "Verifying output of test on '%{resource}' using '%{executable}'"
 testGroupTestResponse = "Import resource kind, returning group test response"
 testNoActualState = "No actual state returned"
@@ -129,6 +129,7 @@ validateJson = "Validating against JSON: %{json}"
 resourceInvalidJson = "Resource reported input JSON is not valid"
 invalidArrayKey = "Unsupported array value for key '%{key}'.  Only string and number is supported."
 invalidKey = "Unsupported value for key '%{key}'.  Only string, bool, number, and array is supported."
+inDesiredStateNotBool = "'_inDesiredState' is not a boolean"
 
 [dscresources.dscresource]
 invokeGet = "Invoking get for '%{resource}'"

dsc_lib/src/dscresources/command_resource.rs

@@ -283,11 +283,29 @@ pub fn invoke_test(resource: &ResourceManifest, cwd: &str, expected: &str) -> Re
                     return Err(DscError::Operation(t!("dscresources.commandResource.failedParseJson", executable = &test.executable, stdout = stdout, stderr = stderr, err = err).to_string()))
                 }
             };
-            let diff_properties = get_diff(&expected_value, &actual_value);
+            // if actual state contains _inDesiredState, we use that to determine if the resource is in desired state
+            let mut in_desired_state: Option<bool> = None;
+            if let Some(in_desired_state_value) = actual_value.get("_inDesiredState") {
+                if let Some(desired_state) = in_desired_state_value.as_bool() {
+                    in_desired_state = Some(desired_state);
+                } else {
+                    return Err(DscError::Operation(t!("dscresources.commandResource.inDesiredStateNotBool").to_string()));
+                }
+            }
+
+            let mut diff_properties: Vec<String> = Vec::new();
+            match in_desired_state {
+                Some(true) => {
+                    // if _inDesiredState is true, we don't need to check for diff properties
+                },
+                Some(false) | None => {
+                    diff_properties = get_diff(&expected_value, &actual_value);
+                }
+            }
             Ok(TestResult::Resource(ResourceTestResponse {
                 desired_state: expected_value,
                 actual_state: actual_value,
-                in_desired_state: diff_properties.is_empty(),
+                in_desired_state: in_desired_state.unwrap_or(diff_properties.is_empty()),
                 diff_properties,
             }))
         },

tools/dsctest/dscindesiredstate.dsc.resource.json

@@ -0,0 +1,26 @@
+{
+    "$schema": "https://aka.ms/dsc/schemas/v3/bundled/resource/manifest.json",
+    "type": "Test/InDesiredState",
+    "version": "0.1.0",
+    "test": {
+        "executable": "dsctest",
+        "args": [
+            "in-desired-state",
+            {
+                "jsonInputArg": "--input",
+                "mandatory": true
+            }
+        ],
+        "return": "state"
+    },
+    "schema": {
+        "command": {
+            "executable": "dsctest",
+            "args": [
+                "schema",
+                "-s",
+                "in-desired-state"
+            ]
+        }
+    }
+}

tools/dsctest/src/args.rs

@@ -8,6 +8,7 @@ pub enum Schemas {
     Delete,
     Exist,
     ExitCode,
+    InDesiredState,
     Sleep,
     Trace,
     WhatIf,
@@ -41,6 +42,12 @@ pub enum SubCommand {
         input: String,
     },
 
+    #[clap(name = "in-desired-state", about = "Specify if the resource is in the desired state")]
+    InDesiredState {
+        #[clap(name = "input", short, long, help = "The input to the in desired state command as JSON")]
+        input: String,
+    },
+
     #[clap(name = "schema", about = "Get the JSON schema for a subcommand")]
     Schema {
         #[clap(name = "subcommand", short, long, help = "The subcommand to get the schema for")]

tools/dsctest/src/in_desired_state.rs

@@ -0,0 +1,13 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+
+use schemars::JsonSchema;
+use serde::{Deserialize, Serialize};
+
+#[derive(Debug, Clone, PartialEq, Deserialize, Serialize, JsonSchema)]
+#[serde(deny_unknown_fields)]
+pub struct InDesiredState {
+    #[serde(rename = "_inDesiredState", skip_serializing_if = "Option::is_none")]
+    pub in_desired_state: Option<bool>,
+    pub value: String,
+}

tools/dsctest/src/main.rs

@@ -5,6 +5,7 @@ mod args;
 mod delete;
 mod exist;
 mod exit_code;
+mod in_desired_state;
 mod sleep;
 mod trace;
 mod whatif;
@@ -15,6 +16,7 @@ use schemars::schema_for;
 use crate::delete::Delete;
 use crate::exist::{Exist, State};
 use crate::exit_code::ExitCode;
+use crate::in_desired_state::InDesiredState;
 use crate::sleep::Sleep;
 use crate::trace::Trace;
 use crate::whatif::WhatIf;
@@ -65,6 +67,17 @@ fn main() {
             }
             input
         },
+        SubCommand::InDesiredState { input } => {
+            let mut in_desired_state = match serde_json::from_str::<in_desired_state::InDesiredState>(&input) {
+                Ok(in_desired_state) => in_desired_state,
+                Err(err) => {
+                    eprintln!("Error JSON does not match schema: {err}");
+                    std::process::exit(1);
+                }
+            };
+            in_desired_state.value = "SomethingElse".to_string();
+            serde_json::to_string(&in_desired_state).unwrap()
+        },
         SubCommand::Schema { subcommand } => {
             let schema = match subcommand {
                 Schemas::Delete => {
@@ -76,6 +89,9 @@ fn main() {
                 Schemas::ExitCode => {
                     schema_for!(ExitCode)
                 },
+                Schemas::InDesiredState => {
+                    schema_for!(InDesiredState)
+                },
                 Schemas::Sleep => {
                     schema_for!(Sleep)
                 },