package yqlib import ( "testing" ) var prefix = "D0, P[], (doc)::a:\n cool:\n bob: dylan\n" var encoderDecoderOperatorScenarios = []expressionScenario{ { description: "Encode value as json string", document: `{a: {cool: "thing"}}`, expression: `.b = (.a | to_json)`, expected: []string{ `D0, P[], (doc)::{a: {cool: "thing"}, b: "{\n \"cool\": \"thing\"\n}\n"} `, }, }, { description: "Encode value as json string, on one line", subdescription: "Pass in a 0 indent to print json on a single line.", document: `{a: {cool: "thing"}}`, expression: `.b = (.a | to_json(0))`, expected: []string{ `D0, P[], (doc)::{a: {cool: "thing"}, b: '{"cool":"thing"}'} `, }, }, { description: "Encode value as json string, on one line shorthand", subdescription: "Pass in a 0 indent to print json on a single line.", document: `{a: {cool: "thing"}}`, expression: `.b = (.a | @json)`, expected: []string{ `D0, P[], (doc)::{a: {cool: "thing"}, b: '{"cool":"thing"}'} `, }, }, { description: "Decode a json encoded string", subdescription: "Keep in mind JSON is a subset of YAML. If you want idiomatic yaml, pipe through the style operator to clear out the JSON styling.", document: `a: '{"cool":"thing"}'`, expression: `.a | from_json | ... style=""`, expected: []string{ "D0, P[a], (!!map)::cool: thing\n", }, }, { skipDoc: true, document: `{a: {cool: "thing"}}`, expression: `.b = (.a | to_props)`, expected: []string{ `D0, P[], (doc)::{a: {cool: "thing"}, b: "cool = thing\n"} `, }, }, { description: "Encode value as props string", document: `{a: {cool: "thing"}}`, expression: `.b = (.a | @props)`, expected: []string{ `D0, P[], (doc)::{a: {cool: "thing"}, b: "cool = thing\n"} `, }, }, { description: "Decode props encoded string", document: `a: "cats=great\ndogs=cool as well"`, expression: `.a |= from_props`, expected: []string{ "D0, P[], (doc)::a:\n cats: great\n dogs: cool as well\n", }, }, { skipDoc: true, document: "a:\n cool:\n bob: dylan", expression: `.b = (.a | @yaml)`, expected: []string{ prefix + "b: |\n cool:\n bob: dylan\n", }, }, { description: "Encode value as yaml string", subdescription: "Indent defaults to 2", document: "a:\n cool:\n bob: dylan", expression: `.b = (.a | to_yaml)`, expected: []string{ prefix + "b: |\n cool:\n bob: dylan\n", }, }, { description: "Encode value as yaml string, with custom indentation", subdescription: "You can specify the indentation level as the first parameter.", document: "a:\n cool:\n bob: dylan", expression: `.b = (.a | to_yaml(8))`, expected: []string{ prefix + "b: |\n cool:\n bob: dylan\n", }, }, { skipDoc: true, document: `{a: {cool: "thing"}}`, expression: `.b = (.a | to_yaml)`, expected: []string{ `D0, P[], (doc)::{a: {cool: "thing"}, b: "{cool: \"thing\"}\n"} `, }, }, { description: "Decode a yaml encoded string", document: `a: "foo: bar"`, expression: `.b = (.a | from_yaml)`, expected: []string{ "D0, P[], (doc)::a: \"foo: bar\"\nb:\n foo: bar\n", }, }, { description: "Update a multiline encoded yaml string", dontFormatInputForDoc: true, document: "a: |\n foo: bar\n baz: dog\n", expression: `.a |= (from_yaml | .foo = "cat" | to_yaml)`, expected: []string{ "D0, P[], (doc)::a: |\n foo: cat\n baz: dog\n", }, }, { skipDoc: true, dontFormatInputForDoc: true, document: "a: |-\n foo: bar\n baz: dog\n", expression: `.a |= (from_yaml | .foo = "cat" | to_yaml)`, expected: []string{ "D0, P[], (doc)::a: |-\n foo: cat\n baz: dog\n", }, }, { description: "Update a single line encoded yaml string", dontFormatInputForDoc: true, document: "a: 'foo: bar'", expression: `.a |= (from_yaml | .foo = "cat" | to_yaml)`, expected: []string{ "D0, P[], (doc)::a: 'foo: cat'\n", }, }, { description: "Encode array of scalars as csv string", subdescription: "Scalars are strings, numbers and booleans.", document: `[cat, "thing1,thing2", true, 3.40]`, expression: `@csv`, expected: []string{ "D0, P[], (!!str)::cat,\"thing1,thing2\",true,3.40\n", }, }, { description: "Encode array of arrays as csv string", document: `[[cat, "thing1,thing2", true, 3.40], [dog, thing3, false, 12]]`, expression: `@csv`, expected: []string{ "D0, P[], (!!str)::cat,\"thing1,thing2\",true,3.40\ndog,thing3,false,12\n", }, }, { description: "Encode array of array scalars as tsv string", subdescription: "Scalars are strings, numbers and booleans.", document: `[[cat, "thing1,thing2", true, 3.40], [dog, thing3, false, 12]]`, expression: `@tsv`, expected: []string{ "D0, P[], (!!str)::cat\tthing1,thing2\ttrue\t3.40\ndog\tthing3\tfalse\t12\n", }, }, { skipDoc: true, dontFormatInputForDoc: true, document: "a: \"foo: bar\"", expression: `.a |= (from_yaml | .foo = {"a": "frog"} | to_yaml)`, expected: []string{ "D0, P[], (doc)::a: \"foo:\\n a: frog\"\n", }, }, { description: "Encode value as xml string", document: `{a: {cool: {foo: "bar", +id: hi}}}`, expression: `.a | to_xml`, expected: []string{ "D0, P[a], (!!str)::\n bar\n\n\n", }, }, { description: "Encode value as xml string on a single line", document: `{a: {cool: {foo: "bar", +id: hi}}}`, expression: `.a | @xml`, expected: []string{ "D0, P[a], (!!str)::bar\n\n", }, }, { description: "Encode value as xml string with custom indentation", document: `{a: {cool: {foo: "bar", +id: hi}}}`, expression: `{"cat": .a | to_xml(1)}`, expected: []string{ "D0, P[], (!!map)::cat: |\n \n bar\n \n", }, }, { description: "Decode a xml encoded string", document: `a: "bar"`, expression: `.b = (.a | from_xml)`, expected: []string{ "D0, P[], (doc)::a: \"bar\"\nb:\n foo: bar\n", }, }, { description: "Encode a string to base64", document: "coolData: a special string", expression: ".coolData | @base64", expected: []string{ "D0, P[coolData], (!!str)::YSBzcGVjaWFsIHN0cmluZw==\n", }, }, { description: "Encode a yaml document to base64", subdescription: "Pipe through @yaml first to convert to a string, then use @base64 to encode it.", document: "a: apple", expression: "@yaml | @base64", expected: []string{ "D0, P[], (!!str)::YTogYXBwbGUK\n", }, }, { description: "Decode a base64 encoded string", subdescription: "Decoded data is assumed to be a string.", document: "coolData: V29ya3Mgd2l0aCBVVEYtMTYg8J+Yig==", expression: ".coolData | @base64d", expected: []string{ "D0, P[coolData], (!!str)::Works with UTF-16 😊\n", }, }, { description: "Decode a base64 encoded yaml document", subdescription: "Pipe through `from_yaml` to parse the decoded base64 string as a yaml document.", document: "coolData: YTogYXBwbGUK", expression: ".coolData |= (@base64d | from_yaml)", expected: []string{ "D0, P[], (doc)::coolData:\n a: apple\n", }, }, } func TestEncoderDecoderOperatorScenarios(t *testing.T) { for _, tt := range encoderDecoderOperatorScenarios { testScenario(t, &tt) } documentOperatorScenarios(t, "encode-decode", encoderDecoderOperatorScenarios) }