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
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
|
#
# Author:: Daniel DeLeo (<dan@chef.io>)
# Copyright:: Copyright 2014-2016, Chef Software, Inc.
# License:: Apache License, Version 2.0
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
require "spec_helper"
require "tempfile"
require "chef-config/exceptions"
require "chef-config/windows"
require "chef-config/workstation_config_loader"
RSpec.describe ChefConfig::WorkstationConfigLoader do
let(:explicit_config_location) { nil }
let(:env) { {} }
let(:config_loader) do
described_class.new(explicit_config_location).tap do |c|
allow(c).to receive(:env).and_return(env)
end
end
before do
# We set this to nil so that a dev workstation will
# not interfere with the tests.
ChefConfig::Config.reset
ChefConfig::Config[:config_d_dir] = nil
end
# Test methods that do I/O or reference external state which are stubbed out
# elsewhere.
describe "external dependencies" do
let(:config_loader) { described_class.new(nil) }
it "delegates to ENV for env" do
expect(config_loader.env).to equal(ENV)
end
it "tests a path's existence" do
expect(config_loader.path_exists?("/nope/nope/nope/nope/frab/jab/nab")).to be(false)
expect(config_loader.path_exists?(__FILE__)).to be(true)
end
end
describe "locating the config file" do
context "without an explicit config" do
before do
allow(config_loader).to receive(:path_exists?).with(an_instance_of(String)).and_return(false)
end
it "has no config if HOME is not set" do
expect(config_loader.config_location).to be(nil)
expect(config_loader.no_config_found?).to be(true)
end
context "when HOME is set and contains a knife.rb" do
let(:home) { "/Users/example.user" }
before do
allow(ChefConfig::PathHelper).to receive(:home).with(".chef").and_yield(File.join(home, ".chef"))
allow(config_loader).to receive(:path_exists?).with("#{home}/.chef/knife.rb").and_return(true)
end
it "uses the config in HOME/.chef/knife.rb" do
expect(config_loader.config_location).to eq("#{home}/.chef/knife.rb")
end
context "and has a config.rb" do
before do
allow(config_loader).to receive(:path_exists?).with("#{home}/.chef/config.rb").and_return(true)
end
it "uses the config in HOME/.chef/config.rb" do
expect(config_loader.config_location).to eq("#{home}/.chef/config.rb")
end
context "and/or a parent dir contains a .chef dir" do
let(:env_pwd) { "/path/to/cwd" }
before do
if ChefConfig.windows?
env["CD"] = env_pwd
else
env["PWD"] = env_pwd
end
allow(config_loader).to receive(:path_exists?).with("#{env_pwd}/.chef/knife.rb").and_return(true)
allow(File).to receive(:exist?).with("#{env_pwd}/.chef").and_return(true)
allow(File).to receive(:directory?).with("#{env_pwd}/.chef").and_return(true)
end
it "prefers the config from parent_dir/.chef" do
expect(config_loader.config_location).to eq("#{env_pwd}/.chef/knife.rb")
end
context "and the parent dir's .chef dir has a config.rb" do
before do
allow(config_loader).to receive(:path_exists?).with("#{env_pwd}/.chef/config.rb").and_return(true)
end
it "prefers the config from parent_dir/.chef" do
expect(config_loader.config_location).to eq("#{env_pwd}/.chef/config.rb")
end
context "and/or the current working directory contains a .chef dir" do
let(:cwd) { Dir.pwd }
before do
allow(config_loader).to receive(:path_exists?).with("#{cwd}/knife.rb").and_return(true)
end
it "prefers a knife.rb located in the cwd" do
expect(config_loader.config_location).to eq("#{cwd}/knife.rb")
end
context "and the CWD's .chef dir has a config.rb" do
before do
allow(config_loader).to receive(:path_exists?).with("#{cwd}/config.rb").and_return(true)
end
it "prefers a config located in the cwd" do
expect(config_loader.config_location).to eq("#{cwd}/config.rb")
end
context "and/or KNIFE_HOME is set" do
let(:knife_home) { "/path/to/knife/home" }
before do
env["KNIFE_HOME"] = knife_home
allow(config_loader).to receive(:path_exists?).with("#{knife_home}/knife.rb").and_return(true)
end
it "prefers a knife located in KNIFE_HOME" do
expect(config_loader.config_location).to eq("/path/to/knife/home/knife.rb")
end
context "and KNIFE_HOME contains a config.rb" do
before do
env["KNIFE_HOME"] = knife_home
allow(config_loader).to receive(:path_exists?).with("#{knife_home}/config.rb").and_return(true)
end
it "prefers a config.rb located in KNIFE_HOME" do
expect(config_loader.config_location).to eq("/path/to/knife/home/config.rb")
end
end
end
end
end
end
end
end
end
context "when the current working dir is inside a symlinked directory" do
before do
# pwd according to your shell is /home/someuser/prod/chef-repo, but
# chef-repo is a symlink to /home/someuser/codes/chef-repo
env["CD"] = "/home/someuser/prod/chef-repo" # windows
env["PWD"] = "/home/someuser/prod/chef-repo" # unix
allow(Dir).to receive(:pwd).and_return("/home/someuser/codes/chef-repo")
end
it "loads the config from the non-dereferenced directory path" do
expect(File).to receive(:exist?).with("/home/someuser/prod/chef-repo/.chef").and_return(false)
expect(File).to receive(:exist?).with("/home/someuser/prod/.chef").and_return(true)
expect(File).to receive(:directory?).with("/home/someuser/prod/.chef").and_return(true)
expect(config_loader).to receive(:path_exists?).with("/home/someuser/prod/.chef/knife.rb").and_return(true)
expect(config_loader.config_location).to eq("/home/someuser/prod/.chef/knife.rb")
end
end
end
context "when given an explicit config to load" do
let(:explicit_config_location) { "/path/to/explicit/config.rb" }
it "prefers the explicit config" do
expect(config_loader.config_location).to eq(explicit_config_location)
end
end
end
describe "loading the config file" do
context "when no explicit config is specifed and no implicit config is found" do
before do
allow(config_loader).to receive(:path_exists?).with(an_instance_of(String)).and_return(false)
end
it "skips loading" do
expect(config_loader.config_location).to be(nil)
expect(config_loader).not_to receive(:apply_config)
config_loader.load
end
end
context "when an explicit config is given but it doesn't exist" do
let(:explicit_config_location) { "/nope/nope/nope/frab/jab/nab" }
it "raises a configuration error" do
expect { config_loader.load }.to raise_error(ChefConfig::ConfigurationError)
end
end
context "when the config file exists" do
let(:config_content) { "" }
# We need to keep a reference to the tempfile because while #close does
# not unlink the file, the object being GC'd will.
let(:tempfile) do
Tempfile.new("Chef-WorkstationConfigLoader-rspec-test").tap do |t|
t.print(config_content)
t.close
end
end
let(:explicit_config_location) do
tempfile.path
end
after { File.unlink(explicit_config_location) if File.exist?(explicit_config_location) }
context "and is valid" do
let(:config_content) { "config_file_evaluated(true)" }
it "loads the config" do
expect(config_loader).to receive(:apply_config).and_call_original
config_loader.load
expect(ChefConfig::Config.config_file_evaluated).to be(true)
end
it "sets ChefConfig::Config.config_file" do
config_loader.load
expect(ChefConfig::Config.config_file).to eq(explicit_config_location)
end
end
context "and has a syntax error" do
let(:config_content) { "{{{{{:{{" }
it "raises a ConfigurationError" do
expect { config_loader.load }.to raise_error(ChefConfig::ConfigurationError)
end
end
context "and raises a ruby exception during evaluation" do
let(:config_content) { ":foo\n:bar\nraise 'oops'\n:baz\n" }
it "raises a ConfigurationError" do
expect { config_loader.load }.to raise_error(ChefConfig::ConfigurationError)
end
end
end
end
describe "when loading config.d" do
context "when the conf.d directory exists" do
let(:config_content) { "" }
let(:tempdir) { Dir.mktmpdir("chef-workstation-test") }
let!(:confd_file) do
Tempfile.new(["Chef-WorkstationConfigLoader-rspec-test", ".rb"], tempdir).tap do |t|
t.print(config_content)
t.close
end
end
before do
ChefConfig::Config[:config_d_dir] = tempdir
allow(config_loader).to receive(:path_exists?).with(
an_instance_of(String)).and_return(false)
end
after do
FileUtils.remove_entry_secure tempdir
end
context "and is valid" do
let(:config_content) { "config_d_file_evaluated(true)" }
it "loads the config" do
expect(config_loader).to receive(:apply_config).and_call_original
config_loader.load
expect(ChefConfig::Config.config_d_file_evaluated).to be(true)
end
end
context "and has a syntax error" do
let(:config_content) { "{{{{{:{{" }
it "raises a ConfigurationError" do
expect { config_loader.load }.to raise_error(ChefConfig::ConfigurationError)
end
end
context "has a non rb file" do
let(:sytax_error_content) { "{{{{{:{{" }
let(:config_content) { "config_d_file_evaluated(true)" }
let!(:not_confd_file) do
Tempfile.new(["Chef-WorkstationConfigLoader-rspec-test", ".foorb"], tempdir).tap do |t|
t.print(sytax_error_content)
t.close
end
end
it "does not load the non rb file" do
expect { config_loader.load }.not_to raise_error
expect(ChefConfig::Config.config_d_file_evaluated).to be(true)
end
end
end
context "when the conf.d directory does not exist" do
before do
ChefConfig::Config[:config_d_dir] = "/nope/nope/nope/nope/notdoingit"
end
it "does not load anything" do
expect(config_loader).not_to receive(:apply_config)
end
end
end
describe "when loading a credentials file" do
if ChefConfig.windows?
let(:home) { "C:/Users/example.user" }
else
let(:home) { "/Users/example.user" }
end
let(:credentials_file) { "#{home}/.chef/credentials" }
let(:context_file) { "#{home}/.chef/context" }
before do
allow(ChefConfig::PathHelper).to receive(:home).with(".chef").and_return(File.join(home, ".chef"))
allow(ChefConfig::PathHelper).to receive(:home).with(".chef", "credentials").and_return(credentials_file)
allow(ChefConfig::PathHelper).to receive(:home).with(".chef", "context").and_return(context_file)
allow(File).to receive(:file?).with(context_file).and_return false
end
context "when the file exists" do
before do
expect(File).to receive(:read).with(credentials_file, { encoding: "utf-8" }).and_return(content)
allow(File).to receive(:file?).with(credentials_file).and_return true
end
context "and has a default profile" do
let(:content) do
content = <<EOH
[default]
node_name = 'barney'
client_key = "barney_rubble.pem"
chef_server_url = "https://api.chef.io/organizations/bedrock"
EOH
content
end
it "applies the expected config" do
expect { config_loader.load_credentials }.not_to raise_error
expect(ChefConfig::Config.chef_server_url).to eq("https://api.chef.io/organizations/bedrock")
expect(ChefConfig::Config.client_key.to_s).to eq("#{home}/.chef/barney_rubble.pem")
expect(ChefConfig::Config.profile.to_s).to eq("default")
end
end
context "and has a default profile with knife settings" do
let(:content) do
content = <<EOH
[default]
node_name = 'barney'
client_key = "barney_rubble.pem"
chef_server_url = "https://api.chef.io/organizations/bedrock"
knife = {
secret_file = "/home/barney/.chef/encrypted_data_bag_secret.pem"
}
[default.knife]
ssh_user = "knife_ssh_user"
EOH
content
end
it "applies the expected knife config" do
expect { config_loader.load_credentials }.not_to raise_error
expect(ChefConfig::Config.chef_server_url).to eq("https://api.chef.io/organizations/bedrock")
expect(ChefConfig::Config.client_key.to_s).to eq("#{home}/.chef/barney_rubble.pem")
expect(ChefConfig::Config.knife[:ssh_user].to_s).to eq("knife_ssh_user")
expect(ChefConfig::Config.knife[:secret_file].to_s).to eq("/home/barney/.chef/encrypted_data_bag_secret.pem")
expect(ChefConfig::Config.profile.to_s).to eq("default")
end
end
context "and has a profile containing a full key" do
let(:content) do
content = <<EOH
[default]
client_key = """
-----BEGIN RSA PRIVATE KEY-----
foo
"""
EOH
content
end
it "applies the expected config" do
expect { config_loader.load_credentials }.not_to raise_error
expect(ChefConfig::Config.client_key_contents).to eq(<<EOH
-----BEGIN RSA PRIVATE KEY-----
foo
EOH
)
end
end
context "and has several profiles" do
let(:content) do
content = <<EOH
[default]
client_name = "default"
[environment]
client_name = "environment"
[explicit]
client_name = "explicit"
[context]
client_name = "context"
EOH
content
end
let(:env) { {} }
before do
stub_const("ENV", env)
end
it "selects the correct profile explicitly" do
expect { config_loader.load_credentials("explicit") }.not_to raise_error
expect(ChefConfig::Config.node_name).to eq("explicit")
end
context "with an environment variable" do
let(:env) { { "CHEF_PROFILE" => "environment" } }
it "selects the correct profile" do
expect { config_loader.load_credentials }.not_to raise_error
expect(ChefConfig::Config.node_name).to eq("environment")
end
end
it "selects the correct profile with a context file" do
allow(File).to receive(:file?).with(context_file).and_return true
expect(File).to receive(:read).with(context_file).and_return "context"
expect { config_loader.load_credentials }.not_to raise_error
expect(ChefConfig::Config.node_name).to eq("context")
end
it "falls back to the default" do
expect { config_loader.load_credentials }.not_to raise_error
expect(ChefConfig::Config.node_name).to eq("default")
end
end
context "and contains both node_name and client_name" do
let(:content) do
content = <<EOH
[default]
node_name = 'barney'
client_name = 'barney'
EOH
content
end
it "raises a ConfigurationError" do
expect { config_loader.load_credentials }.to raise_error(ChefConfig::ConfigurationError)
end
end
context "and has a syntax error" do
let(:content) { "<<<<<" }
it "raises a ConfigurationError" do
expect { config_loader.load_credentials }.to raise_error(ChefConfig::ConfigurationError)
end
end
end
context "when the file does not exist" do
it "does not load anything" do
allow(File).to receive(:file?).with(credentials_file).and_return false
expect(Tomlrb).not_to receive(:load_file)
config_loader.load_credentials
end
end
end
end
|