test-kitchen 1.6.0 → 1.7.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (180) hide show
  1. checksums.yaml +4 -4
  2. data/.cane +8 -7
  3. data/.github/ISSUE_TEMPLATE.md +56 -0
  4. data/.gitignore +28 -27
  5. data/.kitchen.ci.yml +23 -0
  6. data/.kitchen.proxy.yml +27 -0
  7. data/.rubocop.yml +3 -3
  8. data/.travis.yml +70 -53
  9. data/.yardopts +3 -3
  10. data/Berksfile +3 -0
  11. data/CHANGELOG.md +1083 -1051
  12. data/CONTRIBUTING.md +14 -14
  13. data/Gemfile +19 -14
  14. data/Gemfile.proxy_tests +4 -5
  15. data/Guardfile +42 -42
  16. data/LICENSE +15 -15
  17. data/MAINTAINERS.md +23 -24
  18. data/README.md +135 -135
  19. data/Rakefile +61 -76
  20. data/appveyor.yml +44 -34
  21. data/features/kitchen_action_commands.feature +164 -164
  22. data/features/kitchen_command.feature +16 -16
  23. data/features/kitchen_console_command.feature +34 -34
  24. data/features/kitchen_defaults.feature +38 -38
  25. data/features/kitchen_diagnose_command.feature +96 -96
  26. data/features/kitchen_driver_create_command.feature +64 -64
  27. data/features/kitchen_driver_discover_command.feature +25 -25
  28. data/features/kitchen_help_command.feature +16 -16
  29. data/features/kitchen_init_command.feature +274 -274
  30. data/features/kitchen_list_command.feature +104 -104
  31. data/features/kitchen_login_command.feature +62 -62
  32. data/features/kitchen_sink_command.feature +30 -30
  33. data/features/kitchen_test_command.feature +88 -88
  34. data/features/step_definitions/gem_steps.rb +36 -36
  35. data/features/step_definitions/git_steps.rb +5 -5
  36. data/features/step_definitions/output_steps.rb +5 -5
  37. data/features/support/env.rb +75 -75
  38. data/lib/kitchen.rb +150 -150
  39. data/lib/kitchen/base64_stream.rb +55 -55
  40. data/lib/kitchen/cli.rb +419 -419
  41. data/lib/kitchen/collection.rb +55 -55
  42. data/lib/kitchen/color.rb +65 -65
  43. data/lib/kitchen/command.rb +185 -185
  44. data/lib/kitchen/command/action.rb +45 -45
  45. data/lib/kitchen/command/console.rb +58 -58
  46. data/lib/kitchen/command/diagnose.rb +92 -92
  47. data/lib/kitchen/command/driver_discover.rb +105 -105
  48. data/lib/kitchen/command/exec.rb +41 -41
  49. data/lib/kitchen/command/list.rb +119 -119
  50. data/lib/kitchen/command/login.rb +43 -43
  51. data/lib/kitchen/command/sink.rb +54 -54
  52. data/lib/kitchen/command/test.rb +51 -51
  53. data/lib/kitchen/config.rb +322 -322
  54. data/lib/kitchen/configurable.rb +529 -529
  55. data/lib/kitchen/data_munger.rb +959 -960
  56. data/lib/kitchen/diagnostic.rb +141 -141
  57. data/lib/kitchen/driver.rb +56 -56
  58. data/lib/kitchen/driver/base.rb +134 -134
  59. data/lib/kitchen/driver/dummy.rb +108 -108
  60. data/lib/kitchen/driver/proxy.rb +72 -72
  61. data/lib/kitchen/driver/ssh_base.rb +357 -357
  62. data/lib/kitchen/errors.rb +229 -229
  63. data/lib/kitchen/generator/driver_create.rb +177 -177
  64. data/lib/kitchen/generator/init.rb +296 -296
  65. data/lib/kitchen/instance.rb +662 -662
  66. data/lib/kitchen/lazy_hash.rb +142 -142
  67. data/lib/kitchen/loader/yaml.rb +349 -349
  68. data/lib/kitchen/logger.rb +423 -423
  69. data/lib/kitchen/logging.rb +56 -56
  70. data/lib/kitchen/login_command.rb +52 -52
  71. data/lib/kitchen/metadata_chopper.rb +52 -52
  72. data/lib/kitchen/platform.rb +67 -67
  73. data/lib/kitchen/provisioner.rb +54 -54
  74. data/lib/kitchen/provisioner/base.rb +236 -236
  75. data/lib/kitchen/provisioner/chef/berkshelf.rb +114 -114
  76. data/lib/kitchen/provisioner/chef/common_sandbox.rb +322 -322
  77. data/lib/kitchen/provisioner/chef/librarian.rb +112 -112
  78. data/lib/kitchen/provisioner/chef_apply.rb +124 -125
  79. data/lib/kitchen/provisioner/chef_base.rb +341 -294
  80. data/lib/kitchen/provisioner/chef_solo.rb +88 -89
  81. data/lib/kitchen/provisioner/chef_zero.rb +245 -245
  82. data/lib/kitchen/provisioner/dummy.rb +79 -79
  83. data/lib/kitchen/provisioner/shell.rb +138 -138
  84. data/lib/kitchen/rake_tasks.rb +63 -63
  85. data/lib/kitchen/shell_out.rb +93 -93
  86. data/lib/kitchen/ssh.rb +276 -276
  87. data/lib/kitchen/state_file.rb +120 -120
  88. data/lib/kitchen/suite.rb +51 -51
  89. data/lib/kitchen/thor_tasks.rb +66 -66
  90. data/lib/kitchen/transport.rb +54 -54
  91. data/lib/kitchen/transport/base.rb +176 -176
  92. data/lib/kitchen/transport/dummy.rb +79 -79
  93. data/lib/kitchen/transport/ssh.rb +364 -364
  94. data/lib/kitchen/transport/winrm.rb +486 -486
  95. data/lib/kitchen/util.rb +147 -147
  96. data/lib/kitchen/verifier.rb +55 -55
  97. data/lib/kitchen/verifier/base.rb +235 -235
  98. data/lib/kitchen/verifier/busser.rb +277 -277
  99. data/lib/kitchen/verifier/dummy.rb +79 -79
  100. data/lib/kitchen/verifier/shell.rb +101 -101
  101. data/lib/kitchen/version.rb +21 -21
  102. data/lib/vendor/hash_recursive_merge.rb +82 -82
  103. data/spec/kitchen/base64_stream_spec.rb +77 -77
  104. data/spec/kitchen/cli_spec.rb +56 -56
  105. data/spec/kitchen/collection_spec.rb +80 -80
  106. data/spec/kitchen/color_spec.rb +54 -54
  107. data/spec/kitchen/config_spec.rb +408 -408
  108. data/spec/kitchen/configurable_spec.rb +1095 -1062
  109. data/spec/kitchen/data_munger_spec.rb +2694 -2383
  110. data/spec/kitchen/diagnostic_spec.rb +129 -129
  111. data/spec/kitchen/driver/base_spec.rb +121 -121
  112. data/spec/kitchen/driver/dummy_spec.rb +199 -199
  113. data/spec/kitchen/driver/proxy_spec.rb +138 -138
  114. data/spec/kitchen/driver/ssh_base_spec.rb +1115 -1115
  115. data/spec/kitchen/driver_spec.rb +112 -112
  116. data/spec/kitchen/errors_spec.rb +309 -309
  117. data/spec/kitchen/instance_spec.rb +1419 -1419
  118. data/spec/kitchen/lazy_hash_spec.rb +117 -117
  119. data/spec/kitchen/loader/yaml_spec.rb +774 -774
  120. data/spec/kitchen/logger_spec.rb +429 -429
  121. data/spec/kitchen/logging_spec.rb +59 -59
  122. data/spec/kitchen/login_command_spec.rb +68 -68
  123. data/spec/kitchen/metadata_chopper_spec.rb +82 -82
  124. data/spec/kitchen/platform_spec.rb +89 -89
  125. data/spec/kitchen/provisioner/base_spec.rb +386 -386
  126. data/spec/kitchen/provisioner/chef_apply_spec.rb +136 -136
  127. data/spec/kitchen/provisioner/chef_base_spec.rb +1161 -1067
  128. data/spec/kitchen/provisioner/chef_solo_spec.rb +557 -557
  129. data/spec/kitchen/provisioner/chef_zero_spec.rb +1001 -1001
  130. data/spec/kitchen/provisioner/dummy_spec.rb +99 -99
  131. data/spec/kitchen/provisioner/shell_spec.rb +566 -566
  132. data/spec/kitchen/provisioner_spec.rb +107 -107
  133. data/spec/kitchen/shell_out_spec.rb +150 -150
  134. data/spec/kitchen/ssh_spec.rb +693 -693
  135. data/spec/kitchen/state_file_spec.rb +129 -129
  136. data/spec/kitchen/suite_spec.rb +62 -62
  137. data/spec/kitchen/transport/base_spec.rb +89 -89
  138. data/spec/kitchen/transport/ssh_spec.rb +1255 -1255
  139. data/spec/kitchen/transport/winrm_spec.rb +1143 -1143
  140. data/spec/kitchen/transport_spec.rb +112 -112
  141. data/spec/kitchen/util_spec.rb +165 -165
  142. data/spec/kitchen/verifier/base_spec.rb +362 -362
  143. data/spec/kitchen/verifier/busser_spec.rb +610 -610
  144. data/spec/kitchen/verifier/dummy_spec.rb +99 -99
  145. data/spec/kitchen/verifier/shell_spec.rb +160 -158
  146. data/spec/kitchen/verifier_spec.rb +120 -120
  147. data/spec/kitchen_spec.rb +114 -114
  148. data/spec/spec_helper.rb +85 -85
  149. data/spec/support/powershell_max_size_spec.rb +40 -40
  150. data/support/busser_install_command.ps1 +14 -14
  151. data/support/busser_install_command.sh +14 -14
  152. data/support/chef-client-zero.rb +77 -77
  153. data/support/chef_base_init_command.ps1 +18 -18
  154. data/support/chef_base_init_command.sh +2 -2
  155. data/support/chef_base_install_command.ps1 +85 -85
  156. data/support/chef_base_install_command.sh +229 -229
  157. data/support/chef_zero_prepare_command_legacy.ps1 +9 -9
  158. data/support/chef_zero_prepare_command_legacy.sh +10 -10
  159. data/support/download_helpers.sh +109 -109
  160. data/support/dummy-validation.pem +27 -27
  161. data/templates/driver/CHANGELOG.md.erb +3 -3
  162. data/templates/driver/Gemfile.erb +3 -3
  163. data/templates/driver/README.md.erb +64 -64
  164. data/templates/driver/Rakefile.erb +21 -21
  165. data/templates/driver/driver.rb.erb +23 -23
  166. data/templates/driver/gemspec.erb +29 -29
  167. data/templates/driver/gitignore.erb +17 -17
  168. data/templates/driver/license_apachev2.erb +15 -15
  169. data/templates/driver/license_lgplv3.erb +16 -16
  170. data/templates/driver/license_mit.erb +22 -22
  171. data/templates/driver/license_reserved.erb +5 -5
  172. data/templates/driver/tailor.erb +4 -4
  173. data/templates/driver/travis.yml.erb +11 -11
  174. data/templates/driver/version.rb.erb +12 -12
  175. data/templates/init/chefignore.erb +1 -1
  176. data/templates/init/kitchen.yml.erb +18 -18
  177. data/test-kitchen.gemspec +62 -62
  178. data/test/integration/default/default_spec.rb +3 -0
  179. data/testing_windows.md +37 -37
  180. metadata +23 -11
