Add support to read paramters from STDIN

SteveL-MSFT · SteveL-MSFT · commit febb12dac5ad · 2025-06-04T21:48:34.000-07:00
diff --git a/dsc/locales/en-us.toml b/dsc/locales/en-us.toml
@@ -37,6 +37,7 @@ resource = "The name of the resource to invoke"
 ctrlCReceived = "Ctrl-C received"
 failedCtrlCHandler = "Failed to set Ctrl-C handler"
 failedReadingParametersFile = "Failed to read parameters file"
+readingParametersFromStdin = "Reading parameters from STDIN"
 generatingCompleter = "Generating completion script for"
 readingParametersFile = "Reading parameters from file"
 usingDscVersion = "Running DSC version"
@@ -133,3 +134,4 @@ failedToAbsolutizePath = "Error making config path absolute"
 failedToGetParentPath = "Error reading config path parent"
 dscConfigRootAlreadySet = "The current value of DSC_CONFIG_ROOT env var will be overridden"
 settingDscConfigRoot = "Setting DSC_CONFIG_ROOT env var as"
+stdinNotAllowedForBothParametersAndInput = "Cannot read from STDIN for both parameters and input."
diff --git a/dsc/src/main.rs b/dsc/src/main.rs
@@ -5,11 +5,13 @@ use args::{Args, SubCommand};
 use clap::{CommandFactory, Parser};
 use clap_complete::generate;
 use rust_i18n::{i18n, t};
-use std::{io, process::exit};
+use std::{io, io::Read, process::exit};
 use sysinfo::{Process, RefreshKind, System, get_current_pid, ProcessRefreshKind};
 use tracing::{error, info, warn, debug};
 use dsc_lib::progress::ProgressFormat;
 
+use crate::util::EXIT_INVALID_INPUT;
+
 #[cfg(debug_assertions)]
 use crossterm::event;
 #[cfg(debug_assertions)]
