add progress bar

Author: SteveL-MSFT

dsc/src/subcommand.rs

@@ -5,7 +5,6 @@ use crate::args::{ConfigSubCommand, DscType, OutputFormat, ResourceSubCommand};
 use crate::resource_command::{get_resource, self};
 use crate::tablewriter::Table;
 use crate::util::{EXIT_DSC_ERROR, EXIT_INVALID_INPUT, EXIT_JSON_ERROR, EXIT_SUCCESS, EXIT_VALIDATION_FAILED, get_schema, write_output, get_input, set_dscconfigroot};
-use tracing::error;
 
 use atty::Stream;
 use dsc_lib::{
@@ -17,6 +16,7 @@ use dsc_lib::{
 use jsonschema::JSONSchema;
 use serde_yaml::Value;
 use std::process::exit;
+use tracing::error;
 
 pub fn config_get(configurator: &mut Configurator, format: &Option<OutputFormat>)
 {

dsc_lib/Cargo.toml

@@ -5,7 +5,8 @@ edition = "2021"
 
 [dependencies]
 base64 = "0.21"
-derive_builder ="0.12"
+derive_builder ="0.20"
+indicatif = { version = "0.17" }
 jsonschema = "0.17"
 regex = "1.7"
 reqwest = { version = "0.11", features = ["blocking"] }
@@ -16,7 +17,7 @@ serde_yaml = { version = "0.9.3" }
 thiserror = "1.0"
 chrono = "0.4.26"
 tracing = "0.1.37"
-tree-sitter = "~0.20.10"
+tree-sitter = "0.21"
 tree-sitter-dscexpression = { path = "../tree-sitter-dscexpression" }
 
 [dev-dependencies]

dsc_lib/src/configure/mod.rs

@@ -12,8 +12,9 @@ use self::config_doc::{Configuration, DataType};
 use self::depends_on::get_resource_invocation_order;
 use self::config_result::{ConfigurationGetResult, ConfigurationSetResult, ConfigurationTestResult, ConfigurationExportResult};
 use self::contraints::{check_length, check_number_limits, check_allowed_values};
+use indicatif::{ProgressBar, ProgressStyle};
 use serde_json::{Map, Value};
-use std::collections::{HashMap, HashSet};
+use std::collections::HashMap;
 use tracing::debug;
 
 pub mod context;
@@ -130,6 +131,14 @@ fn escape_property_values(properties: &Map<String, Value>) -> Result<Option<Map<
     Ok(Some(result))
 }
 
+fn get_progress_bar(len: u64) -> Result<ProgressBar, DscError> {
+    let pb = ProgressBar::new(len);
+    pb.set_style(ProgressStyle::with_template(
+        "{spinner:.green} [{elapsed_precise}] [{bar:40.cyan/blue}] {pos:>7}/{len:7} {msg}"
+    )?);
+   Ok(pb)
+}
+
 impl Configurator {
     /// Create a new `Configurator` instance.
     ///
@@ -163,7 +172,11 @@ impl Configurator {
     pub fn invoke_get(&mut self, _error_action: ErrorAction, _progress_callback: impl Fn() + 'static) -> Result<ConfigurationGetResult, DscError> {
         let config = self.validate_config()?;
         let mut result = ConfigurationGetResult::new();
-        for resource in get_resource_invocation_order(&config, &mut self.statement_parser, &self.context)? {
+        let resources = get_resource_invocation_order(&config, &mut self.statement_parser, &self.context)?;
+        let pb = get_progress_bar(resources.len() as u64)?;
+        for resource in resources {
+            pb.inc(1);
+            pb.set_message(format!("Get {}", resource.name));
             let properties = self.invoke_property_expressions(&resource.properties)?;
             let Some(dsc_resource) = self.discovery.find_resource(&resource.resource_type.to_lowercase()) else {
                 return Err(DscError::ResourceNotFound(resource.resource_type));
@@ -179,6 +192,7 @@ impl Configurator {
             result.results.push(resource_result);
         }
 
+        pb.finish_and_clear();
         Ok(result)
     }
 
@@ -195,7 +209,11 @@ impl Configurator {
     pub fn invoke_set(&mut self, skip_test: bool, _error_action: ErrorAction, _progress_callback: impl Fn() + 'static) -> Result<ConfigurationSetResult, DscError> {
         let config = self.validate_config()?;
         let mut result = ConfigurationSetResult::new();
-        for resource in get_resource_invocation_order(&config, &mut self.statement_parser, &self.context)? {
+        let resources = get_resource_invocation_order(&config, &mut self.statement_parser, &self.context)?;
+        let pb = get_progress_bar(resources.len() as u64)?;
+        for resource in resources {
+            pb.inc(1);
+            pb.set_message(format!("Set {}", resource.name));
             let properties = self.invoke_property_expressions(&resource.properties)?;
             let Some(dsc_resource) = self.discovery.find_resource(&resource.resource_type.to_lowercase()) else {
                 return Err(DscError::ResourceNotFound(resource.resource_type));
@@ -211,6 +229,7 @@ impl Configurator {
             result.results.push(resource_result);
         }
 
+        pb.finish_and_clear();
         Ok(result)
     }
 
@@ -227,7 +246,11 @@ impl Configurator {
     pub fn invoke_test(&mut self, _error_action: ErrorAction, _progress_callback: impl Fn() + 'static) -> Result<ConfigurationTestResult, DscError> {
         let config = self.validate_config()?;
         let mut result = ConfigurationTestResult::new();
-        for resource in get_resource_invocation_order(&config, &mut self.statement_parser, &self.context)? {
+        let resources = get_resource_invocation_order(&config, &mut self.statement_parser, &self.context)?;
+        let pb = get_progress_bar(resources.len() as u64)?;
+        for resource in resources {
+            pb.inc(1);
+            pb.set_message(format!("Test {}", resource.name));
             let properties = self.invoke_property_expressions(&resource.properties)?;
             let Some(dsc_resource) = self.discovery.find_resource(&resource.resource_type.to_lowercase()) else {
                 return Err(DscError::ResourceNotFound(resource.resource_type));
@@ -243,6 +266,7 @@ impl Configurator {
             result.results.push(resource_result);
         }
 
+        pb.finish_and_clear();
         Ok(result)
     }
 
@@ -263,17 +287,13 @@ impl Configurator {
     pub fn invoke_export(&mut self, _error_action: ErrorAction, _progress_callback: impl Fn() + 'static) -> Result<ConfigurationExportResult, DscError> {
         let config = self.validate_config()?;
 
-        let duplicates = Self::find_duplicate_resource_types(&config);
-        if !duplicates.is_empty()
-        {
-            let duplicates_string = &duplicates.join(",");
-            return Err(DscError::Validation(format!("Resource(s) {duplicates_string} specified multiple times")));
-        }
-
         let mut result = ConfigurationExportResult::new();
         let mut conf = config_doc::Configuration::new();
 
+        let pb = get_progress_bar(config.resources.len() as u64)?;
         for resource in &config.resources {
+            pb.inc(1);
+            pb.set_message(format!("Export {}", resource.name));
             let Some(dsc_resource) = self.discovery.find_resource(&resource.resource_type.to_lowercase()) else {
                 return Err(DscError::ResourceNotFound(resource.resource_type.clone()));
             };
@@ -283,7 +303,7 @@ impl Configurator {
         }
 
         result.result = Some(conf);
-
+        pb.finish_and_clear();
         Ok(result)
     }
 
@@ -367,27 +387,6 @@ impl Configurator {
         Ok(())
     }
 
-    fn find_duplicate_resource_types(config: &Configuration) -> Vec<String>
-    {
-        let mut map: HashMap<&String, i32> = HashMap::new();
-        let mut result: HashSet<String> = HashSet::new();
-        let resource_list = &config.resources;
-        if resource_list.is_empty() {
-            return Vec::new();
-        }
-
-        for r in resource_list
-        {
-            let v = map.entry(&r.resource_type).or_insert(0);
-            *v += 1;
-            if *v > 1 {
-                result.insert(r.resource_type.clone());
-            }
-        }
-
-        result.into_iter().collect()
-    }
-
     fn validate_config(&mut self) -> Result<Configuration, DscError> {
         let config: Configuration = serde_json::from_str(self.config.as_str())?;
 

dsc_lib/src/dscerror.rs

@@ -3,6 +3,7 @@
 
 use std::str::Utf8Error;
 
+use indicatif::style::TemplateError;
 use reqwest::StatusCode;
 use thiserror::Error;
 use tracing::error;
@@ -76,6 +77,9 @@ pub enum DscError {
     #[error("Parser: {0}")]
     Parser(String),
 
+    #[error("Progress: {0}")]
+    Progress(#[from] TemplateError),
+
     #[error("Resource not found: {0}")]
     ResourceNotFound(String),
 

dsc_lib/src/parser/mod.rs

@@ -24,7 +24,7 @@ impl Statement {
     /// This function will return an error if the underlying parser fails to initialize.
     pub fn new() -> Result<Self, DscError> {
         let mut parser = Parser::new();
-        parser.set_language(tree_sitter_dscexpression::language())?;
+        parser.set_language(&tree_sitter_dscexpression::language())?;
         let function_dispatcher = FunctionDispatcher::new();
         Ok(Self {
             parser,

tree-sitter-dscexpression/Cargo.toml

@@ -20,7 +20,7 @@ include = [
 path = "bindings/rust/lib.rs"
 
 [dependencies]
-tree-sitter = "~0.20.10"
+tree-sitter = "0.21"
 
 [build-dependencies]
 cc = "1.0"