remove use of static, add parameter, rename function

SteveL-MSFT · SteveL-MSFT · commit c4bc91e407a4 · 2025-02-05T12:43:05.000-08:00
diff --git a/dsc/src/main.rs b/dsc/src/main.rs
@@ -76,7 +76,7 @@ fn main() {
                     exit(util::EXIT_JSON_ERROR);
                 }
             };
-            util::write_output(&json, output_format.as_ref());
+            util::write_object(&json, output_format.as_ref(), false);
         },
     }
 
diff --git a/dsc/src/resource_command.rs b/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_output};
+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 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}};
@@ -48,7 +48,7 @@ pub fn get(dsc: &DscManager, resource_type: &str, mut input: String, format: Opt
                     exit(EXIT_JSON_ERROR);
                 }
             };
-            write_output(&json, format);
+            write_object(&json, format, false);
         }
         Err(err) => {
             error!("Error: {err}");
@@ -88,6 +88,7 @@ pub fn get_all(dsc: &DscManager, resource_type: &str, format: Option<&OutputForm
         }
     };
 
+    let mut first = true;
     for instance in export_result.actual_state
     {
         let get_result = GetResult::Resource(ResourceGetResponse {
@@ -101,7 +102,8 @@ pub fn get_all(dsc: &DscManager, resource_type: &str, format: Option<&OutputForm
                 exit(EXIT_JSON_ERROR);
             }
         };
-        write_output(&json, format);
+        write_object(&json, format, !first);
+        first = false;
     }
 }
 
@@ -142,7 +144,7 @@ pub fn set(dsc: &DscManager, resource_type: &str, mut input: String, format: Opt
                     exit(EXIT_JSON_ERROR);
                 }
             };
-            write_output(&json, format);
+            write_object(&json, format, false);
         }
         Err(err) => {
             error!("Error: {err}");
@@ -188,7 +190,7 @@ pub fn test(dsc: &DscManager, resource_type: &str, mut input: String, format: Op
                     exit(EXIT_JSON_ERROR);
                 }
             };
-            write_output(&json, format);
+            write_object(&json, format, false);
         }
         Err(err) => {
             error!("{err}");
@@ -248,7 +250,7 @@ pub fn schema(dsc: &DscManager, resource_type: &str, format: Option<&OutputForma
                     exit(EXIT_JSON_ERROR);
                 }
             };
-            write_output(&json, format);
+            write_object(&json, format, false);
         }
         Err(err) => {
             error!("Error: {err}");
@@ -294,7 +296,7 @@ pub fn export(dsc: &mut DscManager, resource_type: &str, format: Option<&OutputF
             exit(EXIT_JSON_ERROR);
         }
     };
-    write_output(&json, format);
+    write_object(&json, format, false);
 }
 
 #[must_use]
diff --git a/dsc/src/subcommand.rs b/dsc/src/subcommand.rs
@@ -5,7 +5,7 @@ use crate::args::{ConfigSubCommand, DscType, OutputFormat, ResourceSubCommand};
 use crate::resolve::{get_contents, Include};
 use crate::resource_command::{get_resource, self};
 use crate::tablewriter::Table;
