-
Notifications
You must be signed in to change notification settings - Fork 505
/
dotenv_spec.rb
393 lines (319 loc) · 10.1 KB
/
dotenv_spec.rb
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
require "spec_helper"
describe Dotenv do
before do
Dir.chdir(File.expand_path("../fixtures", __FILE__))
end
shared_examples "load" do
context "with no args" do
let(:env_files) { [] }
it "defaults to .env" do
expect(Dotenv::Environment).to receive(:new).with(expand(".env"), anything).and_call_original
subject
end
end
context "with a tilde path" do
let(:env_files) { ["~/.env"] }
it "expands the path" do
expected = expand("~/.env")
allow(File).to receive(:exist?) { |arg| arg == expected }
expect(Dotenv::Environment).to receive(:new).with(expected, anything)
.and_return(Dotenv::Environment.new(".env"))
subject
end
end
context "with multiple files" do
let(:env_files) { [".env", fixture_path("plain.env")] }
let(:expected) do
{"OPTION_A" => "1",
"OPTION_B" => "2",
"OPTION_C" => "3",
"OPTION_D" => "4",
"OPTION_E" => "5",
"PLAIN" => "true",
"DOTENV" => "true"}
end
it "loads all files" do
subject
expected.each do |key, value|
expect(ENV[key]).to eq(value)
end
end
it "returns hash of loaded variables" do
expect(subject).to eq(expected)
end
it "does not return unchanged variables" do
ENV["OPTION_A"] = "1"
expect(subject).not_to have_key("OPTION_A")
end
end
end
shared_examples "overwrite" do
it_behaves_like "load"
context "with multiple files" do
let(:env_files) { [fixture_path("important.env"), fixture_path("plain.env")] }
let(:expected) do
{
"OPTION_A" => "abc",
"OPTION_B" => "2",
"OPTION_C" => "3",
"OPTION_D" => "4",
"OPTION_E" => "5",
"PLAIN" => "false"
}
end
it "respects the file importance order" do
subject
expected.each do |key, value|
expect(ENV[key]).to eq(value)
end
end
end
end
describe "load" do
let(:env_files) { [] }
subject { Dotenv.load(*env_files) }
it_behaves_like "load"
it "initializes the Environment with overwrite: false" do
expect(Dotenv::Environment).to receive(:new).with(anything, overwrite: false)
.and_call_original
subject
end
context "when the file does not exist" do
let(:env_files) { [".env_does_not_exist"] }
it "fails silently" do
expect { subject }.not_to raise_error
end
it "does not change ENV" do
expect { subject }.not_to change { ENV.inspect }
end
end
end
describe "load!" do
let(:env_files) { [] }
subject { Dotenv.load!(*env_files) }
it_behaves_like "load"
it "initializes Environment with overwrite: false" do
expect(Dotenv::Environment).to receive(:new).with(anything, overwrite: false)
.and_call_original
subject
end
context "when one file exists and one does not" do
let(:env_files) { [".env", ".env_does_not_exist"] }
it "raises an Errno::ENOENT error" do
expect { subject }.to raise_error(Errno::ENOENT)
end
end
end
describe "overwrite" do
let(:env_files) { [fixture_path("plain.env")] }
subject { Dotenv.overwrite(*env_files) }
it_behaves_like "load"
it_behaves_like "overwrite"
it "initializes the Environment overwrite: true" do
expect(Dotenv::Environment).to receive(:new).with(anything, overwrite: true)
.and_call_original
subject
end
context "when loading a file containing already set variables" do
let(:env_files) { [fixture_path("plain.env")] }
it "overwrites any existing ENV variables" do
ENV["OPTION_A"] = "predefined"
subject
expect(ENV["OPTION_A"]).to eq("1")
end
end
context "when the file does not exist" do
let(:env_files) { [".env_does_not_exist"] }
it "fails silently" do
expect { subject }.not_to raise_error
end
it "does not change ENV" do
expect { subject }.not_to change { ENV.inspect }
end
end
end
describe "overwrite!" do
let(:env_files) { [fixture_path("plain.env")] }
subject { Dotenv.overwrite!(*env_files) }
it_behaves_like "load"
it_behaves_like "overwrite"
it "initializes the Environment with overwrite: true" do
expect(Dotenv::Environment).to receive(:new).with(anything, overwrite: true)
.and_call_original
subject
end
context "when loading a file containing already set variables" do
let(:env_files) { [fixture_path("plain.env")] }
it "overwrites any existing ENV variables" do
ENV["OPTION_A"] = "predefined"
subject
expect(ENV["OPTION_A"]).to eq("1")
end
end
context "when one file exists and one does not" do
let(:env_files) { [".env", ".env_does_not_exist"] }
it "raises an Errno::ENOENT error" do
expect { subject }.to raise_error(Errno::ENOENT)
end
end
end
describe "with an instrumenter" do
let(:instrumenter) { double("instrumenter", instrument: {}) }
before { Dotenv.instrumenter = instrumenter }
after { Dotenv.instrumenter = nil }
describe "load" do
it "instruments if the file exists" do
expect(instrumenter).to receive(:instrument) do |name, payload|
expect(name).to eq("load.dotenv")
expect(payload[:env]).to be_instance_of(Dotenv::Environment)
{}
end
Dotenv.load
end
it "does not instrument if file does not exist" do
expect(instrumenter).to receive(:instrument).never
Dotenv.load ".doesnotexist"
end
end
end
describe "require keys" do
let(:env_files) { [".env", fixture_path("bom.env")] }
before { Dotenv.load(*env_files) }
it "raises exception with not defined mandatory ENV keys" do
expect { Dotenv.require_keys("BOM", "TEST") }.to raise_error(
Dotenv::MissingKeys,
'Missing required configuration key: ["TEST"]'
)
end
end
describe "parse" do
let(:env_files) { [] }
subject { Dotenv.parse(*env_files) }
context "with no args" do
let(:env_files) { [] }
it "defaults to .env" do
expect(Dotenv::Environment).to receive(:new).with(expand(".env"),
anything)
subject
end
end
context "with a tilde path" do
let(:env_files) { ["~/.env"] }
it "expands the path" do
expected = expand("~/.env")
allow(File).to receive(:exist?) { |arg| arg == expected }
expect(Dotenv::Environment).to receive(:new).with(expected, anything)
subject
end
end
context "with multiple files" do
let(:env_files) { [".env", fixture_path("plain.env")] }
let(:expected) do
{"OPTION_A" => "1",
"OPTION_B" => "2",
"OPTION_C" => "3",
"OPTION_D" => "4",
"OPTION_E" => "5",
"PLAIN" => "true",
"DOTENV" => "true"}
end
it "does not modify ENV" do
subject
expected.each do |key, _value|
expect(ENV[key]).to be_nil
end
end
it "returns hash of parsed key/value pairs" do
expect(subject).to eq(expected)
end
end
it "initializes the Environment with overwrite: false" do
expect(Dotenv::Environment).to receive(:new).with(anything, overwrite: false)
subject
end
context "when the file does not exist" do
let(:env_files) { [".env_does_not_exist"] }
it "fails silently" do
expect { subject }.not_to raise_error
expect(subject).to eq({})
end
end
end
describe "Unicode" do
subject { fixture_path("bom.env") }
it "loads a file with a Unicode BOM" do
expect(Dotenv.load(subject)).to eql("BOM" => "UTF-8")
end
it "fixture file has UTF-8 BOM" do
contents = File.binread(subject).force_encoding("UTF-8")
expect(contents).to start_with("\xEF\xBB\xBF".force_encoding("UTF-8"))
end
end
describe "restore" do
it "restores previously saved snapshot" do
ENV["MODIFIED"] = "true"
Dotenv.restore # save was already called in setup
expect(ENV["MODIFIED"]).to be_nil
end
it "raises an error in threads" do
ENV["MODIFIED"] = "true"
Thread.new do
expect { Dotenv.restore }.to raise_error(ThreadError, /not thread safe/)
end.join
expect(ENV["MODIFIED"]).to eq("true")
end
it "is a noop if nil state provided" do
expect { Dotenv.restore(nil) }.not_to raise_error
end
it "is a noop if no previously saved state" do
# Clear state saved in setup
expect(Dotenv.instance_variable_get(:@diff)).to be_instance_of(Dotenv::Diff)
Dotenv.instance_variable_set(:@diff, nil)
expect { Dotenv.restore }.not_to raise_error
end
it "can save and restore stubbed ENV" do
stub_const("ENV", ENV.to_h.merge("STUBBED" => "1"))
Dotenv.save
ENV["MODIFIED"] = "1"
Dotenv.restore
expect(ENV["STUBBED"]).to eq("1")
expect(ENV["MODIFED"]).to be(nil)
end
end
describe "modify" do
it "sets values for the block" do
ENV["FOO"] = "initial"
Dotenv.modify(FOO: "during", BAR: "baz") do
expect(ENV["FOO"]).to eq("during")
expect(ENV["BAR"]).to eq("baz")
end
expect(ENV["FOO"]).to eq("initial")
expect(ENV).not_to have_key("BAR")
end
end
describe "update" do
it "sets new variables" do
Dotenv.update({"OPTION_A" => "1"})
expect(ENV["OPTION_A"]).to eq("1")
end
it "does not overwrite defined variables" do
ENV["OPTION_A"] = "original"
Dotenv.update({"OPTION_A" => "updated"})
expect(ENV["OPTION_A"]).to eq("original")
end
context "with overwrite: true" do
it "sets new variables" do
Dotenv.update({"OPTION_A" => "1"}, overwrite: true)
expect(ENV["OPTION_A"]).to eq("1")
end
it "overwrites defined variables" do
ENV["OPTION_A"] = "original"
Dotenv.update({"OPTION_A" => "updated"}, overwrite: true)
expect(ENV["OPTION_A"]).to eq("updated")
end
end
end
def expand(path)
File.expand_path path
end
end