From eb1ada611575a6ae6f5ff01c428adb2a3c939239 Mon Sep 17 00:00:00 2001 From: Arash Outadi Date: Tue, 16 Jun 2020 12:12:04 -0700 Subject: [PATCH] issue1332 - Fix for yamls with unquoted double curly braces (#1988) * Gnarly hardcoded fix * Whoops remove println --- crates/nu-cli/src/commands/from_yaml.rs | 96 +++++++++++++++++++------ crates/nu-plugin/src/test_helpers.rs | 9 +++ 2 files changed, 85 insertions(+), 20 deletions(-) diff --git a/crates/nu-cli/src/commands/from_yaml.rs b/crates/nu-cli/src/commands/from_yaml.rs index f28e004482..bafb8bf17e 100644 --- a/crates/nu-cli/src/commands/from_yaml.rs +++ b/crates/nu-cli/src/commands/from_yaml.rs @@ -59,27 +59,19 @@ fn convert_yaml_value_to_nu_value( ) -> Result { let tag = tag.into(); + let err_not_compatible_number = ShellError::labeled_error( + "Expected a compatible number", + "expected a compatible number", + &tag, + ); Ok(match v { serde_yaml::Value::Bool(b) => UntaggedValue::boolean(*b).into_value(tag), serde_yaml::Value::Number(n) if n.is_i64() => { - UntaggedValue::int(n.as_i64().ok_or_else(|| { - ShellError::labeled_error( - "Expected a compatible number", - "expected a compatible number", - &tag, - ) - })?) - .into_value(tag) + UntaggedValue::int(n.as_i64().ok_or_else(|| err_not_compatible_number)?).into_value(tag) } serde_yaml::Value::Number(n) if n.is_f64() => { - UntaggedValue::decimal(n.as_f64().ok_or_else(|| { - ShellError::labeled_error( - "Expected a compatible number", - "expected a compatible number", - &tag, - ) - })?) - .into_value(tag) + UntaggedValue::decimal(n.as_f64().ok_or_else(|| err_not_compatible_number)?) + .into_value(tag) } serde_yaml::Value::String(s) => UntaggedValue::string(s).into_value(tag), serde_yaml::Value::Sequence(a) => { @@ -93,11 +85,39 @@ fn convert_yaml_value_to_nu_value( let mut collected = TaggedDictBuilder::new(&tag); for (k, v) in t.iter() { - match k { - serde_yaml::Value::String(k) => { + // A ShellError that we re-use multiple times in the Mapping scenario + let err_unexpected_map = ShellError::labeled_error( + format!("Unexpected YAML:\nKey: {:?}\nValue: {:?}", k, v), + "unexpected", + tag.clone(), + ); + match (k, v) { + (serde_yaml::Value::String(k), _) => { collected.insert_value(k.clone(), convert_yaml_value_to_nu_value(v, &tag)?); } - _ => unimplemented!("Unknown key type"), + // Hard-code fix for cases where "v" is a string without quotations with double curly braces + // e.g. k = value + // value: {{ something }} + // Strangely, serde_yaml returns + // "value" -> Mapping(Mapping { map: {Mapping(Mapping { map: {String("something"): Null} }): Null} }) + (serde_yaml::Value::Mapping(m), serde_yaml::Value::Null) => { + return m + .iter() + .take(1) + .collect_vec() + .first() + .and_then(|e| match e { + (serde_yaml::Value::String(s), serde_yaml::Value::Null) => Some( + UntaggedValue::string("{{ ".to_owned() + &s + " }}") + .into_value(tag), + ), + _ => None, + }) + .ok_or(err_unexpected_map); + } + (_, _) => { + return Err(err_unexpected_map); + } } } @@ -151,7 +171,9 @@ async fn from_yaml( #[cfg(test)] mod tests { - use super::FromYAML; + use super::*; + use nu_plugin::row; + use nu_plugin::test_helpers::value::string; #[test] fn examples_work_as_expected() { @@ -159,4 +181,38 @@ mod tests { test_examples(FromYAML {}) } + + #[test] + fn test_problematic_yaml() { + struct TestCase { + description: &'static str, + input: &'static str, + expected: Result, + } + let tt: Vec = vec![ + TestCase { + description: "Double Curly Braces With Quotes", + input: r#"value: "{{ something }}""#, + expected: Ok(row!["value".to_owned() => string("{{ something }}")]), + }, + TestCase { + description: "Double Curly Braces Without Quotes", + input: r#"value: {{ something }}"#, + expected: Ok(row!["value".to_owned() => string("{{ something }}")]), + }, + ]; + for tc in tt.into_iter() { + let actual = from_yaml_string_to_value(tc.input.to_owned(), Tag::default()); + if actual.is_err() { + assert!( + tc.expected.is_err(), + "actual is Err for test:\nTest Description {}\nErr: {:?}", + tc.description, + actual + ); + } else { + assert_eq!(actual, tc.expected, "{}", tc.description); + } + } + } } diff --git a/crates/nu-plugin/src/test_helpers.rs b/crates/nu-plugin/src/test_helpers.rs index f64c01ef52..2ef4661e2b 100644 --- a/crates/nu-plugin/src/test_helpers.rs +++ b/crates/nu-plugin/src/test_helpers.rs @@ -215,4 +215,13 @@ pub mod value { )) .into_untagged_value()) } + + #[macro_export] + macro_rules! row { + ($( $key: expr => $val: expr ),*) => {{ + let mut map = indexmap::IndexMap::new(); + $( map.insert($key, $val); )* + UntaggedValue::row(map).into_untagged_value() + }} + } }