mirror of
https://github.com/mikefarah/yq.git
synced 2026-09-01 22:31:12 +08:00
Add INI support
This commit is contained in:
beliys
@@ -0,0 +1,106 @@
|
||||
//go:build !yq_noini
|
||||
|
||||
package yqlib
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"io"
|
||||
|
||||
"github.com/go-ini/ini"
|
||||
)
|
||||
|
||||
type iniDecoder struct {
|
||||
reader io.Reader
|
||||
finished bool // Flag to signal completion of processing
|
||||
}
|
||||
|
||||
func NewINIDecoder() Decoder {
|
||||
return &iniDecoder{
|
||||
finished: false, // Initialize the flag as false
|
||||
}
|
||||
}
|
||||
|
||||
func (dec *iniDecoder) Init(reader io.Reader) error {
|
||||
// Store the reader for use in Decode
|
||||
dec.reader = reader
|
||||
return nil
|
||||
}
|
||||
|
||||
func (dec *iniDecoder) Decode() (*CandidateNode, error) {
|
||||
// If processing is already finished, return io.EOF
|
||||
if dec.finished {
|
||||
return nil, io.EOF
|
||||
}
|
||||
|
||||
// Read all content from the stored reader
|
||||
content, err := io.ReadAll(dec.reader)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("failed to read INI content: %v", err)
|
||||
}
|
||||
|
||||
// Parse the INI content
|
||||
cfg, err := ini.Load(content)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("failed to parse INI content: %v", err)
|
||||
}
|
||||
|
||||
// Create a root CandidateNode as a MappingNode (since INI is key-value based)
|
||||
root := &CandidateNode{
|
||||
Kind: MappingNode,
|
||||
Tag: "!!map",
|
||||
Value: "",
|
||||
}
|
||||
|
||||
// Process each section in the INI file
|
||||
for _, section := range cfg.Sections() {
|
||||
sectionName := section.Name()
|
||||
|
||||
if sectionName == ini.DefaultSection {
|
||||
// For the default section, add key-value pairs directly to the root node
|
||||
for _, key := range section.Keys() {
|
||||
keyName := key.Name()
|
||||
keyValue := key.String()
|
||||
|
||||
// Create a key node (scalar for the key name)
|
||||
keyNode := createStringScalarNode(keyName)
|
||||
// Create a value node (scalar for the value)
|
||||
valueNode := createStringScalarNode(keyValue)
|
||||
|
||||
// Add key-value pair to the root node
|
||||
root.AddKeyValueChild(keyNode, valueNode)
|
||||
}
|
||||
} else {
|
||||
// For named sections, create a nested map
|
||||
sectionNode := &CandidateNode{
|
||||
Kind: MappingNode,
|
||||
Tag: "!!map",
|
||||
Value: "",
|
||||
}
|
||||
|
||||
// Add key-value pairs to the section node
|
||||
for _, key := range section.Keys() {
|
||||
keyName := key.Name()
|
||||
keyValue := key.String()
|
||||
|
||||
// Create a key node (scalar for the key name)
|
||||
keyNode := createStringScalarNode(keyName)
|
||||
// Create a value node (scalar for the value)
|
||||
valueNode := createStringScalarNode(keyValue)
|
||||
|
||||
// Add key-value pair to the section node
|
||||
sectionNode.AddKeyValueChild(keyNode, valueNode)
|
||||
}
|
||||
|
||||
// Create a key node for the section name
|
||||
sectionKeyNode := createStringScalarNode(sectionName)
|
||||
// Add the section as a nested map to the root node
|
||||
root.AddKeyValueChild(sectionKeyNode, sectionNode)
|
||||
}
|
||||
}
|
||||
|
||||
// Set the finished flag to true to prevent further Decode calls
|
||||
dec.finished = true
|
||||
|
||||
// Return the root node
|
||||
return root, nil
|
||||
}
|
||||
@@ -0,0 +1,115 @@
|
||||
//go:build !yq_noini
|
||||
|
||||
package yqlib
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"fmt"
|
||||
"io"
|
||||
|
||||
"github.com/go-ini/ini"
|
||||
)
|
||||
|
||||
type iniEncoder struct {
|
||||
indentString string
|
||||
}
|
||||
|
||||
// NewINIEncoder creates a new INI encoder with the specified indent level for formatting.
|
||||
func NewINIEncoder(indent int) Encoder {
|
||||
var indentString = ""
|
||||
for index := 0; index < indent; index++ {
|
||||
indentString = indentString + " "
|
||||
}
|
||||
return &iniEncoder{indentString}
|
||||
}
|
||||
|
||||
// CanHandleAliases indicates whether the encoder supports aliases. INI does not support aliases.
|
||||
func (ie *iniEncoder) CanHandleAliases() bool {
|
||||
return false
|
||||
}
|
||||
|
||||
// PrintDocumentSeparator is a no-op since INI does not support multiple documents.
|
||||
func (ie *iniEncoder) PrintDocumentSeparator(_ io.Writer) error {
|
||||
return nil
|
||||
}
|
||||
|
||||
// PrintLeadingContent is a no-op since INI does not support leading content or comments at the encoder level.
|
||||
func (ie *iniEncoder) PrintLeadingContent(_ io.Writer, _ string) error {
|
||||
return nil
|
||||
}
|
||||
|
||||
// Encode converts a CandidateNode into INI format and writes it to the provided writer.
|
||||
func (ie *iniEncoder) Encode(writer io.Writer, node *CandidateNode) error {
|
||||
log.Debugf("I need to encode %v", NodeToString(node))
|
||||
log.Debugf("kids %v", len(node.Content))
|
||||
|
||||
if node.Kind == ScalarNode {
|
||||
return writeStringINI(writer, node.Value+"\n")
|
||||
}
|
||||
|
||||
// Create a new INI configuration.
|
||||
cfg := ini.Empty()
|
||||
|
||||
if node.Kind == MappingNode {
|
||||
// Default section for key-value pairs at the root level.
|
||||
defaultSection, err := cfg.NewSection(ini.DefaultSection)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
// Process the node's content.
|
||||
for i := 0; i < len(node.Content); i += 2 {
|
||||
keyNode := node.Content[i]
|
||||
valueNode := node.Content[i+1]
|
||||
key := keyNode.Value
|
||||
|
||||
if valueNode.Kind == ScalarNode {
|
||||
// Add key-value pair to the default section.
|
||||
_, err := defaultSection.NewKey(key, valueNode.Value)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
} else if valueNode.Kind == MappingNode {
|
||||
// Create a new section for nested MappingNode.
|
||||
section, err := cfg.NewSection(key)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
// Process nested key-value pairs.
|
||||
for j := 0; j < len(valueNode.Content); j += 2 {
|
||||
nestedKeyNode := valueNode.Content[j]
|
||||
nestedValueNode := valueNode.Content[j+1]
|
||||
if nestedValueNode.Kind == ScalarNode {
|
||||
_, err := section.NewKey(nestedKeyNode.Value, nestedValueNode.Value)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
} else {
|
||||
log.Debugf("Skipping nested non-scalar value for key %s: %v", nestedKeyNode.Value, nestedValueNode.Kind)
|
||||
}
|
||||
}
|
||||
} else {
|
||||
log.Debugf("Skipping non-scalar value for key %s: %v", key, valueNode.Kind)
|
||||
}
|
||||
}
|
||||
} else {
|
||||
return fmt.Errorf("INI encoder supports only MappingNode at the root level, got %v", node.Kind)
|
||||
}
|
||||
|
||||
// Use a buffer to store the INI output as the library doesn't support direct io.Writer with indent.
|
||||
var buffer bytes.Buffer
|
||||
_, err := cfg.WriteToIndent(&buffer, ie.indentString)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
// Write the buffer content to the provided writer.
|
||||
_, err = writer.Write(buffer.Bytes())
|
||||
return err
|
||||
}
|
||||
|
||||
// writeStringINI is a helper function to write a string to the provided writer for INI encoder.
|
||||
func writeStringINI(writer io.Writer, content string) error {
|
||||
_, err := writer.Write([]byte(content))
|
||||
return err
|
||||
}
|
||||
@@ -77,6 +77,11 @@ var LuaFormat = &Format{"lua", []string{"l"},
|
||||
func() Decoder { return NewLuaDecoder(ConfiguredLuaPreferences) },
|
||||
}
|
||||
|
||||
var INIFormat = &Format{"ini", []string{"i"},
|
||||
func() Encoder { return NewINIEncoder(0) },
|
||||
func() Decoder { return NewINIDecoder() },
|
||||
}
|
||||
|
||||
var Formats = []*Format{
|
||||
YamlFormat,
|
||||
JSONFormat,
|
||||
@@ -90,6 +95,7 @@ var Formats = []*Format{
|
||||
TomlFormat,
|
||||
ShellVariablesFormat,
|
||||
LuaFormat,
|
||||
INIFormat,
|
||||
}
|
||||
|
||||
func (f *Format) MatchesName(name string) bool {
|
||||
|
||||
@@ -0,0 +1,22 @@
|
||||
package yqlib
|
||||
|
||||
type INIPreferences struct {
|
||||
Indent int
|
||||
ColorsEnabled bool
|
||||
}
|
||||
|
||||
func NewDefaultINIPreferences() INIPreferences {
|
||||
return INIPreferences{
|
||||
Indent: 2,
|
||||
ColorsEnabled: false,
|
||||
}
|
||||
}
|
||||
|
||||
func (p *INIPreferences) Copy() INIPreferences {
|
||||
return INIPreferences{
|
||||
Indent: p.Indent,
|
||||
ColorsEnabled: p.ColorsEnabled,
|
||||
}
|
||||
}
|
||||
|
||||
var ConfiguredINIPreferences = NewDefaultINIPreferences()
|
||||
@@ -0,0 +1,200 @@
|
||||
//go:build !yq_noini
|
||||
|
||||
package yqlib
|
||||
|
||||
import (
|
||||
"bufio"
|
||||
"fmt"
|
||||
"testing"
|
||||
|
||||
"github.com/mikefarah/yq/v4/test"
|
||||
)
|
||||
|
||||
const simpleINIInput = `[section]
|
||||
key = value
|
||||
`
|
||||
|
||||
const expectedSimpleINIOutput = `[section]
|
||||
key = value
|
||||
`
|
||||
|
||||
const expectedSimpleINIYaml = `section:
|
||||
key: value
|
||||
`
|
||||
|
||||
var iniScenarios = []formatScenario{
|
||||
{
|
||||
description: "Parse INI: simple",
|
||||
input: simpleINIInput,
|
||||
scenarioType: "decode",
|
||||
expected: expectedSimpleINIYaml,
|
||||
},
|
||||
{
|
||||
description: "Encode INI: simple",
|
||||
input: `section: {key: value}`,
|
||||
indent: 0,
|
||||
expected: expectedSimpleINIOutput,
|
||||
scenarioType: "encode",
|
||||
},
|
||||
{
|
||||
description: "Roundtrip INI: simple",
|
||||
input: simpleINIInput,
|
||||
expected: expectedSimpleINIOutput,
|
||||
scenarioType: "roundtrip",
|
||||
indent: 0,
|
||||
},
|
||||
{
|
||||
description: "bad ini",
|
||||
input: `[section\nkey = value`,
|
||||
expectedError: `bad file 'sample.yml': failed to parse INI content: unclosed section: [section\nkey = value`,
|
||||
scenarioType: "decode-error",
|
||||
},
|
||||
}
|
||||
|
||||
func documentRoundtripINIScenario(w *bufio.Writer, s formatScenario, indent int) {
|
||||
writeOrPanic(w, fmt.Sprintf("## %v\n", s.description))
|
||||
|
||||
if s.subdescription != "" {
|
||||
writeOrPanic(w, s.subdescription)
|
||||
writeOrPanic(w, "\n\n")
|
||||
}
|
||||
|
||||
writeOrPanic(w, "Given a sample.ini file of:\n")
|
||||
writeOrPanic(w, fmt.Sprintf("```ini\n%v\n```\n", s.input))
|
||||
|
||||
writeOrPanic(w, "then\n")
|
||||
|
||||
expression := s.expression
|
||||
if expression != "" {
|
||||
writeOrPanic(w, fmt.Sprintf("```bash\nyq -p=ini -o=ini -I=%v '%v' sample.ini\n```\n", indent, expression))
|
||||
} else {
|
||||
writeOrPanic(w, fmt.Sprintf("```bash\nyq -p=ini -o=ini -I=%v sample.ini\n```\n", indent))
|
||||
}
|
||||
|
||||
writeOrPanic(w, "will output\n")
|
||||
prefs := ConfiguredINIPreferences.Copy()
|
||||
prefs.Indent = indent
|
||||
|
||||
// Pass prefs.Indent instead of prefs
|
||||
writeOrPanic(w, fmt.Sprintf("```ini\n%v```\n\n", mustProcessFormatScenario(s, NewINIDecoder(), NewINIEncoder(prefs.Indent))))
|
||||
}
|
||||
|
||||
func documentDecodeINIScenario(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.ini file of:\n")
|
||||
writeOrPanic(w, fmt.Sprintf("```ini\n%v\n```\n", s.input))
|
||||
|
||||
writeOrPanic(w, "then\n")
|
||||
|
||||
expression := s.expression
|
||||
if expression != "" {
|
||||
writeOrPanic(w, fmt.Sprintf("```bash\nyq -p=ini '%v' sample.ini\n```\n", expression))
|
||||
} else {
|
||||
writeOrPanic(w, "```bash\nyq -p=ini sample.ini\n```\n")
|
||||
}
|
||||
|
||||
writeOrPanic(w, "will output\n")
|
||||
|
||||
writeOrPanic(w, fmt.Sprintf("```yaml\n%v```\n\n", mustProcessFormatScenario(s, NewINIDecoder(), NewYamlEncoder(ConfiguredYamlPreferences))))
|
||||
}
|
||||
|
||||
func testINIScenario(t *testing.T, s formatScenario) {
|
||||
prefs := ConfiguredINIPreferences.Copy()
|
||||
prefs.Indent = s.indent
|
||||
switch s.scenarioType {
|
||||
case "encode":
|
||||
// Pass prefs.Indent instead of prefs
|
||||
test.AssertResultWithContext(t, s.expected, mustProcessFormatScenario(s, NewYamlDecoder(ConfiguredYamlPreferences), NewINIEncoder(prefs.Indent)), s.description)
|
||||
case "decode":
|
||||
test.AssertResultWithContext(t, s.expected, mustProcessFormatScenario(s, NewINIDecoder(), NewYamlEncoder(ConfiguredYamlPreferences)), s.description)
|
||||
case "roundtrip":
|
||||
// Pass prefs.Indent instead of prefs
|
||||
test.AssertResultWithContext(t, s.expected, mustProcessFormatScenario(s, NewINIDecoder(), NewINIEncoder(prefs.Indent)), s.description)
|
||||
case "decode-error":
|
||||
// Pass prefs.Indent instead of prefs
|
||||
result, err := processFormatScenario(s, NewINIDecoder(), NewINIEncoder(prefs.Indent))
|
||||
if err == nil {
|
||||
t.Errorf("Expected error '%v' but it worked: %v", s.expectedError, result)
|
||||
} else {
|
||||
test.AssertResultComplexWithContext(t, s.expectedError, err.Error(), s.description)
|
||||
}
|
||||
default:
|
||||
panic(fmt.Sprintf("unhandled scenario type %q", s.scenarioType))
|
||||
}
|
||||
}
|
||||
|
||||
func documentINIScenario(t *testing.T, w *bufio.Writer, i interface{}) {
|
||||
s := i.(formatScenario)
|
||||
if s.skipDoc {
|
||||
return
|
||||
}
|
||||
switch s.scenarioType {
|
||||
case "encode":
|
||||
documentINIEncodeScenario(w, s)
|
||||
case "decode":
|
||||
documentDecodeINIScenario(w, s)
|
||||
case "roundtrip":
|
||||
documentRoundtripINIScenario(w, s, s.indent)
|
||||
case "decode-error":
|
||||
// Add handling for decode-error scenario type to prevent panic
|
||||
writeOrPanic(w, fmt.Sprintf("## %v\n", s.description))
|
||||
if s.subdescription != "" {
|
||||
writeOrPanic(w, s.subdescription)
|
||||
writeOrPanic(w, "\n\n")
|
||||
}
|
||||
writeOrPanic(w, "Given a sample.ini file of:\n")
|
||||
writeOrPanic(w, fmt.Sprintf("```ini\n%v\n```\n", s.input))
|
||||
writeOrPanic(w, "then an error is expected:\n")
|
||||
writeOrPanic(w, fmt.Sprintf("```\n%v\n```\n\n", s.expectedError))
|
||||
default:
|
||||
panic(fmt.Sprintf("unhandled scenario type %q", s.scenarioType))
|
||||
}
|
||||
}
|
||||
|
||||
func documentINIEncodeScenario(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 == "" {
|
||||
expression = "."
|
||||
}
|
||||
|
||||
if s.indent == 2 {
|
||||
writeOrPanic(w, fmt.Sprintf("```bash\nyq -o=ini '%v' sample.yml\n```\n", expression))
|
||||
} else {
|
||||
writeOrPanic(w, fmt.Sprintf("```bash\nyq -o=ini -I=%v '%v' sample.yml\n```\n", s.indent, expression))
|
||||
}
|
||||
writeOrPanic(w, "will output\n")
|
||||
prefs := ConfiguredINIPreferences.Copy()
|
||||
prefs.Indent = s.indent
|
||||
|
||||
// Pass prefs.Indent instead of prefs
|
||||
writeOrPanic(w, fmt.Sprintf("```ini\n%v```\n\n", mustProcessFormatScenario(s, NewYamlDecoder(ConfiguredYamlPreferences), NewINIEncoder(prefs.Indent))))
|
||||
}
|
||||
|
||||
func TestINIScenarios(t *testing.T) {
|
||||
for _, tt := range iniScenarios {
|
||||
testINIScenario(t, tt)
|
||||
}
|
||||
genericScenarios := make([]interface{}, len(iniScenarios))
|
||||
for i, s := range iniScenarios {
|
||||
genericScenarios[i] = s
|
||||
}
|
||||
documentScenarios(t, "usage", "convert", genericScenarios, documentINIScenario)
|
||||
}
|
||||
@@ -0,0 +1,11 @@
|
||||
//go:build yq_noini
|
||||
|
||||
package yqlib
|
||||
|
||||
func NewINIDecoder() Decoder {
|
||||
return nil
|
||||
}
|
||||
|
||||
func NewINIEncoder(indent int) Encoder {
|
||||
return nil
|
||||
}
|
||||
Reference in New Issue
Block a user