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
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
|
#!/usr/bin/env rspec
require 'spec_helper'
describe Puppet::Type.type(:exec) do
include PuppetSpec::Files
def exec_tester(command, exitstatus = 0, rest = {})
@user_name = 'some_user_name'
@group_name = 'some_group_name'
Puppet.features.stubs(:root?).returns(true)
output = rest.delete(:output) || ''
tries = rest[:tries] || 1
args = {
:name => command,
:path => @example_path,
:user => @user_name,
:group => @group_name,
:logoutput => false,
:loglevel => :err,
:returns => 0
}.merge(rest)
exec = Puppet::Type.type(:exec).new(args)
status = stub "process", :exitstatus => exitstatus
Puppet::Util::SUIDManager.expects(:run_and_capture).times(tries).
with([command], @user_name, @group_name).returns([output, status])
return exec
end
before do
@command = make_absolute('/bin/true whatever')
@executable = make_absolute('/bin/true')
@bogus_cmd = make_absolute('/bogus/cmd')
end
describe "when not stubbing the provider", :fails_on_windows => true do
before do
File.stubs(:exists?).returns false
File.stubs(:exists?).with(@executable).returns true
File.stubs(:exists?).with('/bin/false').returns true
@example_path = Puppet.features.posix? ? %w{/usr/bin /bin} : [ "C:/Program Files/something/bin", "C:/Ruby/bin" ]
File.stubs(:exists?).with(File.join(@example_path[0],"true")).returns true
File.stubs(:exists?).with(File.join(@example_path[0],"false")).returns true
end
it "should return :executed_command as its event" do
resource = Puppet::Type.type(:exec).new :command => @command
resource.parameter(:returns).event.name.should == :executed_command
end
describe "when execing" do
it "should use the 'run_and_capture' method to exec" do
exec_tester("true").refresh.should == :executed_command
end
it "should report a failure" do
proc { exec_tester('false', 1).refresh }.
should raise_error(Puppet::Error, /^false returned 1 instead of/)
end
it "should not report a failure if the exit status is specified in a returns array" do
proc { exec_tester("false", 1, :returns => [0, 1]).refresh }.should_not raise_error
end
it "should report a failure if the exit status is not specified in a returns array" do
proc { exec_tester('false', 1, :returns => [0, 100]).refresh }.
should raise_error(Puppet::Error, /^false returned 1 instead of/)
end
it "should log the output on success" do
output = "output1\noutput2\n"
exec_tester('false', 0, :output => output, :logoutput => true).refresh
output.split("\n").each do |line|
log = @logs.shift
log.level.should == :err
log.message.should == line
end
end
it "should log the output on failure" do
output = "output1\noutput2\n"
proc { exec_tester('false', 1, :output => output, :logoutput => true).refresh }.
should raise_error(Puppet::Error)
output.split("\n").each do |line|
log = @logs.shift
log.level.should == :err
log.message.should == line
end
end
end
describe "when logoutput=>on_failure is set" do
it "should log the output on failure" do
output = "output1\noutput2\n"
proc { exec_tester('false', 1, :output => output, :logoutput => :on_failure).refresh }.
should raise_error(Puppet::Error, /^false returned 1 instead of/)
output.split("\n").each do |line|
log = @logs.shift
log.level.should == :err
log.message.should == line
end
end
it "should log the output on failure when returns is specified as an array" do
output = "output1\noutput2\n"
proc {
exec_tester('false', 1, :output => output, :returns => [0, 100],
:logoutput => :on_failure).refresh
}.should raise_error(Puppet::Error, /^false returned 1 instead of/)
output.split("\n").each do |line|
log = @logs.shift
log.level.should == :err
log.message.should == line
end
end
it "shouldn't log the output on success" do
exec_tester('true', 0, :output => "a\nb\nc\n", :logoutput => :on_failure).refresh
@logs.should == []
end
end
it "shouldn't log the output on success when non-zero exit status is in a returns array" do
exec_tester("true", 100, :output => "a\n", :logoutput => :on_failure, :returns => [1, 100]).refresh
@logs.should == []
end
describe " when multiple tries are set," do
it "should repeat the command attempt 'tries' times on failure and produce an error" do
tries = 5
resource = exec_tester("false", 1, :tries => tries, :try_sleep => 0)
proc { resource.refresh }.should raise_error(Puppet::Error)
end
end
end
it "should be able to autorequire files mentioned in the command", :fails_on_windows => true do
foo = make_absolute('/bin/foo')
catalog = Puppet::Resource::Catalog.new
tmp = Puppet::Type.type(:file).new(:name => foo)
catalog.add_resource tmp
execer = Puppet::Type.type(:exec).new(:name => foo)
catalog.add_resource execer
catalog.relationship_graph.dependencies(execer).should == [tmp]
end
describe "when handling the path parameter", :fails_on_windows => true do
expect = %w{one two three four}
{ "an array" => expect,
"a colon separated list" => "one:two:three:four",
"a semi-colon separated list" => "one;two;three;four",
"both array and colon lists" => ["one", "two:three", "four"],
"both array and semi-colon lists" => ["one", "two;three", "four"],
"colon and semi-colon lists" => ["one:two", "three;four"]
}.each do |test, input|
it "should accept #{test}" do
type = Puppet::Type.type(:exec).new(:name => @command, :path => input)
type[:path].should == expect
end
end
end
describe "when setting user", :fails_on_windows => true do
it "should fail if we are not root" do
Puppet.features.stubs(:root?).returns(false)
expect { Puppet::Type.type(:exec).new(:name => @command, :user => 'input') }.
should raise_error Puppet::Error, /Parameter user failed/
end
['one', 2, 'root', 4294967295, 4294967296].each do |value|
it "should accept '#{value}' as user if we are root" do
Puppet.features.stubs(:root?).returns(true)
type = Puppet::Type.type(:exec).new(:name => @command, :user => value)
type[:user].should == value
end
end
end
describe "when setting group" do
shared_examples_for "exec[:group]" do
['one', 2, 'wheel', 4294967295, 4294967296].each do |value|
it "should accept '#{value}' without error or judgement", :fails_on_windows => true do
type = Puppet::Type.type(:exec).new(:name => @command, :group => value)
type[:group].should == value
end
end
end
describe "when running as root" do
before :each do Puppet.features.stubs(:root?).returns(true) end
it_behaves_like "exec[:group]"
end
describe "when not running as root" do
before :each do Puppet.features.stubs(:root?).returns(false) end
it_behaves_like "exec[:group]"
end
end
describe "when setting cwd" do
it_should_behave_like "all path parameters", :cwd, :array => false do
def instance(path)
Puppet::Type.type(:exec).new(:name => @executable, :cwd => path)
end
end
end
shared_examples_for "all exec command parameters" do |param|
{ "relative" => "example", "absolute" => "/bin/example" }.sort.each do |name, command|
describe "if command is #{name}" do
before :each do
@param = param
end
def test(command, valid)
if @param == :name then
instance = Puppet::Type.type(:exec).new()
else
instance = Puppet::Type.type(:exec).new(:name => @executable)
end
if valid then
instance.provider.expects(:validatecmd).returns(true)
else
instance.provider.expects(:validatecmd).raises(Puppet::Error, "from a stub")
end
instance[@param] = command
end
it "should work if the provider calls the command valid" do
expect { test(command, true) }.should_not raise_error
end
it "should fail if the provider calls the command invalid" do
expect { test(command, false) }.
should raise_error Puppet::Error, /Parameter #{@param} failed: from a stub/
end
end
end
end
shared_examples_for "all exec command parameters that take arrays" do |param|
describe "when given an array of inputs" do
before :each do
@test = Puppet::Type.type(:exec).new(:name => @executable)
end
it "should accept the array when all commands return valid" do
input = %w{one two three}
@test.provider.expects(:validatecmd).times(input.length).returns(true)
@test[param] = input
@test[param].should == input
end
it "should reject the array when any commands return invalid" do
input = %w{one two three}
@test.provider.expects(:validatecmd).with(input.first).returns(false)
input[1..-1].each do |cmd|
@test.provider.expects(:validatecmd).with(cmd).returns(true)
end
@test[param] = input
@test[param].should == input
end
it "should reject the array when all commands return invalid" do
input = %w{one two three}
@test.provider.expects(:validatecmd).times(input.length).returns(false)
@test[param] = input
@test[param].should == input
end
end
end
describe "when setting refresh" do
it_should_behave_like "all exec command parameters", :refresh
end
describe "for simple parameters" do
before :each do
@exec = Puppet::Type.type(:exec).new(:name => @executable)
end
describe "when setting environment" do
{ "single values" => "foo=bar",
"multiple values" => ["foo=bar", "baz=quux"],
}.each do |name, data|
it "should accept #{name}" do
@exec[:environment] = data
@exec[:environment].should == data
end
end
{ "single values" => "foo",
"only values" => ["foo", "bar"],
"any values" => ["foo=bar", "baz"]
}.each do |name, data|
it "should reject #{name} without assignment" do
expect { @exec[:environment] = data }.
should raise_error Puppet::Error, /Invalid environment setting/
end
end
end
describe "when setting timeout" do
[0, 0.1, 1, 10, 4294967295].each do |valid|
it "should accept '#{valid}' as valid" do
@exec[:timeout] = valid
@exec[:timeout].should == valid
end
it "should accept '#{valid}' in an array as valid" do
@exec[:timeout] = [valid]
@exec[:timeout].should == valid
end
end
['1/2', '', 'foo', '5foo'].each do |invalid|
it "should reject '#{invalid}' as invalid" do
expect { @exec[:timeout] = invalid }.
should raise_error Puppet::Error, /The timeout must be a number/
end
it "should reject '#{invalid}' in an array as invalid" do
expect { @exec[:timeout] = [invalid] }.
should raise_error Puppet::Error, /The timeout must be a number/
end
end
# REMIND: the exec provider is not supported on windows yet
it "should fail if timeout is exceeded", :fails_on_windows => true do
File.stubs(:exists?).with('/bin/sleep').returns(true)
File.stubs(:exists?).with('sleep').returns(false)
sleep_exec = Puppet::Type.type(:exec).new(:name => 'sleep 1', :path => ['/bin'], :timeout => '0.2')
lambda { sleep_exec.refresh }.should raise_error Puppet::Error, "Command exceeded timeout"
end
it "should convert timeout to a float" do
command = make_absolute('/bin/false')
resource = Puppet::Type.type(:exec).new :command => command, :timeout => "12"
resource[:timeout].should be_a(Float)
resource[:timeout].should == 12.0
end
it "should munge negative timeouts to 0.0" do
command = make_absolute('/bin/false')
resource = Puppet::Type.type(:exec).new :command => command, :timeout => "-12.0"
resource.parameter(:timeout).value.should be_a(Float)
resource.parameter(:timeout).value.should == 0.0
end
end
describe "when setting tries" do
[1, 10, 4294967295].each do |valid|
it "should accept '#{valid}' as valid" do
@exec[:tries] = valid
@exec[:tries].should == valid
end
if "REVISIT: too much test log spam" == "a good thing" then
it "should accept '#{valid}' in an array as valid" do
pending "inconsistent, but this is not supporting arrays, unlike timeout"
@exec[:tries] = [valid]
@exec[:tries].should == valid
end
end
end
[-3.5, -1, 0, 0.2, '1/2', '1_000_000', '+12', '', 'foo'].each do |invalid|
it "should reject '#{invalid}' as invalid" do
expect { @exec[:tries] = invalid }.
should raise_error Puppet::Error, /Tries must be an integer/
end
if "REVISIT: too much test log spam" == "a good thing" then
it "should reject '#{invalid}' in an array as invalid" do
pending "inconsistent, but this is not supporting arrays, unlike timeout"
expect { @exec[:tries] = [invalid] }.
should raise_error Puppet::Error, /Tries must be an integer/
end
end
end
end
describe "when setting try_sleep" do
[0, 0.2, 1, 10, 4294967295].each do |valid|
it "should accept '#{valid}' as valid" do
@exec[:try_sleep] = valid
@exec[:try_sleep].should == valid
end
if "REVISIT: too much test log spam" == "a good thing" then
it "should accept '#{valid}' in an array as valid" do
pending "inconsistent, but this is not supporting arrays, unlike timeout"
@exec[:try_sleep] = [valid]
@exec[:try_sleep].should == valid
end
end
end
{ -3.5 => "cannot be a negative number",
-1 => "cannot be a negative number",
'1/2' => 'must be a number',
'1_000_000' => 'must be a number',
'+12' => 'must be a number',
'' => 'must be a number',
'foo' => 'must be a number',
}.each do |invalid, error|
it "should reject '#{invalid}' as invalid" do
expect { @exec[:try_sleep] = invalid }.
should raise_error Puppet::Error, /try_sleep #{error}/
end
if "REVISIT: too much test log spam" == "a good thing" then
it "should reject '#{invalid}' in an array as invalid" do
pending "inconsistent, but this is not supporting arrays, unlike timeout"
expect { @exec[:try_sleep] = [invalid] }.
should raise_error Puppet::Error, /try_sleep #{error}/
end
end
end
end
describe "when setting refreshonly" do
[:true, :false].each do |value|
it "should accept '#{value}'" do
@exec[:refreshonly] = value
@exec[:refreshonly].should == value
end
end
[1, 0, "1", "0", "yes", "y", "no", "n"].each do |value|
it "should reject '#{value}'" do
expect { @exec[:refreshonly] = value }.
should raise_error(Puppet::Error,
/Invalid value #{value.inspect}\. Valid values are true, false/
)
end
end
end
describe "when setting creates" do
it_should_behave_like "all path parameters", :creates, :array => true do
def instance(path)
Puppet::Type.type(:exec).new(:name => @executable, :creates => path)
end
end
end
end
describe "when setting unless" do
it_should_behave_like "all exec command parameters", :unless
it_should_behave_like "all exec command parameters that take arrays", :unless
end
describe "when setting onlyif" do
it_should_behave_like "all exec command parameters", :onlyif
it_should_behave_like "all exec command parameters that take arrays", :onlyif
end
describe "#check" do
before :each do
@test = Puppet::Type.type(:exec).new(:name => @executable)
end
describe ":refreshonly" do
{ :true => false, :false => true }.each do |input, result|
it "should return '#{result}' when given '#{input}'" do
@test[:refreshonly] = input
@test.check_all_attributes.should == result
end
end
end
describe ":creates" do
before :all do
@exist = "/"
@unexist = "/this/path/should/never/exist"
while FileTest.exist?(@unexist) do @unexist += "/foo" end
end
context "with a single item" do
it "should run when the item does not exist" do
@test[:creates] = @unexist
@test.check_all_attributes.should == true
end
it "should not run when the item exists" do
@test[:creates] = @exist
@test.check_all_attributes.should == false
end
end
context "with an array with one item" do
it "should run when the item does not exist" do
@test[:creates] = [@unexist]
@test.check_all_attributes.should == true
end
it "should not run when the item exists" do
@test[:creates] = [@exist]
@test.check_all_attributes.should == false
end
end
context "with an array with multiple items" do
it "should run when all items do not exist" do
@test[:creates] = [@unexist] * 3
@test.check_all_attributes.should == true
end
it "should not run when one item exists" do
@test[:creates] = [@unexist, @exist, @unexist]
@test.check_all_attributes.should == false
end
it "should not run when all items exist" do
@test[:creates] = [@exist] * 3
end
end
end
{ :onlyif => { :pass => false, :fail => true },
:unless => { :pass => true, :fail => false },
}.each do |param, sense|
describe ":#{param}" do
before :each do
@pass = make_absolute("/magic/pass")
@fail = make_absolute("/magic/fail")
@pass_status = stub('status', :exitstatus => sense[:pass] ? 0 : 1)
@fail_status = stub('status', :exitstatus => sense[:fail] ? 0 : 1)
@test.provider.stubs(:checkexe).returns(true)
[true, false].each do |check|
@test.provider.stubs(:run).with(@pass, check).
returns(['test output', @pass_status])
@test.provider.stubs(:run).with(@fail, check).
returns(['test output', @fail_status])
end
end
context "with a single item" do
it "should run if the command exits non-zero" do
@test[param] = @fail
@test.check_all_attributes.should == true
end
it "should not run if the command exits zero" do
@test[param] = @pass
@test.check_all_attributes.should == false
end
end
context "with an array with a single item" do
it "should run if the command exits non-zero" do
@test[param] = [@fail]
@test.check_all_attributes.should == true
end
it "should not run if the command exits zero" do
@test[param] = [@pass]
@test.check_all_attributes.should == false
end
end
context "with an array with multiple items" do
it "should run if all the commands exits non-zero" do
@test[param] = [@fail] * 3
@test.check_all_attributes.should == true
end
it "should not run if one command exits zero" do
@test[param] = [@pass, @fail, @pass]
@test.check_all_attributes.should == false
end
it "should not run if all command exits zero" do
@test[param] = [@pass] * 3
@test.check_all_attributes.should == false
end
end
end
end
end
describe "#retrieve", :fails_on_windows => true do
before :each do
@exec_resource = Puppet::Type.type(:exec).new(:name => @bogus_cmd)
end
it "should return :notrun when check_all_attributes returns true" do
@exec_resource.stubs(:check_all_attributes).returns true
@exec_resource.retrieve[:returns].should == :notrun
end
it "should return default exit code 0 when check_all_attributes returns false" do
@exec_resource.stubs(:check_all_attributes).returns false
@exec_resource.retrieve[:returns].should == ['0']
end
it "should return the specified exit code when check_all_attributes returns false" do
@exec_resource.stubs(:check_all_attributes).returns false
@exec_resource[:returns] = 42
@exec_resource.retrieve[:returns].should == ["42"]
end
end
describe "#output" do
before :each do
@exec_resource = Puppet::Type.type(:exec).new(:name => @bogus_cmd)
end
it "should return the provider's run output" do
provider = stub 'provider'
status = stubs "process_status"
status.stubs(:exitstatus).returns("0")
provider.expects(:run).returns(["silly output", status])
@exec_resource.stubs(:provider).returns(provider)
@exec_resource.refresh
@exec_resource.output.should == 'silly output'
end
end
describe "#refresh" do
before :each do
@exec_resource = Puppet::Type.type(:exec).new(:name => @bogus_cmd)
end
it "should call provider run with the refresh parameter if it is set" do
myother_bogus_cmd = make_absolute('/myother/bogus/cmd')
provider = stub 'provider'
@exec_resource.stubs(:provider).returns(provider)
@exec_resource.stubs(:[]).with(:refresh).returns(myother_bogus_cmd)
provider.expects(:run).with(myother_bogus_cmd)
@exec_resource.refresh
end
it "should call provider run with the specified command if the refresh parameter is not set" do
provider = stub 'provider'
status = stubs "process_status"
status.stubs(:exitstatus).returns("0")
provider.expects(:run).with(@bogus_cmd).returns(["silly output", status])
@exec_resource.stubs(:provider).returns(provider)
@exec_resource.refresh
end
it "should not run the provider if check_all_attributes is false" do
@exec_resource.stubs(:check_all_attributes).returns false
provider = stub 'provider'
provider.expects(:run).never
@exec_resource.stubs(:provider).returns(provider)
@exec_resource.refresh
end
end
end
|