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
|
#
# Author:: AJ Christensen (<aj@junglist.gen.nz>)
# Copyright:: Copyright 2008-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"
describe Chef::Application::Client, "reconfigure" do
let(:app) do
a = described_class.new
a.cli_arguments = []
a
end
before do
allow(Kernel).to receive(:trap).and_return(:ok)
allow(::File).to receive(:read).with(Chef::Config.platform_specific_path("/etc/chef/client.rb")).and_return("")
@original_argv = ARGV.dup
ARGV.clear
allow(app).to receive(:trap)
allow(app).to receive(:configure_logging).and_return(true)
Chef::Config[:interval] = 10
Chef::Config[:once] = false
# protect the unit tests against accidental --delete-entire-chef-repo from firing
# for real during tests. DO NOT delete this line.
expect(FileUtils).not_to receive(:rm_rf)
end
after do
ARGV.replace(@original_argv)
end
describe "parse cli_arguments" do
it "should call set_specific_recipes" do
expect(app).to receive(:set_specific_recipes).and_return(true)
app.reconfigure
end
context "when given a named_run_list" do
before do
ARGV.replace( %w{ --named-run-list arglebargle-example } )
app.reconfigure
end
it "sets named_run_list in Chef::Config" do
expect(Chef::Config[:named_run_list]).to eq("arglebargle-example")
end
end
end
describe "when configured to not fork the client process" do
before do
Chef::Config[:client_fork] = false
Chef::Config[:daemonize] = false
Chef::Config[:interval] = nil
Chef::Config[:splay] = nil
end
context "when interval is given" do
before do
Chef::Config[:interval] = 600
allow(ChefConfig).to receive(:windows?).and_return(false)
end
it "should terminate with message" do
expect(Chef::Application).to receive(:fatal!).with(
"Unforked chef-client interval runs are disabled in Chef 12.
Configuration settings:
interval = 600 seconds
Enable chef-client interval runs by setting `:client_fork = true` in your config file or adding `--fork` to your command line options.",
)
app.reconfigure
end
end
context "when interval is given on windows" do
before do
Chef::Config[:interval] = 600
allow(ChefConfig).to receive(:windows?).and_return(true)
end
it "should not terminate" do
expect(Chef::Application).not_to receive(:fatal!)
app.reconfigure
end
end
context "when configured to run once" do
before do
Chef::Config[:once] = true
Chef::Config[:interval] = 1000
end
it "should reconfigure chef-client" do
app.reconfigure
expect(Chef::Config[:interval]).to be_nil
end
end
end
describe "when in daemonized mode and no interval has been set" do
before do
Chef::Config[:daemonize] = true
Chef::Config[:interval] = nil
end
it "should set the interval to 1800" do
app.reconfigure
expect(Chef::Config.interval).to eq(1800)
end
end
describe "when configured to run once" do
before do
Chef::Config[:once] = true
Chef::Config[:daemonize] = false
Chef::Config[:splay] = 60
Chef::Config[:interval] = 1800
end
it "ignores the splay" do
app.reconfigure
expect(Chef::Config.splay).to be_nil
end
it "forces the interval to nil" do
app.reconfigure
expect(Chef::Config.interval).to be_nil
end
end
describe "when --no-listen is set" do
it "configures listen = false" do
app.config[:listen] = false
app.reconfigure
expect(Chef::Config[:listen]).to eq(false)
end
end
describe "when the json_attribs configuration option is specified" do
let(:json_attribs) { { "a" => "b" } }
let(:config_fetcher) { double(Chef::ConfigFetcher, :fetch_json => json_attribs) }
let(:json_source) { "https://foo.com/foo.json" }
before do
allow(app).to receive(:configure_chef).and_return(true)
Chef::Config[:json_attribs] = json_source
expect(Chef::ConfigFetcher).to receive(:new).with(json_source).
and_return(config_fetcher)
end
it "reads the JSON attributes from the specified source" do
app.reconfigure
expect(app.chef_client_json).to eq(json_attribs)
end
end
describe "audit mode" do
shared_examples "experimental feature" do
before do
allow(Chef::Log).to receive(:warn)
end
end
shared_examples "unrecognized setting" do
it "fatals with a message including the incorrect setting" do
expect(Chef::Application).to receive(:fatal!).with(/Unrecognized setting #{mode} for audit mode/)
app.reconfigure
end
end
shared_context "set via config file" do
before do
Chef::Config[:audit_mode] = mode
end
end
shared_context "set via command line" do
before do
ARGV.replace(["--audit-mode", mode])
end
end
describe "enabled via config file" do
include_context "set via config file" do
let(:mode) { :enabled }
include_examples "experimental feature"
end
end
describe "enabled via command line" do
include_context "set via command line" do
let(:mode) { "enabled" }
include_examples "experimental feature"
end
end
describe "audit_only via config file" do
include_context "set via config file" do
let(:mode) { :audit_only }
include_examples "experimental feature"
end
end
describe "audit-only via command line" do
include_context "set via command line" do
let(:mode) { "audit-only" }
include_examples "experimental feature"
end
end
describe "unrecognized setting via config file" do
include_context "set via config file" do
let(:mode) { :derp }
include_examples "unrecognized setting"
end
end
describe "unrecognized setting via command line" do
include_context "set via command line" do
let(:mode) { "derp" }
include_examples "unrecognized setting"
end
end
end
describe "when both the pidfile and lockfile opts are set to the same value" do
before do
Chef::Config[:pid_file] = "/path/to/file"
Chef::Config[:lockfile] = "/path/to/file"
end
it "should throw an exception" do
expect { app.reconfigure }.to raise_error(Chef::Exceptions::PIDFileLockfileMatch)
end
end
end
describe Chef::Application::Client, "setup_application" do
before do
@app = Chef::Application::Client.new
# this is all stuff the reconfigure method needs
allow(@app).to receive(:configure_opt_parser).and_return(true)
allow(@app).to receive(:configure_chef).and_return(true)
allow(@app).to receive(:configure_logging).and_return(true)
end
it "should change privileges" do
expect(Chef::Daemon).to receive(:change_privilege).and_return(true)
@app.setup_application
end
after do
Chef::Config[:solo] = false
end
end
describe Chef::Application::Client, "configure_chef" do
let(:app) { Chef::Application::Client.new }
before do
@original_argv = ARGV.dup
ARGV.clear
allow(::File).to receive(:read).with(Chef::Config.platform_specific_path("/etc/chef/client.rb")).and_return("")
app.configure_chef
end
after do
ARGV.replace(@original_argv)
end
it "should set the colored output to true by default on windows and true on all other platforms as well" do
if windows?
expect(Chef::Config[:color]).to be_truthy
else
expect(Chef::Config[:color]).to be_truthy
end
end
end
describe Chef::Application::Client, "run_application", :unix_only do
before(:each) do
Chef::Config[:specific_recipes] = [] # normally gets set in @app.reconfigure
@app = Chef::Application::Client.new
@app.setup_signal_handlers
# Default logger doesn't work correctly when logging from a trap handler.
@app.configure_logging
@pipe = IO.pipe
@client = Chef::Client.new
allow(Chef::Client).to receive(:new).and_return(@client)
allow(@client).to receive(:run) do
@pipe[1].puts "started"
sleep 1
@pipe[1].puts "finished"
end
end
context "when sent SIGTERM", :volatile_on_solaris do
context "when converging in forked process" do
before do
Chef::Config[:daemonize] = true
allow(Chef::Daemon).to receive(:daemonize).and_return(true)
end
it "should exit hard with exitstatus 3", :volatile do
pid = fork do
@app.run_application
end
Process.kill("TERM", pid)
_pid, result = Process.waitpid2(pid)
expect(result.exitstatus).to eq(3)
end
it "should allow child to finish converging" do
pid = fork do
@app.run_application
end
expect(@pipe[0].gets).to eq("started\n")
Process.kill("TERM", pid)
Process.wait(pid)
# The timeout value needs to be large enough for the child process to finish
expect(IO.select([@pipe[0]], nil, nil, 15)).not_to be_nil
expect(@pipe[0].gets).to eq("finished\n")
end
end
context "when running unforked" do
before(:each) do
Chef::Config[:client_fork] = false
Chef::Config[:daemonize] = false
end
it "should exit gracefully when sent during converge" do
pid = fork do
@app.run_application
end
expect(@pipe[0].gets).to eq("started\n")
Process.kill("TERM", pid)
_pid, result = Process.waitpid2(pid)
expect(result.exitstatus).to eq(0)
expect(IO.select([@pipe[0]], nil, nil, 0)).not_to be_nil
expect(@pipe[0].gets).to eq("finished\n")
end
it "should exit hard when sent before converge" do
pid = fork do
sleep 3
@app.run_application
end
Process.kill("TERM", pid)
_pid, result = Process.waitpid2(pid)
expect(result.exitstatus).to eq(3)
end
end
end
describe "when splay is set" do
before do
Chef::Config[:splay] = 10
Chef::Config[:interval] = 10
run_count = 0
# uncomment to debug failures...
# Chef::Log.init($stderr)
# Chef::Log.level = :debug
allow(@app).to receive(:run_chef_client) do
run_count += 1
if run_count > 3
exit 0
end
# If everything is fine, sending USR1 to self should prevent
# app to go into splay sleep forever.
Process.kill("USR1", Process.pid)
# On Ruby < 2.1, we need to give the signal handlers a little
# more time, otherwise the test will fail because interleavings.
sleep 1
end
number_of_sleep_calls = 0
# This is a very complicated way of writing
# @app.should_receive(:sleep).once.
# We have to do it this way because the main loop of
# Chef::Application::Client swallows most exceptions, and we need to be
# able to expose our expectation failures to the parent process in the test.
allow(@app).to receive(:interval_sleep) do |arg|
number_of_sleep_calls += 1
if number_of_sleep_calls > 1
exit 127
end
end
end
it "shouldn't sleep when sent USR1" do
allow(@app).to receive(:interval_sleep).with(0).and_call_original
pid = fork do
@app.run_application
end
_pid, result = Process.waitpid2(pid)
expect(result.exitstatus).to eq(0)
end
end
end
|