Class: Chef::Provider::Execute

Inherits:
Chef::Provider show all
Extended by:
Forwardable
Defined in:
lib/chef/provider/execute.rb

Direct Known Subclasses

Script

Constant Summary

Constants included from Mixin::ShellOut

Mixin::ShellOut::DEPRECATED_OPTIONS

Instance Attribute Summary

Attributes inherited from Chef::Provider

#action, #cookbook_name, #current_resource, #new_resource, #recipe_name, #run_context

Instance Method Summary collapse

Methods inherited from Chef::Provider

#action_nothing, #check_resource_semantics!, #cleanup_after_converge, #converge_by, #converge_if_changed, #events, include_resource_dsl, include_resource_dsl_module, #initialize, #node, #process_resource_requirements, provides, provides?, #requirements, #resource_collection, #resource_updated?, #run_action, #set_updated_status, supports?, use_inline_resources, #whyrun_mode?

Methods included from Mixin::Provides

#provided_as, #provides, #provides?

Methods included from Mixin::DescendantsTracker

#descendants, descendants, direct_descendants, #direct_descendants, find_descendants_by_name, #find_descendants_by_name, #inherited, store_inherited

Methods included from DeprecatedLWRPClass

#const_missing, #deprecated_constants, #register_deprecated_lwrp_class

Methods included from Mixin::LazyModuleInclude

#descendants, #include, #included

Methods included from Mixin::NotifyingBlock

#notifying_block, #subcontext_block

Methods included from DSL::DeclareResource

#build_resource, #declare_resource, #delete_resource, #delete_resource!, #edit_resource, #edit_resource!, #find_resource, #find_resource!, #with_run_context

Methods included from Mixin::ShellOut

#run_command_compatible_options, #shell_out, #shell_out!, #shell_out_with_systems_locale, #shell_out_with_systems_locale!

Methods included from Mixin::PowershellOut

#powershell_out, #powershell_out!

Methods included from Mixin::WindowsArchitectureHelper

#assert_valid_windows_architecture!, #disable_wow64_file_redirection, #forced_32bit_override_required?, #is_i386_process_on_x86_64_windows?, #node_supports_windows_architecture?, #node_windows_architecture, #restore_wow64_file_redirection, #valid_windows_architecture?, #with_os_architecture, #wow64_architecture_override_required?, #wow64_directory

Methods included from DSL::PlatformIntrospection

#docker?, #platform?, #platform_family?, #value_for_platform, #value_for_platform_family

Constructor Details

This class inherits a constructor from Chef::Provider

Instance Method Details

#action_run ⇒ Object 



54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/chef/provider/execute.rb', line 54

def action_run
  if creates && sentinel_file.exist?
    Chef::Log.debug("#{new_resource} sentinel file #{sentinel_file} exists - nothing to do")
    return false
  end

  converge_by("execute #{description}") do
    begin
      shell_out!(command, opts)
    rescue Mixlib::ShellOut::ShellCommandFailed
      if sensitive?
        raise Mixlib::ShellOut::ShellCommandFailed,
          "Command execution failed. STDOUT/STDERR suppressed for sensitive resource"
      else
        raise
      end
    end
    Chef::Log.info("#{new_resource} ran successfully")
  end
end

#define_resource_requirements ⇒ Object 



41
42
43
44
45
46
 
# File 'lib/chef/provider/execute.rb', line 41

def define_resource_requirements
   # @todo: this should change to raise in some appropriate major version bump.
  if creates && creates_relative? && !cwd
    Chef::Log.warn "Providing a relative path for the creates attribute without the cwd is deprecated and will be changed to fail in the future (CHEF-3819)"
  end
end

#load_current_resource ⇒ Object 



32
33
34
35
 
# File 'lib/chef/provider/execute.rb', line 32

def load_current_resource
  current_resource = Chef::Resource::Execute.new(new_resource.name)
  current_resource
end

#timeout ⇒ Object 



48
49
50
51
52
 
# File 'lib/chef/provider/execute.rb', line 48

def timeout
  # original implementation did not specify a timeout, but ShellOut
  # *always* times out. So, set a very long default timeout
  new_resource.timeout || 3600
end

#whyrun_supported? ⇒ Boolean

Returns:

  • (Boolean) 


37
38
39
 
# File 'lib/chef/provider/execute.rb', line 37

def whyrun_supported?
  true
end