connect output to result

SteveL-MSFT · SteveL-MSFT · commit 2ea358f9e8e4 · 2025-07-26T18:15:09.000-07:00
diff --git a/dsc_lib/locales/en-us.toml b/dsc_lib/locales/en-us.toml
@@ -71,6 +71,11 @@ propertyNotString = "Property '%{name}' with value '%{value}' is not a string"
 metadataMicrosoftDscIgnored = "Resource returned '_metadata' property 'Microsoft.DSC' which is ignored"
 metadataNotObject = "Resource returned '_metadata' property which is not an object"
 metadataRestartRequiredInvalid = "Resource returned '_metadata' property '_restartRequired' which contains invalid value: %{value}"
+skippingOutput = "Skipping output for '%{name}' due to condition evaluating to false"
+outputValueNotDefined = "Output value '%{name}' is not defined"
+secureOutputSkipped = "Secure output '%{name}' is skipped"
+outputTypeNotMatched = "Output '%{name}' type does not match expected type '%{expected_type}'"
+copyNotSupported = "Copy for output '%{name}' is currently not supported"
 
 [discovery.commandDiscovery]
 couldNotReadSetting = "Could not read 'resourcePath' setting"
diff --git a/dsc_lib/src/configure/config_doc.rs b/dsc_lib/src/configure/config_doc.rs
@@ -7,6 +7,7 @@ use schemars::{JsonSchema, json_schema};
 use serde::{Deserialize, Serialize};
 use serde_json::{Map, Value};
 use std::collections::HashMap;
+use std::fmt::Display;
 
 use crate::{dscerror::DscError, schemas::DscRepoSchema};
 
@@ -180,6 +181,20 @@ pub enum DataType {
     Array,
 }
 
+impl Display for DataType {
+    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
+        match self {
+            DataType::String => write!(f, "string"),
+            DataType::SecureString => write!(f, "secureString"),
+            DataType::Int => write!(f, "int"),
+            DataType::Bool => write!(f, "bool"),
+            DataType::Object => write!(f, "object"),
+            DataType::SecureObject => write!(f, "secureObject"),
+            DataType::Array => write!(f, "array"),
+        }
+    }
+}
+
 #[derive(Debug, Clone, PartialEq, Deserialize, Serialize, JsonSchema)]
 pub enum CopyMode {
     #[serde(rename = "serial")]
diff --git a/dsc_lib/src/configure/config_result.rs b/dsc_lib/src/configure/config_result.rs
@@ -3,6 +3,7 @@
 
 use schemars::JsonSchema;
 use serde::{Deserialize, Serialize};
+use serde_json::{Map, Value};
 use crate::dscresources::invoke_result::{GetResult, SetResult, TestResult};
 use crate::configure::config_doc::{Configuration, Metadata};
 
@@ -54,6 +55,8 @@ pub struct ConfigurationGetResult {
     pub messages: Vec<ResourceMessage>,
     #[serde(rename = "hadErrors")]
     pub had_errors: bool,
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub outputs: Option<Map<String, Value>>,
 }
 
 impl ConfigurationGetResult {
@@ -64,6 +67,7 @@ impl ConfigurationGetResult {
             results: Vec::new(),
             messages: Vec::new(),
             had_errors: false,
+            outputs: None,
         }
     }
 }
@@ -85,6 +89,7 @@ impl From<ConfigurationTestResult> for ConfigurationGetResult {
             results,
             messages: test_result.messages,
             had_errors: test_result.had_errors,
+            outputs: test_result.outputs,
         }
     }
 }
@@ -140,6 +145,8 @@ pub struct ConfigurationSetResult {
     pub messages: Vec<ResourceMessage>,
     #[serde(rename = "hadErrors")]
     pub had_errors: bool,
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub outputs: Option<Map<String, Value>>,
 }
 
 impl ConfigurationSetResult {
@@ -150,6 +157,7 @@ impl ConfigurationSetResult {
             results: Vec::new(),
             messages: Vec::new(),
             had_errors: false,
+            outputs: None,
         }
     }
 }
@@ -200,6 +208,8 @@ pub struct ConfigurationTestResult {
     pub messages: Vec<ResourceMessage>,
     #[serde(rename = "hadErrors")]
     pub had_errors: bool,
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub outputs: Option<Map<String, Value>>,
 }
 
 impl ConfigurationTestResult {
@@ -210,6 +220,7 @@ impl ConfigurationTestResult {
             results: Vec::new(),
             messages: Vec::new(),
             had_errors: false,
+            outputs: None,
         }
     }
 }
@@ -228,6 +239,8 @@ pub struct ConfigurationExportResult {
     pub messages: Vec<ResourceMessage>,
     #[serde(rename = "hadErrors")]
     pub had_errors: bool,
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub outputs: Option<Map<String, Value>>,
 }
 
 impl ConfigurationExportResult {
@@ -238,6 +251,7 @@ impl ConfigurationExportResult {
             result: None,
             messages: Vec::new(),
             had_errors: false,
+            outputs: None,
         }
     }
 }
