From a8824d680b65a7d6fcd8c749171291d1fec78eda Mon Sep 17 00:00:00 2001 From: Steve Lee Date: Mon, 17 Jun 2024 12:53:00 -0700 Subject: [PATCH 1/2] add support for `set` and `test` for include --- dsc/examples/osinfo_parameters.dsc.yaml | 4 ++ dsc/src/subcommand.rs | 38 ++--------- dsc/tests/dsc_include.tests.ps1 | 43 +++++++++--- dsc_lib/src/configure/mod.rs | 9 +-- dsc_lib/src/dscerror.rs | 3 + dsc_lib/src/dscresources/command_resource.rs | 26 +++++-- dsc_lib/src/dscresources/dscresource.rs | 21 +++++- dsc_lib/src/dscresources/invoke_result.rs | 71 ++++++-------------- 8 files changed, 109 insertions(+), 106 deletions(-) diff --git a/dsc/examples/osinfo_parameters.dsc.yaml b/dsc/examples/osinfo_parameters.dsc.yaml index a5bb49fc..5e6613c5 100644 --- a/dsc/examples/osinfo_parameters.dsc.yaml +++ b/dsc/examples/osinfo_parameters.dsc.yaml @@ -13,3 +13,7 @@ resources: type: Microsoft/OSInfo properties: family: "[parameters('osFamily')]" +- name: another os instance + type: Microsoft/OSInfo + properties: + family: macOS diff --git a/dsc/src/subcommand.rs b/dsc/src/subcommand.rs index d0e935c6..0161a33f 100644 --- a/dsc/src/subcommand.rs +++ b/dsc/src/subcommand.rs @@ -9,9 +9,7 @@ use crate::tablewriter::Table; use crate::util::{DSC_CONFIG_ROOT, EXIT_DSC_ERROR, EXIT_INVALID_INPUT, EXIT_JSON_ERROR, EXIT_VALIDATION_FAILED, get_schema, write_output, get_input, set_dscconfigroot, validate_json}; use dsc_lib::configure::{Configurator, config_doc::ExecutionKind, config_result::ResourceGetResult}; use dsc_lib::dscerror::DscError; -use dsc_lib::dscresources::invoke_result::{ - GroupResourceSetResponse, GroupResourceTestResponse, ResolveResult, TestResult -}; +use dsc_lib::dscresources::invoke_result::ResolveResult; use dsc_lib::{ DscManager, dscresources::invoke_result::ValidateResult, @@ -27,11 +25,7 @@ pub fn config_get(configurator: &mut Configurator, format: &Option match configurator.invoke_get() { Ok(result) => { if *as_group { - let mut group_result = Vec::::new(); - for result in result.results { - group_result.push(result); - }; - let json = match serde_json::to_string(&group_result) { + let json = match serde_json::to_string(&(result.results)) { Ok(json) => json, Err(err) => { error!("JSON Error: {err}"); @@ -66,10 +60,7 @@ pub fn config_set(configurator: &mut Configurator, format: &Option match configurator.invoke_set(false) { Ok(result) => { if *as_group { - let group_result = GroupResourceSetResponse { - results: result.results - }; - let json = match serde_json::to_string(&group_result) { + let json = match serde_json::to_string(&(result.results)) { Ok(json) => json, Err(err) => { error!("JSON Error: {err}"); @@ -104,23 +95,6 @@ pub fn config_test(configurator: &mut Configurator, format: &Option { if *as_group { - let mut in_desired_state = true; - for test_result in &result.results { - match &test_result.result { - TestResult::Resource(resource_test_result) => { - if !resource_test_result.in_desired_state { - in_desired_state = false; - break; - } - }, - TestResult::Group(group_resource_test_result) => { - if !group_resource_test_result.in_desired_state { - in_desired_state = false; - break; - } - } - } - } let json = if *as_get { let mut group_result = Vec::::new(); for test_result in result.results { @@ -135,11 +109,7 @@ pub fn config_test(configurator: &mut Configurator, format: &Option json, Err(err) => { error!("JSON Error: {err}"); diff --git a/dsc/tests/dsc_include.tests.ps1 b/dsc/tests/dsc_include.tests.ps1 index fab0690a..bcce188d 100644 --- a/dsc/tests/dsc_include.tests.ps1 +++ b/dsc/tests/dsc_include.tests.ps1 @@ -10,15 +10,6 @@ Describe 'Include tests' { $osinfoParametersConfigPath = Get-Item (Join-Path $includePath 'osinfo.parameters.yaml') $logPath = Join-Path $TestDrive 'stderr.log' - - $includeConfig = @' - `$schema: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/2024/04/config/document.json - resources: - - name: Echo - type: Test/Echo - properties: - output: Hello World -'@ } It 'Include config with default parameters' { @@ -183,4 +174,38 @@ resources: $out.results[1].result[0].result[0].type | Should -Be 'Test/Echo' $out.results[1].result[0].result[0].result[0].actualState.output | Should -Be 'one' } + + It 'Set with include works' { + $echoConfig = @' +$schema: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/2024/04/config/document.json +resources: +- name: one + type: Test/Echo + properties: + output: Hello World +'@ + + $echoConfigPath = Join-Path $TestDrive 'echo.dsc.yaml' + $echoConfig | Set-Content -Path $echoConfigPath -Encoding utf8 + # need to escape backslashes for YAML + $echoConfigPathParent = (Split-Path $echoConfigPath -Parent).Replace('\', '\\') + $echoConfigPathLeaf = (Split-Path $echoConfigPath -Leaf).Replace('\', '\\') + $directorySeparator = [System.IO.Path]::DirectorySeparatorChar.ToString().Replace('\', '\\') + + $includeConfig = @" +`$schema: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/2024/04/config/document.json +resources: +- name: nested + type: Microsoft.DSC/Include + properties: + configurationFile: "[concat('$echoConfigPathParent', '$directorySeparator', '$echoConfigPathLeaf')]" +"@ + + $out = dsc config set -d $includeConfig | ConvertFrom-Json + $LASTEXITCODE | Should -Be 0 + $out.results[0].result[0].name | Should -Be 'one' + $out.results[0].result[0].type | Should -Be 'Test/Echo' + $out.results[0].result[0].result.afterState.output | Should -Be 'Hello World' + $out.hadErrors | Should -Be $false + } } diff --git a/dsc_lib/src/configure/mod.rs b/dsc_lib/src/configure/mod.rs index 6e99670e..8bee22fd 100644 --- a/dsc_lib/src/configure/mod.rs +++ b/dsc_lib/src/configure/mod.rs @@ -4,10 +4,11 @@ use crate::configure::config_doc::{ExecutionKind, Metadata}; use crate::configure::parameters::Input; use crate::dscerror::DscError; -use crate::dscresources::dscresource::get_diff; -use crate::dscresources::invoke_result::GetResult; -use crate::dscresources::{dscresource::{Capability, Invoke}, invoke_result::{SetResult, ResourceSetResponse}}; -use crate::dscresources::resource_manifest::Kind; +use crate::dscresources::{ + {dscresource::{Capability, Invoke, get_diff}, invoke_result::{SetResult, ResourceSetResponse}}, + invoke_result::GetResult, + resource_manifest::Kind, +}; use crate::DscResource; use crate::discovery::Discovery; use crate::parser::Statement; diff --git a/dsc_lib/src/dscerror.rs b/dsc_lib/src/dscerror.rs index e0dfca4f..45833079 100644 --- a/dsc_lib/src/dscerror.rs +++ b/dsc_lib/src/dscerror.rs @@ -95,6 +95,9 @@ pub enum DscError { #[error("Resource not found: {0}")] ResourceNotFound(String), + #[error("Resource manifest not found: {0}")] + ResourceManifestNotFound(String), + #[error("Schema: {0}")] Schema(String), diff --git a/dsc_lib/src/dscresources/command_resource.rs b/dsc_lib/src/dscresources/command_resource.rs index 28472599..bce7828f 100644 --- a/dsc_lib/src/dscresources/command_resource.rs +++ b/dsc_lib/src/dscresources/command_resource.rs @@ -6,7 +6,7 @@ use serde_json::Value; use std::{collections::HashMap, env, io::{Read, Write}, process::{Command, Stdio}}; use crate::{configure::{config_doc::ExecutionKind, {config_result::ResourceGetResult, parameters, Configurator}}, util::parse_input_to_json}; use crate::dscerror::DscError; -use super::{dscresource::get_diff, invoke_result::{ExportResult, GetResult, ResolveResult, SetResult, TestResult, ValidateResult, ResourceGetResponse, ResourceSetResponse, ResourceTestResponse}, resource_manifest::{ArgKind, InputKind, Kind, ResourceManifest, ReturnKind, SchemaKind}}; +use super::{dscresource::get_diff, invoke_result::{ExportResult, GetResult, ResolveResult, SetResult, TestResult, ValidateResult, ResourceGetResponse, ResourceSetResponse, ResourceTestResponse, get_in_desired_state}, resource_manifest::{ArgKind, InputKind, Kind, ResourceManifest, ReturnKind, SchemaKind}}; use tracing::{error, warn, info, debug, trace}; pub const EXIT_PROCESS_TERMINATED: i32 = 0x102; @@ -94,7 +94,13 @@ pub fn invoke_get(resource: &ResourceManifest, cwd: &str, filter: &str) -> Resul /// Error returned if the resource does not successfully set the desired state #[allow(clippy::too_many_lines)] pub fn invoke_set(resource: &ResourceManifest, cwd: &str, desired: &str, skip_test: bool, execution_type: &ExecutionKind) -> Result { - // TODO: support import resources + debug!("Invoking set for '{}'", &resource.resource_type); + if resource.kind == Some(Kind::Import) { + let mut configurator = get_configurator(resource, cwd, desired)?; + let config_result = configurator.invoke_set(skip_test)?; + return Ok(SetResult::Group(config_result.results)); + } + let operation_type: String; let mut is_synthetic_what_if = false; let set_method = match execution_type { @@ -124,16 +130,17 @@ pub fn invoke_set(resource: &ResourceManifest, cwd: &str, desired: &str, skip_te if is_synthetic_what_if { return Ok(test_result.into()); } - let (in_desired_state, actual_state) = match test_result { + let (in_desired_state, actual_state) = match &test_result { TestResult::Group(group_response) => { + let in_desired_state = get_in_desired_state(&test_result); let mut result_array: Vec = Vec::new(); - for result in group_response.results { + for result in group_response { result_array.push(serde_json::to_value(result)?); } - (group_response.in_desired_state, Value::from(result_array)) + (in_desired_state, Value::from(result_array)) }, TestResult::Resource(response) => { - (response.in_desired_state, response.actual_state) + (response.in_desired_state, response.actual_state.clone()) } }; @@ -267,7 +274,12 @@ pub fn invoke_set(resource: &ResourceManifest, cwd: &str, desired: &str, skip_te /// /// Error is returned if the underlying command returns a non-zero exit code. pub fn invoke_test(resource: &ResourceManifest, cwd: &str, expected: &str) -> Result { - // TODO: support import resources + debug!("Invoking test for '{}'", &resource.resource_type); + if resource.kind == Some(Kind::Import) { + let mut configurator = get_configurator(resource, cwd, expected)?; + let config_result = configurator.invoke_test()?; + return Ok(TestResult::Group(config_result.results)); + } let Some(test) = &resource.test else { info!("Resource '{}' does not implement test, performing synthetic test", &resource.resource_type); diff --git a/dsc_lib/src/dscresources/dscresource.rs b/dsc_lib/src/dscresources/dscresource.rs index 24506cf9..c0678d38 100644 --- a/dsc_lib/src/dscresources/dscresource.rs +++ b/dsc_lib/src/dscresources/dscresource.rs @@ -7,6 +7,7 @@ use schemars::JsonSchema; use serde::{Deserialize, Serialize}; use serde_json::Value; use std::collections::HashMap; +use tracing::debug; use super::{command_resource, dscerror, invoke_result::{ExportResult, GetResult, ResolveResult, ResourceTestResponse, SetResult, TestResult, ValidateResult}, resource_manifest::import_manifest}; @@ -187,6 +188,7 @@ pub trait Invoke { impl Invoke for DscResource { fn get(&self, filter: &str) -> Result { + debug!("Invoking get for resource: {}", self.type_name); match &self.implemented_as { ImplementedAs::Custom(_custom) => { Err(DscError::NotImplemented("get custom resources".to_string())) @@ -202,6 +204,7 @@ impl Invoke for DscResource { } fn set(&self, desired: &str, skip_test: bool, execution_type: &ExecutionKind) -> Result { + debug!("Invoking set for resource: {}", self.type_name); match &self.implemented_as { ImplementedAs::Custom(_custom) => { Err(DscError::NotImplemented("set custom resources".to_string())) @@ -217,6 +220,7 @@ impl Invoke for DscResource { } fn test(&self, expected: &str) -> Result { + debug!("Invoking test for resource: {}", self.type_name); match &self.implemented_as { ImplementedAs::Custom(_custom) => { Err(DscError::NotImplemented("test custom resources".to_string())) @@ -230,7 +234,15 @@ impl Invoke for DscResource { let resource_manifest = import_manifest(manifest.clone())?; if resource_manifest.test.is_none() { let get_result = self.get(expected)?; - let desired_state = serde_json::from_str(expected)?; + let desired_state = if self.kind == Kind::Import { + let config = self.resolve(expected)?.configuration; + // TODO: implement way to resolve entire config doc including expressions and parameters + // as the raw configuration (desired state) won't match the result, also convert the desired + // state to a TestResult so the comparison is consistent + serde_json::to_value(config["resources"].clone())? + } else { + serde_json::from_str(expected)? + }; let actual_state = match get_result { GetResult::Group(results) => { let mut result_array: Vec = Vec::new(); @@ -245,7 +257,7 @@ impl Invoke for DscResource { }; let diff_properties = get_diff( &desired_state, &actual_state); let test_result = TestResult::Resource(ResourceTestResponse { - desired_state: serde_json::from_str(expected)?, + desired_state, actual_state, in_desired_state: diff_properties.is_empty(), diff_properties, @@ -260,6 +272,7 @@ impl Invoke for DscResource { } fn delete(&self, filter: &str) -> Result<(), DscError> { + debug!("Invoking delete for resource: {}", self.type_name); match &self.implemented_as { ImplementedAs::Custom(_custom) => { Err(DscError::NotImplemented("set custom resources".to_string())) @@ -275,6 +288,7 @@ impl Invoke for DscResource { } fn validate(&self, config: &str) -> Result { + debug!("Invoking validate for resource: {}", self.type_name); match &self.implemented_as { ImplementedAs::Custom(_custom) => { Err(DscError::NotImplemented("validate custom resources".to_string())) @@ -290,6 +304,7 @@ impl Invoke for DscResource { } fn schema(&self) -> Result { + debug!("Invoking schema for resource: {}", self.type_name); match &self.implemented_as { ImplementedAs::Custom(_custom) => { Err(DscError::NotImplemented("schema custom resources".to_string())) @@ -305,6 +320,7 @@ impl Invoke for DscResource { } fn export(&self, input: &str) -> Result { + debug!("Invoking export for resource: {}", self.type_name); let Some(manifest) = &self.manifest else { return Err(DscError::MissingManifest(self.type_name.clone())); }; @@ -313,6 +329,7 @@ impl Invoke for DscResource { } fn resolve(&self, input: &str) -> Result { + debug!("Invoking resolve for resource: {}", self.type_name); let Some(manifest) = &self.manifest else { return Err(DscError::MissingManifest(self.type_name.clone())); }; diff --git a/dsc_lib/src/dscresources/invoke_result.rs b/dsc_lib/src/dscresources/invoke_result.rs index e539d535..63d7aaf5 100644 --- a/dsc_lib/src/dscresources/invoke_result.rs +++ b/dsc_lib/src/dscresources/invoke_result.rs @@ -19,7 +19,7 @@ impl From for GetResult { match value { TestResult::Group(group) => { let mut results = Vec::::new(); - for result in group.results { + for result in group { results.push(result.into()); } GetResult::Group(results) @@ -41,32 +41,11 @@ pub struct ResourceGetResponse { pub actual_state: Value, } -#[derive(Debug, Clone, PartialEq, Deserialize, Serialize, JsonSchema)] -#[serde(deny_unknown_fields)] -pub struct GroupResourceSetResponse { - pub results: Vec, -} - -impl GroupResourceSetResponse { - #[must_use] - pub fn new() -> Self { - Self { - results: Vec::new(), - } - } -} - -impl Default for GroupResourceSetResponse { - fn default() -> Self { - Self::new() - } -} - #[derive(Debug, Clone, PartialEq, Deserialize, Serialize, JsonSchema)] #[serde(untagged)] pub enum SetResult { Resource(ResourceSetResponse), - Group(GroupResourceSetResponse), + Group(Vec), } impl From for SetResult { @@ -74,10 +53,10 @@ impl From for SetResult { match value { TestResult::Group(group) => { let mut results = Vec::::new(); - for result in group.results { + for result in group { results.push(result.into()); } - SetResult::Group(GroupResourceSetResponse { results }) + SetResult::Group(results) }, TestResult::Resource(resource) => { SetResult::Resource(ResourceSetResponse { @@ -104,35 +83,27 @@ pub struct ResourceSetResponse { pub changed_properties: Option>, } -#[derive(Debug, Clone, PartialEq, Deserialize, Serialize, JsonSchema)] -#[serde(deny_unknown_fields)] -pub struct GroupResourceTestResponse { - pub results: Vec, - #[serde(rename = "inDesiredState")] - pub in_desired_state: bool, -} - -impl GroupResourceTestResponse { - #[must_use] - pub fn new() -> Self { - Self { - results: Vec::new(), - in_desired_state: false, - } - } -} - -impl Default for GroupResourceTestResponse { - fn default() -> Self { - Self::new() - } -} - #[derive(Debug, Clone, PartialEq, Deserialize, Serialize, JsonSchema)] #[serde(untagged)] pub enum TestResult { Resource(ResourceTestResponse), - Group(GroupResourceTestResponse), + Group(Vec), +} + +pub fn get_in_desired_state(test_result: &TestResult) -> bool { + match test_result { + TestResult::Resource(ref resource_test_result) => { + return resource_test_result.in_desired_state; + }, + TestResult::Group(ref group_test_result) => { + for result in group_test_result { + if !get_in_desired_state(&(result.result)) { + return false; + } + } + true + } + } } #[derive(Debug, Clone, PartialEq, Deserialize, Serialize, JsonSchema)] From a706d913262a73c303960f717256477c9d3e34d7 Mon Sep 17 00:00:00 2001 From: Steve Lee Date: Mon, 17 Jun 2024 12:54:22 -0700 Subject: [PATCH 2/2] fix clippy --- dsc_lib/src/dscresources/invoke_result.rs | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/dsc_lib/src/dscresources/invoke_result.rs b/dsc_lib/src/dscresources/invoke_result.rs index 63d7aaf5..da66b5cc 100644 --- a/dsc_lib/src/dscresources/invoke_result.rs +++ b/dsc_lib/src/dscresources/invoke_result.rs @@ -90,10 +90,11 @@ pub enum TestResult { Group(Vec), } +#[must_use] pub fn get_in_desired_state(test_result: &TestResult) -> bool { match test_result { TestResult::Resource(ref resource_test_result) => { - return resource_test_result.in_desired_state; + resource_test_result.in_desired_state }, TestResult::Group(ref group_test_result) => { for result in group_test_result {