1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
|
package envparse
import (
"bytes"
"strings"
"testing"
)
func TestParse_OK(t *testing.T) {
buf := []byte(`# Start of file
FIRST=key and value pair
_=_ # ok
_2=_2 # ok
FIRST="overwrite # original" #...
`)
env, err := Parse(bytes.NewReader(buf))
if err != nil {
t.Fatalf("unexpected error: %v", err)
}
if len(env) != 3 {
t.Fatalf("expected 3 keys but found %d: %#v", len(env), env)
}
if expected := "overwrite # original"; env["FIRST"] != expected {
t.Errorf("expected FIRST=%q but found %q", expected, env["FIRST"])
}
if env["_"] != "_" {
t.Errorf("expected _=_ but found: %q", env["_"])
}
if env["_2"] != "_2" {
t.Errorf("expected _2=_2 but found: %q", env["_2"])
}
}
func TestParse_Err(t *testing.T) {
cases := []struct {
name string
buf string
n int
err error
}{
{"MissingEqual", "FOO=bar\nx\nXYZ=1\n", 2, ErrMissingSeparator},
{"NewlineInDoubleQuote", "A=1\nB=\"foo\nbar\"\nC=3\n", 2, ErrUnmatchedDouble},
{"NewLineInSingleQuote", "A=2\nB='foo\nbar'\nC=3", 2, ErrUnmatchedSingle},
{"CheckLineCount", "\n\n\n\n\nA=1 # ok\n# ok\n\n\nU=\"\\\xFF\"", 10, ErrMultibyteEscape},
}
for _, c := range cases {
t.Run(c.name, func(t *testing.T) {
env, err := Parse(bytes.NewReader([]byte(c.buf)))
if err == nil {
t.Fatalf("error=%v env=%#v", err, env)
}
perr := err.(*ParseError)
if c.n != perr.Line || (c.err != nil && c.err != perr.Err) {
t.Errorf("expected error [%v] on line (%d) but found error [%v] on line (%d)",
c.err, c.n, perr.Err, perr.Line)
}
if c.err == nil {
t.Logf("unchecked (expected) error: %v", err)
}
})
}
}
func TestParseLine_OK(t *testing.T) {
cases := []struct {
name string
ln string
k string
v string
}{
{"Empty", "", "", ""},
{"Emptyish", " ", "", ""},
{"OnlyComment", "# ...", "", ""},
{"OnlyCommentish", " # ...", "", ""},
{"EmptyValue", "FoO=", "FoO", ""},
{"EmptyValueComment", "F=# ...", "F", ""},
{"EmptyValueSpace", "F_O= ", "F_O", ""},
{"EmptyValueSpaceComment", "F= # ...", "F", ""},
{"Simple", "FOO=bar", "FOO", "bar"},
{"Export", "export FOO=bar", "FOO", "bar"},
{"Spaces", " FOO = bar baz ", "FOO", "bar baz"},
{"Tabs", " FOO = bar ", "FOO", "bar"},
{"ExportSpaces", "export FOO = bar", "FOO", "bar"},
{"ExportAsKey", "export = bar", "export", "bar"},
{"Nums", "A1B2C3=a1b2c3", "A1B2C3", "a1b2c3"},
{"Comments", "FOO=bar # ok", "FOO", "bar"},
{"EmptyComments1", "FOO=#bar#", "FOO", ""},
{"EmptyComments2", "FOO= # bar ", "FOO", ""},
{"DoubleQuotes", `FOO="bar#"`, "FOO", "bar#"},
{"DoubleQuoteNewline", `FOO="bar\n"`, "FOO", "bar\n"},
{"DoubleQuoteNewlineComment", `FOO="bar\n" # comment`, "FOO", "bar\n"},
{"DoubleQuoteSpaces", `FOO = " bar\t" `, "FOO", " bar\t"},
{"SingleQuotes", "FOO='bar#'", "FOO", "bar#"},
{"SingleQuotesNewline", `FOO='\n' # empty`, "FOO", "\\n"},
{"SingleQuotesEmpty", "FOO='' # empty", "FOO", ""},
{"NormalSingleMix", "FOO=normal'single ' ", "FOO", "normalsingle "},
{"NormalDoubleMix", `FOO= "double\\" normal # "EOL"`, "FOO", "double\\ normal"},
{"AllModes", `export FOO = 'single\n' \\normal\t "double\"\n " # comment`, "FOO", "single\\n \\\\normal\\t double\"\n "},
{"UnicodeLiteral", "U1=\U0001F525", "U1", "\U0001F525"},
{"UnicodeLiteralQuoted", "U2= ' \U0001F525 ' ", "U2", " \U0001F525 "},
{"EscapedUnicode1byte", `U3="\u2318"`, "U3", "\U00002318"},
{"EscapedUnicode2byte", `U3="\uD83D\uDE01"`, "U3", "\U0001F601"},
{"EscapedUnicodeCombined", `U4="\u2318\uD83D\uDE01"`, "U4", "\U00002318\U0001F601"},
{"README.mdEscapedUnicode", `FOO="The template value\nmay have included\nsome newlines!\n\ud83d\udd25"`, "FOO", "The template value\nmay have included\nsome newlines!\nš„"},
{"UnderscoreKey", "_=x' ' ", "_", "x "},
{"DottedKey", "FOO.BAR=x", "FOO.BAR", "x"},
{"FwdSlashedKey", "FOO/BAR=x", "FOO/BAR", "x"},
{"README.md", `SOME_KEY = normal unquoted \text 'plus single quoted\' "\"double quoted " # EOL`, "SOME_KEY", `normal unquoted \text plus single quoted\ "double quoted `},
{"WindowsNewline", `w="\r\n"`, "w", "\r\n"},
}
for _, c := range cases {
t.Run(c.name, func(t *testing.T) {
k, v, err := parseLine([]byte(c.ln))
if err != nil {
t.Fatalf("error: %v", err)
}
if string(k) != c.k {
t.Errorf("expected key %q but found %q", c.k, string(k))
}
if string(v) != c.v {
t.Errorf("expected value %q but found [%s] - %q", c.v, string(v), string(v))
}
})
}
}
func TestParseLine_Err(t *testing.T) {
cases := []struct {
name string
ln string
// Either exact err or partial error message should be set
err error
partial string
}{
{"MissingEqual", "foo bar", ErrMissingSeparator, ""},
{"EmptyKey", "=bar", ErrEmptyKey, ""},
{"EqualOnly", "=", ErrEmptyKey, ""},
{"InvalidKey", "1abc=x", nil, "key"},
{"InvalidKey2", "@abc=x", nil, "key"},
{"InvalidKey3", "a b c=x", nil, "key"},
{"InvalidKey4", "a\nb=x", nil, "key"},
{"InvalidValue", "FOO=\x00", nil, "value"},
{"OpenDoubleQuote", `FOO=" bar`, ErrUnmatchedDouble, ""},
{"OpenSingleQuote", `FOO=' bar`, ErrUnmatchedSingle, ""},
{"UnmatchedMix", `FOO=ok '"ok"' \"not ok ''`, ErrUnmatchedDouble, ""},
{"UnmatchedMix2", `FOO=ok '"ok"' \"not ok '"'`, ErrUnmatchedSingle, ""},
{"InvalidEscape", `FOO="\a"`, nil, `"a"`},
{"IncompleteEscape", `FOO="\`, ErrIncompleteEscape, ""},
{"IncompleteHex", `FOO="\u12"`, ErrIncompleteHex, ""},
{"InvalidHex", `FOO="\uabcZ"`, nil, `"Z"`},
{"IncompleteSurrogatePair1", `FOO="abc \uD83D"`, ErrIncompleteSur, ""},
{"IncompleteSurrogatePair2", `FOO="abc \uD83D \uDE01"`, ErrIncompleteSur, ""},
{"IncompleteSurrogatePair3", `FOO="abc \uD83DDE01"`, ErrIncompleteSur, ""},
{"IncompleteSurrogatePair4", `FOO="abc \uD83D\uDE0"`, nil, `"\""`},
}
for _, c := range cases {
t.Run(c.name, func(t *testing.T) {
k, v, err := parseLine([]byte(c.ln))
if err == nil {
t.Fatalf("err == nil; found: %s=%q", k, v)
}
if c.err != nil && c.err != err {
t.Errorf("expected err=%v but found %v", c.err, err)
}
if c.partial != "" && !strings.Contains(err.Error(), c.partial) {
t.Errorf("expected err to contain %q but found %v", c.partial, err)
}
})
}
}
func BenchmarkParseLine_Simple(b *testing.B) {
line := []byte("FOO=bar")
b.ResetTimer()
for i := 0; i < b.N; i++ {
k, v, err := parseLine(line)
if err != nil {
b.Fatalf("unexpected error: %v", err)
}
if len(k) != 3 {
b.Fatalf("unexpected key: %q (%d)", k, len(k))
}
if len(v) != 3 {
b.Fatalf("unexpected value: %q (%d)", v, len(v))
}
}
}
func BenchmarkParseLine_Complex(b *testing.B) {
line := []byte(`export FOO = bar"baz'\n'\t " ā '#\n\t' "#\uD83D\ude01" # a really # long # comment!!!1111 `)
b.ResetTimer()
for i := 0; i < b.N; i++ {
k, v, err := parseLine(line)
if err != nil {
b.Fatalf("unexpected error: %v", err)
}
if len(k) != 3 {
b.Fatalf("unexpected key: %q (%d)", k, len(k))
}
if len(v) != 27 {
b.Fatalf("unexpected value: %q (%d)", v, len(v))
}
}
}
|
