(GH-538) Update exit_codes field to use ExitCodesMap.

This change updates the `exit_codes` fields for the `ResourceManifest`
and `ExtensionManifest` structs to use the new `ExitCodesMap` type
instead of `Option<HashMap<String, String>>`.

It also updates the `run_process_async()` and `invoke_command()`
functions to work with references to `ExitCodesMap` and removes the
now-extraneous `fn convert_hashmap_string_keys_to_i32()` function.

Author: michaeltlombardi

lib/dsc-lib/src/dscresources/command_resource.rs

@@ -7,7 +7,7 @@ use rust_i18n::t;
 use serde::Deserialize;
 use serde_json::{Map, Value};
 use std::{collections::HashMap, env, path::{Path, PathBuf}, process::Stdio};
-use crate::{configure::{config_doc::ExecutionKind, config_result::{ResourceGetResult, ResourceTestResult}}, types::FullyQualifiedTypeName, util::canonicalize_which};
+use crate::{configure::{config_doc::ExecutionKind, config_result::{ResourceGetResult, ResourceTestResult}}, types::{ExitCodesMap, FullyQualifiedTypeName}, util::canonicalize_which};
 use crate::dscerror::DscError;
 use super::{dscresource::{get_diff, redact, DscResource}, invoke_result::{ExportResult, GetResult, ResolveResult, SetResult, TestResult, ValidateResult, ResourceGetResponse, ResourceSetResponse, ResourceTestResponse, get_in_desired_state}, resource_manifest::{GetArgKind, SetDeleteArgKind, InputKind, Kind, ReturnKind, SchemaKind}};
 use tracing::{error, warn, info, debug, trace};
@@ -733,7 +733,7 @@ pub fn invoke_resolve(resource: &DscResource, input: &str) -> Result<ResolveResu
 ///
 /// Error is returned if the command fails to execute or stdin/stdout/stderr cannot be opened.
 ///
