suyiiyii/yq
1
0
Fork 0
mirror of https://github.com/mikefarah/yq.git synced 2026-07-11 01:09:54 +00:00
Code Issues Packages Projects Releases Wiki Activity

adding test scenario for encoding with wrapped scalars

Browse Source
This commit is contained in:
Daniel Carbone 2022-06-23 22:27:50 -05:00
parent a9d1b1ab85
commit b13b2334be
No known key found for this signature in database
GPG Key ID: 348D611030B4EACB
4 changed files with 152 additions and 60 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

49
pkg/yqlib/doc/usage/properties.md
View File

@ -17,7 +17,7 @@ Given a sample.yml file of:
```yaml ```yaml
# block comments don't come through # block comments don't come through
person: # neither do comments on maps person: # neither do comments on maps
name: Mike # comments on values appear name: Mike Wazowski # comments on values appear
pets: pets:
- cat # comments on array values appear - cat # comments on array values appear
food: [pizza] # comments on arrays do not food: [pizza] # comments on arrays do not
@ -32,7 +32,36 @@ yq -o=props sample.yml
will output will output
```properties ```properties
# comments on values appear # comments on values appear
person.name = Mike person.name = Mike Wazowski
# comments on array values appear
person.pets.0 = cat
person.food.0 = pizza
```
## Encode properties: scalar encapsulation
Note that string values with blank characters in them are encapsulated with double quotes
Given a sample.yml file of:
```yaml
# block comments don't come through
person: # neither do comments on maps
name: Mike Wazowski # comments on values appear
pets:
- cat # comments on array values appear
food: [pizza] # comments on arrays do not
emptyArray: []
emptyMap: []
```
then
```bash
yq -o=props --unwrapScalar=false sample.yml
```
will output
```properties
# comments on values appear
person.name = "Mike Wazowski"
# comments on array values appear # comments on array values appear
person.pets.0 = cat person.pets.0 = cat
@ -44,7 +73,7 @@ Given a sample.yml file of:
```yaml ```yaml
# block comments don't come through # block comments don't come through
person: # neither do comments on maps person: # neither do comments on maps
name: Mike # comments on values appear name: Mike Wazowski # comments on values appear
pets: pets:
- cat # comments on array values appear - cat # comments on array values appear
food: [pizza] # comments on arrays do not food: [pizza] # comments on arrays do not
@ -58,7 +87,7 @@ yq -o=props '... comments = ""' sample.yml
``` ```
will output will output
```properties ```properties
person.name = Mike person.name = Mike Wazowski
person.pets.0 = cat person.pets.0 = cat
person.food.0 = pizza person.food.0 = pizza
``` ```
@ -70,7 +99,7 @@ Given a sample.yml file of:
```yaml ```yaml
# block comments don't come through # block comments don't come through
person: # neither do comments on maps person: # neither do comments on maps
name: Mike # comments on values appear name: Mike Wazowski # comments on values appear
pets: pets:
- cat # comments on array values appear - cat # comments on array values appear
food: [pizza] # comments on arrays do not food: [pizza] # comments on arrays do not
@ -85,7 +114,7 @@ yq -o=props '(.. | select( (tag == "!!map" or tag =="!!seq") and length == 0)) =
will output will output
```properties ```properties
# comments on values appear # comments on values appear
person.name = Mike person.name = Mike Wazowski
# comments on array values appear # comments on array values appear
person.pets.0 = cat person.pets.0 = cat
@ -98,7 +127,7 @@ emptyMap =
Given a sample.properties file of: Given a sample.properties file of:
```properties ```properties
# comments on values appear # comments on values appear
person.name = Mike person.name = Mike Wazowski
# comments on array values appear # comments on array values appear
person.pets.0 = cat person.pets.0 = cat
@ -112,7 +141,7 @@ yq -p=props sample.properties
will output will output
```yaml ```yaml
person: person:
name: Mike # comments on values appear name: Mike Wazowski # comments on values appear
pets: pets:
- cat # comments on array values appear - cat # comments on array values appear
food: food:
@ -123,7 +152,7 @@ person:
Given a sample.properties file of: Given a sample.properties file of:
```properties ```properties
# comments on values appear # comments on values appear
person.name = Mike person.name = Mike Wazowski
# comments on array values appear # comments on array values appear
person.pets.0 = cat person.pets.0 = cat
@ -137,7 +166,7 @@ yq -p=props -o=props '.person.pets.0 = "dog"' sample.properties
will output will output
```properties ```properties
# comments on values appear # comments on values appear
person.name = Mike person.name = Mike Wazowski
# comments on array values appear # comments on array values appear
person.pets.0 = dog person.pets.0 = dog

