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
|
#!/usr/bin/env rspec
require 'spec_helper'
require 'puppet/interface/action'
describe Puppet::Interface::Action do
describe "when validating the action name" do
[nil, '', 'foo bar', '-foobar'].each do |input|
it "should treat #{input.inspect} as an invalid name" do
expect { Puppet::Interface::Action.new(nil, input) }.
should raise_error(/is an invalid action name/)
end
end
end
describe "#when_invoked=" do
it "should fail if the block has arity 0" do
pending "Ruby 1.8 (painfully) treats argument-free blocks as arity -1" if
RUBY_VERSION =~ /^1\.8/
expect {
Puppet::Interface.new(:action_when_invoked, '1.0.0') do
action :foo do
when_invoked { }
end
end
}.to raise_error ArgumentError, /foo/
end
it "should work with arity 1 blocks" do
face = Puppet::Interface.new(:action_when_invoked, '1.0.0') do
action :foo do
when_invoked {|one| }
end
end
# -1, because we use option defaulting. :(
face.method(:foo).arity.should == -1
end
it "should work with arity 2 blocks" do
face = Puppet::Interface.new(:action_when_invoked, '1.0.0') do
action :foo do
when_invoked {|one, two| }
end
end
# -2, because we use option defaulting. :(
face.method(:foo).arity.should == -2
end
it "should work with arity 1 blocks that collect arguments" do
face = Puppet::Interface.new(:action_when_invoked, '1.0.0') do
action :foo do
when_invoked {|*one| }
end
end
# -1, because we use only varargs
face.method(:foo).arity.should == -1
end
it "should work with arity 2 blocks that collect arguments" do
face = Puppet::Interface.new(:action_when_invoked, '1.0.0') do
action :foo do
when_invoked {|one, *two| }
end
end
# -2, because we take one mandatory argument, and one varargs
face.method(:foo).arity.should == -2
end
end
describe "when invoking" do
it "should be able to call other actions on the same object" do
face = Puppet::Interface.new(:my_face, '0.0.1') do
action(:foo) do
when_invoked { |options| 25 }
end
action(:bar) do
when_invoked { |options| "the value of foo is '#{foo}'" }
end
end
face.foo.should == 25
face.bar.should == "the value of foo is '25'"
end
# bar is a class action calling a class action
# quux is a class action calling an instance action
# baz is an instance action calling a class action
# qux is an instance action calling an instance action
it "should be able to call other actions on the same object when defined on a class" do
class Puppet::Interface::MyInterfaceBaseClass < Puppet::Interface
action(:foo) do
when_invoked { |options| 25 }
end
action(:bar) do
when_invoked { |options| "the value of foo is '#{foo}'" }
end
action(:quux) do
when_invoked { |options| "qux told me #{qux}" }
end
end
face = Puppet::Interface::MyInterfaceBaseClass.new(:my_inherited_face, '0.0.1') do
action(:baz) do
when_invoked { |options| "the value of foo in baz is '#{foo}'" }
end
action(:qux) do
when_invoked { |options| baz }
end
end
face.foo.should == 25
face.bar.should == "the value of foo is '25'"
face.quux.should == "qux told me the value of foo in baz is '25'"
face.baz.should == "the value of foo in baz is '25'"
face.qux.should == "the value of foo in baz is '25'"
end
context "when calling the Ruby API" do
let :face do
Puppet::Interface.new(:ruby_api, '1.0.0') do
action :bar do
when_invoked do |*args|
args.last
end
end
end
end
it "should work when no options are supplied" do
options = face.bar
options.should == {}
end
it "should work when options are supplied" do
options = face.bar(:bar => "beer")
options.should == { :bar => "beer" }
end
it "should call #validate_args on the action when invoked" do
face.get_action(:bar).expects(:validate_args).with([1, :two, 'three', {}])
face.bar 1, :two, 'three'
end
end
end
describe "with action-level options" do
it "should support options with an empty block" do
face = Puppet::Interface.new(:action_level_options, '0.0.1') do
action :foo do
when_invoked do |options| true end
option "--bar" do
# this line left deliberately blank
end
end
end
face.should_not be_option :bar
face.get_action(:foo).should be_option :bar
end
it "should return only action level options when there are no face options" do
face = Puppet::Interface.new(:action_level_options, '0.0.1') do
action :foo do
when_invoked do |options| true end
option "--bar"
end
end
face.get_action(:foo).options.should =~ [:bar]
end
describe "with both face and action options" do
let :face do
Puppet::Interface.new(:action_level_options, '0.0.1') do
action :foo do when_invoked do |options| true end ; option "--bar" end
action :baz do when_invoked do |options| true end ; option "--bim" end
option "--quux"
end
end
it "should return combined face and action options" do
face.get_action(:foo).options.should =~ [:bar, :quux]
end
it "should fetch options that the face inherited" do
parent = Class.new(Puppet::Interface)
parent.option "--foo"
child = parent.new(:inherited_options, '0.0.1') do
option "--bar"
action :action do
when_invoked do |options| true end
option "--baz"
end
end
action = child.get_action(:action)
action.should be
[:baz, :bar, :foo].each do |name|
action.get_option(name).should be_an_instance_of Puppet::Interface::Option
end
end
it "should get an action option when asked" do
face.get_action(:foo).get_option(:bar).
should be_an_instance_of Puppet::Interface::Option
end
it "should get a face option when asked" do
face.get_action(:foo).get_option(:quux).
should be_an_instance_of Puppet::Interface::Option
end
it "should return options only for this action" do
face.get_action(:baz).options.should =~ [:bim, :quux]
end
end
it_should_behave_like "things that declare options" do
def add_options_to(&block)
face = Puppet::Interface.new(:with_options, '0.0.1') do
action(:foo) do
when_invoked do |options| true end
self.instance_eval &block
end
end
face.get_action(:foo)
end
end
it "should fail when a face option duplicates an action option" do
expect {
Puppet::Interface.new(:action_level_options, '0.0.1') do
option "--foo"
action :bar do option "--foo" end
end
}.should raise_error ArgumentError, /Option foo conflicts with existing option foo/i
end
it "should fail when a required action option is not provided" do
face = Puppet::Interface.new(:required_action_option, '0.0.1') do
action(:bar) do
option('--foo') { required }
when_invoked {|options| }
end
end
expect { face.bar }.to raise_error ArgumentError, /The following options are required: foo/
end
it "should fail when a required face option is not provided" do
face = Puppet::Interface.new(:required_face_option, '0.0.1') do
option('--foo') { required }
action(:bar) { when_invoked {|options| } }
end
expect { face.bar }.to raise_error ArgumentError, /The following options are required: foo/
end
end
context "with decorators" do
context "declared locally" do
let :face do
Puppet::Interface.new(:action_decorators, '0.0.1') do
action :bar do when_invoked do |options| true end end
def reported; @reported; end
def report(arg)
(@reported ||= []) << arg
end
end
end
it "should execute before advice on action options in declaration order" do
face.action(:boo) do
option("--foo") { before_action { |_,_,_| report :foo } }
option("--bar", '-b') { before_action { |_,_,_| report :bar } }
option("-q", "--quux") { before_action { |_,_,_| report :quux } }
option("-f") { before_action { |_,_,_| report :f } }
option("--baz") { before_action { |_,_,_| report :baz } }
when_invoked {|options| }
end
face.boo :foo => 1, :bar => 1, :quux => 1, :f => 1, :baz => 1
face.reported.should == [ :foo, :bar, :quux, :f, :baz ]
end
it "should execute after advice on action options in declaration order" do
face.action(:boo) do
option("--foo") { after_action { |_,_,_| report :foo } }
option("--bar", '-b') { after_action { |_,_,_| report :bar } }
option("-q", "--quux") { after_action { |_,_,_| report :quux } }
option("-f") { after_action { |_,_,_| report :f } }
option("--baz") { after_action { |_,_,_| report :baz } }
when_invoked {|options| }
end
face.boo :foo => 1, :bar => 1, :quux => 1, :f => 1, :baz => 1
face.reported.should == [ :foo, :bar, :quux, :f, :baz ].reverse
end
it "should execute before advice on face options in declaration order" do
face.instance_eval do
option("--foo") { before_action { |_,_,_| report :foo } }
option("--bar", '-b') { before_action { |_,_,_| report :bar } }
option("-q", "--quux") { before_action { |_,_,_| report :quux } }
option("-f") { before_action { |_,_,_| report :f } }
option("--baz") { before_action { |_,_,_| report :baz } }
end
face.script(:boo) {|options| }
face.boo :foo => 1, :bar => 1, :quux => 1, :f => 1, :baz => 1
face.reported.should == [ :foo, :bar, :quux, :f, :baz ]
end
it "should execute after advice on face options in declaration order" do
face.instance_eval do
option("--foo") { after_action { |_,_,_| report :foo } }
option("--bar", '-b') { after_action { |_,_,_| report :bar } }
option("-q", "--quux") { after_action { |_,_,_| report :quux } }
option("-f") { after_action { |_,_,_| report :f } }
option("--baz") { after_action { |_,_,_| report :baz } }
end
face.script(:boo) {|options| }
face.boo :foo => 1, :bar => 1, :quux => 1, :f => 1, :baz => 1
face.reported.should == [ :foo, :bar, :quux, :f, :baz ].reverse
end
it "should execute before advice on face options before action options" do
face.instance_eval do
option("--face-foo") { before_action { |_,_,_| report :face_foo } }
option("--face-bar", '-r') { before_action { |_,_,_| report :face_bar } }
action(:boo) do
option("--action-foo") { before_action { |_,_,_| report :action_foo } }
option("--action-bar", '-b') { before_action { |_,_,_| report :action_bar } }
option("-q", "--action-quux") { before_action { |_,_,_| report :action_quux } }
option("-a") { before_action { |_,_,_| report :a } }
option("--action-baz") { before_action { |_,_,_| report :action_baz } }
when_invoked {|options| }
end
option("-u", "--face-quux") { before_action { |_,_,_| report :face_quux } }
option("-f") { before_action { |_,_,_| report :f } }
option("--face-baz") { before_action { |_,_,_| report :face_baz } }
end
expected_calls = [ :face_foo, :face_bar, :face_quux, :f, :face_baz,
:action_foo, :action_bar, :action_quux, :a, :action_baz ]
face.boo Hash[ *expected_calls.zip([]).flatten ]
face.reported.should == expected_calls
end
it "should execute after advice on face options in declaration order" do
face.instance_eval do
option("--face-foo") { after_action { |_,_,_| report :face_foo } }
option("--face-bar", '-r') { after_action { |_,_,_| report :face_bar } }
action(:boo) do
option("--action-foo") { after_action { |_,_,_| report :action_foo } }
option("--action-bar", '-b') { after_action { |_,_,_| report :action_bar } }
option("-q", "--action-quux") { after_action { |_,_,_| report :action_quux } }
option("-a") { after_action { |_,_,_| report :a } }
option("--action-baz") { after_action { |_,_,_| report :action_baz } }
when_invoked {|options| }
end
option("-u", "--face-quux") { after_action { |_,_,_| report :face_quux } }
option("-f") { after_action { |_,_,_| report :f } }
option("--face-baz") { after_action { |_,_,_| report :face_baz } }
end
expected_calls = [ :face_foo, :face_bar, :face_quux, :f, :face_baz,
:action_foo, :action_bar, :action_quux, :a, :action_baz ]
face.boo Hash[ *expected_calls.zip([]).flatten ]
face.reported.should == expected_calls.reverse
end
it "should not invoke a decorator if the options are empty" do
face.option("--foo FOO") { before_action { |_,_,_| report :before_action } }
face.expects(:report).never
face.bar
end
context "passing a subset of the options" do
before :each do
face.option("--foo") { before_action { |_,_,_| report :foo } }
face.option("--bar") { before_action { |_,_,_| report :bar } }
end
it "should invoke only foo's advice when passed only 'foo'" do
face.bar(:foo => true)
face.reported.should == [ :foo ]
end
it "should invoke only bar's advice when passed only 'bar'" do
face.bar(:bar => true)
face.reported.should == [ :bar ]
end
it "should invoke advice for all passed options" do
face.bar(:foo => true, :bar => true)
face.reported.should == [ :foo, :bar ]
end
end
end
context "and inheritance" do
let :parent do
Class.new(Puppet::Interface) do
script(:on_parent) {|options| :on_parent }
def reported; @reported; end
def report(arg)
(@reported ||= []) << arg
end
end
end
let :child do
parent.new(:inherited_decorators, '0.0.1') do
script(:on_child) {|options| :on_child }
end
end
context "locally declared face options" do
subject do
child.option("--foo=") { before_action { |_,_,_| report :child_before } }
child
end
it "should be invoked when calling a child action" do
subject.on_child(:foo => true, :bar => true).should == :on_child
subject.reported.should == [ :child_before ]
end
it "should be invoked when calling a parent action" do
subject.on_parent(:foo => true, :bar => true).should == :on_parent
subject.reported.should == [ :child_before ]
end
end
context "inherited face option decorators" do
subject do
parent.option("--foo=") { before_action { |_,_,_| report :parent_before } }
child
end
it "should be invoked when calling a child action" do
subject.on_child(:foo => true, :bar => true).should == :on_child
subject.reported.should == [ :parent_before ]
end
it "should be invoked when calling a parent action" do
subject.on_parent(:foo => true, :bar => true).should == :on_parent
subject.reported.should == [ :parent_before ]
end
end
context "with both inherited and local face options" do
# Decorations should be invoked in declaration order, according to
# inheritance (e.g. parent class options should be handled before
# subclass options).
subject do
child.option "-c" do
before_action { |action, args, options| report :c_before }
after_action { |action, args, options| report :c_after }
end
parent.option "-a" do
before_action { |action, args, options| report :a_before }
after_action { |action, args, options| report :a_after }
end
child.option "-d" do
before_action { |action, args, options| report :d_before }
after_action { |action, args, options| report :d_after }
end
parent.option "-b" do
before_action { |action, args, options| report :b_before }
after_action { |action, args, options| report :b_after }
end
child.script(:decorations) { |options| report :invoked }
child
end
it "should invoke all decorations when calling a child action" do
subject.decorations(:a => 1, :b => 1, :c => 1, :d => 1)
subject.reported.should == [
:a_before, :b_before, :c_before, :d_before,
:invoked,
:d_after, :c_after, :b_after, :a_after
]
end
it "should invoke all decorations when calling a parent action" do
subject.decorations(:a => 1, :b => 1, :c => 1, :d => 1)
subject.reported.should == [
:a_before, :b_before, :c_before, :d_before,
:invoked,
:d_after, :c_after, :b_after, :a_after
]
end
end
end
end
it_should_behave_like "documentation on faces" do
subject do
face = Puppet::Interface.new(:action_documentation, '0.0.1') do
action :documentation do
when_invoked do |options| true end
end
end
face.get_action(:documentation)
end
end
context "#when_rendering" do
it "should fail if no type is given when_rendering"
it "should accept a when_rendering block"
it "should accept multiple when_rendering blocks"
it "should fail if when_rendering gets a non-symbol identifier"
it "should fail if a second block is given for the same type"
it "should return the block if asked"
end
context "#validate_args" do
subject do
Puppet::Interface.new(:validate_args, '1.0.0') do
script :test do |options| true end
end
end
it "should fail if a required option is not passed" do
subject.option "--foo" do required end
expect { subject.test }.to raise_error ArgumentError, /options are required/
end
it "should fail if two aliases to one option are passed" do
subject.option "--foo", "-f"
expect { subject.test :foo => true, :f => true }.
to raise_error ArgumentError, /Multiple aliases for the same option/
end
end
end
|