Merge pull request #651 from MartinHowarthFlexciton/allow-bool-hash-and-dont-panic

Allow bool hash and dont panic

Author: epage

src/file/format/yaml.rs

@@ -50,7 +50,8 @@ fn from_yaml_value(
                 match key {
                     yaml::Yaml::String(k) => m.insert(k.to_owned(), from_yaml_value(uri, value)?),
                     yaml::Yaml::Integer(k) => m.insert(k.to_string(), from_yaml_value(uri, value)?),
-                    _ => unreachable!(),
+                    yaml::Yaml::Boolean(k) => m.insert(k.to_string(), from_yaml_value(uri, value)?),
+                    other => Err(Box::new(UnsupportedHashKeyError(format!("{other:?}"))))?,
                 };
             }
             Ok(Value::new(uri, ValueKind::Table(m)))
@@ -103,3 +104,22 @@ impl Error for FloatParsingError {
         "Floating point number parsing failed"
     }
 }
+
+#[derive(Debug, Clone)]
+struct UnsupportedHashKeyError(String);
+
+impl fmt::Display for UnsupportedHashKeyError {
+    fn fmt(&self, format: &mut fmt::Formatter<'_>) -> fmt::Result {
+        write!(
+            format,
+            "Cannot parse {} because it is an unsupported hash key type",
+            self.0
+        )
+    }
+}
+
+impl Error for UnsupportedHashKeyError {
+    fn description(&self) -> &str {
+        "Unsupported yaml hash key found"
+    }
+}

tests/testsuite/file_yaml.rs

@@ -338,3 +338,47 @@ fn yaml() {
     let date: DateTime<Utc> = s.get("yaml_datetime").unwrap();
     assert_eq!(date, Utc.with_ymd_and_hms(2017, 6, 12, 10, 58, 30).unwrap());
 }
+
+#[test]
+/// We only support certain types as keys to a yaml hash, this test ensures
+/// we communicate that to the user effectively.
+fn test_yaml_parsing_unsupported_hash_has_useful_error_message() {
+    let result = Config::builder()
+        .add_source(File::from_str(
+            r#"
+inner_vec:
+    [1, 2]: "unsupported"
+"#,
+            FileFormat::Yaml,
+        ))
+        .build();
+    assert!(result.is_err());
+    assert_data_eq!(
+        result.unwrap_err().to_string(),
+        str!["Cannot parse Array([Integer(1), Integer(2)]) because it is an unsupported hash key type"]
+    );
+}
+
+#[test]
+fn test_yaml_parsing_bool_hash() {
+    #[derive(Debug, Deserialize)]
+    struct TestStruct {
+        inner_bool: HashMap<bool, String>,
+    }
+
+    let config = Config::builder()
+        .add_source(File::from_str(
+            r#"
+inner_bool:
+    true: "bool true"
+    false: "bool false"
+"#,
+            FileFormat::Yaml,
+        ))
+        .build()
+        .unwrap()
+        .try_deserialize::<TestStruct>()
+        .unwrap();
+    assert_eq!(config.inner_bool.get(&true).unwrap(), "bool true");
+    assert_eq!(config.inner_bool.get(&false).unwrap(), "bool false");
+}