Add metadata so adapter resource knows if input is configuration or for a resource

dsc_lib/src/configure/config_doc.rs

@@ -71,9 +71,10 @@ pub struct Resource {
     #[serde(rename = "dependsOn", skip_serializing_if = "Option::is_none")]
     #[schemars(regex(pattern = r"^\[resourceId\(\s*'[a-zA-Z0-9\.]+/[a-zA-Z0-9]+'\s*,\s*'[a-zA-Z0-9 ]+'\s*\)]$"))]
     pub depends_on: Option<Vec<String>>,
-    // `identity` can be used for run-as
     #[serde(skip_serializing_if = "Option::is_none")]
     pub properties: Option<Map<String, Value>>,
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub metadata: Option<HashMap<String, Value>>,
 }
 
 // Defines the valid and recognized canonical URIs for the configuration schema
@@ -127,6 +128,7 @@ impl Resource {
             name: String::new(),
             depends_on: None,
             properties: None,
+            metadata: None,
         }
     }
 }

dsc_lib/src/configure/mod.rs

@@ -4,6 +4,7 @@
 use crate::configure::parameters::Input;
 use crate::dscerror::DscError;
 use crate::dscresources::dscresource::Invoke;
+use crate::dscresources::resource_manifest::Kind;
 use crate::DscResource;
 use crate::discovery::Discovery;
 use crate::parser::Statement;
@@ -142,6 +143,24 @@ fn get_progress_bar(len: u64) -> Result<ProgressBar, DscError> {
    Ok(pb)
 }
 