-use crate::util::{DSC_CONFIG_ROOT, EXIT_DSC_ERROR, EXIT_INVALID_ARGS, EXIT_INVALID_INPUT, EXIT_JSON_ERROR, get_schema, write_output, get_input, set_dscconfigroot, validate_json};
+use crate::util::{DSC_CONFIG_ROOT, EXIT_DSC_ERROR, EXIT_INVALID_ARGS, EXIT_INVALID_INPUT, EXIT_JSON_ERROR, get_schema, write_object, get_input, set_dscconfigroot, validate_json};
 use dsc_lib::{
     configure::{
         config_doc::{
@@ -48,7 +48,7 @@ pub fn config_get(configurator: &mut Configurator, format: Option<&OutputFormat>
                         exit(EXIT_JSON_ERROR);
                     }
                 };
-                write_output(&json, format);
+                write_object(&json, format, false);
             }
             else {
                 let json = match serde_json::to_string(&result) {
@@ -58,7 +58,7 @@ pub fn config_get(configurator: &mut Configurator, format: Option<&OutputFormat>
                         exit(EXIT_JSON_ERROR);
                     }
                 };
-                write_output(&json, format);
+                write_object(&json, format, false);
                 if result.had_errors {
                     exit(EXIT_DSC_ERROR);
                 }
@@ -83,7 +83,7 @@ pub fn config_set(configurator: &mut Configurator, format: Option<&OutputFormat>
                         exit(EXIT_JSON_ERROR);
                     }
                 };
-                write_output(&json, format);
+                write_object(&json, format, false);
             }
             else {
                 let json = match serde_json::to_string(&result) {
@@ -93,7 +93,7 @@ pub fn config_set(configurator: &mut Configurator, format: Option<&OutputFormat>
                         exit(EXIT_JSON_ERROR);
                     }
                 };
-                write_output(&json, format);
+                write_object(&json, format, false);
                 if result.had_errors {
                     exit(EXIT_DSC_ERROR);
                 }
@@ -169,7 +169,7 @@ pub fn config_test(configurator: &mut Configurator, format: Option<&OutputFormat
                         }
                     }
                 };
-                write_output(&json, format);
+                write_object(&json, format, false);
             }
             else {
                 let json = match serde_json::to_string(&result) {
@@ -179,7 +179,7 @@ pub fn config_test(configurator: &mut Configurator, format: Option<&OutputFormat
                         exit(EXIT_JSON_ERROR);
                     }
                 };
-                write_output(&json, format);
+                write_object(&json, format, false);
                 if result.had_errors {
                     exit(EXIT_DSC_ERROR);
                 }
@@ -203,7 +203,7 @@ pub fn config_export(configurator: &mut Configurator, format: Option<&OutputForm
                     exit(EXIT_JSON_ERROR);
                 }
             };
-            write_output(&json, format);
+            write_object(&json, format, false);
             if result.had_errors {
 
                 for msg in result.messages
@@ -401,7 +401,7 @@ pub fn config(subcommand: &ConfigSubCommand, parameters: &Option<String>, mounte
                 exit(EXIT_JSON_ERROR);
             };
 
-            write_output(&json, output_format.as_ref());
+            write_object(&json, output_format.as_ref(), false);
         },
         ConfigSubCommand::Export { output_format, .. } => {
             config_export(&mut configurator, output_format.as_ref());
@@ -435,7 +435,7 @@ pub fn config(subcommand: &ConfigSubCommand, parameters: &Option<String>, mounte
                     exit(EXIT_JSON_ERROR);
                 }
             };
-            write_output(&json_string, output_format.as_ref());
+            write_object(&json_string, output_format.as_ref(), false);
         },
     }
 }
@@ -591,6 +591,7 @@ fn list_resources(dsc: &mut DscManager, resource_name: Option<&String>, adapter_
         // write as table if format is not specified and interactive
         write_table = true;
     }
+    let mut first = true;
     for resource in dsc.list_available_resources(resource_name.unwrap_or(&String::from("*")), adapter_name.unwrap_or(&String::new()), progress_format) {
         let mut capabilities = "--------".to_string();
         let capability_types = [
@@ -667,7 +668,8 @@ fn list_resources(dsc: &mut DscManager, resource_name: Option<&String>, adapter_
                     exit(EXIT_JSON_ERROR);
                 }
             };
-            write_output(&json, format);
+            write_object(&json, format, !first);
+            first = false;
             // insert newline separating instances if writing to console
             if io::stdout().is_terminal() { println!(); }
         }
diff --git a/dsc/src/util.rs b/dsc/src/util.rs
@@ -208,15 +208,14 @@ pub fn get_schema(dsc_type: DscType) -> RootSchema {
     }
 }
 
-static mut FIRST_WRITE: bool = true;
-
-/// Write the output to the console
+/// Write the JSON object to the console
 ///
 /// # Arguments
 ///
 /// * `json` - The JSON to write
 /// * `format` - The format to use