@@ -51,17 +53,40 @@ fn main() {
         },
         SubCommand::Config { subcommand, parameters, parameters_file, system_root, as_group, as_assert, as_include } => {
             if let Some(file_name) = parameters_file {
+                if file_name == "-" {
+                    info!("{}", t!("main.readingParametersFromStdin"));
+                    let mut stdin = Vec::<u8>::new();
+                    let parameters = match io::stdin().read_to_end(&mut stdin) {
+                        Ok(_) => {
+                            match String::from_utf8(stdin) {
+                                Ok(input) => {
+                                    input
+                                },
+                                Err(err) => {
+                                    error!("{}: {err}", t!("util.invalidUtf8"));
+                                    exit(EXIT_INVALID_INPUT);
+                                }
+                            }
+                        },
+                        Err(err) => {
+                            error!("{}: {err}", t!("util.failedToReadStdin"));
+                            exit(EXIT_INVALID_INPUT);
+                        }
+                    };
+                    subcommand::config(&subcommand, &Some(parameters), true, system_root.as_ref(), &as_group, &as_assert, &as_include, progress_format);
+                    return;
+                }
                 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_assert, &as_include, progress_format),
+                    Ok(parameters) => subcommand::config(&subcommand, &Some(parameters), false, 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_assert, &as_include, progress_format);
+                subcommand::config(&subcommand, &parameters, false, system_root.as_ref(), &as_group, &as_assert, &as_include, progress_format);
             }
         },
         SubCommand::Extension { subcommand } => {
diff --git a/dsc/src/subcommand.rs b/dsc/src/subcommand.rs
@@ -271,15 +271,16 @@ fn initialize_config_root(path: Option<&String>) -> Option<String> {
 }
 
 #[allow(clippy::too_many_lines)]
-pub fn config(subcommand: &ConfigSubCommand, parameters: &Option<String>, mounted_path: Option<&String>, as_group: &bool, as_assert: &bool, as_include: &bool, progress_format: ProgressFormat) {
+#[allow(clippy::too_many_arguments)]
+pub fn config(subcommand: &ConfigSubCommand, parameters: &Option<String>, parameters_from_stdin: bool, mounted_path: Option<&String>, as_group: &bool, as_assert: &bool, as_include: &bool, progress_format: ProgressFormat) {
     let (new_parameters, json_string) = match subcommand {
         ConfigSubCommand::Get { input, file, .. } |
         ConfigSubCommand::Set { input, file, .. } |
         ConfigSubCommand::Test { input, file, .. } |
         ConfigSubCommand::Validate { input, file, .. } |
         ConfigSubCommand::Export { input, file, .. } => {
             let new_path = initialize_config_root(file.as_ref());
-            let document = get_input(input.as_ref(), new_path.as_ref());
+            let document = get_input(input.as_ref(), new_path.as_ref(), parameters_from_stdin);
             if *as_include {
                 let (new_parameters, config_json) = match get_contents(&document) {
                     Ok((parameters, config_json)) => (parameters, config_json),
@@ -295,7 +296,7 @@ pub fn config(subcommand: &ConfigSubCommand, parameters: &Option<String>, mounte
         },
         ConfigSubCommand::Resolve { input, file, .. } => {
             let new_path = initialize_config_root(file.as_ref());
-            let document = get_input(input.as_ref(), new_path.as_ref());
+            let document = get_input(input.as_ref(), new_path.as_ref(), parameters_from_stdin);
             let (new_parameters, config_json) = match get_contents(&document) {
                 Ok((parameters, config_json)) => (parameters, config_json),
                 Err(err) => {
@@ -391,7 +392,7 @@ pub fn config(subcommand: &ConfigSubCommand, parameters: &Option<String>, mounte
             };
             if *as_include {
                 let new_path = initialize_config_root(file.as_ref());
-                let input = get_input(input.as_ref(), new_path.as_ref());
+                let input = get_input(input.as_ref(), new_path.as_ref(), parameters_from_stdin);
                 match serde_json::from_str::<Include>(&input) {
                     Ok(_) => {
                         // valid, so do nothing
@@ -582,14 +583,14 @@ pub fn resource(subcommand: &ResourceSubCommand, progress_format: ProgressFormat
         },
         ResourceSubCommand::Export { resource, input, file, output_format } => {
             dsc.find_resources(&[resource.to_string()], progress_format);
-            let parsed_input = get_input(input.as_ref(), file.as_ref());
+            let parsed_input = get_input(input.as_ref(), file.as_ref(), false);
             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);
             if *all { resource_command::get_all(&dsc, resource, output_format.as_ref()); }
             else {
-                let parsed_input = get_input(input.as_ref(), path.as_ref());
+                let parsed_input = get_input(input.as_ref(), path.as_ref(), false);
                 let format = match output_format {
                     Some(GetOutputFormat::Json) => Some(OutputFormat::Json),
                     Some(GetOutputFormat::JsonArray) => {
@@ -605,17 +606,17 @@ pub fn resource(subcommand: &ResourceSubCommand, progress_format: ProgressFormat
         },
         ResourceSubCommand::Set { resource, input, file: path, output_format } => {
             dsc.find_resources(&[resource.to_string()], progress_format);
-            let parsed_input = get_input(input.as_ref(), path.as_ref());
+            let parsed_input = get_input(input.as_ref(), path.as_ref(), false);
             resource_command::set(&dsc, resource, &parsed_input, output_format.as_ref());
         },
         ResourceSubCommand::Test { resource, input, file: path, output_format } => {
             dsc.find_resources(&[resource.to_string()], progress_format);
-            let parsed_input = get_input(input.as_ref(), path.as_ref());
+            let parsed_input = get_input(input.as_ref(), path.as_ref(), false);
             resource_command::test(&dsc, resource, &parsed_input, output_format.as_ref());
         },
         ResourceSubCommand::Delete { resource, input, file: path } => {
             dsc.find_resources(&[resource.to_string()], progress_format);
-            let parsed_input = get_input(input.as_ref(), path.as_ref());
+            let parsed_input = get_input(input.as_ref(), path.as_ref(), false);
             resource_command::delete(&dsc, resource, &parsed_input);
         },
     }
diff --git a/dsc/src/util.rs b/dsc/src/util.rs
@@ -426,7 +426,7 @@ pub fn validate_json(source: &str, schema: &Value, json: &Value) -> Result<(), D
     Ok(())
 }
 
-pub fn get_input(input: Option<&String>, file: Option<&String>) -> String {
+pub fn get_input(input: Option<&String>, file: Option<&String>, parameters_from_stdin: bool) -> String {
     trace!("Input: {input:?}, File: {file:?}");
     let value = if let Some(input) = input {
         debug!("{}", t!("util.readingInput"));
@@ -442,6 +442,10 @@ pub fn get_input(input: Option<&String>, file: Option<&String>) -> String {
         // check if need to read from STDIN
         if path == "-" {
             info!("{}", t!("util.readingInputFromStdin"));
+            if parameters_from_stdin {
+                error!("{}", t!("util.stdinNotAllowedForBothParametersAndInput"));
+                exit(EXIT_INVALID_INPUT);
+            }
             let mut stdin = Vec::<u8>::new();
             match std::io::stdin().read_to_end(&mut stdin) {
                 Ok(_) => {
@@ -535,13 +539,13 @@ pub fn set_dscconfigroot(config_path: &str) -> String
 
 
 /// Check if the test result is in the desired state.
-/// 
+///
 /// # Arguments
-/// 
+///
 /// * `test_result` - The test result to check
-/// 
+///
 /// # Returns
-/// 
+///
 /// * `bool` - True if the test result is in the desired state, false otherwise
 #[must_use]
 pub fn in_desired_state(test_result: &ResourceTestResult) -> bool {
diff --git a/dsc/tests/dsc_parameters.tests.ps1 b/dsc/tests/dsc_parameters.tests.ps1
@@ -316,4 +316,31 @@ Describe 'Parameters tests' {
 
       $output | Should -Match "Parameter input failure:.*?$type"
     }
+
+    It 'Parameters can be read from STDIN' {
+      $params = @{
+        parameters = @{
+          osFamily = 'Windows'
+        }
+      } | ConvertTo-Json -Compress
+
+      $out = $params | dsc config -f - test -f "$PSScriptRoot/../examples/osinfo_parameters.dsc.yaml" 2> $TestDrive/error.log | ConvertFrom-Json
+      $LASTEXITCODE | Should -Be 0 -Because (Get-Content -Path $TestDrive/error.log | Out-String)
+      $out.results[0].result.desiredState.family | Should -BeExactly 'Windows'
+      $out.results[0].result.inDesiredState | Should -Be $IsWindows
+    }
+
+    It 'Parameters and input cannot both be from STDIN' {
+      $params = @{
+        parameters = @{
+          osFamily = 'Windows'
+        }
+      } | ConvertTo-Json -Compress
+
+      $out = $params | dsc config -f - test -f - 2> $TestDrive/error.log
+      $LASTEXITCODE | Should -Be 4
+      $out | Should -BeNullOrEmpty
+      $errorMessage = Get-Content -Path $TestDrive/error.log -Raw
+      $errorMessage | Should -BeLike "*ERROR*Cannot read from STDIN for both parameters and input*"
+    }
 }
