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
|
#
# Author:: Adam Jacob (<adam@chef.io>)
# Author:: Tim Hinderliter (<tim@chef.io>)
# Author:: Daniel DeLeo (<dan@chef.io>)
# Author:: John Keiser (<jkeiser@chef.io>)
# 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::Knife::UI do
before do
@out, @err, @in = StringIO.new, StringIO.new, StringIO.new
@config = {
:verbosity => 0,
:yes => nil,
:format => "summary",
}
@ui = Chef::Knife::UI.new(@out, @err, @in, @config)
end
describe "edit" do
ruby_for_json = { "foo" => "bar" }
json_from_ruby = "{\n \"foo\": \"bar\"\n}"
json_from_editor = "{\n \"bar\": \"foo\"\n}"
ruby_from_editor = { "bar" => "foo" }
my_editor = "veeeye"
temp_path = "/tmp/bar/baz"
let(:subject) { @ui.edit_data(ruby_for_json, parse_output) }
let(:parse_output) { false }
context "when editing is disabled" do
before do
@ui.config[:disable_editing] = true
stub_const("Tempfile", double) # Tempfiles should never be invoked
end
context "when parse_output is false" do
it "returns pretty json string" do
expect(subject).to eql(json_from_ruby)
end
end
context "when parse_output is true" do
let(:parse_output) { true }
it "returns a ruby object" do
expect(subject).to eql(ruby_for_json)
end
end
end
context "when editing is enabled" do
before do
@ui.config[:disable_editing] = false
@ui.config[:editor] = my_editor
@mock = double("Tempfile")
expect(@mock).to receive(:sync=).with(true)
expect(@mock).to receive(:puts).with(json_from_ruby)
expect(@mock).to receive(:close)
expect(@mock).to receive(:path).at_least(:once).and_return(temp_path)
expect(Tempfile).to receive(:open).with([ "knife-edit-", ".json" ]).and_yield(@mock)
end
context "and the editor works" do
before do
expect(@ui).to receive(:system).with("#{my_editor} #{temp_path}").and_return(true)
expect(IO).to receive(:read).with(temp_path).and_return(json_from_editor)
end
context "when parse_output is false" do
it "returns an edited pretty json string" do
expect(subject).to eql(json_from_editor)
end
end
context "when parse_output is true" do
let(:parse_output) { true }
it "returns an edited ruby object" do
expect(subject).to eql(ruby_from_editor)
end
end
end
context "when running the editor fails with nil" do
before do
expect(@ui).to receive(:system).with("#{my_editor} #{temp_path}").and_return(nil)
expect(IO).not_to receive(:read)
end
it "throws an exception" do
expect{ subject }.to raise_error(RuntimeError)
end
end
context "when running the editor fails with false" do
before do
expect(@ui).to receive(:system).with("#{my_editor} #{temp_path}").and_return(false)
expect(IO).not_to receive(:read)
end
it "throws an exception" do
expect{ subject }.to raise_error(RuntimeError)
end
end
end
context "when editing and not stubbing Tempfile (semi-functional test)" do
before do
@ui.config[:disable_editing] = false
@ui.config[:editor] = my_editor
@tempfile = Tempfile.new([ "knife-edit-", ".json" ])
expect(Tempfile).to receive(:open).with([ "knife-edit-", ".json" ]).and_yield(@tempfile)
end
context "and the editor works" do
before do
expect(@ui).to receive(:system).with("#{my_editor} #{@tempfile.path}").and_return(true)
expect(IO).to receive(:read).with(@tempfile.path).and_return(json_from_editor)
end
context "when parse_output is false" do
it "returns an edited pretty json string" do
expect(subject).to eql(json_from_editor)
end
it "the tempfile should have mode 0600", :unix_only do
# XXX: this looks odd because we're really testing Tempfile.new here
expect(File.stat(@tempfile.path).mode & 0777).to eql(0600)
expect(subject).to eql(json_from_editor)
end
end
context "when parse_output is true" do
let(:parse_output) { true }
it "returns an edited ruby object" do
expect(subject).to eql(ruby_from_editor)
end
it "the tempfile should have mode 0600", :unix_only do
# XXX: this looks odd because we're really testing Tempfile.new here
expect(File.stat(@tempfile.path).mode & 0777).to eql(0600)
expect(subject).to eql(ruby_from_editor)
end
end
end
end
end
describe "format_list_for_display" do
it "should print the full hash if --with-uri is true" do
@ui.config[:with_uri] = true
expect(@ui.format_list_for_display({ :marcy => :playground })).to eq({ :marcy => :playground })
end
it "should print only the keys if --with-uri is false" do
@ui.config[:with_uri] = false
expect(@ui.format_list_for_display({ :marcy => :playground })).to eq([ :marcy ])
end
end
shared_examples "an output mehthod handling IO exceptions" do |method|
it "should throw Errno::EIO exceptions" do
allow(@out).to receive(:puts).and_raise(Errno::EIO)
allow(@err).to receive(:puts).and_raise(Errno::EIO)
expect {@ui.send(method, "hi")}.to raise_error(Errno::EIO)
end
it "should ignore Errno::EPIPE exceptions (CHEF-3516)" do
allow(@out).to receive(:puts).and_raise(Errno::EPIPE)
allow(@err).to receive(:puts).and_raise(Errno::EPIPE)
expect {@ui.send(method, "hi")}.to raise_error(SystemExit)
end
it "should throw Errno::EPIPE exceptions with -VV (CHEF-3516)" do
@config[:verbosity] = 2
allow(@out).to receive(:puts).and_raise(Errno::EPIPE)
allow(@err).to receive(:puts).and_raise(Errno::EPIPE)
expect {@ui.send(method, "hi")}.to raise_error(Errno::EPIPE)
end
end
describe "output" do
it_behaves_like "an output mehthod handling IO exceptions", :output
it "formats strings appropriately" do
@ui.output("hi")
expect(@out.string).to eq("hi\n")
end
it "formats hashes appropriately" do
@ui.output({"hi" => "a", "lo" => "b" })
expect(@out.string).to eq <<EOM
hi: a
lo: b
EOM
end
it "formats empty hashes appropriately" do
@ui.output({})
expect(@out.string).to eq("\n")
end
it "formats arrays appropriately" do
@ui.output([ "a", "b" ])
expect(@out.string).to eq <<EOM
a
b
EOM
end
it "formats empty arrays appropriately" do
@ui.output([ ])
expect(@out.string).to eq("\n")
end
it "formats single-member arrays appropriately" do
@ui.output([ "a" ])
expect(@out.string).to eq("a\n")
end
it "formats nested single-member arrays appropriately" do
@ui.output([ [ "a" ] ])
expect(@out.string).to eq("a\n")
end
it "formats nested arrays appropriately" do
@ui.output([ [ "a", "b" ], [ "c", "d" ]])
expect(@out.string).to eq <<EOM
a
b
c
d
EOM
end
it "formats nested arrays with single- and empty subarrays appropriately" do
@ui.output([ [ "a", "b" ], [ "c" ], [], [ "d", "e" ]])
expect(@out.string).to eq <<EOM
a
b
c
d
e
EOM
end
it "formats arrays of hashes with extra lines in between for readability" do
@ui.output([ { "a" => "b", "c" => "d" }, { "x" => "y" }, { "m" => "n", "o" => "p" }])
expect(@out.string).to eq <<EOM
a: b
c: d
x: y
m: n
o: p
EOM
end
it "formats hashes with empty array members appropriately" do
@ui.output({ "a" => [], "b" => "c" })
expect(@out.string).to eq <<EOM
a:
b: c
EOM
end
it "formats hashes with single-member array values appropriately" do
@ui.output({ "a" => [ "foo" ], "b" => "c" })
expect(@out.string).to eq <<EOM
a: foo
b: c
EOM
end
it "formats hashes with array members appropriately" do
@ui.output({ "a" => [ "foo", "bar" ], "b" => "c" })
expect(@out.string).to eq <<EOM
a:
foo
bar
b: c
EOM
end
it "formats hashes with single-member nested array values appropriately" do
@ui.output({ "a" => [ [ "foo" ] ], "b" => "c" })
expect(@out.string).to eq <<EOM
a:
foo
b: c
EOM
end
it "formats hashes with nested array values appropriately" do
@ui.output({ "a" => [ [ "foo", "bar" ], [ "baz", "bjork" ] ], "b" => "c" })
# XXX: using a HEREDOC at this point results in a line with required spaces which auto-whitespace removal settings
# on editors will remove and will break this test.
expect(@out.string).to eq("a:\n foo\n bar\n \n baz\n bjork\nb: c\n")
end
it "formats hashes with hash values appropriately" do
@ui.output({ "a" => { "aa" => "bb", "cc" => "dd" }, "b" => "c" })
expect(@out.string).to eq <<EOM
a:
aa: bb
cc: dd
b: c
EOM
end
it "formats hashes with empty hash values appropriately" do
@ui.output({ "a" => { }, "b" => "c" })
expect(@out.string).to eq <<EOM
a:
b: c
EOM
end
end
describe "warn" do
it_behaves_like "an output mehthod handling IO exceptions", :warn
end
describe "error" do
it_behaves_like "an output mehthod handling IO exceptions", :warn
end
describe "fatal" do
it_behaves_like "an output mehthod handling IO exceptions", :warn
end
describe "format_for_display" do
it "should return the raw data" do
input = { :gi => :go }
expect(@ui.format_for_display(input)).to eq(input)
end
describe "with --attribute passed" do
it "should return the deeply nested attribute" do
input = { "gi" => { "go" => "ge" }, "id" => "sample-data-bag-item" }
@ui.config[:attribute] = "gi.go"
expect(@ui.format_for_display(input)).to eq({ "sample-data-bag-item" => { "gi.go" => "ge" } })
end
it "should return multiple attributes" do
input = { "gi" => "go", "hi" => "ho", "id" => "sample-data-bag-item" }
@ui.config[:attribute] = ["gi", "hi"]
expect(@ui.format_for_display(input)).to eq({ "sample-data-bag-item" => { "gi" => "go", "hi"=> "ho" } })
end
it "should handle attributes named the same as methods" do
input = { "keys" => "values", "hi" => "ho", "id" => "sample-data-bag-item" }
@ui.config[:attribute] = "keys"
expect(@ui.format_for_display(input)).to eq({ "sample-data-bag-item" => { "keys" => "values" } })
end
it "should handle nested attributes named the same as methods" do
input = { "keys" => {"keys" => "values"}, "hi" => "ho", "id" => "sample-data-bag-item" }
@ui.config[:attribute] = "keys.keys"
expect(@ui.format_for_display(input)).to eq({ "sample-data-bag-item" => { "keys.keys" => "values" } })
end
it "should return the name attribute" do
allow_any_instance_of(Chef::Node).to receive(:name).and_return("chef.localdomain")
input = Chef::Node.new
@ui.config[:attribute] = "name"
expect(@ui.format_for_display(input)).to eq( {"chef.localdomain"=>{"name"=>"chef.localdomain"} })
end
it "returns nil when given an attribute path that isn't a name or attribute" do
input = { "keys" => {"keys" => "values"}, "hi" => "ho", "id" => "sample-data-bag-item" }
non_existing_path = "nope.nada.nothingtoseehere"
@ui.config[:attribute] = non_existing_path
expect(@ui.format_for_display(input)).to eq({ "sample-data-bag-item" => { non_existing_path => nil } })
end
end
describe "with --run-list passed" do
it "should return the run list" do
input = Chef::Node.new
input.name("sample-node")
input.run_list("role[monkey]", "role[churchmouse]")
@ui.config[:run_list] = true
response = @ui.format_for_display(input)
expect(response["sample-node"]["run_list"][0]).to eq("role[monkey]")
expect(response["sample-node"]["run_list"][1]).to eq("role[churchmouse]")
end
end
end
describe "format_cookbook_list_for_display" do
before(:each) do
@item = {
"cookbook_name" => {
"url" => "http://url/cookbooks/cookbook",
"versions" => [
{ "version" => "3.0.0", "url" => "http://url/cookbooks/3.0.0" },
{ "version" => "2.0.0", "url" => "http://url/cookbooks/2.0.0" },
{ "version" => "1.0.0", "url" => "http://url/cookbooks/1.0.0" },
],
}
}
end
it "should return an array of the cookbooks with versions" do
expected_response = [ "cookbook_name 3.0.0 2.0.0 1.0.0" ]
response = @ui.format_cookbook_list_for_display(@item)
expect(response).to eq(expected_response)
end
describe "with --with-uri" do
it "should return the URIs" do
response = {
"cookbook_name"=>{
"1.0.0" => "http://url/cookbooks/1.0.0",
"2.0.0" => "http://url/cookbooks/2.0.0",
"3.0.0" => "http://url/cookbooks/3.0.0"}
}
@ui.config[:with_uri] = true
expect(@ui.format_cookbook_list_for_display(@item)).to eq(response)
end
end
context "when running on Windows" do
before(:each) do
stdout = double("StringIO", :tty? => true)
allow(@ui).to receive(:stdout).and_return(stdout)
allow(ChefConfig).to receive(:windows?) { true }
Chef::Config.reset
end
after(:each) do
Chef::Config.reset
end
it "should have color set to true if knife config has color explicitly set to true" do
Chef::Config[:color] = true
@ui.config[:color] = true
expect(@ui.color?).to eql(true)
end
it "should have color set to false if knife config has color explicitly set to false" do
Chef::Config[:color] = false
expect(@ui.color?).to eql(false)
end
it "should not have color set to false by default" do
expect(@ui.color?).to eql(false)
end
end
end
describe "confirm" do
let(:stdout) {StringIO.new}
let(:output) {stdout.string}
let(:question) { "monkeys rule" }
let(:answer) { "y" }
let(:default_choice) { nil }
let(:append_instructions) { true }
def run_confirm
allow(@ui).to receive(:stdout).and_return(stdout)
allow(@ui.stdin).to receive(:readline).and_return(answer)
@ui.confirm(question, append_instructions, default_choice)
end
def run_confirm_without_exit
allow(@ui).to receive(:stdout).and_return(stdout)
allow(@ui.stdin).to receive(:readline).and_return(answer)
@ui.confirm_without_exit(question, append_instructions, default_choice)
end
shared_examples_for "confirm with positive answer" do
it "confirm should return true" do
expect(run_confirm).to be_truthy
end
it "confirm_without_exit should return true" do
expect(run_confirm_without_exit).to be_truthy
end
end
shared_examples_for "confirm with negative answer" do
it "confirm should exit 3" do
expect {
run_confirm
}.to raise_error(SystemExit) { |e| expect(e.status).to eq(3) }
end
it "confirm_without_exit should return false" do
expect(run_confirm_without_exit).to be_falsey
end
end
describe "with default choice set to true" do
let(:default_choice) { true }
it "should show 'Y/n' in the instructions" do
run_confirm
expect(output).to include("Y/n")
end
describe "with empty answer" do
let(:answer) { "" }
it_behaves_like "confirm with positive answer"
end
describe "with answer N " do
let(:answer) { "N" }
it_behaves_like "confirm with negative answer"
end
end
describe "with default choice set to false" do
let(:default_choice) { false }
it "should show 'y/N' in the instructions" do
run_confirm
expect(output).to include("y/N")
end
describe "with empty answer" do
let(:answer) { "" }
it_behaves_like "confirm with negative answer"
end
describe "with answer N " do
let(:answer) { "Y" }
it_behaves_like "confirm with positive answer"
end
end
["Y", "y"].each do |answer|
describe "with answer #{answer}" do
let(:answer) { answer }
it_behaves_like "confirm with positive answer"
end
end
["N", "n"].each do |answer|
describe "with answer #{answer}" do
let(:answer) { answer }
it_behaves_like "confirm with negative answer"
end
end
describe "with --y or --yes passed" do
it "should return true" do
@ui.config[:yes] = true
expect(run_confirm).to be_truthy
expect(output).to eq("")
end
end
end
describe "when asking for free-form user input" do
it "asks a question and returns the answer provided by the user" do
out = StringIO.new
allow(@ui).to receive(:stdout).and_return(out)
allow(@ui).to receive(:stdin).and_return(StringIO.new("http://mychefserver.example.com\n"))
expect(@ui.ask_question("your chef server URL?")).to eq("http://mychefserver.example.com")
expect(out.string).to eq("your chef server URL?")
end
it "suggests a default setting and returns the default when the user's response only contains whitespace" do
out = StringIO.new
allow(@ui).to receive(:stdout).and_return(out)
allow(@ui).to receive(:stdin).and_return(StringIO.new(" \n"))
expect(@ui.ask_question("your chef server URL? ", :default => "http://localhost:4000")).to eq("http://localhost:4000")
expect(out.string).to eq("your chef server URL? [http://localhost:4000] ")
end
end
end
|