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
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
|
#
# Author:: Bryan McLellan (btm@loftninjas.org)
# Copyright:: Copyright 2009-2016, Bryan McLellan
# 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"
class Chef::Provider::Service::Freebsd
public :service_enable_variable_name
public :determine_enabled_status!
public :determine_current_status!
end
describe Chef::Provider::Service::Freebsd do
let(:node) do
node = Chef::Node.new
node.automatic_attrs[:command] = { ps: "ps -ax" }
node
end
let(:new_resource) do
new_resource = Chef::Resource::Service.new("apache22")
new_resource.pattern("httpd")
new_resource.supports({ status: false })
new_resource
end
let(:current_resource) do
current_resource = Chef::Resource::Service.new("apache22")
current_resource
end
let(:provider) do
events = Chef::EventDispatch::Dispatcher.new
run_context = Chef::RunContext.new(node, {}, events)
provider = Chef::Provider::Service::Freebsd.new(new_resource, run_context)
provider.action = :start
provider
end
before do
allow(Chef::Resource::Service).to receive(:new).and_return(current_resource)
end
def stub_etc_rcd_script
allow(::File).to receive(:exist?).and_return(false)
expect(::File).to receive(:exist?).with("/etc/rc.d/#{new_resource.service_name}").and_return(true)
end
def stub_usr_local_rcd_script
allow(::File).to receive(:exist?).and_return(false)
expect(::File).to receive(:exist?).with("/usr/local/etc/rc.d/#{new_resource.service_name}").and_return(true)
end
def run_load_current_resource
stub_usr_local_rcd_script
provider.load_current_resource
end
describe Chef::Provider::Service::Freebsd, "initialize" do
it "should default enabled_state_found to false" do
expect(provider.enabled_state_found).to be false
end
it "should find /usr/local/etc/rc.d init scripts" do
stub_usr_local_rcd_script
expect(provider.init_command).to eql "/usr/local/etc/rc.d/apache22"
end
it "should find /etc/rc.d init scripts" do
stub_etc_rcd_script
expect(provider.init_command).to eql "/etc/rc.d/apache22"
end
it "should set init_command to nil if it can't find anything" do
allow(::File).to receive(:exist?).and_return(false)
expect(provider.init_command).to be nil
end
end
describe Chef::Provider::Service::Freebsd, "determine_current_status!" do
before do
stub_usr_local_rcd_script
provider.current_resource = current_resource
current_resource.service_name(new_resource.service_name)
end
context "when a status command has been specified" do
let(:status) { double(stdout: "", exitstatus: 0) }
before do
new_resource.status_command("/bin/chefhasmonkeypants status")
end
it "should run the services status command if one has been specified" do
expect(provider).to receive(:shell_out).with("/bin/chefhasmonkeypants status").and_return(status)
provider.determine_current_status!
end
end
context "when the service supports status" do
let(:status) { double(stdout: "", exitstatus: 0) }
before do
new_resource.supports({ status: true })
end
it "should run '/etc/init.d/service_name status'" do
expect(provider).to receive(:shell_out).with("/usr/local/etc/rc.d/#{new_resource.service_name} status").and_return(status)
provider.determine_current_status!
end
it "should set running to true if the status command returns 0" do
expect(provider).to receive(:shell_out).with("/usr/local/etc/rc.d/#{new_resource.service_name} status").and_return(status)
provider.determine_current_status!
expect(current_resource.running).to be true
end
it "should set running to false if the status command returns anything except 0" do
expect(provider).to receive(:shell_out).with("/usr/local/etc/rc.d/#{new_resource.service_name} status").and_raise(Mixlib::ShellOut::ShellCommandFailed)
provider.determine_current_status!
expect(current_resource.running).to be false
end
end
context "when we have a 'ps' property" do
let(:stdout) do
StringIO.new(<<~PS_SAMPLE)
413 ?? Ss 0:02.51 /usr/sbin/syslogd -s
539 ?? Is 0:00.14 /usr/sbin/sshd
545 ?? Ss 0:17.53 sendmail: accepting connections (sendmail)
PS_SAMPLE
end
let(:status) { double(stdout: stdout, exitstatus: 0) }
before do
node.automatic_attrs[:command] = { ps: "ps -ax" }
end
it "should shell_out! the node's ps command" do
expect(provider).to receive(:shell_out!).with(node[:command][:ps]).and_return(status)
provider.determine_current_status!
end
it "should read stdout of the ps command" do
allow(provider).to receive(:shell_out!).and_return(status)
expect(stdout).to receive(:each_line).and_return(true)
provider.determine_current_status!
end
context "when the regex matches the output" do
let(:stdout) do
StringIO.new(<<~PS_SAMPLE)
555 ?? Ss 0:05.16 /usr/sbin/cron -s
9881 ?? Ss 0:06.67 /usr/local/sbin/httpd -DNOHTTPACCEPT
PS_SAMPLE
end
it "should set running to true" do
allow(provider).to receive(:shell_out!).and_return(status)
provider.determine_current_status!
expect(current_resource.running).to be_truthy
end
end
it "should set running to false if the regex doesn't match" do
allow(provider).to receive(:shell_out!).and_return(status)
provider.determine_current_status!
expect(current_resource.running).to be_falsey
end
it "should set running to nil if ps fails" do
allow(provider).to receive(:shell_out!).and_raise(Mixlib::ShellOut::ShellCommandFailed)
provider.determine_current_status!
expect(current_resource.running).to be_nil
expect(provider.status_load_success).to be_nil
end
context "when ps is empty string" do
before do
node.automatic_attrs[:command] = { ps: "" }
end
it "should set running to nil" do
provider.determine_current_status!
expect(current_resource.running).to be_nil
end
end
end
end
describe Chef::Provider::Service::Freebsd, "determine_enabled_status!" do
before do
stub_usr_local_rcd_script
provider.current_resource = current_resource
current_resource.service_name(new_resource.service_name)
allow(provider).to receive(:service_enable_variable_name).and_return("#{new_resource.service_name}_enable")
end
context "when /etc/rc.conf does not exist" do
before do
expect(::File).to receive(:exist?).with("/etc/rc.conf").and_return(false)
end
it "sets enabled to false" do
provider.determine_enabled_status!
expect(current_resource.enabled).to be false
end
end
context "when /etc/rc.conf does exist" do
before do
expect(::File).to receive(:exist?).with("/etc/rc.conf").and_return(true)
expect(provider).to receive(:read_rc_conf).and_return(lines)
end
%w{YES Yes yes yEs YeS}.each do |setting|
context "when the enable variable is set to #{setting}" do
let(:lines) { [ %Q{#{new_resource.service_name}_enable="#{setting}"} ] }
it "sets enabled to true" do
provider.determine_enabled_status!
expect(current_resource.enabled).to be true
end
end
end
%w{No NO no nO None NONE none nOnE}.each do |setting|
context "when the enable variable is set to #{setting}" do
let(:lines) { [ %Q{#{new_resource.service_name}_enable="#{setting}"} ] }
it "sets enabled to false" do
provider.determine_enabled_status!
expect(current_resource.enabled).to be false
end
end
end
context "when the enable variable is garbage" do
let(:lines) { [ %Q{#{new_resource.service_name}_enable="alskdjflasdkjflakdfj"} ] }
it "sets enabled to false" do
provider.determine_enabled_status!
expect(current_resource.enabled).to be false
end
end
context "when the enable variable partial matches (left) some other service and we are disabled" do
let(:lines) do
[
%Q{thing_#{new_resource.service_name}_enable="YES"},
%Q{#{new_resource.service_name}_enable="NO"},
] end
it "sets enabled based on the exact match (false)" do
provider.determine_enabled_status!
expect(current_resource.enabled).to be false
end
end
context "when the enable variable partial matches (right) some other service and we are disabled" do
let(:lines) do
[
%Q{#{new_resource.service_name}_thing_enable="YES"},
%Q{#{new_resource.service_name}_enable="NO"},
] end
it "sets enabled based on the exact match (false)" do
provider.determine_enabled_status!
expect(current_resource.enabled).to be false
end
end
context "when the enable variable partial matches (left) some other disabled service and we are enabled" do
let(:lines) do
[
%Q{thing_#{new_resource.service_name}_enable="NO"},
%Q{#{new_resource.service_name}_enable="YES"},
] end
it "sets enabled based on the exact match (true)" do
provider.determine_enabled_status!
expect(current_resource.enabled).to be true
end
end
context "when the enable variable partial matches (right) some other disabled service and we are enabled" do
let(:lines) do
[
%Q{#{new_resource.service_name}_thing_enable="NO"},
%Q{#{new_resource.service_name}_enable="YES"},
] end
it "sets enabled based on the exact match (true)" do
provider.determine_enabled_status!
expect(current_resource.enabled).to be true
end
end
context "when the enable variable only partial matches (left) some other enabled service" do
let(:lines) { [ %Q{thing_#{new_resource.service_name}_enable="YES"} ] }
it "sets enabled to false" do
provider.determine_enabled_status!
expect(current_resource.enabled).to be false
end
end
context "when the enable variable only partial matches (right) some other enabled service" do
let(:lines) { [ %Q{#{new_resource.service_name}_thing_enable="YES"} ] }
it "sets enabled to false" do
provider.determine_enabled_status!
expect(current_resource.enabled).to be false
end
end
context "when nothing matches" do
let(:lines) { [] }
it "sets enabled to true" do
provider.determine_enabled_status!
expect(current_resource.enabled).to be false
end
end
end
end
describe Chef::Provider::Service::Freebsd, "service_enable_variable_name" do
before do
stub_usr_local_rcd_script
provider.current_resource = current_resource
current_resource.service_name(new_resource.service_name)
expect(::File).to receive(:open).with("/usr/local/etc/rc.d/#{new_resource.service_name}").and_yield(rcscript)
end
context "when the rc script has a 'name' variable" do
let(:rcscript) do
StringIO.new(<<~EOF)
name="#{new_resource.service_name}"
rcvar=`set_rcvar`
EOF
end
it "should not raise an exception if the rcscript have a name variable" do
expect { provider.service_enable_variable_name }.not_to raise_error
end
it "should not run rcvar" do
expect(provider).not_to receive(:shell_out!)
provider.service_enable_variable_name
end
it "should return the enable variable determined from the rcscript name" do
expect(provider.service_enable_variable_name).to eql "#{new_resource.service_name}_enable"
end
end
describe "when the rcscript does not have a name variable" do
let(:rcscript) do
StringIO.new <<~EOF
rcvar=`set_rcvar`
EOF
end
before do
status = double(stdout: rcvar_stdout, exitstatus: 0)
allow(provider).to receive(:shell_out!).with("/usr/local/etc/rc.d/#{new_resource.service_name} rcvar").and_return(status)
end
describe "when rcvar returns foobar_enable" do
let(:rcvar_stdout) do
rcvar_stdout = <<~EOF
# apache22
#
# #{new_resource.service_name}_enable="YES"
# (default: "")
EOF
end
it "should get the service name from rcvar if the rcscript does not have a name variable" do
expect(provider.service_enable_variable_name).to eq("#{new_resource.service_name}_enable")
end
it "should not raise an exception if the rcscript does not have a name variable" do
expect { provider.service_enable_variable_name }.not_to raise_error
end
end
describe "when rcvar does not return foobar_enable" do
let(:rcvar_stdout) do
rcvar_stdout = <<~EOF
# service_with_noname
#
EOF
end
it "should return nil" do
expect(provider.service_enable_variable_name).to be nil
end
end
end
end
describe Chef::Provider::Service::Freebsd, "load_current_resource" do
before(:each) do
stub_usr_local_rcd_script
expect(provider).to receive(:determine_current_status!)
current_resource.running(false)
allow(provider).to receive(:service_enable_variable_name).and_return "#{new_resource.service_name}_enable"
end
it "should create a current resource with the name of the new resource" do
expect(Chef::Resource::Service).to receive(:new).and_return(current_resource)
provider.load_current_resource
end
it "should set the current resources service name to the new resources service name" do
provider.load_current_resource
expect(current_resource.service_name).to eq(new_resource.service_name)
end
it "should return the current resource" do
expect(provider.load_current_resource).to eql(current_resource)
end
end
context "when testing actions" do
before(:each) do
stub_usr_local_rcd_script
expect(provider).to receive(:determine_current_status!)
current_resource.running(false)
expect(provider).to receive(:determine_enabled_status!)
current_resource.enabled(false)
provider.load_current_resource
end
describe Chef::Provider::Service::Freebsd, "start_service" do
it "should call the start command if one is specified" do
new_resource.start_command("/etc/rc.d/chef startyousillysally")
expect(provider).to receive(:shell_out!).with("/etc/rc.d/chef startyousillysally", default_env: false)
provider.start_service()
end
it "should call '/usr/local/etc/rc.d/service_name faststart' if no start command is specified" do
expect(provider).to receive(:shell_out!).with("/usr/local/etc/rc.d/#{new_resource.service_name} faststart", default_env: false)
provider.start_service()
end
end
describe Chef::Provider::Service::Freebsd, "stop_service" do
it "should call the stop command if one is specified" do
new_resource.stop_command("/etc/init.d/chef itoldyoutostop")
expect(provider).to receive(:shell_out!).with("/etc/init.d/chef itoldyoutostop", default_env: false)
provider.stop_service()
end
it "should call '/usr/local/etc/rc.d/service_name faststop' if no stop command is specified" do
expect(provider).to receive(:shell_out!).with("/usr/local/etc/rc.d/#{new_resource.service_name} faststop", default_env: false)
provider.stop_service()
end
end
describe Chef::Provider::Service::Freebsd, "restart_service" do
it "should call 'restart' on the service_name if the resource supports it" do
new_resource.supports({ restart: true })
expect(provider).to receive(:shell_out!).with("/usr/local/etc/rc.d/#{new_resource.service_name} fastrestart", default_env: false)
provider.restart_service()
end
it "should call the restart_command if one has been specified" do
new_resource.restart_command("/etc/init.d/chef restartinafire")
expect(provider).to receive(:shell_out!).with("/etc/init.d/chef restartinafire", default_env: false)
provider.restart_service()
end
it "otherwise it should call stop and start" do
expect(provider).to receive(:stop_service)
expect(provider).to receive(:start_service)
provider.restart_service()
end
end
end
describe Chef::Provider::Service::Freebsd, "define_resource_requirements" do
before do
provider.current_resource = current_resource
end
context "when the init script is not found" do
before do
provider.init_command = nil
allow(provider).to receive(:service_enable_variable_name).and_return("#{new_resource.service_name}_enable")
end
%w{start reload restart enable}.each do |action|
it "should raise an exception when the action is #{action}" do
provider.define_resource_requirements
provider.action = action
expect { provider.process_resource_requirements }.to raise_error(Chef::Exceptions::Service)
end
end
%w{stop disable}.each do |action|
it "should not raise an error when the action is #{action}" do
provider.define_resource_requirements
provider.action = action
expect { provider.process_resource_requirements }.not_to raise_error
end
end
end
context "when the init script is found, but the service_enable_variable_name is nil" do
before do
provider.init_command = nil
allow(provider).to receive(:service_enable_variable_name).and_return(nil)
end
%w{start reload restart enable}.each do |action|
it "should raise an exception when the action is #{action}" do
provider.action = action
provider.define_resource_requirements
expect { provider.process_resource_requirements }.to raise_error(Chef::Exceptions::Service)
end
end
%w{stop disable}.each do |action|
it "should not raise an error when the action is #{action}" do
provider.action = action
provider.define_resource_requirements
expect { provider.process_resource_requirements }.not_to raise_error
end
end
end
end
describe Chef::Provider::Service::Freebsd, "enable_service" do
before do
provider.current_resource = current_resource
allow(provider).to receive(:service_enable_variable_name).and_return("#{new_resource.service_name}_enable")
end
it "should enable the service if it is not enabled" do
allow(current_resource).to receive(:enabled).and_return(false)
expect(provider).to receive(:read_rc_conf).and_return([ "foo", "#{new_resource.service_name}_enable=\"NO\"", "bar" ])
expect(provider).to receive(:write_rc_conf).with(["foo", "bar", "#{new_resource.service_name}_enable=\"YES\""])
provider.enable_service()
end
it "should not partial match an already enabled service" do
allow(current_resource).to receive(:enabled).and_return(false)
expect(provider).to receive(:read_rc_conf).and_return([ "foo", "thing_#{new_resource.service_name}_enable=\"NO\"", "bar" ])
expect(provider).to receive(:write_rc_conf).with(["foo", "thing_#{new_resource.service_name}_enable=\"NO\"", "bar", "#{new_resource.service_name}_enable=\"YES\""])
provider.enable_service()
end
it "should enable the service if it is not enabled and not already specified in the rc.conf file" do
allow(current_resource).to receive(:enabled).and_return(false)
expect(provider).to receive(:read_rc_conf).and_return(%w{foo bar})
expect(provider).to receive(:write_rc_conf).with(["foo", "bar", "#{new_resource.service_name}_enable=\"YES\""])
provider.enable_service()
end
it "should not enable the service if it is already enabled" do
allow(current_resource).to receive(:enabled).and_return(true)
expect(provider).not_to receive(:write_rc_conf)
provider.enable_service
end
it "should remove commented out versions of it being enabled" do
allow(current_resource).to receive(:enabled).and_return(false)
expect(provider).to receive(:read_rc_conf).and_return([ "foo", "bar", "\# #{new_resource.service_name}_enable=\"YES\"", "\# #{new_resource.service_name}_enable=\"NO\""])
expect(provider).to receive(:write_rc_conf).with(["foo", "bar", "#{new_resource.service_name}_enable=\"YES\""])
provider.enable_service()
end
end
describe Chef::Provider::Service::Freebsd, "disable_service" do
before do
provider.current_resource = current_resource
allow(provider).to receive(:service_enable_variable_name).and_return("#{new_resource.service_name}_enable")
end
it "should disable the service if it is not disabled" do
allow(current_resource).to receive(:enabled).and_return(true)
expect(provider).to receive(:read_rc_conf).and_return([ "foo", "#{new_resource.service_name}_enable=\"YES\"", "bar" ])
expect(provider).to receive(:write_rc_conf).with(["foo", "bar", "#{new_resource.service_name}_enable=\"NO\""])
provider.disable_service()
end
it "should not disable an enabled service that partially matches" do
allow(current_resource).to receive(:enabled).and_return(true)
expect(provider).to receive(:read_rc_conf).and_return([ "foo", "thing_#{new_resource.service_name}_enable=\"YES\"", "bar" ])
expect(provider).to receive(:write_rc_conf).with(["foo", "thing_#{new_resource.service_name}_enable=\"YES\"", "bar", "#{new_resource.service_name}_enable=\"NO\""])
provider.disable_service()
end
it "should not disable the service if it is already disabled" do
allow(current_resource).to receive(:enabled).and_return(false)
expect(provider).not_to receive(:write_rc_conf)
provider.disable_service()
end
it "should remove commented out versions of it being disabled or enabled" do
allow(current_resource).to receive(:enabled).and_return(true)
expect(provider).to receive(:read_rc_conf).and_return([ "foo", "bar", "\# #{new_resource.service_name}_enable=\"YES\"", "\# #{new_resource.service_name}_enable=\"NO\""])
expect(provider).to receive(:write_rc_conf).with(["foo", "bar", "#{new_resource.service_name}_enable=\"NO\""])
provider.disable_service()
end
end
end
|