diff --git a/dsc_lib/src/configure/context.rs b/dsc_lib/src/configure/context.rs
@@ -19,6 +19,7 @@ pub struct Context {
     pub variables: Map<String, Value>,
     pub start_datetime: DateTime<Local>,
     pub restart_required: Option<Vec<RestartRequired>>,
+    pub outputs: Map<String, Value>,
 }
 
 impl Context {
@@ -37,6 +38,7 @@ impl Context {
             variables: Map::new(),
             start_datetime: chrono::Local::now(),
             restart_required: None,
+            outputs: Map::new(),
         }
     }
 }
diff --git a/dsc_lib/src/configure/mod.rs b/dsc_lib/src/configure/mod.rs
@@ -1,7 +1,7 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
 
-use crate::configure::config_doc::{ExecutionKind, Metadata, Resource};
+use crate::configure::config_doc::{ExecutionKind, Metadata, Resource, ValueOrCopy};
 use crate::configure::{config_doc::RestartRequired, parameters::Input};
 use crate::dscerror::DscError;
 use crate::dscresources::invoke_result::ExportResult;
@@ -376,6 +376,10 @@ impl Configurator {
         result.metadata = Some(
             self.get_result_metadata(Operation::Get)
         );
+        self.process_output()?;
+        if !self.context.outputs.is_empty() {
+            result.outputs = Some(self.context.outputs.clone());
+        }
         Ok(result)
     }
 
@@ -533,6 +537,10 @@ impl Configurator {
         result.metadata = Some(
             self.get_result_metadata(Operation::Set)
         );
+        self.process_output()?;
+        if !self.context.outputs.is_empty() {
+            result.outputs = Some(self.context.outputs.clone());
+        }
         Ok(result)
     }
 
@@ -607,6 +615,10 @@ impl Configurator {
         result.metadata = Some(
             self.get_result_metadata(Operation::Test)
         );
+        self.process_output()?;
+        if !self.context.outputs.is_empty() {
+            result.outputs = Some(self.context.outputs.clone());
+        }
         Ok(result)
     }
 
@@ -665,6 +677,10 @@ impl Configurator {
         }
 
         result.result = Some(conf);
+        self.process_output()?;
+        if !self.context.outputs.is_empty() {
+            result.outputs = Some(self.context.outputs.clone());
+        }
         Ok(result)
     }
 
@@ -679,6 +695,46 @@ impl Configurator {
         Ok(false)
     }
 
