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

Decoder Properties (#1099)

Browse Source 
* Decoder Properties

* Added properties round trip test

* Fixed property decode for github actions

* Refactored XML test to use common functions

* Switched formatScenario parameter order for more readablity
This commit is contained in:
Mike Farah
2022-02-10 12:02:53 +11:00
committed by GitHub
parent 4d4bd5114d
commit a9c3617b4f
14 changed files with 464 additions and 191 deletions
Download Patch File Download Diff File Expand all files Collapse all files
pkg/yqlib/properties_test.go
+109 -9
View File
@@ -26,6 +26,22 @@ person.pets.0 = cat
person.food.0 = pizza
`
var expectedUpdatedProperties = `# comments on values appear
person.name = Mike
# comments on array values appear
person.pets.0 = dog
person.food.0 = pizza
`
var expectedDecodedYaml = `person:
name: Mike # comments on values appear
pets:
- cat # comments on array values appear
food:
- pizza
`
var expectedPropertiesNoComments = `person.name = Mike
person.pets.0 = cat
person.food.0 = pizza
@@ -61,10 +77,29 @@ var propertyScenarios = []formatScenario{
input: samplePropertiesYaml,
expected: expectedPropertiesWithEmptyMapsAndArrays,
},
{
description: "Decode properties",
input: expectedProperties,
expected: expectedDecodedYaml,
scenarioType: "decode",
},
{
description: "Roundtrip",
input: expectedProperties,
expression: `.person.pets.0 = "dog"`,
expected: expectedUpdatedProperties,
scenarioType: "roundtrip",
},
{
description: "Empty doc",
skipDoc: true,
input: "",
expected: "",
scenarioType: "decode",
},
}
func documentPropertyScenario(t *testing.T, w *bufio.Writer, i interface{}) {
s := i.(formatScenario)
func documentEncodePropertyScenario(w *bufio.Writer, s formatScenario) {
writeOrPanic(w, fmt.Sprintf("## %v\n", s.description))
if s.subdescription != "" {
@@ -78,23 +113,88 @@ func documentPropertyScenario(t *testing.T, w *bufio.Writer, i interface{}) {
writeOrPanic(w, "then\n")
expression := s.expression
if expression == "" {
expression = "."
}
if s.indent == 2 {
if expression != "" {
writeOrPanic(w, fmt.Sprintf("```bash\nyq -o=props '%v' sample.yml\n```\n", expression))
} else {
writeOrPanic(w, fmt.Sprintf("```bash\nyq -o=props -I=%v '%v' sample.yml\n```\n", s.indent, expression))
writeOrPanic(w, "```bash\nyq -o=props sample.yml\n```\n")
}
writeOrPanic(w, "will output\n")
writeOrPanic(w, fmt.Sprintf("```properties\n%v```\n\n", processFormatScenario(s, NewPropertiesEncoder())))
writeOrPanic(w, fmt.Sprintf("```properties\n%v```\n\n", processFormatScenario(s, NewYamlDecoder(), NewPropertiesEncoder())))
}
func documentDecodePropertyScenario(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.properties file of:\n")
writeOrPanic(w, fmt.Sprintf("```properties\n%v\n```\n", s.input))
writeOrPanic(w, "then\n")
expression := s.expression
if expression != "" {
writeOrPanic(w, fmt.Sprintf("```bash\nyq -p=props '%v' sample.properties\n```\n", expression))
} else {
writeOrPanic(w, "```bash\nyq -p=props sample.properties\n```\n")
}
writeOrPanic(w, "will output\n")
writeOrPanic(w, fmt.Sprintf("```yaml\n%v```\n\n", processFormatScenario(s, NewPropertiesDecoder(), NewYamlEncoder(s.indent, false, true, true))))
}
func documentRoundTripPropertyScenario(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.properties file of:\n")
writeOrPanic(w, fmt.Sprintf("```properties\n%v\n```\n", s.input))
writeOrPanic(w, "then\n")
expression := s.expression
if expression != "" {
writeOrPanic(w, fmt.Sprintf("```bash\nyq -p=props -o=props '%v' sample.properties\n```\n", expression))
} else {
writeOrPanic(w, "```bash\nyq -p=props -o=props sample.properties\n```\n")
}
writeOrPanic(w, "will output\n")
writeOrPanic(w, fmt.Sprintf("```properties\n%v```\n\n", processFormatScenario(s, NewPropertiesDecoder(), NewPropertiesEncoder())))
}
func documentPropertyScenario(t *testing.T, w *bufio.Writer, i interface{}) {
s := i.(formatScenario)
if s.scenarioType == "decode" {
documentDecodePropertyScenario(w, s)
} else if s.scenarioType == "roundtrip" {
documentRoundTripPropertyScenario(w, s)
} else {
documentEncodePropertyScenario(w, s)
}
}
func TestPropertyScenarios(t *testing.T) {
for _, s := range propertyScenarios {
test.AssertResultWithContext(t, s.expected, processFormatScenario(s, NewPropertiesEncoder()), s.description)
if s.scenarioType == "decode" {
test.AssertResultWithContext(t, s.expected, processFormatScenario(s, NewPropertiesDecoder(), NewYamlEncoder(2, false, true, true)), s.description)
} else if s.scenarioType == "roundtrip" {
test.AssertResultWithContext(t, s.expected, processFormatScenario(s, NewPropertiesDecoder(), NewPropertiesEncoder()), s.description)
} else {
test.AssertResultWithContext(t, s.expected, processFormatScenario(s, NewYamlDecoder(), NewPropertiesEncoder()), s.description)
}
}
genericScenarios := make([]interface{}, len(propertyScenarios))
for i, s := range propertyScenarios {