Skip to content

file: escape written values the default reader would alter #389

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
gaoflow wants to merge 1 commit into
base: main
Choose a base branch
from
+77 −1
Open

file: escape written values the default reader would alter #389

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 10 additions & 1 deletion file.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -463,8 +463,17 @@ func (f *File) writeToBuffer(indent string) (*bytes.Buffer, error) {
val = `"""` + val + `"""`
} else if !f.options.IgnoreInlineComment && strings.ContainsAny(val, "#;") {
val = "`" + val + "`"
} else if hasSurroundedQuote(val, '"') || hasSurroundedQuote(val, '\'') ||
strings.HasPrefix(val, `"""`) {
// Reader would unquote these or read them as a wrapper, so escape.
val = "`" + val + "`"
} else if len(strings.TrimSpace(val)) != len(val) {
val = `"` + val + `"`
if strings.Contains(val, `"`) {
// Reader can't strip "..." with an inner quote; wrap raw instead.
val = "`" + val + "`"
} else {
val = `"` + val + `"`
}
}
if _, err := buf.WriteString(equalSign + val + LineBreak); err != nil {
return false, err
Expand Down
67 changes: 67 additions & 0 deletions file_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -535,3 +535,70 @@ v = 3
require.NoError(t, f.Reload())
assert.Equal(t, []string{"1", "2", "3"}, f.Section("slice").Key("v").ValueWithShadows())
}

func TestFile_WriteTo_ValueRoundTrip(t *testing.T) {
t.Run("values survive the default reader byte-for-byte", func(t *testing.T) {
bt := "`"
cases := []struct {
name string
val string
}{
// Surrounded by matching quotes: the reader would unquote these.
{"double-quoted", `"quoted"`},
{"single-quoted", `'quoted'`},
{"double-quoted empty", `""`},
{"single-quoted empty", `''`},
{"double-quoted spaces", `"a b"`},
{"single-quoted spaces", `'a b'`},
{"double-quoted number", `"123"`},
{"single-quoted number", `'123'`},
{"double-quoted equals", `"a=b"`},
// Leading/trailing spaces around an inner quote break "..." wrapping.
{"space then quote", ` "x" `},
{"quote then space", `"abc `},
// A value opening with """ would be read as a multi-line wrapper.
{"triple-quote wrapped", `"""abc"""`},
{"triple-quote prefix", `"""abc`},
{"four quotes", `""""`},
// No-regression: already-safe values must round-trip unchanged.
{"plain", "some value"},
{"inner quote", `a"b`},
{"quoted list", `"one", "two"`},
{"trailing space", "abc "},
{"three quotes", `"""`},
{"backtick", "a" + bt + "b"},
}
for _, c := range cases {
cfg := Empty()
cfg.Section("").Key("k").SetValue(c.val)
var buf bytes.Buffer
_, err := cfg.WriteTo(&buf)
require.NoError(t, err, c.name)

rc, err := Load(buf.Bytes())
require.NoError(t, err, "%s: reload of %q", c.name, buf.String())
got := rc.Section("").Key("k").String()
assert.Equal(t, c.val, got,
"%s: round-trip mismatch\n in: %q\n ser: %q\n out: %q",
c.name, c.val, buf.String(), got)
}
})

t.Run("safe values are not over-quoted", func(t *testing.T) {
bt := "`"
cases := map[string]string{
"some value": "k = some value\n",
`a"b`: "k = a\"b\n",
`"one", "two"`: "k = \"one\", \"two\"\n",
"a" + bt + "b": "k = \"\"\"a" + bt + "b\"\"\"\n",
}
for val, want := range cases {
cfg := Empty()
cfg.Section("").Key("k").SetValue(val)
var buf bytes.Buffer
_, err := cfg.WriteTo(&buf)
require.NoError(t, err, val)
assert.Equal(t, want, buf.String(), "value %q serialized form", val)
}
})
}