suyiiyii/yq
1
0
Fork 0
mirror of https://github.com/mikefarah/yq.git synced 2025-01-31 03:35:56 +00:00
Code Issues Packages Projects Releases Wiki Activity

Refactored XML test to use common functions

Browse Source
This commit is contained in:
Mike Farah 2022-02-10 11:49:45 +11:00
parent 3ac531ce74
commit 8bce6ff4a2
1 changed files with 22 additions and 97 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

119
pkg/yqlib/xml_test.go
View File

@ -2,77 +2,12 @@ package yqlib
import ( import (
"bufio" "bufio"
"bytes"
"errors"
"fmt" "fmt"
"io"
"strings"
"testing" "testing"
"github.com/mikefarah/yq/v4/test" "github.com/mikefarah/yq/v4/test"
yaml "gopkg.in/yaml.v3"
) )
func decodeXML(t *testing.T, s formatScenario) *CandidateNode {
decoder := NewXMLDecoder("+", "+content")
decoder.Init(strings.NewReader(s.input))
node := &yaml.Node{}
err := decoder.Decode(node)
if err != nil && !errors.Is(err, io.EOF) {
t.Error(err, "fail to decode", s.input)
}
expression := s.expression
if expression == "" {
expression = "."
}
exp, err := getExpressionParser().ParseExpression(expression)
if err != nil {
t.Error(err)
return nil
}
candidateNode := CandidateNode{Node: node}
context, err := NewDataTreeNavigator().GetMatchingNodes(Context{MatchingNodes: candidateNode.AsList()}, exp)
if err != nil {
t.Error(err)
return nil
}
return context.MatchingNodes.Front().Value.(*CandidateNode)
}
func processXMLScenario(s formatScenario) string {
var output bytes.Buffer
writer := bufio.NewWriter(&output)
var encoder = NewXMLEncoder(2, "+", "+content")
var decoder = NewYamlDecoder()
if s.scenarioType == "roundtrip" {
decoder = NewXMLDecoder("+", "+content")
}
inputs, err := readDocuments(strings.NewReader(s.input), "sample.yml", 0, decoder)
if err != nil {
panic(err)
}
node := inputs.Front().Value.(*CandidateNode).Node
err = encoder.Encode(writer, node)
if err != nil {
panic(err)
}
writer.Flush()
return output.String()
}
type formatScenario struct { type formatScenario struct {
input string input string
indent int indent int
@ -121,7 +56,7 @@ for x --></x>
<!-- after cat --> <!-- after cat -->
` `
var expectedDecodeYamlWithSubChild = `D0, P[], (doc)::# before cat var expectedDecodeYamlWithSubChild = `# before cat
cat: cat:
# in cat before # in cat before
x: "3" # multi x: "3" # multi
@ -161,7 +96,7 @@ for x --></x>
<!-- after cat --> <!-- after cat -->
` `
var expectedDecodeYamlWithArray = `D0, P[], (doc)::# before cat var expectedDecodeYamlWithArray = `# before cat
cat: cat:
# in cat before # in cat before
x: "3" # multi x: "3" # multi
@ -185,7 +120,7 @@ cat:
# after cat # after cat
` `
var expectedDecodeYamlWithComments = `D0, P[], (doc)::# before cat var expectedDecodeYamlWithComments = `# before cat
cat: cat:
# in cat before # in cat before
x: "3" # multi x: "3" # multi
@ -234,32 +169,32 @@ var xmlScenarios = []formatScenario{
description: "Parse xml: simple", description: "Parse xml: simple",
subdescription: "Notice how all the values are strings, see the next example on how you can fix that.", subdescription: "Notice how all the values are strings, see the next example on how you can fix that.",
input: "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<cat>\n <says>meow</says>\n <legs>4</legs>\n <cute>true</cute>\n</cat>", input: "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<cat>\n <says>meow</says>\n <legs>4</legs>\n <cute>true</cute>\n</cat>",
expected: "D0, P[], (doc)::cat:\n says: meow\n legs: \"4\"\n cute: \"true\"\n", expected: "cat:\n says: meow\n legs: \"4\"\n cute: \"true\"\n",
}, },
{ {
description: "Parse xml: number", description: "Parse xml: number",
subdescription: "All values are assumed to be strings when parsing XML, but you can use the `from_yaml` operator on all the strings values to autoparse into the correct type.", subdescription: "All values are assumed to be strings when parsing XML, but you can use the `from_yaml` operator on all the strings values to autoparse into the correct type.",
input: "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<cat>\n <says>meow</says>\n <legs>4</legs>\n <cute>true</cute>\n</cat>", input: "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<cat>\n <says>meow</says>\n <legs>4</legs>\n <cute>true</cute>\n</cat>",
expression: " (.. | select(tag == \"!!str\")) |= from_yaml", expression: " (.. | select(tag == \"!!str\")) |= from_yaml",
expected: "D0, P[], ()::cat:\n says: meow\n legs: 4\n cute: true\n", expected: "cat:\n says: meow\n legs: 4\n cute: true\n",
}, },
{ {
description: "Parse xml: array", description: "Parse xml: array",
subdescription: "Consecutive nodes with identical xml names are assumed to be arrays.", subdescription: "Consecutive nodes with identical xml names are assumed to be arrays.",
input: "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<animal>cat</animal>\n<animal>goat</animal>", input: "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<animal>cat</animal>\n<animal>goat</animal>",
expected: "D0, P[], (doc)::animal:\n - cat\n - goat\n", expected: "animal:\n - cat\n - goat\n",
}, },
{ {
description: "Parse xml: attributes", description: "Parse xml: attributes",
subdescription: "Attributes are converted to fields, with the default attribute prefix '+'. Use '--xml-attribute-prefix` to set your own.", subdescription: "Attributes are converted to fields, with the default attribute prefix '+'. Use '--xml-attribute-prefix` to set your own.",
input: "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<cat legs=\"4\">\n <legs>7</legs>\n</cat>", input: "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<cat legs=\"4\">\n <legs>7</legs>\n</cat>",
expected: "D0, P[], (doc)::cat:\n +legs: \"4\"\n legs: \"7\"\n", expected: "cat:\n +legs: \"4\"\n legs: \"7\"\n",
}, },
{ {
description: "Parse xml: attributes with content", description: "Parse xml: attributes with content",
subdescription: "Content is added as a field, using the default content name of `+content`. Use `--xml-content-name` to set your own.", subdescription: "Content is added as a field, using the default content name of `+content`. Use `--xml-content-name` to set your own.",
input: "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<cat legs=\"4\">meow</cat>", input: "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<cat legs=\"4\">meow</cat>",
expected: "D0, P[], (doc)::cat:\n +content: meow\n +legs: \"4\"\n", expected: "cat:\n +content: meow\n +legs: \"4\"\n",
}, },
{ {
description: "Parse xml: with comments", description: "Parse xml: with comments",
@ -272,28 +207,28 @@ var xmlScenarios = []formatScenario{
description: "Empty doc", description: "Empty doc",
skipDoc: true, skipDoc: true,
input: "", input: "",
expected: "D0, P[], ()::null\n", expected: "",
scenarioType: "decode", scenarioType: "decode",
}, },
{ {
description: "Empty single node", description: "Empty single node",
skipDoc: true, skipDoc: true,
input: "<a/>", input: "<a/>",
expected: "D0, P[], (doc)::a:\n", expected: "a:\n",
scenarioType: "decode", scenarioType: "decode",
}, },
{ {
description: "Empty close node", description: "Empty close node",
skipDoc: true, skipDoc: true,
input: "<a></a>", input: "<a></a>",
expected: "D0, P[], (doc)::a:\n", expected: "a:\n",
scenarioType: "decode", scenarioType: "decode",
}, },
{ {
description: "Nested empty", description: "Nested empty",
skipDoc: true, skipDoc: true,
input: "<a><b/></a>", input: "<a><b/></a>",
expected: "D0, P[], (doc)::a:\n b:\n", expected: "a:\n b:\n",
scenarioType: "decode", scenarioType: "decode",
}, },
{ {
@ -359,11 +294,12 @@ var xmlScenarios = []formatScenario{
} }
func testXMLScenario(t *testing.T, s formatScenario) { func testXMLScenario(t *testing.T, s formatScenario) {
if s.scenarioType == "encode" || s.scenarioType == "roundtrip" { if s.scenarioType == "encode" {
test.AssertResultWithContext(t, s.expected, processXMLScenario(s), s.description) test.AssertResultWithContext(t, s.expected, processFormatScenario(s, NewXMLEncoder(2, "+", "+content"), NewYamlDecoder()), s.description)
} else if s.scenarioType == "roundtrip" {
test.AssertResultWithContext(t, s.expected, processFormatScenario(s, NewXMLEncoder(2, "+", "+content"), NewXMLDecoder("+", "+content")), s.description)
} else { } else {
var actual = resultToString(t, decodeXML(t, s)) test.AssertResultWithContext(t, s.expected, processFormatScenario(s, NewYamlEncoder(4, false, true, true), NewXMLDecoder("+", "+content")), s.description)
test.AssertResultWithContext(t, s.expected, actual, s.description)
} }
} }
@ -378,12 +314,12 @@ func documentXMLScenario(t *testing.T, w *bufio.Writer, i interface{}) {
} else if s.scenarioType == "roundtrip" { } else if s.scenarioType == "roundtrip" {
documentXMLRoundTripScenario(w, s) documentXMLRoundTripScenario(w, s)
} else { } else {
documentXMLDecodeScenario(t, w, s) documentXMLDecodeScenario(w, s)
} }
} }
func documentXMLDecodeScenario(t *testing.T, w *bufio.Writer, s formatScenario) { func documentXMLDecodeScenario(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 != "" {
@ -402,18 +338,7 @@ func documentXMLDecodeScenario(t *testing.T, w *bufio.Writer, s formatScenario)
writeOrPanic(w, fmt.Sprintf("```bash\nyq -p=xml '%v' sample.xml\n```\n", expression)) writeOrPanic(w, fmt.Sprintf("```bash\nyq -p=xml '%v' sample.xml\n```\n", expression))
writeOrPanic(w, "will output\n") writeOrPanic(w, "will output\n")
var output bytes.Buffer writeOrPanic(w, fmt.Sprintf("```yaml\n%v```\n\n", processFormatScenario(s, NewYamlEncoder(2, false, true, true), NewXMLDecoder("+", "+content"))))
printer := NewSimpleYamlPrinter(bufio.NewWriter(&output), YamlOutputFormat, true, false, 2, true)
node := decodeXML(t, s)
err := printer.PrintResults(node.AsList())
if err != nil {
t.Error(err)
return
}
writeOrPanic(w, fmt.Sprintf("```yaml\n%v```\n\n", output.String()))
} }
func documentXMLEncodeScenario(w *bufio.Writer, s formatScenario) { func documentXMLEncodeScenario(w *bufio.Writer, s formatScenario) {
@ -431,7 +356,7 @@ func documentXMLEncodeScenario(w *bufio.Writer, s formatScenario) {
writeOrPanic(w, "```bash\nyq -o=xml '.' sample.yml\n```\n") writeOrPanic(w, "```bash\nyq -o=xml '.' sample.yml\n```\n")
writeOrPanic(w, "will output\n") writeOrPanic(w, "will output\n")
writeOrPanic(w, fmt.Sprintf("```xml\n%v```\n\n", processXMLScenario(s))) writeOrPanic(w, fmt.Sprintf("```xml\n%v```\n\n", processFormatScenario(s, NewXMLEncoder(2, "+", "+content"), NewYamlDecoder())))
} }
func documentXMLRoundTripScenario(w *bufio.Writer, s formatScenario) { func documentXMLRoundTripScenario(w *bufio.Writer, s formatScenario) {
@ -449,7 +374,7 @@ func documentXMLRoundTripScenario(w *bufio.Writer, s formatScenario) {
writeOrPanic(w, "```bash\nyq -p=xml -o=xml '.' sample.xml\n```\n") writeOrPanic(w, "```bash\nyq -p=xml -o=xml '.' sample.xml\n```\n")
writeOrPanic(w, "will output\n") writeOrPanic(w, "will output\n")
writeOrPanic(w, fmt.Sprintf("```xml\n%v```\n\n", processXMLScenario(s))) writeOrPanic(w, fmt.Sprintf("```xml\n%v```\n\n", processFormatScenario(s, NewXMLEncoder(2, "+", "+content"), NewXMLDecoder("+", "+content"))))
} }
func TestXMLScenarios(t *testing.T) { func TestXMLScenarios(t *testing.T) {