Module: Chef::Mixin::ShellOut

Included in:
Application::Client, Application::Solo, Application::WindowsService, Cookbook::GemInstaller, Cookbook::SyntaxCheck, DSL::Universal, GuardInterpreter::DefaultGuardInterpreter, Knife::CookbookSCMRepo, Knife::CookbookSiteShare, Knife::Ssh, HomebrewUser, PowershellOut, Platform::Rebooter, Provider::AptRepository, Provider::Cron::Unix, Provider::Group, Provider::Ifconfig, Provider::Mount, Provider::Package, Provider::Package::Cab, Provider::Package::Msu, Provider::Package::Openbsd, Provider::Package::Rubygems::AlternateGemEnvironment, Provider::Package::Windows::Exe, Provider::Package::Windows::MSI, Provider::Package::Yum::YumCache, Provider::Service::Freebsd, Provider::Service::Openbsd, Provider::Service::Windows, Provider::SystemdUnit, Resource::Conditional, Resource::FreebsdPackage, Resource::OpenbsdPackage, Util::Selinux
Defined in:
lib/chef/mixin/shell_out.rb

Constant Summary collapse

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



141
142
143
144
 
# File 'lib/chef/mixin/shell_out.rb', line 141

def a_to_s(*args)
  # FIXME: this should be deprecated in favor of shell_out_compact/shell_out_compact!
  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



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

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



119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
 
# File 'lib/chef/mixin/shell_out.rb', line 119

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

  return 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.



85
86
87
88
89
90
91
92
93
94
 
# File 'lib/chef/mixin/shell_out.rb', line 85

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



97
98
99
100
101
 
# File 'lib/chef/mixin/shell_out.rb', line 97

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



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

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 



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

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_with_systems_locale(*command_args) ⇒ Object 



103
104
105
 
# File 'lib/chef/mixin/shell_out.rb', line 103

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

#shell_out_with_systems_locale!(*command_args) ⇒ Object 



107
108
109
110
111
 
# File 'lib/chef/mixin/shell_out.rb', line 107

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