Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support writing progress as JSON #614

Open
wants to merge 15 commits into
base: main
Choose a base branch
from
Open

Support writing progress as JSON #614

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
ea4c723
Added json serialization for progress messages
anmenaga Dec 12, 2024
61d8db1
merged in main
anmenaga Dec 12, 2024
e55fa48
clippy fixes 1
anmenaga Dec 12, 2024
0848337
clippy fixes 2
anmenaga Dec 12, 2024
c5b4ec0
clippy fixes 3
anmenaga Dec 12, 2024
97ffdef
fixed serialization
anmenaga Dec 12, 2024
48a6990
fixed serialization 2
anmenaga Dec 12, 2024
e128db4
added tests
anmenaga Dec 12, 2024
0b03abf
updated config commands
anmenaga Dec 12, 2024
23ce52e
updated config test
anmenaga Dec 12, 2024
78356ed
test debug 1
anmenaga Dec 12, 2024
0064fde
test debug 2
anmenaga Dec 12, 2024
b5a6b73
Merge branch 'main' into issue_592
anmenaga Jan 6, 2025
9c2736d
Added OutputFormat::None
anmenaga Jan 6, 2025
e35ae87
Updated dsc args
anmenaga Jan 6, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 1 addition & 7 deletions dsc/src/args.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,10 @@
use clap::{Parser, Subcommand, ValueEnum};
use clap_complete::Shell;
use dsc_lib::dscresources::command_resource::TraceLevel;
use dsc_lib::util::OutputFormat;
use rust_i18n::t;
use serde::Deserialize;

#[derive(Debug, Clone, PartialEq, Eq, ValueEnum)]
pub enum OutputFormat {
Json,
PrettyJson,
Yaml,
}

#[derive(Debug, Clone, PartialEq, Eq, ValueEnum, Deserialize)]
pub enum TraceFormat {
Default,
Expand Down
4 changes: 3 additions & 1 deletion dsc/src/main.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ use rust_i18n::{i18n, t};
use std::{io, process::exit};
use sysinfo::{Process, RefreshKind, System, get_current_pid, ProcessRefreshKind};
use tracing::{error, info, warn, debug};
use dsc_lib::util::OutputFormat;

#[cfg(debug_assertions)]
use crossterm::event;
Expand Down Expand Up @@ -73,7 +74,8 @@ fn main() {
exit(util::EXIT_JSON_ERROR);
}
};
util::write_output(&json, output_format.as_ref());
let output_format = output_format.unwrap_or_else(|| { OutputFormat::None });
util::write_output(&json, output_format);
},
}

Expand Down
14 changes: 7 additions & 7 deletions dsc/src/resource_command.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
// Copyright (c) Microsoft Corporation.
// 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 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}};
use dsc_lib::dscerror::DscError;
use dsc_lib::util::OutputFormat;
use rust_i18n::t;
use tracing::{error, debug};

Expand All @@ -16,7 +16,7 @@ use dsc_lib::{
};
use std::process::exit;

