Merge pull request #742 from SteveL-MSFT/backport-assertion

SteveL-MSFT · web-flow · commit b619ff241a1b · 2025-04-07T15:21:45.000-07:00
Backport: assertion resource fix
diff --git a/dsc/assertion.dsc.resource.json b/dsc/assertion.dsc.resource.json
@@ -11,6 +11,7 @@
       "pass-through",
       "config",
       "--as-group",
+      "--as-assert",
       "test",
       "--as-get",
       {
@@ -26,6 +27,7 @@
       "pass-through",
       "config",
       "--as-group",
+      "--as-assert",
       "test",
       {
         "jsonInputArg": "--input",
@@ -42,6 +44,7 @@
       "pass-through",
       "config",
       "--as-group",
+      "--as-assert",
       "test",
       "--as-config",
       {
@@ -59,7 +62,8 @@
     "4": "Invalid input format",
     "5": "Resource instance failed schema validation",
     "6": "Command cancelled",
-    "7": "Resource not found"
+    "7": "Resource not found",
+    "8": "Assertion failed"
   },
   "validate": {
     "executable": "dsc",
diff --git a/dsc/examples/assertion.dsc.yaml b/dsc/examples/assertion.dsc.yaml
@@ -23,5 +23,5 @@ resources:
         keyPath: HKLM\Software\Microsoft\Windows NT\CurrentVersion
         valueName: SystemRoot
         valueData:
-          # this is deliberately set to z: drive so that the assertion fails
-          String: Z:\Windows
+          # this is deliberately set to L: drive so that the assertion fails
+          String: L:\Windows
diff --git a/dsc/locales/en-us.toml b/dsc/locales/en-us.toml
@@ -74,6 +74,7 @@ testInputEmpty = "Expected input is required"
 [subcommand]
 actualStateNotObject = "actual_state is not an object"
 unexpectedTestResult = "Unexpected Group TestResult"
+assertionFailed = "Assertion failed for resource '%{resource_type}'"
 message = "message"
 currentDirectory = "current directory"
 noParameters = "No parameters specified"
diff --git a/dsc/src/args.rs b/dsc/src/args.rs
@@ -58,6 +58,8 @@ pub enum SubCommand {
         // Used to inform when DSC is used as a group resource to modify it's output
         #[clap(long, hide = true)]
         as_group: bool,
+        #[clap(long, hide = true)]
+        as_assert: bool,
         // Used to inform when DSC is used as a include group resource
         #[clap(long, hide = true)]
         as_include: bool,
diff --git a/dsc/src/main.rs b/dsc/src/main.rs
@@ -49,19 +49,19 @@ fn main() {
             let mut cmd = Args::command();
             generate(shell, &mut cmd, "dsc", &mut io::stdout());
         },
-        SubCommand::Config { subcommand, parameters, parameters_file, system_root, as_group, as_include } => {
+        SubCommand::Config { subcommand, parameters, parameters_file, system_root, as_group, as_assert, as_include } => {
             if let Some(file_name) = parameters_file {
                 info!("{}: {file_name}", t!("main.readingParametersFile"));
                 match std::fs::read_to_string(&file_name) {
-                    Ok(parameters) => subcommand::config(&subcommand, &Some(parameters), system_root.as_ref(), &as_group, &as_include, progress_format),
+                    Ok(parameters) => subcommand::config(&subcommand, &Some(parameters), system_root.as_ref(), &as_group, &as_assert, &as_include, progress_format),
                     Err(err) => {
                         error!("{} '{file_name}': {err}", t!("main.failedReadingParametersFile"));
                         exit(util::EXIT_INVALID_INPUT);
                     }
                 }
             }
             else {
-                subcommand::config(&subcommand, &parameters, system_root.as_ref(), &as_group, &as_include, progress_format);
+                subcommand::config(&subcommand, &parameters, system_root.as_ref(), &as_group, &as_assert, &as_include, progress_format);
             }
         },
         SubCommand::Resource { subcommand } => {
diff --git a/dsc/src/subcommand.rs b/dsc/src/subcommand.rs
@@ -5,7 +5,7 @@ use crate::args::{ConfigSubCommand, DscType, OutputFormat, ResourceSubCommand};
 use crate::resolve::{get_contents, Include};
 use crate::resource_command::{get_resource, self};
 use crate::tablewriter::Table;
-use crate::util::{DSC_CONFIG_ROOT, EXIT_DSC_ERROR, EXIT_INVALID_ARGS, EXIT_INVALID_INPUT, EXIT_JSON_ERROR, get_schema, write_output, get_input, set_dscconfigroot, validate_json};
+use crate::util::{DSC_CONFIG_ROOT, EXIT_DSC_ERROR, EXIT_DSC_ASSERTION_FAILED, EXIT_INVALID_ARGS, EXIT_INVALID_INPUT, EXIT_JSON_ERROR, get_schema, write_output, get_input, in_desired_state, set_dscconfigroot, validate_json};
 use dsc_lib::{
     configure::{
         config_doc::{
@@ -106,7 +106,7 @@ pub fn config_set(configurator: &mut Configurator, format: Option<&OutputFormat>
     }
 }
 
-pub fn config_test(configurator: &mut Configurator, format: Option<&OutputFormat>, as_group: &bool, as_get: &bool, as_config: &bool)
+pub fn config_test(configurator: &mut Configurator, format: Option<&OutputFormat>, as_group: &bool, as_get: &bool, as_config: &bool, as_assert: &bool)
 {
     match configurator.invoke_test() {
         Ok(result) => {
@@ -115,6 +115,10 @@ pub fn config_test(configurator: &mut Configurator, format: Option<&OutputFormat
                     let mut result_configuration = Configuration::new();
                     result_configuration.resources = Vec::new();
                     for test_result in result.results {
+                        if *as_assert && !in_desired_state(&test_result) {
+                            error!("{}", t!("subcommand.assertionFailed", resource_type = test_result.resource_type));
+                            exit(EXIT_DSC_ASSERTION_FAILED);
+                        }
                         let properties = match test_result.result {
                             TestResult::Resource(test_response) => {
                                 if test_response.actual_state.is_object() {
@@ -150,6 +154,10 @@ pub fn config_test(configurator: &mut Configurator, format: Option<&OutputFormat
                 else if *as_get {
                     let mut group_result = Vec::<ResourceGetResult>::new();
                     for test_result in result.results {
+                        if *as_assert && !in_desired_state(&test_result) {
+                            error!("{}", t!("subcommand.assertionFailed", resource_type = test_result.resource_type));
+                            exit(EXIT_DSC_ASSERTION_FAILED);
+                        }
                         group_result.push(test_result.into());
                     }
                     match serde_json::to_string(&group_result) {
@@ -161,6 +169,14 @@ pub fn config_test(configurator: &mut Configurator, format: Option<&OutputFormat
                     }
                 }
                 else {
+                    if *as_assert {
+                        for test_result in &result.results {
+                            if !in_desired_state(test_result) {
+                                error!("{}", t!("subcommand.assertionFailed", resource_type = test_result.resource_type));
+                                exit(EXIT_DSC_ASSERTION_FAILED);
+                            }
+                        }
+                    }
                     match serde_json::to_string(&(result.results)) {
                         Ok(json) => json,
                         Err(err) => {
@@ -252,7 +268,7 @@ fn initialize_config_root(path: Option<&String>) -> Option<String> {
 }
 
 #[allow(clippy::too_many_lines)]
-pub fn config(subcommand: &ConfigSubCommand, parameters: &Option<String>, mounted_path: Option<&String>, as_group: &bool, as_include: &bool, progress_format: ProgressFormat) {
+pub fn config(subcommand: &ConfigSubCommand, parameters: &Option<String>, mounted_path: Option<&String>, as_group: &bool, as_assert: &bool, as_include: &bool, progress_format: ProgressFormat) {
     let (new_parameters, json_string) = match subcommand {
         ConfigSubCommand::Get { input, file, .. } |
         ConfigSubCommand::Set { input, file, .. } |
@@ -363,7 +379,7 @@ pub fn config(subcommand: &ConfigSubCommand, parameters: &Option<String>, mounte
             config_set(&mut configurator, output_format.as_ref(), as_group);
         },
         ConfigSubCommand::Test { output_format, as_get, as_config, .. } => {
-            config_test(&mut configurator, output_format.as_ref(), as_group, as_get, as_config);
+            config_test(&mut configurator, output_format.as_ref(), as_group, as_get, as_config, as_assert);
         },
         ConfigSubCommand::Validate { input, file, output_format} => {
             let mut result = ValidateResult {
diff --git a/dsc/src/util.rs b/dsc/src/util.rs
@@ -3,6 +3,7 @@
 
 use crate::args::{DscType, OutputFormat, TraceFormat};
 use crate::resolve::Include;
+use dsc_lib::configure::config_result::ResourceTestResult;
 use dsc_lib::{
     configure::{
         config_doc::Configuration,
@@ -54,6 +55,7 @@ pub const EXIT_INVALID_INPUT: i32 = 4;
 pub const EXIT_VALIDATION_FAILED: i32 = 5;
 pub const EXIT_CTRL_C: i32 = 6;
 pub const EXIT_DSC_RESOURCE_NOT_FOUND: i32 = 7;
+pub const EXIT_DSC_ASSERTION_FAILED: i32 = 8;
 
 pub const DSC_CONFIG_ROOT: &str = "DSC_CONFIG_ROOT";
 pub const DSC_TRACE_LEVEL: &str = "DSC_TRACE_LEVEL";
@@ -556,3 +558,30 @@ pub fn set_dscconfigroot(config_path: &str) -> String
 
     full_path.to_string_lossy().into_owned()
 }
+
+
+/// Check if the test result is in the desired state.
+/// 
+/// # Arguments
+/// 
+/// * `test_result` - The test result to check
+/// 
+/// # Returns
+/// 
+/// * `bool` - True if the test result is in the desired state, false otherwise
+#[must_use]
+pub fn in_desired_state(test_result: &ResourceTestResult) -> bool {
+    match &test_result.result {
+        TestResult::Resource(result) => {
+            result.in_desired_state
+        },
+        TestResult::Group(results) => {
+            for result in results {
+                if !in_desired_state(result) {
+                    return false;
+                }
+            }
+            true
+        }
+    }
+}
diff --git a/dsc/tests/dsc_assertion.tests.ps1 b/dsc/tests/dsc_assertion.tests.ps1
@@ -0,0 +1,20 @@
+# Copyright (c) Microsoft Corporation.
+# Licensed under the MIT License.
+
+Describe 'Assertion resource tests' -Skip:(!$IsWindows) {
+    It 'Example works for <operation>' -TestCases @(
+        @{ operation = 'get' }
+        @{ operation = 'set' }
+        @{ operation = 'test' }
+# TODO: Add export to test when https://github.com/PowerShell/DSC/issues/428 is fixed
+#        @{ operation = 'export' }
+    ) {
+        param($operation)
+        $jsonPath = Join-Path $PSScriptRoot '../examples/assertion.dsc.yaml'
+        $out = dsc config $operation -f $jsonPath 2> "$TestDrive/trace.log"
+        $LASTEXITCODE | Should -Be 2
+        $out | Should -BeNullOrEmpty
+        $log = Get-Content "$TestDrive/trace.log" -Raw
+        $log | Should -Match '.*Assertion failed.*'
+    }
+}
diff --git a/dsc/tests/dsc_config_test.tests.ps1 b/dsc/tests/dsc_config_test.tests.ps1
@@ -21,15 +21,14 @@ Describe 'dsc config test tests' {
              family: Windows
 '@
 
-        $out = dsc config test -i $configYaml | ConvertFrom-Json
-        $LASTEXITCODE | Should -Be 0
-
+        $out = dsc config test -i $configYaml 2> "$TestDrive/trace.log" | ConvertFrom-Json
         if ($IsWindows) {
+            $LASTEXITCODE | Should -Be 0
             $out.results[0].result.inDesiredState | Should -BeTrue
-        }
-        else {
-            $out.results[0].result.inDesiredState | Should -BeFalse
-            $out.results[0].result.differingProperties | Should -Contain 'resources'
+        } else {
+            $LASTEXITCODE | Should -Be 2
+            $log = Get-Content "$TestDrive/trace.log" -Raw
+            $log | Should -Match '.*Assertion failed.*'
         }
     }
 

Original file line number	Diff line number	Diff line change
`@@ -49,19 +49,19 @@ fn main() {`
`49`	`49`	`let mut cmd = Args::command();`
`50`	`50`	`generate(shell, &mut cmd, "dsc", &mut io::stdout());`
`51`	`51`	`},`
`52`		`- SubCommand::Config { subcommand, parameters, parameters_file, system_root, as_group, as_include } => {`
	`52`	`+ SubCommand::Config { subcommand, parameters, parameters_file, system_root, as_group, as_assert, as_include } => {`
`53`	`53`	`if let Some(file_name) = parameters_file {`
`54`	`54`	`info!("{}: {file_name}", t!("main.readingParametersFile"));`
`55`	`55`	`match std::fs::read_to_string(&file_name) {`
`56`		`- Ok(parameters) => subcommand::config(&subcommand, &Some(parameters), system_root.as_ref(), &as_group, &as_include, progress_format),`
	`56`	`+ Ok(parameters) => subcommand::config(&subcommand, &Some(parameters), system_root.as_ref(), &as_group, &as_assert, &as_include, progress_format),`
`57`	`57`	`Err(err) => {`
`58`	`58`	`error!("{} '{file_name}': {err}", t!("main.failedReadingParametersFile"));`
`59`	`59`	`exit(util::EXIT_INVALID_INPUT);`
`60`	`60`	`}`
`61`	`61`	`}`
`62`	`62`	`}`
`63`	`63`	`else {`
`64`		`- subcommand::config(&subcommand, &parameters, system_root.as_ref(), &as_group, &as_include, progress_format);`
	`64`	`+ subcommand::config(&subcommand, &parameters, system_root.as_ref(), &as_group, &as_assert, &as_include, progress_format);`
`65`	`65`	`}`
`66`	`66`	`},`
`67`	`67`	`SubCommand::Resource { subcommand } => {`