Class: Chef::Provider::Execute

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

Direct Known Subclasses

Script

Instance Attribute Summary

Attributes inherited from Chef::Provider

#action, #current_resource, #logger, #new_resource, #recipe_name, #run_context

Instance Method Summary collapse

Methods inherited from Chef::Provider

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

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 Mixin::LazyModuleInclude

#descendants, #include, #included

Methods included from Mixin::ShellOut

apply_default_env, maybe_add_timeout, #shell_out, #shell_out!

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 Mixin::PowershellExec

#powershell_exec

Methods included from DSL::Powershell

#ps_credential

Methods included from DSL::RegistryHelper

#registry_data_exists?, #registry_get_subkeys, #registry_get_values, #registry_has_subkeys?, #registry_key_exists?, #registry_value_exists?

Methods included from DSL::DataQuery

#data_bag, #data_bag_item, #search, #tagged?

Methods included from EncryptedDataBagItem::CheckEncrypted

#encrypted?

Methods included from DSL::PlatformIntrospection

#older_than_win_2012_or_8?, #platform?, #platform_family?, #value_for_platform, #value_for_platform_family

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!, #resources, #with_run_context

Constructor Details

This class inherits a constructor from Chef::Provider

Instance Method Details

#action_run ⇒ Object 



50
51
52
53
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 50

def action_run
  if creates && sentinel_file.exist?
    logger.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?
        ex = Mixlib::ShellOut::ShellCommandFailed.new("Command execution failed. STDOUT/STDERR suppressed for sensitive resource")
        # Forcibly hide the exception cause chain here so we don't log the unredacted version
        def ex.cause
          nil
        end
        raise ex
      else
        raise
      end
    end
    logger.info("#{new_resource} ran successfully")
  end
end

#define_resource_requirements ⇒ Object 



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

def define_resource_requirements
  if creates && creates_relative? && !cwd
    # FIXME? move this onto the resource?
    raise Chef::Exceptions::Execute, "Please either specify a full path for the creates property, or specify a cwd property to the #{new_resource} resource"
  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 



44
45
46
47
48
 
# File 'lib/chef/provider/execute.rb', line 44

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