pub fn get(dsc: &DscManager, resource_type: &str, mut input: String, format: Option<&OutputFormat>) {
pub fn get(dsc: &DscManager, resource_type: &str, mut input: String, format: OutputFormat) {
let Some(mut resource) = get_resource(dsc, resource_type) else {
error!("{}", DscError::ResourceNotFound(resource_type.to_string()).to_string());
exit(EXIT_DSC_RESOURCE_NOT_FOUND);
Expand Down Expand Up @@ -57,7 +57,7 @@ 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>) {
pub fn get_all(dsc: &DscManager, resource_type: &str, format: OutputFormat) {
let mut input = String::new();
let Some(mut resource) = get_resource(dsc, resource_type) else {
error!("{}", DscError::ResourceNotFound(resource_type.to_string()).to_string());
Expand Down Expand Up @@ -105,7 +105,7 @@ 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, mut input: String, format: OutputFormat) {
if input.is_empty() {
error!("{}", t!("resource_command.setInputEmpty"));
exit(EXIT_INVALID_ARGS);
Expand Down Expand Up @@ -151,7 +151,7 @@ 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, mut input: String, format: OutputFormat) {
if input.is_empty() {
error!("{}", t!("resource_command.testInputEmpty"));
exit(EXIT_INVALID_ARGS);
Expand Down Expand Up @@ -228,7 +228,7 @@ pub fn delete(dsc: &DscManager, resource_type: &str, mut input: String) {
}
}

pub fn schema(dsc: &DscManager, resource_type: &str, format: Option<&OutputFormat>) {
pub fn schema(dsc: &DscManager, resource_type: &str, format: 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);
Expand Down Expand Up @@ -257,7 +257,7 @@ pub fn schema(dsc: &DscManager, resource_type: &str, format: Option<&OutputForma
}
}

pub fn export(dsc: &mut DscManager, resource_type: &str, format: Option<&OutputFormat>) {
pub fn export(dsc: &mut DscManager, resource_type: &str, format: OutputFormat) {
let mut input = String::new();
let Some(dsc_resource) = get_resource(dsc, resource_type) else {
error!("{}", DscError::ResourceNotFound(resource_type.to_string()).to_string());
Expand Down
96 changes: 56 additions & 40 deletions dsc/src/subcommand.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
// Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.

use crate::args::{ConfigSubCommand, DscType, OutputFormat, ResourceSubCommand};
use crate::args::{ConfigSubCommand, DscType, ResourceSubCommand};
use crate::resolve::{get_contents, Include};
use crate::resource_command::{get_resource, self};
use crate::tablewriter::Table;
Expand All @@ -25,6 +25,7 @@ use dsc_lib::{
},
dscresources::dscresource::{Capability, ImplementedAs, Invoke},
dscresources::resource_manifest::{import_manifest, ResourceManifest},
util::OutputFormat,
};
use rust_i18n::t;
use std::{
Expand All @@ -35,7 +36,7 @@ use std::{
};
use tracing::{debug, error, trace};

pub fn config_get(configurator: &mut Configurator, format: Option<&OutputFormat>, as_group: &bool)
pub fn config_get(configurator: &mut Configurator, format: OutputFormat, as_group: &bool)
{
match configurator.invoke_get() {
Ok(result) => {
Expand Down Expand Up @@ -70,7 +71,7 @@ pub fn config_get(configurator: &mut Configurator, format: Option<&OutputFormat>
}
}

pub fn config_set(configurator: &mut Configurator, format: Option<&OutputFormat>, as_group: &bool)
pub fn config_set(configurator: &mut Configurator, format: OutputFormat, as_group: &bool)
{
match configurator.invoke_set(false) {
Ok(result) => {
Expand Down Expand Up @@ -105,7 +106,7 @@ pub fn config_set(configurator: &mut Configurator, format: Option<&OutputFormat>
}
}

pub fn config_test(configurator: &mut Configurator, format: Option<&OutputFormat>, as_group: &bool, as_get: &bool, as_config: &bool)
pub fn config_test(configurator: &mut Configurator, format: OutputFormat, as_group: &bool, as_get: &bool, as_config: &bool)
{
match configurator.invoke_test() {
Ok(result) => {
Expand Down Expand Up @@ -191,7 +192,7 @@ pub fn config_test(configurator: &mut Configurator, format: Option<&OutputFormat
}
}

pub fn config_export(configurator: &mut Configurator, format: Option<&OutputFormat>)
pub fn config_export(configurator: &mut Configurator, format: OutputFormat)
{
match configurator.invoke_export() {
Ok(result) => {
Expand Down Expand Up @@ -252,12 +253,12 @@ 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_include: &bool) {
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_parameters, json_string, output_format) = match subcommand {
ConfigSubCommand::Get { input, file, output_format, .. } |
ConfigSubCommand::Set { input, file, output_format, .. } |
ConfigSubCommand::Test { input, file, output_format, .. } |
ConfigSubCommand::Validate { input, file, output_format, .. } |
ConfigSubCommand::Export { input, file, output_format, .. } => {
let new_path = initialize_config_root(file.as_ref());
let document = get_input(input.as_ref(), new_path.as_ref());
if *as_include {
Expand All @@ -268,12 +269,12 @@ pub fn config(subcommand: &ConfigSubCommand, parameters: &Option<String>, mounte
exit(EXIT_DSC_ERROR);
}
};
(new_parameters, config_json)
(new_parameters, config_json, output_format)
} else {
(None, document)
(None, document, output_format)
}
},
ConfigSubCommand::Resolve { input, file, .. } => {
ConfigSubCommand::Resolve { input, file, output_format, .. } => {
let new_path = initialize_config_root(file.as_ref());
let document = get_input(input.as_ref(), new_path.as_ref());
let (new_parameters, config_json) = match get_contents(&document) {
Expand All @@ -283,7 +284,7 @@ pub fn config(subcommand: &ConfigSubCommand, parameters: &Option<String>, mounte
exit(EXIT_DSC_ERROR);
}
};
(new_parameters, config_json)
(new_parameters, config_json, output_format)
}
};

Expand All @@ -295,6 +296,9 @@ pub fn config(subcommand: &ConfigSubCommand, parameters: &Option<String>, mounte
}
};

let output_format = output_format.unwrap_or_else(|| { OutputFormat::None });
configurator.set_output_format(output_format);

if let ConfigSubCommand::Set { what_if , .. } = subcommand {
if *what_if {
configurator.context.execution_type = ExecutionKind::WhatIf;
Expand Down Expand Up @@ -356,15 +360,19 @@ pub fn config(subcommand: &ConfigSubCommand, parameters: &Option<String>, mounte

match subcommand {
ConfigSubCommand::Get { output_format, .. } => {
config_get(&mut configurator, output_format.as_ref(), as_group);
let output_format = output_format.unwrap_or_else(|| { OutputFormat::None });
config_get(&mut configurator, output_format, as_group);
},
ConfigSubCommand::Set { output_format, .. } => {
config_set(&mut configurator, output_format.as_ref(), as_group);
let output_format = output_format.unwrap_or_else(|| { OutputFormat::None });
config_set(&mut configurator, output_format, as_group);
},
ConfigSubCommand::Test { output_format, as_get, as_config, .. } => {
config_test(&mut configurator, output_format.as_ref(), as_group, as_get, as_config);
let output_format = output_format.unwrap_or_else(|| { OutputFormat::None });
config_test(&mut configurator, output_format, as_group, as_get, as_config);
},
ConfigSubCommand::Validate { input, file, output_format} => {
let output_format = output_format.unwrap_or_else(|| { OutputFormat::None });
let mut result = ValidateResult {
valid: true,
reason: None,
Expand All @@ -382,7 +390,7 @@ pub fn config(subcommand: &ConfigSubCommand, parameters: &Option<String>, mounte
}
}
} else {
match validate_config(configurator.get_config()) {
match validate_config(configurator.get_config(), output_format) {
Ok(()) => {
// valid, so do nothing
},
Expand All @@ -398,12 +406,14 @@ pub fn config(subcommand: &ConfigSubCommand, parameters: &Option<String>, mounte
exit(EXIT_JSON_ERROR);
};

write_output(&json, output_format.as_ref());
write_output(&json, output_format);
},
ConfigSubCommand::Export { output_format, .. } => {
config_export(&mut configurator, output_format.as_ref());
let output_format = output_format.unwrap_or_else(|| { OutputFormat::None });
config_export(&mut configurator, output_format);
},
ConfigSubCommand::Resolve { output_format, .. } => {
let output_format = output_format.unwrap_or_else(|| { OutputFormat::None });
let configuration = match serde_json::from_str(&json_string) {
Ok(json) => json,
Err(err) => {
Expand Down Expand Up @@ -432,7 +442,7 @@ pub fn config(subcommand: &ConfigSubCommand, parameters: &Option<String>, mounte
exit(EXIT_JSON_ERROR);
}
};
write_output(&json_string, output_format.as_ref());
write_output(&json_string, output_format);
},
}
}
Expand All @@ -450,7 +460,7 @@ pub fn config(subcommand: &ConfigSubCommand, parameters: &Option<String>, mounte
/// # Errors
///
/// * `DscError` - The error that occurred.
pub fn validate_config(config: &Configuration) -> Result<(), DscError> {
pub fn validate_config(config: &Configuration, progress_format: OutputFormat) -> Result<(), DscError> {
// first validate against the config schema
debug!("{}", t!("subcommand.validatingConfiguration"));
let schema = serde_json::to_value(get_schema(DscType::Configuration))?;
Expand All @@ -476,7 +486,7 @@ pub fn validate_config(config: &Configuration) -> Result<(), DscError> {

resource_types.push(type_name.to_lowercase().to_string());
}
dsc.find_resources(&resource_types);
dsc.find_resources(&resource_types, progress_format);

for resource_block in resources {
let Some(type_name) = resource_block["type"].as_str() else {
Expand Down Expand Up @@ -538,43 +548,49 @@ pub fn resource(subcommand: &ResourceSubCommand) {

match subcommand {
ResourceSubCommand::List { resource_name, adapter_name, description, tags, output_format } => {
list_resources(&mut dsc, resource_name.as_ref(), adapter_name.as_ref(), description.as_ref(), tags.as_ref(), output_format.as_ref());
let output_format = output_format.unwrap_or_else(|| { OutputFormat::None });
list_resources(&mut dsc, resource_name.as_ref(), adapter_name.as_ref(), description.as_ref(), tags.as_ref(), output_format);
},
ResourceSubCommand::Schema { resource , output_format } => {
dsc.find_resources(&[resource.to_string()]);
resource_command::schema(&dsc, resource, output_format.as_ref());
let output_format = output_format.unwrap_or_else(|| { OutputFormat::None });
dsc.find_resources(&[resource.to_string()], output_format);
resource_command::schema(&dsc, resource, output_format);
},
ResourceSubCommand::Export { resource, output_format } => {
dsc.find_resources(&[resource.to_string()]);
resource_command::export(&mut dsc, resource, output_format.as_ref());
let output_format = output_format.unwrap_or_else(|| { OutputFormat::None });
dsc.find_resources(&[resource.to_string()], output_format);
resource_command::export(&mut dsc, resource, output_format);
},
ResourceSubCommand::Get { resource, input, file: path, all, output_format } => {
dsc.find_resources(&[resource.to_string()]);
if *all { resource_command::get_all(&dsc, resource, output_format.as_ref()); }
let output_format = output_format.unwrap_or_else(|| { OutputFormat::None });
dsc.find_resources(&[resource.to_string()], output_format);
if *all { resource_command::get_all(&dsc, resource, output_format); }
else {
let parsed_input = get_input(input.as_ref(), path.as_ref());
resource_command::get(&dsc, resource, parsed_input, output_format.as_ref());
resource_command::get(&dsc, resource, parsed_input, output_format);
}
},
ResourceSubCommand::Set { resource, input, file: path, output_format } => {
dsc.find_resources(&[resource.to_string()]);
let output_format = output_format.unwrap_or_else(|| { OutputFormat::None });
dsc.find_resources(&[resource.to_string()], output_format);
let parsed_input = get_input(input.as_ref(), path.as_ref());
resource_command::set(&dsc, resource, parsed_input, output_format.as_ref());
resource_command::set(&dsc, resource, parsed_input, output_format);
},
ResourceSubCommand::Test { resource, input, file: path, output_format } => {
dsc.find_resources(&[resource.to_string()]);
let output_format = output_format.unwrap_or_else(|| { OutputFormat::None });
dsc.find_resources(&[resource.to_string()], output_format);
let parsed_input = get_input(input.as_ref(), path.as_ref());
resource_command::test(&dsc, resource, parsed_input, output_format.as_ref());
resource_command::test(&dsc, resource, parsed_input, output_format);
},
ResourceSubCommand::Delete { resource, input, file: path } => {
dsc.find_resources(&[resource.to_string()]);
dsc.find_resources(&[resource.to_string()], OutputFormat::None); //TODO: add output_format to ResourceSubCommand::Delete
let parsed_input = get_input(input.as_ref(), path.as_ref());
resource_command::delete(&dsc, resource, parsed_input);
},
}
}

fn list_resources(dsc: &mut DscManager, resource_name: Option<&String>, adapter_name: Option<&String>, description: Option<&String>, tags: Option<&Vec<String>>, format: Option<&OutputFormat>) {
fn list_resources(dsc: &mut DscManager, resource_name: Option<&String>, adapter_name: Option<&String>, description: Option<&String>, tags: Option<&Vec<String>>, format: OutputFormat) {
let mut write_table = false;
let mut table = Table::new(&[
t!("subcommand.tableHeader_type").to_string().as_ref(),
Expand All @@ -584,11 +600,11 @@ fn list_resources(dsc: &mut DscManager, resource_name: Option<&String>, adapter_
t!("subcommand.tableheader_adapter").to_string().as_ref(),
t!("subcommand.tableheader_description").to_string().as_ref(),
]);
if format.is_none() && io::stdout().is_terminal() {
if format == OutputFormat::None && io::stdout().is_terminal() {
// write as table if format is not specified and interactive
write_table = true;
}
for resource in dsc.list_available_resources(resource_name.unwrap_or(&String::from("*")), adapter_name.unwrap_or(&String::new())) {
for resource in dsc.list_available_resources(resource_name.unwrap_or(&String::from("*")), adapter_name.unwrap_or(&String::new()), format) {
let mut capabilities = "--------".to_string();
let capability_types = [
(Capability::Get, "g"),
Expand Down
Loading
Loading