Module: Chef::Mixin::ShellOut

Constant Summary

DEPRECATED_OPTIONS =
[ [:command_log_level,   :log_level],
[:command_log_prepend, :log_tag] ]

Instance Method Summary collapse

Instance Method Details

#a_to_s(*args) ⇒ String

Helper for sublcasses to convert an array of string args into a string. It will compact nil or empty strings in the array and will join the array elements with spaces, without introducing any double spaces for nil/empty elements.

Parameters:

  • args (String)

    variable number of string arguments

Returns:

  • (String)

    nicely concatenated string or empty string



160
161
162
163
164
# File 'lib/chef/mixin/shell_out.rb', line 160

def a_to_s(*args)
  # 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

#clean_array(*args) ⇒ Array

Helper for sublcasses 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).

Parameters:

  • args (String)

    variable number of string arguments

Returns:

  • (Array)

    array of strings with nil and null string rejection



182
183
184
# File 'lib/chef/mixin/shell_out.rb', line 182

def clean_array(*args)
  args.flatten.compact.map(&:to_s)
end

#run_command_compatible_options(command_args) ⇒ Object

CHEF-3090: Deprecate command_log_level and command_log_prepend Patterned after github.com/chef/chef/commit/e1509990b559984b43e428d4d801c394e970f432



138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
# File 'lib/chef/mixin/shell_out.rb', line 138

def run_command_compatible_options(command_args)
  return command_args unless command_args.last.is_a?(Hash)

  my_command_args = command_args.dup
  my_options = my_command_args.last

  DEPRECATED_OPTIONS.each do |old_option, new_option|
    # Edge case: someone specifies :command_log_level and 'command_log_level' in the option hash
    next unless value = my_options.delete(old_option) || my_options.delete(old_option.to_s)
    deprecate_option old_option, new_option
    my_options[new_option] = value
  end

  my_command_args
end

#shell_out(*args, **options) ⇒ Object

we use 'en_US.UTF-8' by default because we parse localized strings in English as an API and generally must support UTF-8 unicode.



104
105
106
107
108
109
110
111
112
113
# File 'lib/chef/mixin/shell_out.rb', line 104

def shell_out(*args, **options)
  options = options.dup
  env_key = options.has_key?(:env) ? :env : :environment
  options[env_key] = {
    "LC_ALL" => Chef::Config[:internal_locale],
    "LANGUAGE" => Chef::Config[:internal_locale],
    "LANG" => Chef::Config[:internal_locale],
  }.update(options[env_key] || {})
  shell_out_command(*args, **options)
end

#shell_out!(*command_args) ⇒ Object

call shell_out (using en_US.UTF-8) and raise errors



116
117
118
119
120
# File 'lib/chef/mixin/shell_out.rb', line 116

def shell_out!(*command_args)
  cmd = shell_out(*command_args)
  cmd.error!
  cmd
end

#shell_out_compact(*args, **options) ⇒ Object

PREFERRED APIS:

shell_out_compact and shell_out_compact! flatten their array arguments and remove nils and pass the resultant array to shell_out. this actually eliminates spaces-in-args bugs because this:

shell_out!(“command #arg”)

becomes two arguments if arg has spaces and requires quotations:

shell_out!(“command '#arg'”)

using shell_out_compact! this becomes:

shell_out_compact!(“command”, arg)

and spaces in the arg just works and it does not become two arguments (and the shell quoting around the argument must actually be removed).

there's also an implicit join between all the array elements, and nested arrays are flattened which means that odd where-do-i-put-the-spaces options handling just works, and instead of this:

opts = ""                     # needs to be empty string for when foo and bar are both missing
opts << " -foo" if needs_foo? # needs the leading space on both of these
opts << " -bar" if needs_bar?
shell_out!("cmd#{opts}")      # have to think way too hard about why there's no space here

becomes:

opts = []
opts << "-foo" if needs_foo?
opts << "-bar" if needs_bar?
shell_out_compact!("cmd", opts)

and opts can be an empty array or nil and it'll work out fine.

generally its best to use shell_out_compact! in code and setup expectations on shell_out! in tests



63
64
65
66
67
68
69
# File 'lib/chef/mixin/shell_out.rb', line 63

def shell_out_compact(*args, **options)
  if options.empty?
    shell_out(*clean_array(*args))
  else
    shell_out(*clean_array(*args), **options)
  end
end

#shell_out_compact!(*args, **options) ⇒ Object



71
72
73
74
75
76
77
# File 'lib/chef/mixin/shell_out.rb', line 71

def shell_out_compact!(*args, **options)
  if options.empty?
    shell_out!(*clean_array(*args))
  else
    shell_out!(*clean_array(*args), **options)
  end
end

#shell_out_compact_timeout(*args, **options) ⇒ Object

helper sugar for resources that support passing timeouts to shell_out



81
82
83
84
85
86
87
# File 'lib/chef/mixin/shell_out.rb', line 81

def shell_out_compact_timeout(*args, **options)
  raise "object is not a resource that supports timeouts" unless respond_to?(:new_resource) && new_resource.respond_to?(:timeout)
  options_dup = options.dup
  options_dup[:timeout] = new_resource.timeout if new_resource.timeout
  options_dup[:timeout] = 900 unless options_dup.key?(:timeout)
  shell_out_compact(*args, **options_dup)
end

#shell_out_compact_timeout!(*args, **options) ⇒ Object



89
90
91
92
93
94
95
# File 'lib/chef/mixin/shell_out.rb', line 89

def shell_out_compact_timeout!(*args, **options)
  raise "object is not a resource that supports timeouts" unless respond_to?(:new_resource) && new_resource.respond_to?(:timeout)
  options_dup = options.dup
  options_dup[:timeout] = new_resource.timeout if new_resource.timeout
  options_dup[:timeout] = 900 unless options_dup.key?(:timeout)
  shell_out_compact!(*args, **options_dup)
end

#shell_out_with_systems_locale(*command_args) ⇒ Object



122
123
124
# File 'lib/chef/mixin/shell_out.rb', line 122

def shell_out_with_systems_locale(*command_args)
  shell_out_command(*command_args)
end

#shell_out_with_systems_locale!(*command_args) ⇒ Object



126
127
128
129
130
# File 'lib/chef/mixin/shell_out.rb', line 126

def shell_out_with_systems_locale!(*command_args)
  cmd = shell_out_with_systems_locale(*command_args)
  cmd.error!
  cmd
end