+    pub fn process_output(&mut self) -> Result<(), DscError> {
+        if self.config.outputs.is_none() || self.context.execution_type == ExecutionKind::WhatIf {
+            return Ok(());
+        }
+        if let Some(outputs) = &self.config.outputs {
+            for (name, output) in outputs {
+                if let Some(condition) = &output.condition {
+                    let condition_result = self.statement_parser.parse_and_execute(condition, &self.context)?;
+                    if condition_result != Value::Bool(true) {
+                        info!("{}", t!("configure.mod.skippingOutput", name = name));
+                        continue;
+                    }
+                }
+
+                match &output.value_or_copy {
+                    ValueOrCopy::Value(value) => {
+                        let value_result = self.statement_parser.parse_and_execute(&value, &self.context)?;
+                        if output.r#type == DataType::SecureString || output.r#type == DataType::SecureObject {
+                            warn!("{}", t!("configure.mod.secureOutputSkipped", name = name));
+                            continue;
+                        }
+                        if value_result.is_string() && output.r#type != DataType::String ||
+                            value_result.is_i64() && output.r#type != DataType::Int ||
+                            value_result.is_boolean() && output.r#type != DataType::Bool ||
+                            value_result.is_array() && output.r#type != DataType::Array ||
+                            value_result.is_object() && output.r#type != DataType::Object {
+                            return Err(DscError::Validation(t!("configure.mod.outputTypeNotMatch", name = name, expected_type = output.r#type).to_string()));
+                        }
+                        self.context.outputs.insert(name.clone(), value_result);
+                    },
+                    _ => {
+                        warn!("{}", t!("configure.mod.copyNotSupported", name = name));
+                        continue;
+                    }
+                }
+            }
+        }
+        Ok(())
+    }
+
     /// Set the mounted path for the configuration.
     ///
     /// # Arguments

Original file line number	Diff line number	Diff line change
`@@ -3,6 +3,7 @@`
`3`	`3`
`4`	`4`	`use schemars::JsonSchema;`
`5`	`5`	`use serde::{Deserialize, Serialize};`
	`6`	`+use serde_json::{Map, Value};`
`6`	`7`	`use crate::dscresources::invoke_result::{GetResult, SetResult, TestResult};`
`7`	`8`	`use crate::configure::config_doc::{Configuration, Metadata};`
`8`	`9`
`@@ -54,6 +55,8 @@ pub struct ConfigurationGetResult {`
`54`	`55`	`pub messages: Vec<ResourceMessage>,`
`55`	`56`	`#[serde(rename = "hadErrors")]`
`56`	`57`	`pub had_errors: bool,`
	`58`	`+ #[serde(skip_serializing_if = "Option::is_none")]`
	`59`	`+ pub outputs: Option<Map<String, Value>>,`
`57`	`60`	`}`
`58`	`61`
`59`	`62`	`impl ConfigurationGetResult {`
`@@ -64,6 +67,7 @@ impl ConfigurationGetResult {`
`64`	`67`	`results: Vec::new(),`
`65`	`68`	`messages: Vec::new(),`
`66`	`69`	`had_errors: false,`
	`70`	`+ outputs: None,`
`67`	`71`	`}`
`68`	`72`	`}`
`69`	`73`	`}`
`@@ -85,6 +89,7 @@ impl From<ConfigurationTestResult> for ConfigurationGetResult {`
`85`	`89`	`results,`
`86`	`90`	`messages: test_result.messages,`
`87`	`91`	`had_errors: test_result.had_errors,`
	`92`	`+ outputs: test_result.outputs,`
`88`	`93`	`}`
`89`	`94`	`}`
`90`	`95`	`}`
`@@ -140,6 +145,8 @@ pub struct ConfigurationSetResult {`
`140`	`145`	`pub messages: Vec<ResourceMessage>,`
`141`	`146`	`#[serde(rename = "hadErrors")]`
`142`	`147`	`pub had_errors: bool,`
	`148`	`+ #[serde(skip_serializing_if = "Option::is_none")]`
	`149`	`+ pub outputs: Option<Map<String, Value>>,`
`143`	`150`	`}`
`144`	`151`
`145`	`152`	`impl ConfigurationSetResult {`
`@@ -150,6 +157,7 @@ impl ConfigurationSetResult {`
`150`	`157`	`results: Vec::new(),`
`151`	`158`	`messages: Vec::new(),`
`152`	`159`	`had_errors: false,`
	`160`	`+ outputs: None,`
`153`	`161`	`}`
`154`	`162`	`}`
`155`	`163`	`}`
`@@ -200,6 +208,8 @@ pub struct ConfigurationTestResult {`
`200`	`208`	`pub messages: Vec<ResourceMessage>,`
`201`	`209`	`#[serde(rename = "hadErrors")]`
`202`	`210`	`pub had_errors: bool,`
	`211`	`+ #[serde(skip_serializing_if = "Option::is_none")]`
	`212`	`+ pub outputs: Option<Map<String, Value>>,`
`203`	`213`	`}`
`204`	`214`
`205`	`215`	`impl ConfigurationTestResult {`
`@@ -210,6 +220,7 @@ impl ConfigurationTestResult {`
`210`	`220`	`results: Vec::new(),`
`211`	`221`	`messages: Vec::new(),`
`212`	`222`	`had_errors: false,`
	`223`	`+ outputs: None,`
`213`	`224`	`}`
`214`	`225`	`}`
`215`	`226`	`}`
`@@ -228,6 +239,8 @@ pub struct ConfigurationExportResult {`
`228`	`239`	`pub messages: Vec<ResourceMessage>,`
`229`	`240`	`#[serde(rename = "hadErrors")]`
`230`	`241`	`pub had_errors: bool,`
	`242`	`+ #[serde(skip_serializing_if = "Option::is_none")]`
	`243`	`+ pub outputs: Option<Map<String, Value>>,`
`231`	`244`	`}`
`232`	`245`
`233`	`246`	`impl ConfigurationExportResult {`
`@@ -238,6 +251,7 @@ impl ConfigurationExportResult {`
`238`	`251`	`result: None,`
`239`	`252`	`messages: Vec::new(),`
`240`	`253`	`had_errors: false,`
	`254`	`+ outputs: None,`
`241`	`255`	`}`
`242`	`256`	`}`
`243`	`257`	`}`
Original file line number	Diff line number	Diff line change
`@@ -19,6 +19,7 @@ pub struct Context {`
`19`	`19`	`pub variables: Map<String, Value>,`
`20`	`20`	`pub start_datetime: DateTime<Local>,`
`21`	`21`	`pub restart_required: Option<Vec<RestartRequired>>,`
	`22`	`+ pub outputs: Map<String, Value>,`
`22`	`23`	`}`
`23`	`24`
`24`	`25`	`impl Context {`
`@@ -37,6 +38,7 @@ impl Context {`
`37`	`38`	`variables: Map::new(),`
`38`	`39`	`start_datetime: chrono::Local::now(),`
`39`	`40`	`restart_required: None,`
	`41`	`+ outputs: Map::new(),`
`40`	`42`	`}`
`41`	`43`	`}`
`42`	`44`	`}`