@@ -1,107 +1,107 @@
1
- # -*- encoding: utf-8 -*-
2
- #
3
- # Author:: Fletcher Nichol (<fnichol@nichol.ca>)
4
- #
5
- # Copyright (C) 2013, Fletcher Nichol
6
- #
7
- # Licensed under the Apache License, Version 2.0 (the "License");
8
- # you may not use this file except in compliance with the License.
9
- # You may obtain a copy of the License at
10
- #
11
- # http://www.apache.org/licenses/LICENSE-2.0
12
- #
13
- # Unless required by applicable law or agreed to in writing, software
14
- # distributed under the License is distributed on an "AS IS" BASIS,
15
- # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16
- # See the License for the specific language governing permissions and
17
- # limitations under the License.
18
-
19
- require_relative "../spec_helper"
20
-
21
- require "kitchen/configurable"
22
- require "kitchen/errors"
23
- require "kitchen/logging"
24
- require "kitchen/provisioner"
25
- require "kitchen/provisioner/base"
26
-
27
- module Kitchen
28
-
29
- module Provisioner
30
-
31
- class Coolbeans < Kitchen::Provisioner::Base
32
- end
33
-
34
- class ItDepends < Kitchen::Provisioner::Base
35
-
36
- attr_reader :verify_call_count
37
-
38
- def initialize(config = {})
39
- @verify_call_count = 0
40
- super
41
- end
42
-
43
- def verify_dependencies
44
- @verify_call_count += 1
45
- end
46
- end
47
-
48
- class UnstableDepends < Kitchen::Provisioner::Base
49
-
50
- def verify_dependencies
51
- raise UserError, "Oh noes, you don't have software!"
52
- end
53
- end
54
- end
55
- end
56
-
57
- describe Kitchen::Provisioner do
58
-
59
- describe ".for_plugin" do
60
-
61
- before do
62
- Kitchen::Provisioner.stubs(:require).returns(true)
63
- end
64
-
65
- it "returns a provisioner object of the correct class" do
66
- provisioner = Kitchen::Provisioner.for_plugin("coolbeans", {})
67
-
68
- provisioner.must_be_kind_of Kitchen::Provisioner::Coolbeans
69
- end
70
-
71
- it "returns a provisioner initialized with its config" do
72
- provisioner = Kitchen::Provisioner.for_plugin("coolbeans", :foo => "bar")
73
-
74
- provisioner[:foo].must_equal "bar"
75
- end
76
-
77
- it "calls #verify_dependencies on the provisioner object" do
78
- provisioner = Kitchen::Provisioner.for_plugin("it_depends", {})
79
-
80
- provisioner.verify_call_count.must_equal 1
81
- end
82
-
83
- it "calls #verify_dependencies once per provisioner require" do
84
- Kitchen::Provisioner.stubs(:require).returns(true, false)
85
- provisioner1 = Kitchen::Provisioner.for_plugin("it_depends", {})
86
- provisioner1.verify_call_count.must_equal 1
87
- provisioner2 = Kitchen::Provisioner.for_plugin("it_depends", {})
88
-
89
- provisioner2.verify_call_count.must_equal 0
90
- end
91
-
92
- it "raises ClientError if the provisioner could not be required" do
93
- Kitchen::Provisioner.stubs(:require).raises(LoadError)
94
-
95
- proc { Kitchen::Provisioner.for_plugin("coolbeans", {}) }.
96
- must_raise Kitchen::ClientError
97
- end
98
-
99
- it "raises ClientError if the provisioner's class constant was not found" do
100
- # pretend require worked
101
- Kitchen::Provisioner.stubs(:require).returns(true)
102
-
103
- proc { Kitchen::Provisioner.for_plugin("nope", {}) }.
104
- must_raise Kitchen::ClientError
105
- end
106
- end
107
- end
1
+ # -*- encoding: utf-8 -*-
2
+ #
3
+ # Author:: Fletcher Nichol (<fnichol@nichol.ca>)
4
+ #
5
+ # Copyright (C) 2013, Fletcher Nichol
6
+ #
7
+ # Licensed under the Apache License, Version 2.0 (the "License");
8
+ # you may not use this file except in compliance with the License.
9
+ # You may obtain a copy of the License at
10
+ #
11
+ # http://www.apache.org/licenses/LICENSE-2.0
12
+ #
13
+ # Unless required by applicable law or agreed to in writing, software
14
+ # distributed under the License is distributed on an "AS IS" BASIS,
15
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16
+ # See the License for the specific language governing permissions and
17
+ # limitations under the License.
18
+
19
+ require_relative "../spec_helper"
20
+
21
+ require "kitchen/configurable"
22
+ require "kitchen/errors"
23
+ require "kitchen/logging"
24
+ require "kitchen/provisioner"
25
+ require "kitchen/provisioner/base"
26
+
27
+ module Kitchen
28
+
29
+ module Provisioner
30
+
31
+ class Coolbeans < Kitchen::Provisioner::Base
32
+ end
33
+
34
+ class ItDepends < Kitchen::Provisioner::Base
35
+
36
+ attr_reader :verify_call_count
37
+
38
+ def initialize(config = {})
39
+ @verify_call_count = 0
40
+ super
41
+ end
42
+
43
+ def verify_dependencies
44
+ @verify_call_count += 1
45
+ end
46
+ end
47
+
48
+ class UnstableDepends < Kitchen::Provisioner::Base
49
+
50
+ def verify_dependencies
51
+ raise UserError, "Oh noes, you don't have software!"
52
+ end
53
+ end
54
+ end
55
+ end
56
+
57
+ describe Kitchen::Provisioner do
58
+
59
+ describe ".for_plugin" do
60
+
61
+ before do
62
+ Kitchen::Provisioner.stubs(:require).returns(true)
63
+ end
64
+
65
+ it "returns a provisioner object of the correct class" do
66
+ provisioner = Kitchen::Provisioner.for_plugin("coolbeans", {})
67
+
68
+ provisioner.must_be_kind_of Kitchen::Provisioner::Coolbeans
69
+ end
70
+
71
+ it "returns a provisioner initialized with its config" do
72
+ provisioner = Kitchen::Provisioner.for_plugin("coolbeans", :foo => "bar")
73
+
74
+ provisioner[:foo].must_equal "bar"
75
+ end
76
+
77
+ it "calls #verify_dependencies on the provisioner object" do
78
+ provisioner = Kitchen::Provisioner.for_plugin("it_depends", {})
79
+
80
+ provisioner.verify_call_count.must_equal 1
81
+ end
82
+
83
+ it "calls #verify_dependencies once per provisioner require" do
84
+ Kitchen::Provisioner.stubs(:require).returns(true, false)
85
+ provisioner1 = Kitchen::Provisioner.for_plugin("it_depends", {})
86
+ provisioner1.verify_call_count.must_equal 1
87
+ provisioner2 = Kitchen::Provisioner.for_plugin("it_depends", {})
88
+
89
+ provisioner2.verify_call_count.must_equal 0
90
+ end
91
+
92
+ it "raises ClientError if the provisioner could not be required" do
93
+ Kitchen::Provisioner.stubs(:require).raises(LoadError)
94
+
95
+ proc { Kitchen::Provisioner.for_plugin("coolbeans", {}) }.
96
+ must_raise Kitchen::ClientError
97
+ end
98
+
99
+ it "raises ClientError if the provisioner's class constant was not found" do
100
+ # pretend require worked
101
+ Kitchen::Provisioner.stubs(:require).returns(true)
102
+
103
+ proc { Kitchen::Provisioner.for_plugin("nope", {}) }.
104
+ must_raise Kitchen::ClientError
105
+ end
106
+ end
107
+ end
@@ -1,150 +1,150 @@
1
- # -*- encoding: utf-8 -*-
2
- #
3
- # Author:: Fletcher Nichol (<fnichol@nichol.ca>)
4
- #
5
- # Copyright (C) 2014, Fletcher Nichol
6
- #
7
- # Licensed under the Apache License, Version 2.0 (the "License");
8
- # you may not use this file except in compliance with the License.
9
- # You may obtain a copy of the License at
10
- #
11
- # http://www.apache.org/licenses/LICENSE-2.0
12
- #
13
- # Unless required by applicable law or agreed to in writing, software
14
- # distributed under the License is distributed on an "AS IS" BASIS,
15
- # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16
- # See the License for the specific language governing permissions and
17
- # limitations under the License.
18
-
19
- require_relative "../spec_helper"
20
-
21
- require "kitchen/errors"
22
- require "kitchen/shell_out"
23
- require "kitchen/util"
24
-
25
- module Kitchen
26
-
27
- class Shelly
28
-
29
- include Kitchen::ShellOut
30
-
31
- attr_reader :logs
32
-
33
- def debug(msg)
34
- @logs ||= []
35
- @logs << msg
36
- end
37
-
38
- def logger
39
- "alogger"
40
- end
41
- end
42
- end
43
-
44
- describe Kitchen::ShellOut do
45
-
46
- let(:command) do
47
- stub(
48
- :run_command => true,
49
- :error! => true,
50
- :stdout => "",
51
- :execution_time => 123
52
- )
53
- end
54
-
55
- let(:subject) { Kitchen::Shelly.new }
56
-
57
- describe "#run_command" do
58
-
59
- let(:opts) do
60
- { :live_stream => "alogger", :timeout => 60000 }
61
- end
62
-
63
- before do
64
- Mixlib::ShellOut.stubs(:new).returns(command)
65
- end
66
-
67
- it "builds a Mixlib::ShellOut object with default options" do
68
- Mixlib::ShellOut.unstub(:new)
69
- Mixlib::ShellOut.expects(:new).with("yoyo", opts).returns(command)
70
-
71
- subject.run_command("yoyo")
72
- end
73
-
74
- [:timeout, :cwd, :environment].each do |attr|
75
- it "builds a Mixlib::ShellOut object with a custom #{attr}" do
76
- opts[attr] = "custom"
77
-
78
- Mixlib::ShellOut.unstub(:new)
79
- Mixlib::ShellOut.expects(:new).with("yoyo", opts).returns(command)
80
-
81
- subject.run_command("yoyo", attr => "custom")
82
- end
83
- end
84
-
85
- it "returns the command's standard out" do
86
- command.stubs(:stdout).returns("sweetness")
87
-
88
- subject.run_command("icecream").must_equal "sweetness"
89
- end
90
-
91
- it "raises a ShellCommandFailed if the command does not cleanly exit" do
92
- command.stubs(:error!).
93
- raises(Mixlib::ShellOut::ShellCommandFailed, "boom bad")
94
-
95
- err = proc { subject.run_command("boom") }.
96
- must_raise Kitchen::ShellOut::ShellCommandFailed
97
- err.message.must_equal "boom bad"
98
- end
99
-
100
- it "raises a Kitchen::Errror tagged exception for unknown exceptions" do
101
- command.stubs(:error!).raises(IOError, "boom bad")
102
-
103
- err = proc { subject.run_command("boom") }.must_raise IOError
104
- err.must_be_kind_of Kitchen::Error
105
- err.message.must_equal "boom bad"
106
- end
107
-
108
- it "prepends with sudo if :use_sudo is truthy" do
109
- Mixlib::ShellOut.unstub(:new)
110
- Mixlib::ShellOut.expects(:new).with("sudo -E yo", opts).returns(command)
111
-
112
- subject.run_command("yo", :use_sudo => true)
113
- end
114
-
115
- it "prepends with custom :sudo_command if :use_sudo is truthy" do
116
- Mixlib::ShellOut.unstub(:new)
117
- Mixlib::ShellOut.expects(:new).with("wat yo", opts).returns(command)
118
-
119
- subject.run_command("yo", :use_sudo => true, :sudo_command => "wat")
120
- end
121
-
122
- it "logs a debug BEGIN message" do
123
- subject.run_command("echo whoopa\ndoopa\ndo")
124
-
125
- subject.logs.first.
126
- must_equal "[local command] BEGIN (echo whoopa\ndoopa\ndo)"
127
- end
128
-
129
- it "logs a debug BEGIN message with custom log subject" do
130
- subject.run_command("tenac", :log_subject => "thed")
131
-
132
- subject.logs.first.must_equal "[thed command] BEGIN (tenac)"
133
- end
134
-
135
- it "truncates the debug BEGIN command if it spans multiple lines" do
136
- end
137
-
138
- it "logs a debug END message" do
139
- subject.run_command("echo whoopa doopa")
140
-
141
- subject.logs.last.must_equal "[local command] END (2m3.00s)"
142
- end
143
-
144
- it "logs a debug END message with custom log subject" do
145
- subject.run_command("tenac", :log_subject => "thed")
146
-
147
- subject.logs.last.must_equal "[thed command] END (2m3.00s)"
148
- end
149
- end
150
- end
1
+ # -*- encoding: utf-8 -*-
2
+ #
3
+ # Author:: Fletcher Nichol (<fnichol@nichol.ca>)
4
+ #
5
+ # Copyright (C) 2014, Fletcher Nichol
6
+ #
7
+ # Licensed under the Apache License, Version 2.0 (the "License");
8
+ # you may not use this file except in compliance with the License.
9
+ # You may obtain a copy of the License at
10
+ #
11
+ # http://www.apache.org/licenses/LICENSE-2.0
12
+ #
13
+ # Unless required by applicable law or agreed to in writing, software
14
+ # distributed under the License is distributed on an "AS IS" BASIS,
15
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16
+ # See the License for the specific language governing permissions and
17
+ # limitations under the License.
18
+
19
+ require_relative "../spec_helper"
20
+
21
+ require "kitchen/errors"
22
+ require "kitchen/shell_out"
23
+ require "kitchen/util"
24
+
25
+ module Kitchen
26
+
27
+ class Shelly
28
+
29
+ include Kitchen::ShellOut
30
+
31
+ attr_reader :logs
32
+
33
+ def debug(msg)
34
+ @logs ||= []
35
+ @logs << msg
36
+ end
37
+
38
+ def logger
39
+ "alogger"
40
+ end
41
+ end
42
+ end
43
+
44
+ describe Kitchen::ShellOut do
45
+
46
+ let(:command) do
47
+ stub(
48
+ :run_command => true,
49
+ :error! => true,
50
+ :stdout => "",
51
+ :execution_time => 123
52
+ )
53
+ end
54
+
55
+ let(:subject) { Kitchen::Shelly.new }
56
+
57
+ describe "#run_command" do
58
+
59
+ let(:opts) do
60
+ { :live_stream => "alogger", :timeout => 60000 }
61
+ end
62
+
63
+ before do
64
+ Mixlib::ShellOut.stubs(:new).returns(command)
65
+ end
66
+
67
+ it "builds a Mixlib::ShellOut object with default options" do
68
+ Mixlib::ShellOut.unstub(:new)
69
+ Mixlib::ShellOut.expects(:new).with("yoyo", opts).returns(command)
70
+
71
+ subject.run_command("yoyo")
72
+ end
73
+
74
+ [:timeout, :cwd, :environment].each do |attr|
75
+ it "builds a Mixlib::ShellOut object with a custom #{attr}" do
76
+ opts[attr] = "custom"
77
+
78
+ Mixlib::ShellOut.unstub(:new)
79
+ Mixlib::ShellOut.expects(:new).with("yoyo", opts).returns(command)
80
+
81
+ subject.run_command("yoyo", attr => "custom")
82
+ end
83
+ end
84
+
85
+ it "returns the command's standard out" do
86
+ command.stubs(:stdout).returns("sweetness")
87
+
88
+ subject.run_command("icecream").must_equal "sweetness"
89
+ end
90
+
91
+ it "raises a ShellCommandFailed if the command does not cleanly exit" do
92
+ command.stubs(:error!).
93
+ raises(Mixlib::ShellOut::ShellCommandFailed, "boom bad")
94
+
95
+ err = proc { subject.run_command("boom") }.
96
+ must_raise Kitchen::ShellOut::ShellCommandFailed
97
+ err.message.must_equal "boom bad"
98
+ end
99
+
100
+ it "raises a Kitchen::Errror tagged exception for unknown exceptions" do
101
+ command.stubs(:error!).raises(IOError, "boom bad")
102
+
103
+ err = proc { subject.run_command("boom") }.must_raise IOError
104
+ err.must_be_kind_of Kitchen::Error
105
+ err.message.must_equal "boom bad"
106
+ end
107
+
108
+ it "prepends with sudo if :use_sudo is truthy" do
109
+ Mixlib::ShellOut.unstub(:new)
110
+ Mixlib::ShellOut.expects(:new).with("sudo -E yo", opts).returns(command)
111
+
112
+ subject.run_command("yo", :use_sudo => true)
113
+ end
114
+
115
+ it "prepends with custom :sudo_command if :use_sudo is truthy" do
116
+ Mixlib::ShellOut.unstub(:new)
117
+ Mixlib::ShellOut.expects(:new).with("wat yo", opts).returns(command)
118
+
119
+ subject.run_command("yo", :use_sudo => true, :sudo_command => "wat")
120
+ end
121
+
122
+ it "logs a debug BEGIN message" do
123
+ subject.run_command("echo whoopa\ndoopa\ndo")
124
+
125
+ subject.logs.first.
126
+ must_equal "[local command] BEGIN (echo whoopa\ndoopa\ndo)"
127
+ end
128
+
129
+ it "logs a debug BEGIN message with custom log subject" do
130
+ subject.run_command("tenac", :log_subject => "thed")
131
+
132
+ subject.logs.first.must_equal "[thed command] BEGIN (tenac)"
133
+ end
134
+
135
+ it "truncates the debug BEGIN command if it spans multiple lines" do
136
+ end
137
+
138
+ it "logs a debug END message" do
139
+ subject.run_command("echo whoopa doopa")
140
+
141
+ subject.logs.last.must_equal "[local command] END (2m3.00s)"
142
+ end
143
+
144
+ it "logs a debug END message with custom log subject" do
145
+ subject.run_command("tenac", :log_subject => "thed")
146
+
147
+ subject.logs.last.must_equal "[thed command] END (2m3.00s)"
148
+ end
149
+ end
150
+ end