Merge branch 'main' into struct-casing

Author: SteveL-MSFT

build.ps1

@@ -354,6 +354,7 @@ if (!$SkipBuild) {
 
             if ($IsWindows) {
                 Copy-Item "$path/$binary.exe" $target -ErrorAction Ignore -Verbose
+                Copy-Item "$path/$binary.pdb" $target -ErrorAction Ignore -Verbose
             }
             else {
                 Copy-Item "$path/$binary" $target -ErrorAction Ignore -Verbose

dsc/src/args.rs

@@ -213,6 +213,10 @@ pub enum ResourceSubCommand {
     Export {
         #[clap(short, long, help = t!("args.resource").to_string())]
         resource: String,
+        #[clap(short, long, help = t!("args.input").to_string(), conflicts_with = "file")]
+        input: Option<String>,
+        #[clap(short = 'f', long, help = t!("args.file").to_string(), conflicts_with = "input")]
+        file: Option<String>,
         #[clap(short = 'o', long, help = t!("args.outputFormat").to_string())]
         output_format: Option<OutputFormat>,
     },

dsc/src/resource_command.rs

@@ -259,8 +259,7 @@ pub fn schema(dsc: &DscManager, resource_type: &str, format: Option<&OutputForma
     }
 }
 
-pub fn export(dsc: &mut DscManager, resource_type: &str, format: Option<&OutputFormat>) {
-    let mut input = String::new();
+pub fn export(dsc: &mut DscManager, resource_type: &str, mut input: String, format: Option<&OutputFormat>) {
     let Some(dsc_resource) = get_resource(dsc, resource_type) else {
         error!("{}", DscError::ResourceNotFound(resource_type.to_string()).to_string());
         exit(EXIT_DSC_RESOURCE_NOT_FOUND);

dsc/src/subcommand.rs

@@ -545,9 +545,10 @@ pub fn resource(subcommand: &ResourceSubCommand, progress_format: ProgressFormat
             dsc.find_resources(&[resource.to_string()], progress_format);
             resource_command::schema(&dsc, resource, output_format.as_ref());
         },
-        ResourceSubCommand::Export { resource, output_format } => {
+        ResourceSubCommand::Export { resource, input, file, output_format } => {
             dsc.find_resources(&[resource.to_string()], progress_format);
-            resource_command::export(&mut dsc, resource, output_format.as_ref());
+            let parsed_input = get_input(input.as_ref(), file.as_ref());
+            resource_command::export(&mut dsc, resource, parsed_input, output_format.as_ref());
         },
         ResourceSubCommand::Get { resource, input, file: path, all, output_format } => {
             dsc.find_resources(&[resource.to_string()], progress_format);

dsc/tests/dsc_args.tests.ps1

@@ -97,7 +97,7 @@ actualState:
             $resource = $obj | y2j | ConvertFrom-Json
             $resource | Should -Not -BeNullOrEmpty
             $resource.Type | Should -BeLike '*/*'
-            $resource.Kind | Should -BeIn ('resource', 'group', 'importer', 'adapter')
+            $resource.Kind | Should -BeIn ('resource', 'group', 'exporter', 'importer', 'adapter')
         }
     }
 

dsc/tests/dsc_config_test.tests.ps1

@@ -32,4 +32,34 @@ Describe 'dsc config test tests' {
             $out.results[0].result.differingProperties | Should -Contain 'resources'
         }
     }
+
+    It '_inDesiredState returned is used when: inDesiredState = <inDesiredState> and same = <same>' -TestCases @(
+        @{ inDesiredState = $true; valueOne = 1; valueTwo = 2; same = $true }
+        @{ inDesiredState = $true; valueOne = 3; valueTwo = 4; same = $false }
+        @{ inDesiredState = $false; valueOne = 1; valueTwo = 2; same = $true }
+        @{ inDesiredState = $false; valueOne = 3; valueTwo = 4; same = $false }
+    ) {
+        param($inDesiredState, $valueOne, $valueTwo)
+
+        $configYaml = @"
+  `$schema: https://aka.ms/dsc/schemas/v3/bundled/config/document.json
+  resources:
+    - name: Test
+      type: Test/InDesiredState
+      properties:
+        _inDesiredState: $inDesiredState
+        valueOne: $valueOne
+        valueTwo: $valueTwo
+"@
+
+        $out = dsc config test -i $configYaml | ConvertFrom-Json
+        $LASTEXITCODE | Should -Be 0
+        $out.results[0].result.inDesiredState | Should -Be $inDesiredState
+        if ($same) {
+            $out.results[0].result.differingProperties | Should -BeNullOrEmpty
+        }
+        else {
+            $out.results[0].result.differingProperties | Should -Be @('valueOne', 'valueTwo')
+        }
+    }
 }

dsc/tests/dsc_export.tests.ps1

@@ -88,6 +88,18 @@ Describe 'resource export tests' {
       $config_with_process_list.resources.count | Should -BeGreaterThan 1
     }
 
+    It 'Export can be called on resource with input' {
+        $out = '{"count":3}' | dsc resource export -r Test/Export -f - | ConvertFrom-Json
+        $LASTEXITCODE | Should -Be 0
+        $out.resources.count | Should -Be 3
+        $out.resources[0].type | Should -BeExactly 'Test/Export'
+        $out.resources[0].properties.count | Should -Be 0
+        $out.resources[1].type | Should -BeExactly 'Test/Export'
+        $out.resources[1].properties.count | Should -Be 1
+        $out.resources[2].type | Should -BeExactly 'Test/Export'
+        $out.resources[2].properties.count | Should -Be 2
+    }
+
     It 'Export can be called on a configuration with the use of --output-format as a subcommand' {
 
       $yaml = @'
@@ -105,4 +117,48 @@ Describe 'resource export tests' {
       $config_with_process_list.'resources' | Should -Not -BeNullOrEmpty
       $config_with_process_list.resources.count | Should -BeGreaterThan 1
     }
+
+    It 'Export for config preserves metadata' {
+        $yaml = @'
+          $schema: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/2023/08/config/document.json
+          metadata:
+            winget:
+              processor: dscv3
+            hello: world
+          resources:
+            - name: OS
+              type: Microsoft/OSInfo
+'@
+        $out = $yaml | dsc config export -f - | ConvertFrom-Json
+        $LASTEXITCODE | Should -Be 0
+        $out.metadata.winget.processor | Should -BeExactly 'dscv3'
+        $out.metadata.hello | Should -BeExactly 'world'
+        $out.metadata.'Microsoft.DSC'.operation | Should -BeExactly 'export'
+    }
+
+    It 'Works with Exporter resource' {
+      $yaml = @'
+$schema: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/2023/08/config/document.json
+resources:
+  - name: export this
+    type: Test/Exporter
+    properties:
+      typeNames:
+        - Test/Foo
+        - Test/Bar
+'@
+      $out = dsc config export -i $yaml | ConvertFrom-Json
+      $LASTEXITCODE | Should -Be 0
+      $out.resources | Should -HaveCount 2
+      $out.resources[0].type | Should -BeExactly 'Test/Foo'
+      $out.resources[0].name | Should -BeExactly 'test'
+      $out.resources[0].properties.psobject.properties | Should -HaveCount 2
+      $out.resources[0].properties.foo | Should -BeExactly 'bar'
+      $out.resources[0].properties.hello | Should -BeExactly 'world'
+      $out.resources[1].type | Should -BeExactly 'Test/Bar'
+      $out.resources[1].name | Should -BeExactly 'test'
+      $out.resources[1].properties.psobject.properties | Should -HaveCount 2
+      $out.resources[1].properties.foo | Should -BeExactly 'bar'
+      $out.resources[1].properties.hello | Should -BeExactly 'world'
+    }
 }

dsc_lib/locales/en-us.toml

@@ -99,7 +99,7 @@ setUnexpectedOutput = "Command did not return expected actual output"
 setUnexpectedDiff = "Command did not return expected diff output"
 invokeTest = "Invoking test for '%{resource}'"
 testSyntheticTest = "Resource '%{resource}' does not implement test, performing synthetic test"
-invokeTestUsing = "Invoking test on '%{resource}' using '{executable}'"
+invokeTestUsing = "Invoking test on '%{resource}' using '%{executable}'"
 testVerifyOutput = "Verifying output of test on '%{resource}' using '%{executable}'"
 testGroupTestResponse = "Import resource kind, returning group test response"
 testNoActualState = "No actual state returned"
@@ -129,6 +129,7 @@ validateJson = "Validating against JSON: %{json}"
 resourceInvalidJson = "Resource reported input JSON is not valid"
 invalidArrayKey = "Unsupported array value for key '%{key}'.  Only string and number is supported."
 invalidKey = "Unsupported value for key '%{key}'.  Only string, bool, number, and array is supported."
+inDesiredStateNotBool = "'_inDesiredState' is not a boolean"
 
 [dscresources.dscresource]
 invokeGet = "Invoking get for '%{resource}'"

dsc_lib/src/configure/config_doc.rs

@@ -72,6 +72,8 @@ pub struct MicrosoftDscMetadata {
 pub struct Metadata {
     #[serde(rename = "Microsoft.DSC", skip_serializing_if = "Option::is_none")]
     pub microsoft: Option<MicrosoftDscMetadata>,
+    #[serde(flatten)]
+    pub other: Map<String, Value>,
 }
 
 #[derive(Debug, Clone, PartialEq, Deserialize, Serialize, JsonSchema)]
@@ -85,7 +87,7 @@ pub struct Configuration {
     #[serde(skip_serializing_if = "Option::is_none")]
     pub parameters: Option<HashMap<String, Parameter>>,
     #[serde(skip_serializing_if = "Option::is_none")]
-    pub variables: Option<HashMap<String, Value>>,
+    pub variables: Option<Map<String, Value>>,
     pub resources: Vec<Resource>,
     #[serde(skip_serializing_if = "Option::is_none")]
     pub metadata: Option<Metadata>,
@@ -110,7 +112,7 @@ pub struct Parameter {
     #[serde(skip_serializing_if = "Option::is_none")]
     pub description: Option<String>,
     #[serde(skip_serializing_if = "Option::is_none")]
-    pub metadata: Option<HashMap<String, Value>>,
+    pub metadata: Option<Map<String, Value>>,
 }
 
 #[derive(Debug, Clone, PartialEq, Deserialize, Serialize, JsonSchema)]
@@ -144,7 +146,7 @@ pub struct Resource {
     #[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>>,
+    pub metadata: Option<Map<String, Value>>,
 }
 
 impl Default for Configuration {

dsc_lib/src/configure/context.rs

@@ -4,18 +4,18 @@
 use chrono::{DateTime, Local};
 use crate::configure::config_doc::ExecutionKind;
 use security_context_lib::{get_security_context, SecurityContext};
-use serde_json::Value;
+use serde_json::{Map, Value};
 use std::{collections::HashMap, path::PathBuf};
 
 use super::config_doc::{DataType, SecurityContextKind};
 
 pub struct Context {
     pub execution_type: ExecutionKind,
-    pub references: HashMap<String, Value>,
+    pub references: Map<String, Value>,
     pub system_root: PathBuf,
     pub parameters: HashMap<String, (Value, DataType)>,
     pub security_context: SecurityContextKind,
-    pub variables: HashMap<String, Value>,
+    pub variables: Map<String, Value>,
     pub start_datetime: DateTime<Local>,
 }
 
@@ -24,14 +24,14 @@ impl Context {
     pub fn new() -> Self {
         Self {
             execution_type: ExecutionKind::Actual,
-            references: HashMap::new(),
+            references: Map::new(),
             system_root: get_default_os_system_root(),
             parameters: HashMap::new(),
             security_context: match get_security_context() {
                 SecurityContext::Admin => SecurityContextKind::Elevated,
                 SecurityContext::User => SecurityContextKind::Restricted,
             },
-            variables: HashMap::new(),
+            variables: Map::new(),
             start_datetime: chrono::Local::now(),
         }
     }