Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix not parsing expressions for Group resources #695

Merged
merged 3 commits into from
Mar 17, 2025
Merged

Fix not parsing expressions for Group resources #695

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b52b29e
Fix not parsing expressions for Group resources
SteveL-MSFT Mar 14, 2025
5e9c497
move clone outside of loop
SteveL-MSFT Mar 14, 2025
f3d2a5a
move common code to helper
SteveL-MSFT Mar 15, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions dsc/tests/dsc_expressions.tests.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,4 +79,32 @@ string.
"@.Replace("`r", "")
$out.results[1].result.actualState.output | Should -BeExactly "This is a single-quote: '"
}

It 'Nested Group resource does not invoke expressions' {
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How does this interact with expressions that need the top-level document to resolve, like retrieving a configuration parameter?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I already have this issue #381, so it's currently not possible

$yaml = @'
$schema: https://aka.ms/dsc/schemas/v3/bundled/config/document.json
resources:
- name: Nested Group
type: Microsoft.DSC/Group
properties:
$schema: https://aka.ms/dsc/schemas/v3/bundled/config/document.json
resources:
- name: Deeply nested OSInfo
type: Microsoft/OSInfo
properties: {}
- name: Deeply nested echo
type: Microsoft.DSC.Debug/Echo
properties:
output: >-
[reference(
resourceId('Microsoft/OSInfo', 'Deeply nested OSInfo')
)]
dependsOn:
- "[resourceId('Microsoft/OSInfo', 'Deeply nested OSInfo')]"
'@

$out = dsc config get -i $yaml | ConvertFrom-Json
$LASTEXITCODE | Should -Be 0
$out.results[0].result[1].result.actualState.output.family | Should -BeExactly $out.results[0].result[0].result.actualState.family
}
}
32 changes: 24 additions & 8 deletions dsc_lib/src/configure/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -232,6 +232,18 @@ impl Configurator {
&self.config
}

fn get_properties(&mut self, resource: &Resource, resource_kind: &Kind) -> Result<Option<Map<String, Value>>, DscError> {
match resource_kind {
Kind::Group => {
// if Group resource, we leave it to the resource to handle expressions
Ok(resource.properties.clone())
},
_ => {
Ok(self.invoke_property_expressions(resource.properties.as_ref())?)
},
}
}

/// Invoke the get operation on a resource.
///
/// # Returns
Expand All @@ -245,13 +257,14 @@ impl Configurator {
let mut result = ConfigurationGetResult::new();
let resources = get_resource_invocation_order(&self.config, &mut self.statement_parser, &self.context)?;
let mut progress = ProgressBar::new(resources.len() as u64, self.progress_format)?;
let discovery = &self.discovery.clone();
for resource in resources {
progress.set_resource(&resource.name, &resource.resource_type);
progress.write_activity(format!("Get '{}'", resource.name).as_str());
let properties = self.invoke_property_expressions(resource.properties.as_ref())?;
let Some(dsc_resource) = self.discovery.find_resource(&resource.resource_type) else {
let Some(dsc_resource) = discovery.find_resource(&resource.resource_type) else {
return Err(DscError::ResourceNotFound(resource.resource_type));
};
let properties = self.get_properties(&resource, &dsc_resource.kind)?;
debug!("resource_type {}", &resource.resource_type);
let filter = add_metadata(&dsc_resource.kind, properties)?;
trace!("filter: {filter}");
Expand Down Expand Up @@ -322,13 +335,14 @@ impl Configurator {
let mut result = ConfigurationSetResult::new();
let resources = get_resource_invocation_order(&self.config, &mut self.statement_parser, &self.context)?;
let mut progress = ProgressBar::new(resources.len() as u64, self.progress_format)?;
let discovery = &self.discovery.clone();
for resource in resources {
progress.set_resource(&resource.name, &resource.resource_type);
progress.write_activity(format!("Set '{}'", resource.name).as_str());
let properties = self.invoke_property_expressions(resource.properties.as_ref())?;
let Some(dsc_resource) = self.discovery.find_resource(&resource.resource_type) else {
let Some(dsc_resource) = discovery.find_resource(&resource.resource_type) else {
return Err(DscError::ResourceNotFound(resource.resource_type));
};
let properties = self.get_properties(&resource, &dsc_resource.kind)?;
debug!("resource_type {}", &resource.resource_type);

// see if the properties contains `_exist` and is false
Expand Down Expand Up @@ -466,13 +480,14 @@ impl Configurator {
let mut result = ConfigurationTestResult::new();
let resources = get_resource_invocation_order(&self.config, &mut self.statement_parser, &self.context)?;
let mut progress = ProgressBar::new(resources.len() as u64, self.progress_format)?;
let discovery = &self.discovery.clone();
for resource in resources {
progress.set_resource(&resource.name, &resource.resource_type);
progress.write_activity(format!("Test '{}'", resource.name).as_str());
let properties = self.invoke_property_expressions(resource.properties.as_ref())?;
let Some(dsc_resource) = self.discovery.find_resource(&resource.resource_type) else {
let Some(dsc_resource) = discovery.find_resource(&resource.resource_type) else {
return Err(DscError::ResourceNotFound(resource.resource_type));
};
let properties = self.get_properties(&resource, &dsc_resource.kind)?;
debug!("resource_type {}", &resource.resource_type);
let expected = add_metadata(&dsc_resource.kind, properties)?;
trace!("{}", t!("configure.mod.expectedState", state = expected));
Expand Down Expand Up @@ -541,13 +556,14 @@ impl Configurator {

let mut progress = ProgressBar::new(self.config.resources.len() as u64, self.progress_format)?;
let resources = self.config.resources.clone();
let discovery = &self.discovery.clone();
for resource in &resources {
progress.set_resource(&resource.name, &resource.resource_type);
progress.write_activity(format!("Export '{}'", resource.name).as_str());
let properties = self.invoke_property_expressions(resource.properties.as_ref())?;
let Some(dsc_resource) = self.discovery.find_resource(&resource.resource_type) else {
let Some(dsc_resource) = discovery.find_resource(&resource.resource_type) else {
return Err(DscError::ResourceNotFound(resource.resource_type.clone()));
};
let properties = self.get_properties(resource, &dsc_resource.kind)?;
let input = add_metadata(&dsc_resource.kind, properties)?;
trace!("{}", t!("configure.mod.exportInput", input = input));
let export_result = match add_resource_export_results_to_configuration(dsc_resource, Some(dsc_resource), &mut conf, input.as_str()) {
Expand Down
1 change: 1 addition & 0 deletions dsc_lib/src/discovery/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ use crate::{dscresources::dscresource::DscResource, dscerror::DscError, progress
use std::collections::BTreeMap;
use tracing::error;

#[derive(Clone)]
pub struct Discovery {
pub resources: BTreeMap<String, DscResource>,
}
Expand Down