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
|
#--
# Author:: Daniel DeLeo (<dan@chef.io>)
# Copyright:: Copyright 2010-2018, 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 "mixlib/shellout"
require "chef/mixin/path_sanity"
class Chef
module Mixin
module ShellOut
extend Chef::Mixin::PathSanity
# PREFERRED APIS:
#
# all consumers should now call shell_out!/shell_out.
#
# on unix the shell_out API supports the clean_array() kind of syntax (below) so that
# array args are flat/compact/to_s'd. on windows, array args aren't supported to its
# up to the caller to join(" ") on arrays of strings.
#
# the shell_out_compacted/shell_out_compacted! APIs are private but are intended for use
# in rspec tests, and should ideally always be used to make code refactorings that do not
# change behavior easier:
#
# allow(provider).to receive(:shell_out_compacted!).with("foo", "bar", "baz")
# provider.shell_out!("foo", [ "bar", nil, "baz"])
# provider.shell_out!(["foo", nil, "bar" ], ["baz"])
#
# note that shell_out_compacted also includes adding the magical timeout option to force
# people to setup expectations on that value explicitly. it does not include the default_env
# mangling in order to avoid users having to setup an expectation on anything other than
# setting `default_env: false` and allow us to make tweak to the default_env without breaking
# a thousand unit tests.
#
def shell_out_compact(*args, **options) # FIXME: deprecate
if options.empty?
shell_out(*args)
else
shell_out(*args, **options)
end
end
def shell_out_compact!(*args, **options) # FIXME: deprecate
if options.empty?
shell_out!(*args)
else
shell_out!(*args, **options)
end
end
def shell_out_compact_timeout(*args, **options) # FIXME: deprecate
if options.empty?
shell_out(*args)
else
shell_out(*args, **options)
end
end
def shell_out_compact_timeout!(*args, **options) # FIXME: deprecate
if options.empty?
shell_out!(*args)
else
shell_out!(*args, **options)
end
end
def shell_out_with_systems_locale(*args, **options) # FIXME: deprecate
if options.empty?
shell_out(*args, default_env: false)
else
shell_out(*args, default_env: false, **options)
end
end
def shell_out_with_systems_locale!(*args, **options) # FIXME: deprecate
if options.empty?
shell_out!(*args, default_env: false)
else
shell_out!(*args, default_env: false, **options)
end
end
def a_to_s(*args) # FIXME: deprecate
# can't quite deprecate this yet
#Chef.deprecated(:package_misc, "a_to_s is deprecated use shell_out_compact or shell_out_compact_timeout instead")
args.flatten.reject { |i| i.nil? || i == "" }.map(&:to_s).join(" ")
end
def shell_out(*args, **options)
options = options.dup
options = Chef::Mixin::ShellOut.maybe_add_timeout(self, options)
if options.empty?
shell_out_compacted(*Chef::Mixin::ShellOut.clean_array(*args))
else
shell_out_compacted(*Chef::Mixin::ShellOut.clean_array(*args), **options)
end
end
def shell_out!(*args, **options)
options = options.dup
options = Chef::Mixin::ShellOut.maybe_add_timeout(self, options)
if options.empty?
shell_out_compacted!(*Chef::Mixin::ShellOut.clean_array(*args))
else
shell_out_compacted!(*Chef::Mixin::ShellOut.clean_array(*args), **options)
end
end
# helper sugar for resources that support passing timeouts to shell_out
#
# module method to not pollute namespaces, but that means we need self injected as an arg
# @api private
def self.maybe_add_timeout(obj, options)
if obj.class.ancestors.map(&:to_s).include?("Chef::Provider") && !obj.class.ancestors.map(&:to_s).include?("Chef::Resource::LWRPBase") && obj.new_resource.respond_to?(:timeout) && !options.key?(:timeout)
options = options.dup
# historically resources have not properly declared defaults on their timeouts, so a default default of 900s was enforced here
options[:timeout] = obj.new_resource.timeout ? obj.new_resource.timeout.to_f : 900
end
options
end
# helper function to mangle options when `default_env` is true
#
# @api private
def self.apply_default_env(options)
options = options.dup
default_env = options.delete(:default_env)
default_env = true if default_env.nil?
if default_env
env_key = options.key?(:env) ? :env : :environment
options[env_key] = {
"LC_ALL" => Chef::Config[:internal_locale],
"LANGUAGE" => Chef::Config[:internal_locale],
"LANG" => Chef::Config[:internal_locale],
env_path => sanitized_path,
}.update(options[env_key] || {})
end
options
end
private
# this SHOULD be used for setting up expectations in rspec, see banner comment at top.
#
# the private constraint is meant to avoid code calling this directly, rspec expectations are fine.
#
def shell_out_compacted(*args, **options)
options = Chef::Mixin::ShellOut.apply_default_env(options)
if options.empty?
Chef::Mixin::ShellOut.shell_out_command(*args)
else
Chef::Mixin::ShellOut.shell_out_command(*args, **options)
end
end
# this SHOULD be used for setting up expectations in rspec, see banner comment at top.
#
# the private constraint is meant to avoid code calling this directly, rspec expectations are fine.
#
def shell_out_compacted!(*args, **options)
options = Chef::Mixin::ShellOut.apply_default_env(options)
cmd = if options.empty?
Chef::Mixin::ShellOut.shell_out_command(*args)
else
Chef::Mixin::ShellOut.shell_out_command(*args, **options)
end
cmd.error!
cmd
end
# Helper for subclasses to reject nil out of an array. It allows
# using the array form of shell_out (which avoids the need to surround arguments with
# quote marks to deal with shells).
#
# Usage:
# shell_out!(*clean_array("useradd", universal_options, useradd_options, new_resource.username))
#
# universal_options and useradd_options can be nil, empty array, empty string, strings or arrays
# and the result makes sense.
#
# keeping this separate from shell_out!() makes it a bit easier to write expectations against the
# shell_out args and be able to omit nils and such in the tests (and to test that the nils are
# being rejected correctly).
#
# @param args [String] variable number of string arguments
# @return [Array] array of strings with nil and null string rejection
def self.clean_array(*args)
args.flatten.compact.map(&:to_s)
end
def self.shell_out_command(*args, **options)
cmd = if options.empty?
Mixlib::ShellOut.new(*args)
else
Mixlib::ShellOut.new(*args, **options)
end
cmd.live_stream ||= io_for_live_stream
cmd.run_command
cmd
end
def self.io_for_live_stream
if STDOUT.tty? && !Chef::Config[:daemon] && Chef::Log.debug?
STDOUT
else
nil
end
end
def self.env_path
if Chef::Platform.windows?
"Path"
else
"PATH"
end
end
end
end
end
# Break circular dep
require "chef/config"
|