-pub fn write_output(json: &str, format: Option<&OutputFormat>) {
+/// * `include_separator` - Whether to include a separator for YAML before the object
+pub fn write_object(json: &str, format: Option<&OutputFormat>, include_separator: bool) {
     let mut is_json = true;
     let mut output_format = format;
     let mut syntax_color = false;
@@ -250,8 +249,7 @@ pub fn write_output(json: &str, format: Option<&OutputFormat>) {
         },
         Some(OutputFormat::Yaml) | None => {
             is_json = false;
-            if !unsafe { FIRST_WRITE } {
-                // include YAML document separator for subsequent outputs
+            if include_separator {
                 println!("---");
             }
 
@@ -297,10 +295,6 @@ pub fn write_output(json: &str, format: Option<&OutputFormat>) {
     else {
         println!("{output}");
     }
-
-    unsafe {
-        FIRST_WRITE = false;
-    }
 }
 
 #[allow(clippy::too_many_lines)]

Original file line number	Diff line number	Diff line change
`@@ -76,7 +76,7 @@ fn main() {`
`76`	`76`	`exit(util::EXIT_JSON_ERROR);`
`77`	`77`	`}`
`78`	`78`	`};`
`79`		`- util::write_output(&json, output_format.as_ref());`
	`79`	`+ util::write_object(&json, output_format.as_ref(), false);`
`80`	`80`	`},`
`81`	`81`	`}`
`82`	`82`
Original file line number	Diff line number	Diff line change
`@@ -2,7 +2,7 @@`
`2`	`2`	`// Licensed under the MIT License.`
`3`	`3`
`4`	`4`	`use crate::args::OutputFormat;`
`5`		`-use crate::util::{EXIT_DSC_ERROR, EXIT_INVALID_ARGS, EXIT_JSON_ERROR, EXIT_DSC_RESOURCE_NOT_FOUND, add_type_name_to_json, write_output};`
	`5`	`+use crate::util::{EXIT_DSC_ERROR, EXIT_INVALID_ARGS, EXIT_JSON_ERROR, EXIT_DSC_RESOURCE_NOT_FOUND, add_type_name_to_json, write_object};`
`6`	`6`	`use dsc_lib::configure::config_doc::{Configuration, ExecutionKind};`
`7`	`7`	`use dsc_lib::configure::add_resource_export_results_to_configuration;`
`8`	`8`	`use dsc_lib::dscresources::{resource_manifest::Kind, invoke_result::{GetResult, ResourceGetResponse}};`
`@@ -48,7 +48,7 @@ pub fn get(dsc: &DscManager, resource_type: &str, mut input: String, format: Opt`
`48`	`48`	`exit(EXIT_JSON_ERROR);`
`49`	`49`	`}`
`50`	`50`	`};`
`51`		`- write_output(&json, format);`
	`51`	`+ write_object(&json, format, false);`
`52`	`52`	`}`
`53`	`53`	`Err(err) => {`
`54`	`54`	`error!("Error: {err}");`
`@@ -88,6 +88,7 @@ pub fn get_all(dsc: &DscManager, resource_type: &str, format: Option<&OutputForm`
`88`	`88`	`}`
`89`	`89`	`};`
`90`	`90`
	`91`	`+ let mut first = true;`
`91`	`92`	`for instance in export_result.actual_state`
`92`	`93`	`{`
`93`	`94`	`let get_result = GetResult::Resource(ResourceGetResponse {`
`@@ -101,7 +102,8 @@ pub fn get_all(dsc: &DscManager, resource_type: &str, format: Option<&OutputForm`
`101`	`102`	`exit(EXIT_JSON_ERROR);`
`102`	`103`	`}`
`103`	`104`	`};`
`104`		`- write_output(&json, format);`
	`105`	`+ write_object(&json, format, !first);`
	`106`	`+ first = false;`
`105`	`107`	`}`
`106`	`108`	`}`
`107`	`109`
`@@ -142,7 +144,7 @@ pub fn set(dsc: &DscManager, resource_type: &str, mut input: String, format: Opt`
`142`	`144`	`exit(EXIT_JSON_ERROR);`
`143`	`145`	`}`
`144`	`146`	`};`
`145`		`- write_output(&json, format);`
	`147`	`+ write_object(&json, format, false);`
`146`	`148`	`}`
`147`	`149`	`Err(err) => {`
`148`	`150`	`error!("Error: {err}");`
`@@ -188,7 +190,7 @@ pub fn test(dsc: &DscManager, resource_type: &str, mut input: String, format: Op`
`188`	`190`	`exit(EXIT_JSON_ERROR);`
`189`	`191`	`}`
`190`	`192`	`};`
`191`		`- write_output(&json, format);`
	`193`	`+ write_object(&json, format, false);`
`192`	`194`	`}`
`193`	`195`	`Err(err) => {`
`194`	`196`	`error!("{err}");`
`@@ -248,7 +250,7 @@ pub fn schema(dsc: &DscManager, resource_type: &str, format: Option<&OutputForma`
`248`	`250`	`exit(EXIT_JSON_ERROR);`
`249`	`251`	`}`
`250`	`252`	`};`
`251`		`- write_output(&json, format);`
	`253`	`+ write_object(&json, format, false);`
`252`	`254`	`}`
`253`	`255`	`Err(err) => {`
`254`	`256`	`error!("Error: {err}");`
`@@ -294,7 +296,7 @@ pub fn export(dsc: &mut DscManager, resource_type: &str, format: Option<&OutputF`
`294`	`296`	`exit(EXIT_JSON_ERROR);`
`295`	`297`	`}`
`296`	`298`	`};`
`297`		`- write_output(&json, format);`
	`299`	`+ write_object(&json, format, false);`
`298`	`300`	`}`
`299`	`301`
`300`	`302`	`#[must_use]`
Original file line number	Diff line number	Diff line change
`@@ -5,7 +5,7 @@ use crate::args::{ConfigSubCommand, DscType, OutputFormat, ResourceSubCommand};`
`5`	`5`	`use crate::resolve::{get_contents, Include};`
`6`	`6`	`use crate::resource_command::{get_resource, self};`
`7`	`7`	`use crate::tablewriter::Table;`
`8`		`-use crate::util::{DSC_CONFIG_ROOT, EXIT_DSC_ERROR, EXIT_INVALID_ARGS, EXIT_INVALID_INPUT, EXIT_JSON_ERROR, get_schema, write_output, get_input, set_dscconfigroot, validate_json};`
	`8`	`+use crate::util::{DSC_CONFIG_ROOT, EXIT_DSC_ERROR, EXIT_INVALID_ARGS, EXIT_INVALID_INPUT, EXIT_JSON_ERROR, get_schema, write_object, get_input, set_dscconfigroot, validate_json};`
`9`	`9`	`use dsc_lib::{`
`10`	`10`	`configure::{`
`11`	`11`	`config_doc::{`
`@@ -48,7 +48,7 @@ pub fn config_get(configurator: &mut Configurator, format: Option<&OutputFormat>`
`48`	`48`	`exit(EXIT_JSON_ERROR);`
`49`	`49`	`}`
`50`	`50`	`};`
`51`		`- write_output(&json, format);`
	`51`	`+ write_object(&json, format, false);`
`52`	`52`	`}`
`53`	`53`	`else {`
`54`	`54`	`let json = match serde_json::to_string(&result) {`
`@@ -58,7 +58,7 @@ pub fn config_get(configurator: &mut Configurator, format: Option<&OutputFormat>`
`58`	`58`	`exit(EXIT_JSON_ERROR);`
`59`	`59`	`}`
`60`	`60`	`};`
`61`		`- write_output(&json, format);`
	`61`	`+ write_object(&json, format, false);`
`62`	`62`	`if result.had_errors {`
`63`	`63`	`exit(EXIT_DSC_ERROR);`
`64`	`64`	`}`
`@@ -83,7 +83,7 @@ pub fn config_set(configurator: &mut Configurator, format: Option<&OutputFormat>`
`83`	`83`	`exit(EXIT_JSON_ERROR);`
`84`	`84`	`}`
`85`	`85`	`};`
`86`		`- write_output(&json, format);`
	`86`	`+ write_object(&json, format, false);`
`87`	`87`	`}`
`88`	`88`	`else {`
`89`	`89`	`let json = match serde_json::to_string(&result) {`
`@@ -93,7 +93,7 @@ pub fn config_set(configurator: &mut Configurator, format: Option<&OutputFormat>`
`93`	`93`	`exit(EXIT_JSON_ERROR);`
`94`	`94`	`}`
`95`	`95`	`};`
`96`		`- write_output(&json, format);`
	`96`	`+ write_object(&json, format, false);`
`97`	`97`	`if result.had_errors {`
`98`	`98`	`exit(EXIT_DSC_ERROR);`
`99`	`99`	`}`
`@@ -169,7 +169,7 @@ pub fn config_test(configurator: &mut Configurator, format: Option<&OutputFormat`
`169`	`169`	`}`
`170`	`170`	`}`
`171`	`171`	`};`
`172`		`- write_output(&json, format);`
	`172`	`+ write_object(&json, format, false);`
`173`	`173`	`}`
`174`	`174`	`else {`
`175`	`175`	`let json = match serde_json::to_string(&result) {`
`@@ -179,7 +179,7 @@ pub fn config_test(configurator: &mut Configurator, format: Option<&OutputFormat`
`179`	`179`	`exit(EXIT_JSON_ERROR);`
`180`	`180`	`}`
`181`	`181`	`};`
`182`		`- write_output(&json, format);`
	`182`	`+ write_object(&json, format, false);`
`183`	`183`	`if result.had_errors {`
`184`	`184`	`exit(EXIT_DSC_ERROR);`
`185`	`185`	`}`
`@@ -203,7 +203,7 @@ pub fn config_export(configurator: &mut Configurator, format: Option<&OutputForm`
`203`	`203`	`exit(EXIT_JSON_ERROR);`
`204`	`204`	`}`
`205`	`205`	`};`
`206`		`- write_output(&json, format);`
	`206`	`+ write_object(&json, format, false);`
`207`	`207`	`if result.had_errors {`
`208`	`208`
`209`	`209`	`for msg in result.messages`
`@@ -401,7 +401,7 @@ pub fn config(subcommand: &ConfigSubCommand, parameters: &Option<String>, mounte`
`401`	`401`	`exit(EXIT_JSON_ERROR);`
`402`	`402`	`};`
`403`	`403`
`404`		`- write_output(&json, output_format.as_ref());`
	`404`	`+ write_object(&json, output_format.as_ref(), false);`
`405`	`405`	`},`
`406`	`406`	`ConfigSubCommand::Export { output_format, .. } => {`
`407`	`407`	`config_export(&mut configurator, output_format.as_ref());`
`@@ -435,7 +435,7 @@ pub fn config(subcommand: &ConfigSubCommand, parameters: &Option<String>, mounte`
`435`	`435`	`exit(EXIT_JSON_ERROR);`
`436`	`436`	`}`
`437`	`437`	`};`
`438`		`- write_output(&json_string, output_format.as_ref());`
	`438`	`+ write_object(&json_string, output_format.as_ref(), false);`
`439`	`439`	`},`
`440`	`440`	`}`
`441`	`441`	`}`
`@@ -591,6 +591,7 @@ fn list_resources(dsc: &mut DscManager, resource_name: Option<&String>, adapter_`
`591`	`591`	`// write as table if format is not specified and interactive`
`592`	`592`	`write_table = true;`
`593`	`593`	`}`
	`594`	`+ let mut first = true;`
`594`	`595`	`for resource in dsc.list_available_resources(resource_name.unwrap_or(&String::from("*")), adapter_name.unwrap_or(&String::new()), progress_format) {`
`595`	`596`	`let mut capabilities = "--------".to_string();`
`596`	`597`	`let capability_types = [`
`@@ -667,7 +668,8 @@ fn list_resources(dsc: &mut DscManager, resource_name: Option<&String>, adapter_`
`667`	`668`	`exit(EXIT_JSON_ERROR);`
`668`	`669`	`}`
`669`	`670`	`};`
`670`		`- write_output(&json, format);`
	`671`	`+ write_object(&json, format, !first);`
	`672`	`+ first = false;`
`671`	`673`	`// insert newline separating instances if writing to console`
`672`	`674`	`if io::stdout().is_terminal() { println!(); }`
`673`	`675`	`}`