Merge branch 'main' into executionpolicy

Author: SteveL-MSFT

.config/tsaoptions.json

@@ -3,7 +3,7 @@
     "projectName": "One",
     "areaPath": "One\\MGMT\\Compute\\PowerShell Desired State Configuration",
     "notificationAliases": [
-        "anmenaga@microsoft.com",
+        "tessgauthier@microsoft.com",
         "[email protected]"
     ]
 }

dsc/assertion.dsc.resource.json

@@ -11,6 +11,7 @@
       "pass-through",
       "config",
       "--as-group",
+      "--as-assert",
       "test",
       "--as-get",
       {
@@ -26,6 +27,7 @@
       "pass-through",
       "config",
       "--as-group",
+      "--as-assert",
       "test",
       {
         "jsonInputArg": "--input",
@@ -42,6 +44,7 @@
       "pass-through",
       "config",
       "--as-group",
+      "--as-assert",
       "test",
       "--as-config",
       {
@@ -59,7 +62,8 @@
     "4": "Invalid input format",
     "5": "Resource instance failed schema validation",
     "6": "Command cancelled",
-    "7": "Resource not found"
+    "7": "Resource not found",
+    "8": "Assertion failed"
   },
   "validate": {
     "executable": "dsc",

dsc/examples/assertion.dsc.yaml

@@ -23,5 +23,5 @@ resources:
         keyPath: HKLM\Software\Microsoft\Windows NT\CurrentVersion
         valueName: SystemRoot
         valueData:
-          # this is deliberately set to z: drive so that the assertion fails
-          String: Z:\Windows
+          # this is deliberately set to L: drive so that the assertion fails
+          String: L:\Windows

dsc/examples/powershell.dsc.yaml

@@ -1,21 +1,24 @@
 # Example configuration mixing native app resources with classic PS resources
 $schema: https://aka.ms/dsc/schemas/v3/bundled/config/document.json
+metadata:
+  Microsoft.DSC:
+    securityContext: elevated
 resources:
 - name: Use class PowerShell resources
-  type: Microsoft.DSC/PowerShell
+  type: Microsoft.Windows/WindowsPowerShell
   properties:
     resources:
     - name: OpenSSH service
-      type: PsDesiredStateConfiguration/MSFT_ServiceResource
+      type: PsDesiredStateConfiguration/Service
       properties:
         Name: sshd
     - name: Administrator
-      type: PsDesiredStateConfiguration/MSFT_UserResource
+      type: PsDesiredStateConfiguration/User
       properties:
         UserName: administrator
 - name: current user registry
   type: Microsoft.Windows/Registry
   properties:
     keyPath: HKLM\Software\Microsoft\Windows NT\CurrentVersion
     valueName: ProductName
-    _ensure: Present
+    _exist: True

dsc/locales/en-us.toml

@@ -67,13 +67,13 @@ noParameters = "No parameters specified"
 [resource_command]
 implementedAs = "implemented as"
 invalidOperationOnAdapter = "Can not perform this operation on the adapter itself"
-adapterNotFound = "Adapter not found"
 setInputEmpty = "Desired input is empty"
 testInputEmpty = "Expected input is required"
 
 [subcommand]
 actualStateNotObject = "actual_state is not an object"
 unexpectedTestResult = "Unexpected Group TestResult"
+assertionFailed = "Assertion failed for resource '%{resource_type}'"
 message = "message"
 currentDirectory = "current directory"
 noParameters = "No parameters specified"

dsc/src/args.rs

@@ -58,6 +58,8 @@ pub enum SubCommand {
         // Used to inform when DSC is used as a group resource to modify it's output
         #[clap(long, hide = true)]
         as_group: bool,
+        #[clap(long, hide = true)]
+        as_assert: bool,
         // Used to inform when DSC is used as a include group resource
         #[clap(long, hide = true)]
         as_include: bool,

dsc/src/main.rs

@@ -49,19 +49,19 @@ fn main() {
             let mut cmd = Args::command();
             generate(shell, &mut cmd, "dsc", &mut io::stdout());
         },
-        SubCommand::Config { subcommand, parameters, parameters_file, system_root, as_group, as_include } => {
+        SubCommand::Config { subcommand, parameters, parameters_file, system_root, as_group, as_assert, as_include } => {
             if let Some(file_name) = parameters_file {
                 info!("{}: {file_name}", t!("main.readingParametersFile"));
                 match std::fs::read_to_string(&file_name) {
-                    Ok(parameters) => subcommand::config(&subcommand, &Some(parameters), system_root.as_ref(), &as_group, &as_include, progress_format),
+                    Ok(parameters) => subcommand::config(&subcommand, &Some(parameters), system_root.as_ref(), &as_group, &as_assert, &as_include, progress_format),
                     Err(err) => {
                         error!("{} '{file_name}': {err}", t!("main.failedReadingParametersFile"));
                         exit(util::EXIT_INVALID_INPUT);
                     }
                 }
             }
             else {
-                subcommand::config(&subcommand, &parameters, system_root.as_ref(), &as_group, &as_include, progress_format);
+                subcommand::config(&subcommand, &parameters, system_root.as_ref(), &as_group, &as_assert, &as_include, progress_format);
             }
         },
         SubCommand::Resource { subcommand } => {

dsc/src/resource_command.rs

@@ -2,7 +2,7 @@
 // Licensed under the MIT License.
 
 use crate::args::OutputFormat;
-use crate::util::{EXIT_DSC_ERROR, EXIT_INVALID_ARGS, EXIT_JSON_ERROR, EXIT_DSC_RESOURCE_NOT_FOUND, add_type_name_to_json, write_object};
+use crate::util::{EXIT_DSC_ERROR, EXIT_INVALID_ARGS, EXIT_JSON_ERROR, EXIT_DSC_RESOURCE_NOT_FOUND, write_object};
 use dsc_lib::configure::config_doc::{Configuration, ExecutionKind};
 use dsc_lib::configure::add_resource_export_results_to_configuration;
 use dsc_lib::dscresources::{resource_manifest::Kind, invoke_result::{GetResult, ResourceGetResponse}};
@@ -16,8 +16,8 @@ use dsc_lib::{
 };
 use std::process::exit;
 
-pub fn get(dsc: &DscManager, resource_type: &str, mut input: String, format: Option<&OutputFormat>) {
-    let Some(mut resource) = get_resource(dsc, resource_type) else {
+pub fn get(dsc: &DscManager, resource_type: &str, input: &str, format: Option<&OutputFormat>) {
+    let Some(resource) = get_resource(dsc, resource_type) else {
         error!("{}", DscError::ResourceNotFound(resource_type.to_string()).to_string());
         exit(EXIT_DSC_RESOURCE_NOT_FOUND);
     };
@@ -28,17 +28,7 @@ pub fn get(dsc: &DscManager, resource_type: &str, mut input: String, format: Opt
         exit(EXIT_DSC_ERROR);
     }
 
-    if let Some(requires) = &resource.require_adapter {
-        input = add_type_name_to_json(input, resource.type_name.clone());
-        if let Some(pr) = get_resource(dsc, requires) {
-            resource = pr;
-        } else {
-            error!("{}: {requires}", t!("resource_command.adapterNotFound"));
-            return;
-        };
-    }
-
-    match resource.get(input.as_str()) {
+    match resource.get(input) {
         Ok(result) => {
             // convert to json
             let json = match serde_json::to_string(&result) {
@@ -58,8 +48,8 @@ pub fn get(dsc: &DscManager, resource_type: &str, mut input: String, format: Opt
 }
 
 pub fn get_all(dsc: &DscManager, resource_type: &str, format: Option<&OutputFormat>) {
-    let mut input = String::new();
-    let Some(mut resource) = get_resource(dsc, resource_type) else {
+    let input = String::new();
+    let Some(resource) = get_resource(dsc, resource_type) else {
         error!("{}", DscError::ResourceNotFound(resource_type.to_string()).to_string());
         exit(EXIT_DSC_RESOURCE_NOT_FOUND);
     };
@@ -70,16 +60,6 @@ pub fn get_all(dsc: &DscManager, resource_type: &str, format: Option<&OutputForm
         exit(EXIT_DSC_ERROR);
     }
 
-    if let Some(requires) = &resource.require_adapter {
-        input = add_type_name_to_json(input, resource.type_name.clone());
-        if let Some(pr) = get_resource(dsc, requires) {
-            resource = pr;
-        } else {
-            error!("{}: {requires}", t!("resource_command.adapterNotFound"));
-            return;
-        };
-    }
-
     let export_result = match resource.export(&input) {
         Ok(export) => { export }
         Err(err) => {
@@ -107,13 +87,13 @@ pub fn get_all(dsc: &DscManager, resource_type: &str, format: Option<&OutputForm
     }
 }
 
-pub fn set(dsc: &DscManager, resource_type: &str, mut input: String, format: Option<&OutputFormat>) {
+pub fn set(dsc: &DscManager, resource_type: &str, input: &str, format: Option<&OutputFormat>) {
     if input.is_empty() {
         error!("{}", t!("resource_command.setInputEmpty"));
         exit(EXIT_INVALID_ARGS);
     }
 
-    let Some(mut resource) = get_resource(dsc, resource_type) else {
+    let Some(resource) = get_resource(dsc, resource_type) else {
         error!("{}", DscError::ResourceNotFound(resource_type.to_string()).to_string());
         exit(EXIT_DSC_RESOURCE_NOT_FOUND);
     };
@@ -124,17 +104,7 @@ pub fn set(dsc: &DscManager, resource_type: &str, mut input: String, format: Opt
         exit(EXIT_DSC_ERROR);
     }
 
-    if let Some(requires) = &resource.require_adapter {
-        input = add_type_name_to_json(input, resource.type_name.clone());
-        if let Some(pr) = get_resource(dsc, requires) {
-            resource = pr;
-        } else {
-            error!("{}: {requires}", t!("resource_command.adapterNotFound"));
-            return;
-        };
-    }
-
-    match resource.set(input.as_str(), true, &ExecutionKind::Actual) {
+    match resource.set(input, true, &ExecutionKind::Actual) {
         Ok(result) => {
             // convert to json
             let json = match serde_json::to_string(&result) {
@@ -153,13 +123,13 @@ pub fn set(dsc: &DscManager, resource_type: &str, mut input: String, format: Opt
     }
 }
 
-pub fn test(dsc: &DscManager, resource_type: &str, mut input: String, format: Option<&OutputFormat>) {
+pub fn test(dsc: &DscManager, resource_type: &str, input: &str, format: Option<&OutputFormat>) {
     if input.is_empty() {
         error!("{}", t!("resource_command.testInputEmpty"));
         exit(EXIT_INVALID_ARGS);
     }
 
-    let Some(mut resource) = get_resource(dsc, resource_type) else {
+    let Some(resource) = get_resource(dsc, resource_type) else {
         error!("{}", DscError::ResourceNotFound(resource_type.to_string()).to_string());
         exit(EXIT_DSC_RESOURCE_NOT_FOUND);
     };
@@ -170,17 +140,7 @@ pub fn test(dsc: &DscManager, resource_type: &str, mut input: String, format: Op
         exit(EXIT_DSC_ERROR);
     }
 
-    if let Some(requires) = &resource.require_adapter {
-        input = add_type_name_to_json(input, resource.type_name.clone());
-        if let Some(pr) = get_resource(dsc, requires) {
-            resource = pr;
-        } else {
-            error!("{}: {requires}", t!("resource_command.adapterNotFound"));
-            return;
-        };
-    }
-
-    match resource.test(input.as_str()) {
+    match resource.test(input) {
         Ok(result) => {
             // convert to json
             let json = match serde_json::to_string(&result) {
@@ -199,8 +159,8 @@ pub fn test(dsc: &DscManager, resource_type: &str, mut input: String, format: Op
     }
 }
 
-pub fn delete(dsc: &DscManager, resource_type: &str, mut input: String) {
-    let Some(mut resource) = get_resource(dsc, resource_type) else {
+pub fn delete(dsc: &DscManager, resource_type: &str, input: &str) {
+    let Some(resource) = get_resource(dsc, resource_type) else {
         error!("{}", DscError::ResourceNotFound(resource_type.to_string()).to_string());
         exit(EXIT_DSC_RESOURCE_NOT_FOUND);
     };
@@ -211,17 +171,7 @@ pub fn delete(dsc: &DscManager, resource_type: &str, mut input: String) {
         exit(EXIT_DSC_ERROR);
     }
 
-    if let Some(requires) = &resource.require_adapter {
-        input = add_type_name_to_json(input, resource.type_name.clone());
-        if let Some(pr) = get_resource(dsc, requires) {
-            resource = pr;
-        } else {
-            error!("{}: {requires}", t!("resource_command.adapterNotFound"));
-            return;
-        };
-    }
-
-    match resource.delete(input.as_str()) {
+    match resource.delete(input) {
         Ok(()) => {}
         Err(err) => {
             error!("Error: {err}");
@@ -259,7 +209,7 @@ pub fn schema(dsc: &DscManager, resource_type: &str, format: Option<&OutputForma
     }
 }
 
-pub fn export(dsc: &mut DscManager, resource_type: &str, mut input: String, format: Option<&OutputFormat>) {
+pub fn export(dsc: &mut DscManager, resource_type: &str, input: &str, 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);
@@ -270,20 +220,8 @@ pub fn export(dsc: &mut DscManager, resource_type: &str, mut input: String, form
         exit(EXIT_DSC_ERROR);
     }
 
-    let mut adapter_resource: Option<&DscResource> = None;
-    if let Some(requires) = &dsc_resource.require_adapter {
-        input = add_type_name_to_json(input, dsc_resource.type_name.clone());
-        if let Some(pr) = get_resource(dsc, requires) {
-            adapter_resource = Some(pr);
-        } else {
-            error!("{}: {requires}", t!("resource_command.adapterNotFound"));
-            return;
-        };
-    }
-
     let mut conf = Configuration::new();
-
-    if let Err(err) = add_resource_export_results_to_configuration(dsc_resource, adapter_resource, &mut conf, &input) {
+    if let Err(err) = add_resource_export_results_to_configuration(dsc_resource, &mut conf, input) {
         error!("{err}");
         exit(EXIT_DSC_ERROR);
     }