change to a failure object that contains exitCode and message

Author: SteveL-MSFT

dsc/tests/dsc_config_get.tests.ps1

@@ -110,7 +110,7 @@ Describe 'dsc config get tests' {
             - name: ErrorTest
               type: Test/ExitCode
               properties:
-                exitCode: 1
+                exitCode: 8
 '@
         dsc --progress-format json --trace-format json config get -i $config_yaml 2> $TestDrive/ErrorStream.txt
         $LASTEXITCODE | Should -Be 2
@@ -134,10 +134,12 @@ Describe 'dsc config get tests' {
                     $jp.failed | Should -BeNullOrEmpty
                 }
             }
-            elseif ($null -ne $jp.failed -and $jp.resourceType -eq 'Test/ExitCode') {
+            elseif ($null -ne $jp.failure -and $jp.resourceType -eq 'Test/ExitCode') {
                 if ($jp.resourceName -eq 'ErrorTest') {
                     $InstanceTwoFound = $true
                     $jp.result | Should -BeNullOrEmpty
+                    $jp.failure.exitCode | Should -Be 8
+                    $jp.failure.message | Should -Not -BeNullOrEmpty
                 }
             }
         }

dsc_lib/src/configure/mod.rs

@@ -13,7 +13,7 @@ use crate::dscresources::{
 use crate::DscResource;
 use crate::discovery::Discovery;
 use crate::parser::Statement;
-use crate::progress::{ProgressBar, ProgressFormat};
+use crate::progress::{Failure, ProgressBar, ProgressFormat};
 use self::context::Context;
 use self::config_doc::{Configuration, DataType, MicrosoftDscMetadata, Operation, SecurityContextKind};
 use self::depends_on::get_resource_invocation_order;
@@ -245,7 +245,7 @@ impl Configurator {
             let get_result = match dsc_resource.get(&filter) {
                 Ok(result) => result,
                 Err(e) => {
-                    progress.set_failed();
+                    progress.set_failure(get_failure_from_error(&e));
                     progress.write_increment(1);
                     return Err(e);
                 },
@@ -342,7 +342,7 @@ impl Configurator {
                 set_result = match dsc_resource.set(&desired, skip_test, &self.context.execution_type) {
                     Ok(result) => result,
                     Err(e) => {
-                        progress.set_failed();
+                        progress.set_failure(get_failure_from_error(&e));
                         progress.write_increment(1);
                         return Err(e);
                     },
@@ -357,21 +357,21 @@ impl Configurator {
                 let before_result = match dsc_resource.get(&desired) {
                     Ok(result) => result,
                     Err(e) => {
-                        progress.set_failed();
+                        progress.set_failure(get_failure_from_error(&e));
                         progress.write_increment(1);
                         return Err(e);
                     },
                 };
                 start_datetime = chrono::Local::now();
-                if let Err(err) = dsc_resource.delete(&desired) {
-                    progress.set_failed();
+                if let Err(e) = dsc_resource.delete(&desired) {
+                    progress.set_failure(get_failure_from_error(&e));
                     progress.write_increment(1);
-                    return Err(err);
+                    return Err(e);
                 }
                 let after_result = match dsc_resource.get(&desired) {
                     Ok(result) => result,
                     Err(e) => {
-                        progress.set_failed();
+                        progress.set_failure(get_failure_from_error(&e));
                         progress.write_increment(1);
                         return Err(e);
                     },
@@ -464,7 +464,7 @@ impl Configurator {
             let test_result = match dsc_resource.test(&expected) {
                 Ok(result) => result,
                 Err(e) => {
-                    progress.set_failed();
+                    progress.set_failure(get_failure_from_error(&e));
                     progress.write_increment(1);
                     return Err(e);
                 },
@@ -535,7 +535,7 @@ impl Configurator {
             let export_result = match add_resource_export_results_to_configuration(dsc_resource, Some(dsc_resource), &mut conf, input.as_str()) {
                 Ok(result) => result,
                 Err(e) => {
-                    progress.set_failed();
+                    progress.set_failure(get_failure_from_error(&e));
                     progress.write_increment(1);
                     return Err(e);
                 },
@@ -792,3 +792,21 @@ impl Configurator {
         Ok(Some(result))
     }
 }
+
+fn get_failure_from_error(err: &DscError) -> Option<Failure> {
+    match err {
+        DscError::CommandExit(_resource, exit_code, reason) => {
+            Some(Failure {
+                message: reason.to_string(),
+                exit_code: exit_code.clone(),
+            })
+        },
+        DscError::CommandExitFromManifest(_resource, exit_code, reason) => {
+            Some(Failure {
+                message: reason.to_string(),
+                exit_code: exit_code.clone(),
+            })
+        },
+        _ => None,
+    }
+}

dsc_lib/src/progress.rs

@@ -23,6 +23,13 @@ pub enum ProgressFormat {
     Json,
 }
 
+#[derive(Default, Debug, Clone, Serialize)]
+#[serde(rename_all = "camelCase")]
+pub struct Failure {
+    pub message: String,
+    pub exit_code: i32,
+}
+
 #[derive(Default, Debug, Clone, Serialize)]
 #[serde(rename_all = "camelCase")]
 pub struct Progress {
@@ -49,9 +56,9 @@ pub struct Progress {
     /// The result of the operation.
     #[serde(skip_serializing_if = "Option::is_none")]
     pub result: Option<Value>,
-    /// Indicates if the operation failed.
+    /// Failure information.
     #[serde(skip_serializing_if = "Option::is_none")]
-    pub failed: Option<bool>,
+    pub failure: Option<Failure>,
 }
 
 impl Progress {
@@ -136,7 +143,7 @@ impl ProgressBar {
         self.progress_value.resource_name = Some(name.to_string());
         self.progress_value.resource_type = Some(resource_type.to_string());
         self.progress_value.result = None;
-        self.progress_value.failed = None;
+        self.progress_value.failure = None;
     }
 
     /// Set the result of the operation. This will clear any error.
@@ -146,15 +153,15 @@ impl ProgressBar {
     /// * `result` - The result of the operation
     ///
     pub fn set_result(&mut self, result: &Value) {
-        self.progress_value.failed = None;
+        self.progress_value.failure = None;
         self.progress_value.result = Some(result.clone());
     }
 
     /// Indicate that the operation failed.  This will clear any result.
     ///
-    pub fn set_failed(&mut self) {
+    pub fn set_failure(&mut self, failure: Option<Failure>) {
         self.progress_value.result = None;
-        self.progress_value.failed = Some(true);
+        self.progress_value.failure = failure;
     }
 
     /// Set the status of the operation and write the progress