-async fn run_process_async(executable: &str, args: Option<Vec<String>>, input: Option<&str>, cwd: Option<&Path>, env: Option<HashMap<String, String>>, exit_codes: Option<&HashMap<i32, String>>) -> Result<(i32, String, String), DscError> {
+async fn run_process_async(executable: &str, args: Option<Vec<String>>, input: Option<&str>, cwd: Option<&Path>, env: Option<HashMap<String, String>>, exit_codes: &ExitCodesMap) -> Result<(i32, String, String), DscError> {
 
     // use somewhat large initial buffer to avoid early string reallocations;
     // the value is based on list result of largest of built-in adapters - WMI adapter ~500KB
@@ -823,10 +823,8 @@ async fn run_process_async(executable: &str, args: Option<Vec<String>>, input: O
         debug!("{}", t!("dscresources.commandResource.processChildExit", executable = executable, id = child_id, code = code));
 
         if code != 0 {
-            if let Some(exit_codes) = exit_codes {
-                if let Some(error_message) = exit_codes.get(&code) {
-                    return Err(DscError::CommandExitFromManifest(executable.to_string(), code, error_message.to_string()));
-                }
+            if let Some(error_message) = exit_codes.get_code(code) {
+                return Err(DscError::CommandExitFromManifest(executable.to_string(), code, error_message.clone()));
             }
             return Err(DscError::Command(executable.to_string(), code, stderr_result));
         }
@@ -838,22 +836,6 @@ async fn run_process_async(executable: &str, args: Option<Vec<String>>, input: O
     }
 }
 
-fn convert_hashmap_string_keys_to_i32(input: Option<&HashMap<String, String>>) -> Result<Option<HashMap<i32, String>>, DscError> {
-    if input.is_none() {
-        return Ok(None);
-    }
-
-    let mut output: HashMap<i32, String> = HashMap::new();
-    for (key, value) in input.unwrap() {
-        if let Ok(key_int) = key.parse::<i32>() {
-            output.insert(key_int, value.clone());
-        } else {
-            return Err(DscError::NotSupported(t!("util.invalidExitCodeKey", key = key).to_string()));
-        }
-    }
-    Ok(Some(output))
-}
-
 /// Invoke a command and return the exit code, stdout, and stderr.
 ///
 /// # Arguments
@@ -874,8 +856,7 @@ fn convert_hashmap_string_keys_to_i32(input: Option<&HashMap<String, String>>) -
 /// Will panic if tokio runtime can't be created.
 ///
 #[allow(clippy::implicit_hasher)]
-pub fn invoke_command(executable: &str, args: Option<Vec<String>>, input: Option<&str>, cwd: Option<&Path>, env: Option<HashMap<String, String>>, exit_codes: Option<&HashMap<String, String>>) -> Result<(i32, String, String), DscError> {
-    let exit_codes = convert_hashmap_string_keys_to_i32(exit_codes)?;
+pub fn invoke_command(executable: &str, args: Option<Vec<String>>, input: Option<&str>, cwd: Option<&Path>, env: Option<HashMap<String, String>>, exit_codes: &ExitCodesMap) -> Result<(i32, String, String), DscError> {
     let executable = canonicalize_which(executable, cwd)?;
 
     let run_async = async {
@@ -884,7 +865,7 @@ pub fn invoke_command(executable: &str, args: Option<Vec<String>>, input: Option
             trace!("{}", t!("dscresources.commandResource.commandCwd", cwd = cwd.display()));
         }
 
-        match run_process_async(&executable, args, input, cwd, env, exit_codes.as_ref()).await {
+        match run_process_async(&executable, args, input, cwd, env, exit_codes).await {
             Ok((code, stdout, stderr)) => {
                 Ok((code, stdout, stderr))
             },

lib/dsc-lib/src/dscresources/resource_manifest.rs

@@ -6,11 +6,10 @@ use schemars::JsonSchema;
 use semver::Version;
 use serde::{Deserialize, Serialize};
 use serde_json::{Map, Value};
-use std::collections::HashMap;
 
 use crate::{
     schemas::{dsc_repo::DscRepoSchema, transforms::idiomaticize_string_enum},
-    types::FullyQualifiedTypeName,
+    types::{ExitCodesMap, FullyQualifiedTypeName},
 };
 
 #[derive(Debug, Clone, PartialEq, Deserialize, Serialize, JsonSchema, DscRepoSchema)]
@@ -84,8 +83,8 @@ pub struct ResourceManifest {
     #[serde(skip_serializing_if = "Option::is_none")]
     pub adapter: Option<Adapter>,
     /// Mapping of exit codes to descriptions.  Zero is always success and non-zero is always failure.
-    #[serde(rename = "exitCodes", skip_serializing_if = "Option::is_none")]
-    pub exit_codes: Option<HashMap<String, String>>, // we have to make this a string key instead of i32 due to https://github.com/serde-rs/json/issues/560
+    #[serde(rename = "exitCodes", skip_serializing_if = "ExitCodesMap::is_empty_or_default", default)]
+    pub exit_codes: ExitCodesMap,
     /// Details how to get the schema of the resource.
     #[serde(skip_serializing_if = "Option::is_none")]
     pub schema: Option<SchemaKind>,

lib/dsc-lib/src/extensions/extension_manifest.rs

@@ -6,12 +6,11 @@ use schemars::JsonSchema;
 use semver::Version;
 use serde::{Deserialize, Serialize};
 use serde_json::{Map, Value};
-use std::collections::HashMap;
 
 use crate::dscerror::DscError;
 use crate::extensions::{discover::DiscoverMethod, import::ImportMethod, secret::SecretMethod};
 use crate::schemas::dsc_repo::DscRepoSchema;
-use crate::types::FullyQualifiedTypeName;
+use crate::types::{ExitCodesMap, FullyQualifiedTypeName};
 
 #[derive(Debug, Default, Clone, PartialEq, Deserialize, Serialize, JsonSchema, DscRepoSchema)]
 #[serde(deny_unknown_fields)]
@@ -52,8 +51,8 @@ pub struct ExtensionManifest {
     /// Details how to call the Secret method of the extension.
     pub secret: Option<SecretMethod>,
     /// Mapping of exit codes to descriptions.  Zero is always success and non-zero is always failure.
-    #[serde(rename = "exitCodes", skip_serializing_if = "Option::is_none")]
-    pub exit_codes: Option<HashMap<String, String>>,
+    #[serde(rename = "exitCodes", skip_serializing_if = "ExitCodesMap::is_empty_or_default", default)]
+    pub exit_codes: ExitCodesMap,
     #[serde(skip_serializing_if = "Option::is_none")]
     pub metadata: Option<Map<String, Value>>,
 }