Module: Chef::Mixin::ShellOut

Included in:
Application::WindowsService, Config, Cookbook::SyntaxCheck, DSL::Recipe, GuardInterpreter::DefaultGuardInterpreter, Knife::CookbookSCMRepo, Knife::CookbookSiteShare, Knife::Ssh, HomebrewUser, Platform::Rebooter, Platform::ServiceHelpers, Provider, Provider::Cron::Unix, Provider::Package::Rubygems::AlternateGemEnvironment, Provider::Package::Yum::YumCache, Provider::Service::Freebsd, Provider::Service::Windows, Resource::Conditional, Resource::FreebsdPackage, 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

#run_command_compatible_options(command_args) ⇒ Object

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



70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/chef/mixin/shell_out.rb', line 70

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

  _command_args = command_args.dup
  _options = _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 = _options.delete(old_option) || _options.delete(old_option.to_s)
    deprecate_option old_option, new_option
    _options[new_option] = value
  end

  return _command_args
end

#shell_out(*command_args) ⇒ 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.



31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
 
# File 'lib/chef/mixin/shell_out.rb', line 31

def shell_out(*command_args)
  args = command_args.dup
  if args.last.is_a?(Hash)
    options = args.pop.dup
    env_key = options.has_key?(:env) ? :env : :environment
    options[env_key] ||= {}
    options[env_key] = options[env_key].dup
    options[env_key]['LC_ALL'] ||= Chef::Config[:internal_locale] unless options[env_key].has_key?('LC_ALL')
    args << options
  else
    args << { :environment => { 'LC_ALL' => Chef::Config[:internal_locale] } }
  end

  shell_out_command(*args)
end

#shell_out!(*command_args) ⇒ Object

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



48
49
50
51
52
 
# File 'lib/chef/mixin/shell_out.rb', line 48

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

#shell_out_with_systems_locale(*command_args) ⇒ Object 



54
55
56
 
# File 'lib/chef/mixin/shell_out.rb', line 54

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

#shell_out_with_systems_locale!(*command_args) ⇒ Object 



58
59
60
61
62
 
# File 'lib/chef/mixin/shell_out.rb', line 58

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