-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathenv_preload_test.go
More file actions
449 lines (398 loc) · 13.3 KB
/
env_preload_test.go
File metadata and controls
449 lines (398 loc) · 13.3 KB
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
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
package redant
import (
"os"
"path/filepath"
"strings"
"testing"
)
func TestParseShortEFlag(t *testing.T) {
tests := []struct {
name string
arg string
wantValue string
wantInline bool
wantParsedFlag bool
}{
{name: "short without inline", arg: "-e", wantValue: "", wantInline: false, wantParsedFlag: true},
{name: "short attached value", arg: "-eA=1", wantValue: "A=1", wantInline: true, wantParsedFlag: true},
{name: "short equals value", arg: "-e=A=1", wantValue: "A=1", wantInline: true, wantParsedFlag: true},
{name: "other short flag", arg: "-x", wantValue: "", wantInline: false, wantParsedFlag: false},
{name: "long flag should ignore", arg: "--env", wantValue: "", wantInline: false, wantParsedFlag: false},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
value, inline, parsed := parseShortEFlag(tt.arg)
if value != tt.wantValue || inline != tt.wantInline || parsed != tt.wantParsedFlag {
t.Fatalf("got value=%q inline=%v parsed=%v, want value=%q inline=%v parsed=%v",
value, inline, parsed,
tt.wantValue, tt.wantInline, tt.wantParsedFlag,
)
}
})
}
}
func TestParseLongFlag(t *testing.T) {
tests := []struct {
name string
arg string
wantName string
wantValue string
wantInline bool
wantParsed bool
}{
{name: "plain long", arg: "--env", wantName: "env", wantValue: "", wantInline: false, wantParsed: true},
{name: "long with equals", arg: "--env=A=1", wantName: "env", wantValue: "A=1", wantInline: true, wantParsed: true},
{name: "single dash", arg: "-e", wantParsed: false},
{name: "double dash only", arg: "--", wantParsed: false},
{name: "non flag", arg: "env", wantParsed: false},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
name, value, inline, parsed := parseLongFlag(tt.arg)
if name != tt.wantName || value != tt.wantValue || inline != tt.wantInline || parsed != tt.wantParsed {
t.Fatalf("got name=%q value=%q inline=%v parsed=%v, want name=%q value=%q inline=%v parsed=%v",
name, value, inline, parsed,
tt.wantName, tt.wantValue, tt.wantInline, tt.wantParsed,
)
}
})
}
}
func TestParseEnvFlagFromArgs(t *testing.T) {
tests := []struct {
name string
args []string
index int
wantName string
wantValue string
wantOK bool
wantErr string
}{
{name: "long env next arg", args: []string{"--env", "A=1"}, index: 0, wantName: "env", wantValue: "A=1", wantOK: true},
{name: "long env inline", args: []string{"--env=A=1"}, index: 0, wantName: "env", wantValue: "A=1", wantOK: true},
{name: "short env next arg", args: []string{"-e", "A=1"}, index: 0, wantName: "env", wantValue: "A=1", wantOK: true},
{name: "short env inline", args: []string{"-eA=1"}, index: 0, wantName: "env", wantValue: "A=1", wantOK: true},
{name: "env file next arg", args: []string{"--env-file", ".env"}, index: 0, wantName: "env-file", wantValue: ".env", wantOK: true},
{name: "env file inline", args: []string{"--env-file=.env,.env.local"}, index: 0, wantName: "env-file", wantValue: ".env,.env.local", wantOK: true},
{name: "missing long env value", args: []string{"--env"}, index: 0, wantErr: "requires a value"},
{name: "missing short env value", args: []string{"-e"}, index: 0, wantErr: "requires a value"},
{name: "unknown flag", args: []string{"--name", "demo"}, index: 0, wantOK: false},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
name, value, ok, err := parseEnvFlagFromArgs(tt.args, tt.index)
if tt.wantErr != "" {
if err == nil || !strings.Contains(err.Error(), tt.wantErr) {
t.Fatalf("err=%v, want contains %q", err, tt.wantErr)
}
return
}
if err != nil {
t.Fatalf("unexpected err: %v", err)
}
if name != tt.wantName || value != tt.wantValue || ok != tt.wantOK {
t.Fatalf("got name=%q value=%q ok=%v, want name=%q value=%q ok=%v",
name, value, ok,
tt.wantName, tt.wantValue, tt.wantOK,
)
}
})
}
}
func TestPreloadEnvFromArgs_AppliesAndRestores(t *testing.T) {
const existing = "REDANT_PRELOAD_EXISTING"
const created = "REDANT_PRELOAD_CREATED"
t.Setenv(existing, "orig")
_ = os.Unsetenv(created)
restore, err := preloadEnvFromArgs([]string{"-e", existing + "=override", "--env", created + "=1"})
if err != nil {
t.Fatalf("unexpected err: %v", err)
}
if restore == nil {
t.Fatalf("restore func should not be nil")
}
if got := os.Getenv(existing); got != "override" {
t.Fatalf("existing=%q, want override", got)
}
if got := os.Getenv(created); got != "1" {
t.Fatalf("created=%q, want 1", got)
}
if err := restore(); err != nil {
t.Fatalf("restore error: %v", err)
}
if got := os.Getenv(existing); got != "orig" {
t.Fatalf("existing after restore=%q, want orig", got)
}
if _, ok := os.LookupEnv(created); ok {
t.Fatalf("created should be unset after restore")
}
}
func TestPreloadEnvFromArgs_ShortInlineEquals(t *testing.T) {
const key = "REDANT_PRELOAD_SHORT_INLINE_EQUALS"
_ = os.Unsetenv(key)
restore, err := preloadEnvFromArgs([]string{"-e=" + key + "=ok"})
if err != nil {
t.Fatalf("unexpected err: %v", err)
}
if restore == nil {
t.Fatalf("restore should not be nil")
}
if got := os.Getenv(key); got != "ok" {
t.Fatalf("got %q, want ok", got)
}
if err := restore(); err != nil {
t.Fatalf("restore error: %v", err)
}
if _, ok := os.LookupEnv(key); ok {
t.Fatalf("%s should be unset after restore", key)
}
}
func TestPreloadEnvFromArgs_EnvFileRepeatAndCSV(t *testing.T) {
const inherited = "REDANT_PRELOAD_COMMON"
const only1 = "REDANT_PRELOAD_FILE_A"
const only2 = "REDANT_PRELOAD_FILE_B"
t.Setenv(inherited, "orig-common")
_ = os.Unsetenv(only1)
_ = os.Unsetenv(only2)
tmpDir := t.TempDir()
file1 := filepath.Join(tmpDir, "a.env")
file2 := filepath.Join(tmpDir, "b.env")
if err := os.WriteFile(file1, []byte(inherited+"=from-a\n"+only1+"=one\n"), 0o600); err != nil {
t.Fatalf("write file1: %v", err)
}
if err := os.WriteFile(file2, []byte("export "+inherited+"=\"from-b\"\n"+only2+"='two'\n"), 0o600); err != nil {
t.Fatalf("write file2: %v", err)
}
restore, err := preloadEnvFromArgs([]string{"--env-file", file1, "--env-file", file2 + "," + file1})
if err != nil {
t.Fatalf("unexpected err: %v", err)
}
if restore == nil {
t.Fatalf("restore func should not be nil")
}
if got := os.Getenv(inherited); got != "from-a" {
t.Fatalf("inherited=%q, want from-a", got)
}
if got := os.Getenv(only1); got != "one" {
t.Fatalf("only1=%q, want one", got)
}
if got := os.Getenv(only2); got != "two" {
t.Fatalf("only2=%q, want two", got)
}
if err := restore(); err != nil {
t.Fatalf("restore error: %v", err)
}
if got := os.Getenv(inherited); got != "orig-common" {
t.Fatalf("inherited after restore=%q, want orig-common", got)
}
if _, ok := os.LookupEnv(only1); ok {
t.Fatalf("only1 should be unset after restore")
}
if _, ok := os.LookupEnv(only2); ok {
t.Fatalf("only2 should be unset after restore")
}
}
func TestPreloadEnvFromArgs_StopAtDoubleDash(t *testing.T) {
const key = "REDANT_PRELOAD_STOP_AT_DASH"
_ = os.Unsetenv(key)
restore, err := preloadEnvFromArgs([]string{"--", "-e", key + "=1"})
if err != nil {
t.Fatalf("unexpected err: %v", err)
}
if restore != nil {
t.Fatalf("restore should be nil when no env is changed")
}
if _, ok := os.LookupEnv(key); ok {
t.Fatalf("%s should not be set after --", key)
}
}
func TestPreloadEnvFromArgs_RollbackOnError(t *testing.T) {
const key = "REDANT_PRELOAD_ROLLBACK"
_ = os.Unsetenv(key)
restore, err := preloadEnvFromArgs([]string{"-e", key + "=1", "-e", "INVALID"})
if err == nil {
t.Fatalf("expected error")
}
if restore != nil {
t.Fatalf("restore should be nil on preload error")
}
if _, ok := os.LookupEnv(key); ok {
t.Fatalf("%s should be rolled back when preload fails", key)
}
}
func TestPreloadEnvFromArgs_RollbackOnParseErrorAfterMutation(t *testing.T) {
const key = "REDANT_PRELOAD_ROLLBACK_PARSE"
_ = os.Unsetenv(key)
restore, err := preloadEnvFromArgs([]string{"-e", key + "=1", "--env"})
if err == nil {
t.Fatalf("expected error")
}
if restore != nil {
t.Fatalf("restore should be nil on preload error")
}
if _, ok := os.LookupEnv(key); ok {
t.Fatalf("%s should be rolled back when parse fails", key)
}
}
func TestParseEnvAssignment(t *testing.T) {
tests := []struct {
name string
raw string
wantKey string
wantValue string
wantErr string
}{
{name: "basic", raw: "A=1", wantKey: "A", wantValue: "1"},
{name: "trim spaces", raw: " A = 1 ", wantKey: "A", wantValue: "1"},
{name: "value includes equals", raw: "A=a=b", wantKey: "A", wantValue: "a=b"},
{name: "empty raw", raw: "", wantErr: "empty environment assignment"},
{name: "missing equals", raw: "A", wantErr: "expected KEY=VALUE"},
{name: "missing key", raw: "=1", wantErr: "expected KEY=VALUE"},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
key, value, err := parseEnvAssignment(tt.raw)
if tt.wantErr != "" {
if err == nil || !strings.Contains(err.Error(), tt.wantErr) {
t.Fatalf("err=%v, want contains %q", err, tt.wantErr)
}
return
}
if err != nil {
t.Fatalf("unexpected err: %v", err)
}
if key != tt.wantKey || value != tt.wantValue {
t.Fatalf("got key=%q value=%q, want key=%q value=%q", key, value, tt.wantKey, tt.wantValue)
}
})
}
}
func TestApplyEnvAssignmentsCSV(t *testing.T) {
got := make(map[string]string)
setEnv := func(key, value string) error {
got[key] = value
return nil
}
err := applyEnvAssignmentsCSV(`A=1,"B=hello,world",C=3`, setEnv)
if err != nil {
t.Fatalf("unexpected err: %v", err)
}
if got["A"] != "1" {
t.Fatalf("A=%q, want 1", got["A"])
}
if got["B"] != "hello,world" {
t.Fatalf("B=%q, want hello,world", got["B"])
}
if got["C"] != "3" {
t.Fatalf("C=%q, want 3", got["C"])
}
}
func TestLoadEnvFile_InvalidLineIncludesPosition(t *testing.T) {
tmp := filepath.Join(t.TempDir(), ".env")
if err := os.WriteFile(tmp, []byte("A=1\nINVALID\n"), 0o600); err != nil {
t.Fatalf("write env file: %v", err)
}
err := loadEnvFile(tmp, func(key, value string) error { return nil })
if err == nil {
t.Fatalf("expected error")
}
if !strings.Contains(err.Error(), ":2:") {
t.Fatalf("error should contain line number, got: %v", err)
}
}
func TestConsumesNextArg(t *testing.T) {
tests := []struct {
name string
current string
flagName string
want bool
}{
{name: "long env", current: "--env", flagName: "env", want: true},
{name: "long env-file", current: "--env-file", flagName: "env-file", want: true},
{name: "long inline", current: "--env=A=1", flagName: "env", want: false},
{name: "short e", current: "-e", flagName: "env", want: true},
{name: "short inline", current: "-eA=1", flagName: "env", want: false},
{name: "other", current: "--name", flagName: "env", want: false},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
if got := consumesNextArg(tt.current, tt.flagName); got != tt.want {
t.Fatalf("got %v, want %v", got, tt.want)
}
})
}
}
func TestPreloadEnvFromArgs_RollbackOnEnvFileLoadError(t *testing.T) {
const key = "REDANT_PRELOAD_ROLLBACK_FILE_ERROR"
_ = os.Unsetenv(key)
missing := filepath.Join(t.TempDir(), "not-exists.env")
restore, err := preloadEnvFromArgs([]string{"-e", key + "=1", "--env-file", missing})
if err == nil {
t.Fatalf("expected error")
}
if restore != nil {
t.Fatalf("restore should be nil on preload error")
}
if _, ok := os.LookupEnv(key); ok {
t.Fatalf("%s should be rolled back when env-file load fails", key)
}
}
func TestPreloadEnvFromArgs_NoEnvFlagsNoChange(t *testing.T) {
const key = "REDANT_PRELOAD_NO_CHANGE"
t.Setenv(key, "orig")
restore, err := preloadEnvFromArgs([]string{"--name", "demo", "subcmd"})
if err != nil {
t.Fatalf("unexpected err: %v", err)
}
if restore != nil {
t.Fatalf("restore should be nil when env flags are absent")
}
if got := os.Getenv(key); got != "orig" {
t.Fatalf("got %q, want orig", got)
}
}
func TestNormalizeEnvValue(t *testing.T) {
tests := []struct {
name string
in string
want string
}{
{name: "single quoted", in: "'abc'", want: "abc"},
{name: "double quoted", in: "\"abc\"", want: "abc"},
{name: "double quoted escape", in: "\"a\\nb\"", want: "a\nb"},
{name: "invalid double quote keep raw", in: "\"abc", want: "\"abc"},
{name: "trim spaces", in: " abc ", want: "abc"},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
if got := normalizeEnvValue(tt.in); got != tt.want {
t.Fatalf("got %q, want %q", got, tt.want)
}
})
}
}
func TestRestoreEnvSnapshots(t *testing.T) {
const existing = "REDANT_RESTORE_SNAPSHOT_EXISTING"
const created = "REDANT_RESTORE_SNAPSHOT_CREATED"
t.Setenv(existing, "current")
_ = os.Unsetenv(created)
if err := os.Setenv(created, "temp"); err != nil {
t.Fatalf("set created: %v", err)
}
if err := os.Setenv(existing, "override"); err != nil {
t.Fatalf("set existing: %v", err)
}
snapshots := map[string]envSnapshot{
existing: {value: "orig", existed: true},
created: {value: "", existed: false},
}
if err := restoreEnvSnapshots(snapshots); err != nil {
t.Fatalf("restoreEnvSnapshots err: %v", err)
}
if got := os.Getenv(existing); got != "orig" {
t.Fatalf("existing=%q, want orig", got)
}
if _, ok := os.LookupEnv(created); ok {
t.Fatalf("created should be unset")
}
}