Class: Chef::Resource::LWRPBase

Inherits:
Chef::Resource show all
Extended by:
Mixin::ConvertToClassName, Mixin::FromFile
Defined in:
lib/chef/resource/lwrp_base.rb

Overview

Chef::Resource::LWRPBase

Base class for LWRP resources. Adds DSL sugar on top of Chef::Resource, so attributes, default action, etc. can be defined with pleasing syntax.

Constant Summary collapse

NULL_ARG = 
Object.new

Constants inherited from Chef::Resource

FORBIDDEN_IVARS, HIDDEN_IVARS

Instance Attribute Summary

Attributes inherited from Chef::Resource

#allowed_actions, #cookbook_name, #default_guard_interpreter, #elapsed_time, #enclosing_provider, #not_if_args, #only_if_args, #params, #provider, #recipe_name, #resource_name, #retries, #retry_delay, #run_context, #source_line, #updated

Class Method Summary collapse

Methods included from Mixin::ConvertToClassName

constantize, convert_to_class_name, convert_to_snake_case, filename_to_qualified_string, snake_case_basename

Methods included from Mixin::FromFile

class_from_file, from_file

Methods inherited from Chef::Resource

#action, #after_created, #as_json, #cookbook_version, #custom_exception_message, #customize_exception, #defined_at, #delayed_notifications, dsl_name, #epic_fail, #events, #guard_interpreter, #identity, identity_attr, #ignore_failure, #immediate_notifications, #inspect, #is, json_create, #load_prior_resource, #method_missing, #name, #node, node_map, #noop, #not_if, #notifies, #notifies_delayed, #notifies_immediately, #only_if, provider_base, #provider_for_action, provides, #resolve_notification_references, resource_for_node, resource_matching_short_name, #resources, #run_action, #sensitive, #should_skip?, #state, state_attrs, strict_const_defined?, #subscribes, #supports, #to_hash, #to_json, #to_s, #to_text, #updated?, #updated_by_last_action, #updated_by_last_action?, #validate_action, #validate_resource_spec!

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

#deprecated_ivar

Methods included from DSL::RebootPending

#reboot_pending?

Methods included from DSL::PlatformIntrospection

#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 Mixin::ParamsValidate

#lazy, #set_or_return, #validate

Methods included from DSL::DataQuery

#data_bag, #data_bag_item, #search

Methods included from EncryptedDataBagItem::CheckEncrypted

#encrypted?

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class Chef::Resource

Class Method Details

.actions(*action_names) ⇒ Object

Adds action_names to the list of valid actions for this resource.



109
110
111
112
113
114
115
116
117
118
119
120
 
# File 'lib/chef/resource/lwrp_base.rb', line 109

def self.actions(*action_names)
  if action_names.empty?
    defined?(@actions) ? @actions : from_superclass(:actions, []).dup
  else
    # BC-compat way for checking if actions have already been defined
    if defined?(@actions)
      @actions.push(*action_names)
    else
      @actions = action_names
    end
  end
end

.attribute(attr_name, validation_opts = {}) ⇒ Object

Define an attribute on this resource, including optional validation parameters.



75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/chef/resource/lwrp_base.rb', line 75

def self.attribute(attr_name, validation_opts={})
  # Ruby 1.8 doesn't support default arguments to blocks, but we have to
  # use define_method with a block to capture +validation_opts+.
  # Workaround this by defining two methods :(
  class_eval(<<-SHIM, __FILE__, __LINE__)
    def #{attr_name}(arg=nil)
      _set_or_return_#{attr_name}(arg)
    end
  SHIM

  define_method("_set_or_return_#{attr_name.to_s}".to_sym) do |arg|
    set_or_return(attr_name.to_sym, arg, validation_opts)
  end
end

.build_from_file(cookbook_name, filename, run_context) ⇒ Object

Evaluates the LWRP resource file and instantiates a new Resource class.



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/lwrp_base.rb', line 37

def self.build_from_file(cookbook_name, filename, run_context)
  resource_class = nil
  rname = filename_to_qualified_string(cookbook_name, filename)

  class_name = convert_to_class_name(rname)
  if Resource.strict_const_defined?(class_name)
    Chef::Log.info("#{class_name} light-weight resource is already initialized -- Skipping loading #{filename}!")
    Chef::Log.debug("Overriding already defined LWRPs is not supported anymore starting with Chef 12.")
    resource_class = Resource.const_get(class_name)
  else
    resource_class = Class.new(self)

    resource_class.resource_name = rname
    resource_class.run_context = run_context
    resource_class.class_from_file(filename)

    Chef::Resource.const_set(class_name, resource_class)
    Chef::Log.debug("Loaded contents of #{filename} into a resource named #{rname} defined in Chef::Resource::#{class_name}")
  end

  resource_class
end

.default_action(action_name = NULL_ARG) ⇒ Object

Sets the default action



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/chef/resource/lwrp_base.rb', line 91

def self.default_action(action_name=NULL_ARG)
  unless action_name.equal?(NULL_ARG)
    @actions ||= []
    if action_name.is_a?(Array)
      action = action_name.map { |arg| arg.to_sym }
      @actions = actions | action
      @default_action = action
    else
      action = action_name.to_sym
      @actions.push(action) unless @actions.include?(action)
      @default_action = action
    end
  end

  @default_action ||= from_superclass(:default_action)
end

.lazy(&block) ⇒ Object 



142
143
144
 
# File 'lib/chef/resource/lwrp_base.rb', line 142

def self.lazy(&block)
  DelayedEvaluator.new(&block)
end

.node ⇒ Object 



138
139
140
 
# File 'lib/chef/resource/lwrp_base.rb', line 138

def self.node
  run_context.node
end

.resource_name(arg = NULL_ARG) ⇒ Object Also known as: resource_name=

Set the resource name for this LWRP



61
62
63
64
65
66
67
 
# File 'lib/chef/resource/lwrp_base.rb', line 61

def self.resource_name(arg = NULL_ARG)
  if arg.equal?(NULL_ARG)
    @resource_name
  else
    @resource_name = arg
  end
end

.run_context ⇒ Object 



134
135
136
 
# File 'lib/chef/resource/lwrp_base.rb', line 134

def self.run_context
  @run_context
end

.run_context=(run_context) ⇒ Object

Set the run context on the class. Used to provide access to the node during class definition.



130
131
132
 
# File 'lib/chef/resource/lwrp_base.rb', line 130

def self.run_context=(run_context)
  @run_context = run_context
end

.valid_actions(*args) ⇒ Object

Deprecated. 


123
124
125
126
 
# File 'lib/chef/resource/lwrp_base.rb', line 123

def self.valid_actions(*args)
  Chef::Log.warn("`valid_actions' is deprecated, please use actions `instead'!")
  actions(*args)
end