Class: Chef::Resource::ActionClass

Inherits:
Provider
  • Object
show all
Includes:
DSL::Recipe
Defined in:
lib/chef/resource/action_class.rb

Class Attribute Summary collapse

Attributes inherited from Provider

#action, #after_resource, #current_resource, #logger, #new_resource, #run_context

Class Method Summary collapse

Instance Method Summary collapse

Methods included from DSL::Recipe

#exec, #have_resource_class_for?, #resource_class_for

Methods included from Mixin::LazyModuleInclude

#descendants, #include, #included

Methods included from DSL::Definitions

add_definition, #evaluate_resource_definition, #has_resource_definition?

Methods included from DSL::Resources

add_resource_dsl, remove_resource_dsl

Methods included from DSL::Cheffish

load_cheffish

Methods included from DSL::RebootPending

#reboot_pending?

Methods included from DSL::PlatformIntrospection

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

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::IncludeRecipe

#include_recipe, #load_recipe

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

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::Secret

#default_secret_config, #default_secret_service, #secret, #with_secret_config, #with_secret_service

Methods included from DSL::RenderHelpers

#render_json, #render_toml, #render_yaml

Methods included from DSL::ReaderHelpers

#parse_file, #parse_json, #parse_toml, #parse_yaml

Methods included from DSL::Powershell

#ps_credential

Methods included from DSL::ChefVault

#chef_vault, #chef_vault_item, #chef_vault_item_for_environment

Methods included from DSL::DataQuery

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

Methods included from EncryptedDataBagItem::CheckEncrypted

#encrypted?

Methods included from DSL::Compliance

#include_input, #include_profile, #include_waiver

Methods inherited from Provider

action, action_description, action_descriptions, #action_nothing, #check_resource_semantics!, #cleanup_after_converge, #compile_and_converge_action, #converge_by, #converge_if_changed, #cookbook_name, #define_resource_requirements, #description, #events, include_resource_dsl_module, #initialize, #introduced, #node, #process_resource_requirements, provides, provides?, #recipe_name, #requirements, #resource_collection, #resource_updated?, #run_action, #set_updated_status, supports?, use, use_inline_resources, #validate_required_properties!, #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

Constructor Details

This class inherits a constructor from Chef::Provider

Class Attribute Details

.resource_class ⇒ Class

The Chef::Resource class this ActionClass was declared against.

Returns:

  • (Class) —

    The Chef::Resource class this ActionClass was declared against.



80
81
82
 
# File 'lib/chef/resource/action_class.rb', line 80

def resource_class
  @resource_class
end

Class Method Details

.include_resource_dsl? ⇒ Boolean

Returns:

  • (Boolean) 


70
71
72
 
# File 'lib/chef/resource/action_class.rb', line 70

def self.include_resource_dsl?
  true
end

.inspect ⇒ Object 



87
88
89
 
# File 'lib/chef/resource/action_class.rb', line 87

def self.inspect
  to_s
end

.to_s ⇒ Object 



83
84
85
 
# File 'lib/chef/resource/action_class.rb', line 83

def self.to_s
  "#{resource_class} action provider"
end

Instance Method Details

#load_after_resource ⇒ Object

build the after state (after_resource)



66
67
68
 
# File 'lib/chef/resource/action_class.rb', line 66

def load_after_resource
  @after_resource = return_load_current_value
end

#load_current_resource ⇒ Object

build the before state (current_resource)



61
62
63
 
# File 'lib/chef/resource/action_class.rb', line 61

def load_current_resource
  @current_resource = return_load_current_value
end

#return_load_current_value ⇒ Object 



32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/chef/resource/action_class.rb', line 32

def return_load_current_value
  resource = nil
  if new_resource.respond_to?(:load_current_value!)
    resource = new_resource.class.new(new_resource.name, new_resource.run_context)

    # copy the non-desired state, the identity properties and name property to the new resource
    # (the desired state values must be loaded by load_current_value)
    resource.class.properties.each_value do |property|
      if !property.desired_state? || property.identity? || property.name_property?
        property.set(resource, new_resource.send(property.name)) if new_resource.class.properties[property.name].is_set?(new_resource)
      end
    end

    # we support optionally passing the new_resource as an arg to load_current_value and
    # load_current_value can raise in order to clear the current_resource to nil
    begin
      if resource.method(:load_current_value!).arity > 0
        resource.load_current_value!(new_resource)
      else
        resource.load_current_value!
      end
    rescue Chef::Exceptions::CurrentValueDoesNotExist
      resource = nil
    end
  end
  resource
end

#to_s ⇒ Object 



28
29
30
 
# File 'lib/chef/resource/action_class.rb', line 28

def to_s
  "#{new_resource || "<no resource>"} action #{action ? action.inspect : "<no action>"}"
end