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
|
#
# Author:: Adam Jacob (<adam@opscode.com>)
# Author:: Kyle Goodwin (<kgoodwin@primerevenue.com>)
# Copyright:: Copyright (c) 2008 Opscode, 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 'chef/exceptions'
describe Chef::Config do
before(:all) do
@original_env = { 'HOME' => ENV['HOME'], 'SYSTEMDRIVE' => ENV['SYSTEMDRIVE'], 'HOMEPATH' => ENV['HOMEPATH'], 'USERPROFILE' => ENV['USERPROFILE'] }
end
describe "config attribute writer: chef_server_url" do
before do
Chef::Config.chef_server_url = "https://junglist.gen.nz"
end
it "sets the server url" do
Chef::Config.chef_server_url.should == "https://junglist.gen.nz"
end
context "when the url has a leading space" do
before do
Chef::Config.chef_server_url = " https://junglist.gen.nz"
end
it "strips the space from the url when setting" do
Chef::Config.chef_server_url.should == "https://junglist.gen.nz"
end
end
context "when the url is a frozen string" do
before do
Chef::Config.chef_server_url = " https://junglist.gen.nz".freeze
end
it "strips the space from the url when setting without raising an error" do
Chef::Config.chef_server_url.should == "https://junglist.gen.nz"
end
end
end
describe "when configuring formatters" do
# if TTY and not(force-logger)
# formatter = configured formatter or default formatter
# formatter goes to STDOUT/ERR
# if log file is writeable
# log level is configured level or info
# log location is file
# else
# log level is warn
# log location is STDERR
# end
# elsif not(TTY) and force formatter
# formatter = configured formatter or default formatter
# if log_location specified
# formatter goes to log_location
# else
# formatter goes to STDOUT/ERR
# end
# else
# formatter = "null"
# log_location = configured-value or defualt
# log_level = info or defualt
# end
#
it "has an empty list of formatters by default" do
Chef::Config.formatters.should == []
end
it "configures a formatter with a short name" do
Chef::Config.add_formatter(:doc)
Chef::Config.formatters.should == [[:doc, nil]]
end
it "configures a formatter with a file output" do
Chef::Config.add_formatter(:doc, "/var/log/formatter.log")
Chef::Config.formatters.should == [[:doc, "/var/log/formatter.log"]]
end
end
describe "class method: manage_secret_key" do
before do
Chef::FileCache.stub!(:load).and_return(true)
Chef::FileCache.stub!(:has_key?).with("chef_server_cookie_id").and_return(false)
end
it "should generate and store a chef server cookie id" do
Chef::FileCache.should_receive(:store).with("chef_server_cookie_id", /\w{40}/).and_return(true)
Chef::Config.manage_secret_key
end
describe "when the filecache has a chef server cookie id key" do
before do
Chef::FileCache.stub!(:has_key?).with("chef_server_cookie_id").and_return(true)
end
it "should not generate and store a chef server cookie id" do
Chef::FileCache.should_not_receive(:store).with("chef_server_cookie_id", /\w{40}/)
Chef::Config.manage_secret_key
end
end
end
describe "config attribute writer: log_method=" do
describe "when given an object that responds to sync= e.g. IO" do
it "should configure itself to use the IO as log_location" do
Chef::Config.log_location = STDOUT
Chef::Config.log_location.should == STDOUT
end
end
describe "when given an object that is stringable (to_str)" do
before do
@mockfile = mock("File", :path => "/var/log/chef/client.log", :sync= => true)
File.should_receive(:new).
with("/var/log/chef/client.log", "a").
and_return(@mockfile)
end
it "should configure itself to use a File object based upon the String" do
Chef::Config.log_location = "/var/log/chef/client.log"
Chef::Config.log_location.path.should == "/var/log/chef/client.log"
end
end
end
describe "class method: plaform_specific_path" do
it "should return given path on non-windows systems" do
platform_mock :unix do
path = "/etc/chef/cookbooks"
Chef::Config.platform_specific_path(path).should == "/etc/chef/cookbooks"
end
end
it "should return a windows path on windows systems" do
platform_mock :windows do
path = "/etc/chef/cookbooks"
ENV.stub!(:[]).with('SYSTEMDRIVE').and_return('C:')
# match on a regex that looks for the base path with an optional
# system drive at the beginning (c:)
# system drive is not hardcoded b/c it can change and b/c it is not present on linux systems
Chef::Config.platform_specific_path(path).should == "C:\\chef\\cookbooks"
end
end
end
describe "default values" do
it "Chef::Config[:file_backup_path] defaults to /var/chef/backup" do
backup_path = if windows?
"#{ENV['SYSTEMDRIVE']}\\chef\\backup"
else
"/var/chef/backup"
end
Chef::Config[:file_backup_path].should == backup_path
end
it "Chef::Config[:ssl_verify_mode] defaults to :verify_none" do
Chef::Config[:ssl_verify_mode].should == :verify_none
end
it "Chef::Config[:ssl_ca_path] defaults to nil" do
Chef::Config[:ssl_ca_path].should be_nil
end
describe "when on UNIX" do
before do
Chef::Config.stub(:on_windows?).and_return(false)
end
it "Chef::Config[:ssl_ca_file] defaults to nil" do
Chef::Config[:ssl_ca_file].should be_nil
end
end
it "Chef::Config[:data_bag_path] defaults to /var/chef/data_bags" do
data_bag_path =
Chef::Config.platform_specific_path("/var/chef/data_bags")
Chef::Config[:data_bag_path].should == data_bag_path
end
it "Chef::Config[:environment_path] defaults to /var/chef/environments" do
environment_path = if windows?
"C:\\chef\\environments"
else
"/var/chef/environments"
end
Chef::Config[:environment_path].should == environment_path
end
describe "joining platform specific paths" do
context "on UNIX" do
before do
Chef::Config.stub(:on_windows?).and_return(false)
end
it "joins components when some end with separators" do
Chef::Config.path_join("/foo/", "bar", "baz").should == "/foo/bar/baz"
end
it "joins components that don't end in separators" do
Chef::Config.path_join("/foo", "bar", "baz").should == "/foo/bar/baz"
end
end
context "on Windows" do
before do
Chef::Config.stub(:on_windows?).and_return(true)
end
it "joins components with the windows separator" do
Chef::Config.path_join('c:\\foo\\', 'bar', "baz").should == 'c:\\foo\\bar\\baz'
end
end
end
describe "setting the config dir" do
before do
Chef::Config.stub(:on_windows?).and_return(false)
Chef::Config.config_file = "/etc/chef/client.rb"
end
context "by default" do
it "is the parent dir of the config file" do
Chef::Config.config_dir.should == "/etc/chef"
end
end
context "when chef is running in local mode" do
before do
Chef::Config.local_mode = true
Chef::Config.user_home = "/home/charlie"
end
it "is in the user's home dir" do
Chef::Config.config_dir.should == "/home/charlie/.chef/"
end
end
context "when explicitly set" do
before do
Chef::Config.config_dir = "/other/config/dir/"
end
it "uses the explicit value" do
Chef::Config.config_dir.should == "/other/config/dir/"
end
end
end
describe "finding the windows embedded dir" do
let(:default_config_location) { "c:/opscode/chef/embedded/lib/ruby/gems/1.9.1/gems/chef-11.6.0/lib/chef/config.rb" }
let(:alternate_install_location) { "c:/my/alternate/install/place/chef/embedded/lib/ruby/gems/1.9.1/gems/chef-11.6.0/lib/chef/config.rb" }
let(:non_omnibus_location) { "c:/my/dev/stuff/lib/ruby/gems/1.9.1/gems/chef-11.6.0/lib/chef/config.rb" }
let(:default_ca_file) { "c:/opscode/chef/embedded/ssl/certs/cacert.pem" }
it "finds the embedded dir in the default location" do
Chef::Config.stub(:_this_file).and_return(default_config_location)
Chef::Config.embedded_dir.should == "c:/opscode/chef/embedded"
end
it "finds the embedded dir in a custom install location" do
Chef::Config.stub(:_this_file).and_return(alternate_install_location)
Chef::Config.embedded_dir.should == "c:/my/alternate/install/place/chef/embedded"
end
it "doesn't error when not in an omnibus install" do
Chef::Config.stub(:_this_file).and_return(non_omnibus_location)
Chef::Config.embedded_dir.should be_nil
end
it "sets the ssl_ca_cert path if the cert file is available" do
Chef::Config.stub(:_this_file).and_return(default_config_location)
Chef::Config.stub(:on_windows?).and_return(true)
File.stub(:exist?).with(default_ca_file).and_return(true)
Chef::Config.ssl_ca_file.should == default_ca_file
end
end
end
describe "Chef::Config[:user_home]" do
it "should set when HOME is provided" do
ENV['HOME'] = "/home/kitten"
load File.expand_path(File.join(File.dirname(__FILE__), "..", "..", "lib", "chef", "config.rb"))
Chef::Config[:user_home].should == "/home/kitten"
end
it "should be set when only USERPROFILE is provided" do
ENV['HOME'], ENV['SYSTEMDRIVE'], ENV['HOMEPATH'] = nil, nil, nil
ENV['USERPROFILE'] = "/users/kitten"
load File.expand_path(File.join(File.dirname(__FILE__), "..", "..", "lib", "chef", "config.rb"))
Chef::Config[:user_home].should == "/users/kitten"
end
after(:each) do
@original_env.each do |env_setting|
ENV[env_setting[0]] = env_setting[1]
end
end
end
describe "Chef::Config[:encrypted_data_bag_secret]" do
db_secret_default_path =
Chef::Config.platform_specific_path("/etc/chef/encrypted_data_bag_secret")
let(:db_secret_default_path){ db_secret_default_path }
before do
File.stub(:exist?).with(db_secret_default_path).and_return(secret_exists)
# ugh...the only way to properly test this since the conditional
# is evaluated at file load/require time.
$LOADED_FEATURES.delete_if{|f| f =~ /chef\/config\.rb/}
require 'chef/config'
end
context "#{db_secret_default_path} exists" do
let(:secret_exists) { true }
it "sets the value to #{db_secret_default_path}" do
Chef::Config[:encrypted_data_bag_secret].should eq db_secret_default_path
end
end
context "#{db_secret_default_path} does not exist" do
let(:secret_exists) { false }
it "sets the value to nil" do
Chef::Config[:encrypted_data_bag_secret].should be_nil
end
end
end
describe "Chef::Config[:log_location]" do
it "raises ConfigurationError when log_location directory is missing" do
missing_path = "/tmp/non-existing-dir/file"
expect{Chef::Config.log_location = missing_path}.to raise_error Chef::Exceptions::ConfigurationError
end
end
end
|