+fn add_metadata(kind: &Kind, mut properties: Option<Map<String, Value>> ) -> Result<String, DscError> {
+    if *kind == Kind::Adapter {
+        // add metadata to the properties so the adapter knows this is a config
+        let mut metadata = Map::new();
+        let mut dsc_value = Map::new();
+        dsc_value.insert("context".to_string(), Value::String("configuration".to_string()));
+        metadata.insert("Microsoft.DSC".to_string(), Value::Object(dsc_value));
+        if let Some(mut properties) = properties {
+            properties.insert("metadata".to_string(), Value::Object(metadata));
+            return Ok(serde_json::to_string(&properties)?);
+        }
+        properties = Some(metadata);
+        return Ok(serde_json::to_string(&properties)?);
+    }
+
+    Ok(serde_json::to_string(&properties)?)
+}
+
 impl Configurator {
     /// Create a new `Configurator` instance.
     ///
@@ -185,7 +204,8 @@ impl Configurator {
                 return Err(DscError::ResourceNotFound(resource.resource_type));
             };
             debug!("resource_type {}", &resource.resource_type);
-            let filter = serde_json::to_string(&properties)?;
+            let filter = add_metadata(&dsc_resource.kind, properties)?;
+            trace!("filter: {filter}");
             let get_result = dsc_resource.get(&filter)?;
             let resource_result = config_result::ResourceGetResult {
                 name: resource.name.clone(),
@@ -222,7 +242,8 @@ impl Configurator {
                 return Err(DscError::ResourceNotFound(resource.resource_type));
             };
             debug!("resource_type {}", &resource.resource_type);
-            let desired = serde_json::to_string(&properties)?;
+            let desired = add_metadata(&dsc_resource.kind, properties)?;
+            trace!("desired: {desired}");
             let set_result = dsc_resource.set(&desired, skip_test)?;
             let resource_result = config_result::ResourceSetResult {
                 name: resource.name.clone(),
@@ -259,7 +280,8 @@ impl Configurator {
                 return Err(DscError::ResourceNotFound(resource.resource_type));
             };
             debug!("resource_type {}", &resource.resource_type);
-            let expected = serde_json::to_string(&properties)?;
+            let expected = add_metadata(&dsc_resource.kind, properties)?;
+            trace!("expected: {expected}");
             let test_result = dsc_resource.test(&expected)?;
             let resource_result = config_result::ResourceTestResult {
                 name: resource.name.clone(),
@@ -294,14 +316,15 @@ impl Configurator {
         let mut conf = config_doc::Configuration::new();
 
         let pb = get_progress_bar(config.resources.len() as u64)?;
-        for resource in &config.resources {
+        for resource in config.resources {
             pb.inc(1);
             pb.set_message(format!("Export '{}'", resource.name));
+            let properties = self.invoke_property_expressions(&resource.properties)?;
             let Some(dsc_resource) = self.discovery.find_resource(&resource.resource_type.to_lowercase()) else {
                 return Err(DscError::ResourceNotFound(resource.resource_type.clone()));
             };
-
-            let input = serde_json::to_string(&resource.properties)?;
+            let input = add_metadata(&dsc_resource.kind, properties)?;
+            trace!("input: {input}");
             add_resource_export_results_to_configuration(dsc_resource, Some(dsc_resource), &mut conf, input.as_str())?;
         }
 

powershell-adapter/powershell.resource.ps1

@@ -33,6 +33,14 @@ function RefreshCache
     }
 }
 
+function IsConfiguration($obj) {
+    if ($null -ne $obj.metadata -and $null -ne $obj.metadata.'Microsoft.DSC' -and $obj.metadata.'Microsoft.DSC'.context -eq 'Configuration') {
+        return $true
+    }
+
+    return $false
+}
+
 if (($PSVersionTable.PSVersion.Major -eq 7) -and ($PSVersionTable.PSVersion.Minor -eq 4) `
    -and ($PSVersionTable.PSVersion.PreReleaseLabel.StartsWith("preview")))
 {
@@ -121,7 +129,7 @@ elseif ($Operation -eq 'Get')
 
     RefreshCache
 
-    if ($inputobj_pscustomobj.resources) # we are processing a config batch
+    if (IsConfiguration $inputobj_pscustomobj) # we are processing a config batch
     {
         foreach($r in $inputobj_pscustomobj.resources)
         {
@@ -191,7 +199,7 @@ elseif ($Operation -eq 'Set')
 
     RefreshCache
 
-    if ($inputobj_pscustomobj.resources) # we are processing a config batch
+    if (IsConfiguration $inputobj_pscustomobj) # we are processing a config batch
     {
         foreach($r in $inputobj_pscustomobj.resources)
         {
@@ -259,7 +267,7 @@ elseif ($Operation -eq 'Test')
 
     RefreshCache
 
-    if ($inputobj_pscustomobj.resources) # we are processing a config batch
+    if (IsConfiguration $inputobj_pscustomobj) # we are processing a config batch
     {
         foreach($r in $inputobj_pscustomobj.resources)
         {
@@ -327,7 +335,7 @@ elseif ($Operation -eq 'Export')
 
     RefreshCache
 
-    if ($inputobj_pscustomobj.resources) # we are processing a config batch
+    if (IsConfiguration $inputobj_pscustomobj) # we are processing a config batch
     {
         foreach($r in $inputobj_pscustomobj.resources)
         {

wmi-adapter/Tests/wmi.tests.ps1

@@ -11,7 +11,7 @@ Describe 'WMI adapter resource tests' {
 
             $configPath = Join-path $PSScriptRoot "test_wmi_config.dsc.yaml"
 
-            $dscPath = (get-command dsc -CommandType Application).Path
+            $dscPath = (get-command dsc -CommandType Application | Select-Object -First 1).Path
             $dscFolder = Split-Path -Path $dscPath
             $wmiGroupOptoutFile = Join-Path $dscFolder "wmi.dsc.resource.json.optout"
             $wmiGroupOptinFile = Join-Path $dscFolder "wmi.dsc.resource.json"

wmi-adapter/wmi.resource.ps1

@@ -13,6 +13,14 @@ $ProgressPreference = 'Ignore'
 $WarningPreference = 'Ignore'
 $VerbosePreference = 'Ignore'
 
+function IsConfiguration($obj) {
+    if ($null -ne $obj.metadata -and $null -ne $obj.metadata.'Microsoft.DSC' -and $obj.metadata.'Microsoft.DSC'.context -eq 'Configuration') {
+        return $true
+    }
+
+    return $false
+}
+
 if ($Operation -eq 'List')
 {
     $clases = Get-CimClass
@@ -62,7 +70,7 @@ elseif ($Operation -eq 'Get')
 
     $result = @()
 
-    if ($inputobj_pscustomobj.resources) # we are processing a config batch
+    if (IsConfiguration $inputobj_pscustomobj) # we are processing a config batch
     {
         foreach($r in $inputobj_pscustomobj.resources)
         {