21
pkg/yqlib/json_test.go
View File

@ -9,7 +9,7 @@ import (
"github.com/mikefarah/yq/v4/test" "github.com/mikefarah/yq/v4/test"
) )
var complexExpectYaml = `D0, P[], (!!map)::a: Easy! as one two three const complexExpectYaml = `D0, P[], (!!map)::a: Easy! as one two three
b: b:
c: 2 c: 2
d: d:
@ -96,11 +96,15 @@ func decodeJSON(t *testing.T, jsonString string) *CandidateNode {
} }
func testJSONScenario(t *testing.T, s formatScenario) { func testJSONScenario(t *testing.T, s formatScenario) {
if s.scenarioType == "encode" || s.scenarioType == "roundtrip" { switch s.scenarioType {
case "encode", "decode":
test.AssertResultWithContext(t, s.expected, processFormatScenario(s, NewYamlDecoder(), NewJONEncoder(s.indent, false)), s.description) test.AssertResultWithContext(t, s.expected, processFormatScenario(s, NewYamlDecoder(), NewJONEncoder(s.indent, false)), s.description)
} else { case "":
var actual = resultToString(t, decodeJSON(t, s.input)) var actual = resultToString(t, decodeJSON(t, s.input))
test.AssertResultWithContext(t, s.expected, actual, s.description) test.AssertResultWithContext(t, s.expected, actual, s.description)
default:
panic(fmt.Sprintf("unhandled scenario type %q", s.scenarioType))
} }
} }
@ -135,14 +139,17 @@ func documentJSONDecodeScenario(t *testing.T, w *bufio.Writer, s formatScenario)
func documentJSONScenario(t *testing.T, w *bufio.Writer, i interface{}) { func documentJSONScenario(t *testing.T, w *bufio.Writer, i interface{}) {
s := i.(formatScenario) s := i.(formatScenario)
if s.skipDoc { if s.skipDoc {
return return
} }
if s.scenarioType == "encode" { switch s.scenarioType {
documentJSONEncodeScenario(w, s) case "":
} else {
documentJSONDecodeScenario(t, w, s) documentJSONDecodeScenario(t, w, s)
case "encode":
documentJSONEncodeScenario(w, s)
default:
panic(fmt.Sprintf("unhandled scenario type %q", s.scenarioType))
} }
} }

101
pkg/yqlib/properties_test.go
View File

@ -8,9 +8,9 @@ import (
"github.com/mikefarah/yq/v4/test" "github.com/mikefarah/yq/v4/test"
) )
var samplePropertiesYaml = `# block comments don't come through const samplePropertiesYaml = `# block comments don't come through
person: # neither do comments on maps person: # neither do comments on maps
name: Mike # comments on values appear name: Mike Wazowski # comments on values appear
pets: pets:
- cat # comments on array values appear - cat # comments on array values appear
food: [pizza] # comments on arrays do not food: [pizza] # comments on arrays do not
@ -18,37 +18,45 @@ emptyArray: []
emptyMap: [] emptyMap: []
` `
var expectedProperties = `# comments on values appear const expectedPropertiesUnwrapped = `# comments on values appear
person.name = Mike person.name = Mike Wazowski
# comments on array values appear # comments on array values appear
person.pets.0 = cat person.pets.0 = cat
person.food.0 = pizza person.food.0 = pizza
` `
var expectedUpdatedProperties = `# comments on values appear const expectedPropertiesWrapped = `# comments on values appear
person.name = Mike person.name = "Mike Wazowski"
# comments on array values appear
person.pets.0 = cat
person.food.0 = pizza
`
const expectedUpdatedProperties = `# comments on values appear
person.name = Mike Wazowski
# comments on array values appear # comments on array values appear
person.pets.0 = dog person.pets.0 = dog
person.food.0 = pizza person.food.0 = pizza
` `
var expectedDecodedYaml = `person: const expectedDecodedYaml = `person:
name: Mike # comments on values appear name: Mike Wazowski # comments on values appear
pets: pets:
- cat # comments on array values appear - cat # comments on array values appear
food: food:
- pizza - pizza
` `
var expectedPropertiesNoComments = `person.name = Mike const expectedPropertiesNoComments = `person.name = Mike Wazowski
person.pets.0 = cat person.pets.0 = cat
person.food.0 = pizza person.food.0 = pizza
` `
var expectedPropertiesWithEmptyMapsAndArrays = `# comments on values appear const expectedPropertiesWithEmptyMapsAndArrays = `# comments on values appear
person.name = Mike person.name = Mike Wazowski
# comments on array values appear # comments on array values appear
person.pets.0 = cat person.pets.0 = cat
@ -62,7 +70,14 @@ var propertyScenarios = []formatScenario{
description: "Encode properties", description: "Encode properties",
subdescription: "Note that empty arrays and maps are not encoded by default.", subdescription: "Note that empty arrays and maps are not encoded by default.",
input: samplePropertiesYaml, input: samplePropertiesYaml,
expected: expectedProperties, expected: expectedPropertiesUnwrapped,
},
{
description: "Encode properties: scalar encapsulation",
subdescription: "Note that string values with blank characters in them are encapsulated with double quotes",
input: samplePropertiesYaml,
expected: expectedPropertiesWrapped,
scenarioType: "encode-wrapped",
}, },
{ {
description: "Encode properties: no comments", description: "Encode properties: no comments",
@ -79,7 +94,7 @@ var propertyScenarios = []formatScenario{
}, },
{ {
description: "Decode properties", description: "Decode properties",
input: expectedProperties, input: expectedPropertiesUnwrapped,
expected: expectedDecodedYaml, expected: expectedDecodedYaml,
scenarioType: "decode", scenarioType: "decode",
}, },
@ -92,7 +107,7 @@ var propertyScenarios = []formatScenario{
}, },
{ {
description: "Roundtrip", description: "Roundtrip",
input: expectedProperties, input: expectedPropertiesUnwrapped,
expression: `.person.pets.0 = "dog"`, expression: `.person.pets.0 = "dog"`,
expected: expectedUpdatedProperties, expected: expectedUpdatedProperties,
scenarioType: "roundtrip", scenarioType: "roundtrip",
@ -106,7 +121,7 @@ var propertyScenarios = []formatScenario{
}, },
} }
func documentEncodePropertyScenario(w *bufio.Writer, s formatScenario) { func documentUnwrappedEncodePropertyScenario(w *bufio.Writer, s formatScenario) {
writeOrPanic(w, fmt.Sprintf("## %v\n", s.description)) writeOrPanic(w, fmt.Sprintf("## %v\n", s.description))
if s.subdescription != "" { if s.subdescription != "" {
@ -131,6 +146,31 @@ func documentEncodePropertyScenario(w *bufio.Writer, s formatScenario) {
writeOrPanic(w, fmt.Sprintf("```properties\n%v```\n\n", processFormatScenario(s, NewYamlDecoder(), NewPropertiesEncoder(true)))) writeOrPanic(w, fmt.Sprintf("```properties\n%v```\n\n", processFormatScenario(s, NewYamlDecoder(), NewPropertiesEncoder(true))))
} }
func documentWrappedEncodePropertyScenario(w *bufio.Writer, s formatScenario) {
writeOrPanic(w, fmt.Sprintf("## %v\n", s.description))
if s.subdescription != "" {
writeOrPanic(w, s.subdescription)
writeOrPanic(w, "\n\n")
}
writeOrPanic(w, "Given a sample.yml file of:\n")
writeOrPanic(w, fmt.Sprintf("```yaml\n%v\n```\n", s.input))
writeOrPanic(w, "then\n")
expression := s.expression
if expression != "" {
writeOrPanic(w, fmt.Sprintf("```bash\nyq -o=props --unwrapScalar=false '%v' sample.yml\n```\n", expression))
} else {
writeOrPanic(w, "```bash\nyq -o=props --unwrapScalar=false sample.yml\n```\n")
}
writeOrPanic(w, "will output\n")
writeOrPanic(w, fmt.Sprintf("```properties\n%v```\n\n", processFormatScenario(s, NewYamlDecoder(), NewPropertiesEncoder(false))))
}
func documentDecodePropertyScenario(w *bufio.Writer, s formatScenario) { func documentDecodePropertyScenario(w *bufio.Writer, s formatScenario) {
writeOrPanic(w, fmt.Sprintf("## %v\n", s.description)) writeOrPanic(w, fmt.Sprintf("## %v\n", s.description))
@ -186,24 +226,35 @@ func documentPropertyScenario(t *testing.T, w *bufio.Writer, i interface{}) {
if s.skipDoc { if s.skipDoc {
return return
} }
if s.scenarioType == "decode" { switch s.scenarioType {
case "":
documentUnwrappedEncodePropertyScenario(w, s)
case "decode":
documentDecodePropertyScenario(w, s) documentDecodePropertyScenario(w, s)
} else if s.scenarioType == "roundtrip" { case "encode-wrapped":
documentWrappedEncodePropertyScenario(w, s)
case "roundtrip":
documentRoundTripPropertyScenario(w, s) documentRoundTripPropertyScenario(w, s)
} else {
documentEncodePropertyScenario(w, s)
}
default:
panic(fmt.Sprintf("unhandled scenario type %q", s.scenarioType))
}
} }
func TestPropertyScenarios(t *testing.T) { func TestPropertyScenarios(t *testing.T) {
for _, s := range propertyScenarios { for _, s := range propertyScenarios {
if s.scenarioType == "decode" { switch s.scenarioType {
test.AssertResultWithContext(t, s.expected, processFormatScenario(s, NewPropertiesDecoder(), NewYamlEncoder(2, false, true, true)), s.description) case "":
} else if s.scenarioType == "roundtrip" {
test.AssertResultWithContext(t, s.expected, processFormatScenario(s, NewPropertiesDecoder(), NewPropertiesEncoder(true)), s.description)
} else {
test.AssertResultWithContext(t, s.expected, processFormatScenario(s, NewYamlDecoder(), NewPropertiesEncoder(true)), s.description) test.AssertResultWithContext(t, s.expected, processFormatScenario(s, NewYamlDecoder(), NewPropertiesEncoder(true)), s.description)
case "decode":
test.AssertResultWithContext(t, s.expected, processFormatScenario(s, NewPropertiesDecoder(), NewYamlEncoder(2, false, true, true)), s.description)
case "encode-wrapped":
test.AssertResultWithContext(t, s.expected, processFormatScenario(s, NewYamlDecoder(), NewPropertiesEncoder(false)), s.description)
case "roundtrip":
test.AssertResultWithContext(t, s.expected, processFormatScenario(s, NewPropertiesDecoder(), NewPropertiesEncoder(true)), s.description)
default:
panic(fmt.Sprintf("unhandled scenario type %q", s.scenarioType))
} }
} }
genericScenarios := make([]interface{}, len(propertyScenarios)) genericScenarios := make([]interface{}, len(propertyScenarios))

41
pkg/yqlib/xml_test.go
View File

@ -8,7 +8,7 @@ import (
"github.com/mikefarah/yq/v4/test" "github.com/mikefarah/yq/v4/test"
) )
var inputXMLWithComments = ` const inputXMLWithComments = `
<!-- before cat --> <!-- before cat -->
<cat> <cat>
<!-- in cat before --> <!-- in cat before -->
@ -26,7 +26,7 @@ for x --></x>
</cat> </cat>
<!-- after cat --> <!-- after cat -->
` `
var inputXMLWithCommentsWithSubChild = ` const inputXMLWithCommentsWithSubChild = `
<!-- before cat --> <!-- before cat -->
<cat> <cat>
<!-- in cat before --> <!-- in cat before -->
@ -45,7 +45,7 @@ for x --></x>
<!-- after cat --> <!-- after cat -->
` `
var expectedDecodeYamlWithSubChild = `# before cat const expectedDecodeYamlWithSubChild = `# before cat
cat: cat:
# in cat before # in cat before
x: "3" # multi x: "3" # multi
@ -65,7 +65,7 @@ cat:
# after cat # after cat
` `
var inputXMLWithCommentsWithArray = ` const inputXMLWithCommentsWithArray = `
<!-- before cat --> <!-- before cat -->
<cat> <cat>
<!-- in cat before --> <!-- in cat before -->
@ -85,7 +85,7 @@ for x --></x>
<!-- after cat --> <!-- after cat -->
` `
var expectedDecodeYamlWithArray = `# before cat const expectedDecodeYamlWithArray = `# before cat
cat: cat:
# in cat before # in cat before
x: "3" # multi x: "3" # multi
@ -109,7 +109,7 @@ cat:
# after cat # after cat
` `
var expectedDecodeYamlWithComments = `# before cat const expectedDecodeYamlWithComments = `# before cat
cat: cat:
# in cat before # in cat before
x: "3" # multi x: "3" # multi
@ -126,7 +126,7 @@ cat:
# after cat # after cat
` `
var expectedRoundtripXMLWithComments = `<!-- before cat --><cat><!-- in cat before --> const expectedRoundtripXMLWithComments = `<!-- before cat --><cat><!-- in cat before -->
<x>3<!-- multi <x>3<!-- multi
line comment line comment
for x --></x><!-- before y --> for x --></x><!-- before y -->
@ -137,7 +137,7 @@ in d before -->
</cat><!-- after cat --> </cat><!-- after cat -->
` `
var yamlWithComments = `# above_cat const yamlWithComments = `# above_cat
cat: # inline_cat cat: # inline_cat
# above_array # above_array
array: # inline_array array: # inline_array
@ -147,31 +147,31 @@ cat: # inline_cat
# below_cat # below_cat
` `
var expectedXMLWithComments = `<!-- above_cat inline_cat --><cat><!-- above_array inline_array --> const expectedXMLWithComments = `<!-- above_cat inline_cat --><cat><!-- above_array inline_array -->
<array>val1<!-- inline_val1 --></array> <array>val1<!-- inline_val1 --></array>
<array><!-- above_val2 -->val2<!-- inline_val2 --></array> <array><!-- above_val2 -->val2<!-- inline_val2 --></array>
</cat><!-- below_cat --> </cat><!-- below_cat -->
` `
var inputXMLWithNamespacedAttr = ` const inputXMLWithNamespacedAttr = `
<?xml version="1.0"?> <?xml version="1.0"?>
<map xmlns="some-namespace" xmlns:xsi="some-instance" xsi:schemaLocation="some-url"> <map xmlns="some-namespace" xmlns:xsi="some-instance" xsi:schemaLocation="some-url">
</map> </map>
` `
var expectedYAMLWithNamespacedAttr = `map: const expectedYAMLWithNamespacedAttr = `map:
+xmlns: some-namespace +xmlns: some-namespace
+xmlns:xsi: some-instance +xmlns:xsi: some-instance
+some-instance:schemaLocation: some-url +some-instance:schemaLocation: some-url
` `
var expectedYAMLWithRawNamespacedAttr = `map: const expectedYAMLWithRawNamespacedAttr = `map:
+xmlns: some-namespace +xmlns: some-namespace
+xmlns:xsi: some-instance +xmlns:xsi: some-instance
+xsi:schemaLocation: some-url +xsi:schemaLocation: some-url
` `
var xmlWithCustomDtd = ` const xmlWithCustomDtd = `
<?xml version="1.0"?> <?xml version="1.0"?>
<!DOCTYPE root [ <!DOCTYPE root [
<!ENTITY writer "Blah."> <!ENTITY writer "Blah.">
@ -181,7 +181,7 @@ var xmlWithCustomDtd = `
<item>&writer;&copyright;</item> <item>&writer;&copyright;</item>
</root>` </root>`
var expectedDtd = `root: const expectedDtd = `root:
item: '&writer;&copyright;' item: '&writer;&copyright;'
` `
@ -336,6 +336,8 @@ var xmlScenarios = []formatScenario{
func testXMLScenario(t *testing.T, s formatScenario) { func testXMLScenario(t *testing.T, s formatScenario) {
switch s.scenarioType { switch s.scenarioType {
case "", "decode":
test.AssertResultWithContext(t, s.expected, processFormatScenario(s, NewXMLDecoder("+", "+content", false, false, false), NewYamlEncoder(4, false, true, true)), s.description)
case "encode": case "encode":
test.AssertResultWithContext(t, s.expected, processFormatScenario(s, NewYamlDecoder(), NewXMLEncoder(2, "+", "+content")), s.description) test.AssertResultWithContext(t, s.expected, processFormatScenario(s, NewYamlDecoder(), NewXMLEncoder(2, "+", "+content")), s.description)
case "roundtrip": case "roundtrip":
@ -344,8 +346,9 @@ func testXMLScenario(t *testing.T, s formatScenario) {
test.AssertResultWithContext(t, s.expected, processFormatScenario(s, NewXMLDecoder("+", "+content", false, true, false), NewYamlEncoder(2, false, true, true)), s.description) test.AssertResultWithContext(t, s.expected, processFormatScenario(s, NewXMLDecoder("+", "+content", false, true, false), NewYamlEncoder(2, false, true, true)), s.description)
case "decode-raw-token": case "decode-raw-token":
test.AssertResultWithContext(t, s.expected, processFormatScenario(s, NewXMLDecoder("+", "+content", false, true, true), NewYamlEncoder(2, false, true, true)), s.description) test.AssertResultWithContext(t, s.expected, processFormatScenario(s, NewXMLDecoder("+", "+content", false, true, true), NewYamlEncoder(2, false, true, true)), s.description)
default: default:
test.AssertResultWithContext(t, s.expected, processFormatScenario(s, NewXMLDecoder("+", "+content", false, false, false), NewYamlEncoder(4, false, true, true)), s.description) panic(fmt.Sprintf("unhandled scenario type %q", s.scenarioType))
} }
} }
@ -356,6 +359,8 @@ func documentXMLScenario(t *testing.T, w *bufio.Writer, i interface{}) {
return return
} }
switch s.scenarioType { switch s.scenarioType {
case "", "decode":
documentXMLDecodeScenario(w, s)
case "encode": case "encode":
documentXMLEncodeScenario(w, s) documentXMLEncodeScenario(w, s)
case "roundtrip": case "roundtrip":
@ -364,10 +369,10 @@ func documentXMLScenario(t *testing.T, w *bufio.Writer, i interface{}) {
documentXMLDecodeKeepNsScenario(w, s) documentXMLDecodeKeepNsScenario(w, s)
case "decode-raw-token": case "decode-raw-token":
documentXMLDecodeKeepNsRawTokenScenario(w, s) documentXMLDecodeKeepNsRawTokenScenario(w, s)
default:
documentXMLDecodeScenario(w, s)
}
default:
panic(fmt.Sprintf("unhandled scenario type %q", s.scenarioType))
}
} }
func documentXMLDecodeScenario(w *bufio.Writer, s formatScenario) { func documentXMLDecodeScenario(w *bufio.Writer, s formatScenario) {