class Chef::Resource
Constants
- FORBIDDEN_IVARS
-
FORBIDDEN_IVARS
do not show up when the resource is converted to JSON (ie. hidden from data_collector and sending to the chef server viato_json
/to_h/as_json/inspect) - HIDDEN_IVARS
-
HIDDEN_IVARS
do not show up when the resource is displayed to the user as text (ie. in the error inspector output viato_text
)
Attributes
@return [String] The cookbook this resource was declared in.
@return [String] The actual name that was used to create this resource.
Sometimes, when you say something like `package 'blah'`, the system will create a different resource (i.e. `YumPackage`). When this happens, the user will expect to see the thing they wrote, not the type that was returned. May be `nil`, in which case callers should read #resource_name. See #declared_key.
The guard interpreter that will be used to process ‘only_if` and `not_if` statements by default. If left unset, or set to `:default`, the guard interpreter used will be Chef::GuardInterpreter::DefaultGuardInterpreter
.
Must be a resource class like ‘Chef::Resource::Execute`, or a corresponding to the name of a resource. The resource must descend from `Chef::Resource::Execute`.
TODO this needs to be coerced on input so that retrieval is consistent.
@return [Class, Symbol
, String] the default Guard interpreter resource.
The time it took (in seconds) to run the most recently-run action. Not cumulative across actions. This is set to 0 as soon as a new action starts running, and set to the elapsed time at the end of the action.
@return [Integer] The time (in seconds) it took to process the most recent action. Not cumulative.
@return [Chef::Provider] The provider this resource was declared in (if
it was declared in an LWRP). When you call methods that do not exist on this Resource, Chef will try to call the method on the provider as well before giving up.
@return [Boolean] If the resource was executed by the runner
@return [Mixlib::Log::Child] The logger for this resources. This is a child of the run context’s logger, if one exists.
XXX: this is required for definition params inside of the scope of a subresource to work correctly.
@return [String] The recipe this resource was declared in.
If we are currently initializing the resource, this will be true.
Do NOT use this. It may be removed. It is for internal purposes only. @api private
@return [String] The source line where this resource was declared.
Expected to come from caller() or a stack trace, it usually follows one of these formats: /some/path/to/file.rb:80:in `wombat_tears' C:/some/path/to/file.rb:80 in 1`wombat_tears'
Whether or not this resource was updated during an action. If multiple actions are set on the resource, this will be ‘true` if any action caused an update to happen.
@return [Boolean] Whether the resource was updated during an action.
Public Class Methods
Source
# File lib/chef/resource.rb, line 1079 def self.action(action, description: nil, &recipe_block) action = action.to_sym declare_action_class action_class.action(action, description: description, &recipe_block) self.allowed_actions += [ action ] default_action action if Array(default_action) == [:nothing] end
Define an action on this resource.
The action is defined as a recipe block that will be compiled and then converged when the action is taken (when Resource
is converged). The recipe has access to the resource’s attributes and methods, as well as the Chef
recipe DSL
.
Resources in the action recipe may notify and subscribe to other resources within the action recipe, but cannot notify or subscribe to resources in the main Chef
run.
Resource
actions are inheritable: if resource A defines ‘action :create` and B is a subclass of A, B gets all of A’s actions. Additionally, resource B can define ‘action :create` and call `super()` to invoke A’s action code.
The first action defined (besides ‘:nothing`) will become the default action for the resource.
@param name [Symbol] The action name to define. @param description [String] optional description for the action. Used for
documentation generation.
@param recipe_block The recipe to run when the action is taken. This block
takes no parameters, and will be evaluated in a new context containing: - The resource's public and protected methods (including attributes) - The Chef Recipe DSL (file, etc.) - super() referring to the parent version of the action (if any)
@return The Action class implementing the action
Source
# File lib/chef/resource.rb, line 1153 def self.action_class(&block) @action_class ||= declare_action_class @action_class.class_eval(&block) if block @action_class end
The action class is a ‘Chef::Provider` which is created at Resource
class evaluation time when the Custom Resource
is being constructed.
This happens the first time the ruby parser hits an ‘action` or an `action_class` method, the presence of either indicates that this is going to be a Chef-12.5 custom resource. If we never see one of these directives then we are constructing an old-style Resource+Provider or LWRP or whatever.
If a block is passed, the action_class
is always created and the block is run inside it.
Source
# File lib/chef/resource.rb, line 1002 def self.allowed_actions(*actions) @allowed_actions ||= if superclass.respond_to?(:allowed_actions) superclass.allowed_actions.dup else [ :nothing ] end @allowed_actions |= actions.flatten end
The list of allowed actions for the resource.
@param actions [Array<Symbol>] The list of actions to add to allowed_actions.
@return [Array<Symbol>] The list of actions, as symbols.
Source
# File lib/chef/resource.rb, line 1012 def self.allowed_actions=(value) @allowed_actions = value.uniq end
Source
# File lib/chef/resource.rb, line 1364 def self.chef_version_for_provides(constraint = NOT_PASSED) @chef_version_for_provides = constraint unless constraint == NOT_PASSED @chef_version_for_provides ||= nil end
This API can be used for backcompat to do:
chef_version_for_provides
“< 14.0” if defined?(:chef_version_for_provides)
For core chef versions that do not support chef_version: in provides lines.
Since resource_name
calls provides the generally correct way of doing this is to do ‘chef_version_for_provides` first, then `resource_name` and then any additional options `provides` lines.
Once we no longer care about supporting chef < 14.4 then we can deprecate this API.
@param arg [String] version constraint to match against (e.g. “> 14”)
Source
# File lib/chef/resource.rb, line 1163 def self.custom_resource? false end
Returns true or false based on if the resource is a custom resource. The top-level Chef::Resource
is not a chef resource. This value is inherited.
@return [Boolean] if the resource is a custom_resource
Source
# File lib/chef/resource.rb, line 1183 def self.declare_action_class @action_class ||= begin is_custom_resource! base_provider = if superclass.custom_resource? superclass.action_class else ActionClass end resource_class = self Class.new(base_provider) do self.resource_class = resource_class end end end
Ensure the action class actually gets created. This is called when the user does ‘action :x do … end`.
@api private
Source
# File lib/chef/resource.rb, line 1029 def self.default_action(action_name = NOT_PASSED) unless action_name.equal?(NOT_PASSED) @default_action = Array(action_name).map(&:to_sym) self.allowed_actions |= @default_action end if defined?(@default_action) && @default_action @default_action elsif superclass.respond_to?(:default_action) superclass.default_action else [:nothing] end end
The action that will be run if no other action is specified.
Setting default_action
will automatically add the action to allowed_actions
, if it isn’t already there.
Defaults to [:nothing].
@param action_name [Symbol,Array<Symbol>] The default action (or series
of actions) to use.
@return [Array<Symbol>] The default actions for the resource.
Source
# File lib/chef/resource.rb, line 1044 def self.default_action=(action_name) default_action action_name end
Source
# File lib/chef/resource.rb, line 1487 def self.default_description(default_description = "NOT_PASSED") if default_description != "NOT_PASSED" @default_description = default_description end @default_description end
Source
# File lib/chef/resource.rb, line 1472 def self.deprecated(deprecated = "NOT_PASSED") if deprecated != "NOT_PASSED" @deprecated = true @deprecated_message = deprecated end @deprecated end
Source
# File lib/chef/resource.rb, line 1451 def self.description(description = "NOT_PASSED") if description != "NOT_PASSED" @description = description end @description end
Source
# File lib/chef/resource.rb, line 1465 def self.examples(examples = "NOT_PASSED") if examples != "NOT_PASSED" @examples = examples end @examples end
Source
# File lib/chef/resource.rb, line 738 def self.from_hash(o) resource = new(o["instance_vars"]["@name"]) o["instance_vars"].each do |k, v| resource.instance_variable_set("@#{k}".to_sym, v) end resource end
Source
# File lib/chef/resource.rb, line 750 def self.from_json(j) from_hash(Chef::JSONCompat.parse(j)) end
Source
# File lib/chef/resource.rb, line 861 def self.identity_attr(name = nil) property = identity_property(name) return nil unless property property.name end
Set a property as the “identity attribute” for this resource.
Identical to calling identity_property.first.key.
@param name [Symbol] The name of the property to set.
@return [Symbol]
@deprecated ‘identity_property` should be used instead.
@raise [ArgumentError] If no arguments are passed and the resource has
more than one identity property.
Source
# File lib/chef/resource.rb, line 838 def self.identity_property(name = nil) result = identity_properties(*Array(name)) if result.size > 1 raise Chef::Exceptions::MultipleIdentityError, "identity_property cannot be called on an object with more than one identity property (#{result.map(&:name).join(", ")})." end result.first end
Set the identity of this resource to a particular property.
This drives identity
, which returns data that uniquely refers to a given resource on the given node (in such a way that it can be correlated across Chef
runs).
This method is unnecessary when declaring properties with ‘property`; properties can be added to identity during declaration with `identity: true`.
“‘ruby property :x, identity: true # part of identity property :y # not part of identity “`
@param name [Symbol] A list of property names to set as the identity.
@return [Symbol] The identity property if there is only one; or ‘nil` if
there are more than one.
@raise [ArgumentError] If no arguments are passed and the resource has
more than one identity property.
Source
# File lib/chef/resource.rb, line 1333 def self.inherited(child) super @@sorted_descendants = nil end
Source
# File lib/chef/resource.rb, line 1458 def self.introduced(introduced = "NOT_PASSED") if introduced != "NOT_PASSED" @introduced = introduced end @introduced end
Source
# File lib/chef/resource.rb, line 1173 def self.is_custom_resource! define_singleton_method :custom_resource? do true end end
This sets the resource to being a custom resource, and does so in a way that automatically inherits to all subclasses via defining a method on the class (class variables and class instance variables don’t have the correct semantics here, this is a poor man’s activesupport class_attribute)
@api private
Source
# File lib/chef/resource.rb, line 746 def self.json_create(o) from_hash(o) end
Source
# File lib/chef/resource.rb, line 1110 def self.load_current_value(&load_block) define_method(:load_current_value!, &load_block) end
Define a method to load up this resource’s properties with the current actual values.
@param load_block The block to load. Will be run in the context of a newly
created resource with its identity values filled in.
Source
# File lib/chef/resource.rb, line 111 def initialize(name, run_context = nil) name(name) unless name.nil? @run_context = run_context @logger = if run_context run_context.logger.with_child({ name: name, resource: resource_name }) else Chef::Log.with_child({ name: name, resource: resource_name }) end @before = nil @params = {} @provider = nil @allowed_actions = self.class.allowed_actions.to_a @action = self.class.default_action @updated = false @updated_by_last_action = false @not_if = [] @only_if = [] @source_line = nil @deprecated = false @skip_docs = false # We would like to raise an error when the user gives us a guard # interpreter and a ruby_block to the guard. In order to achieve this # we need to understand when the user overrides the default guard # interpreter. Therefore we store the default separately in a different # attribute. @guard_interpreter = nil @default_guard_interpreter = :default @elapsed_time = 0 @executed_by_runner = false end
Create a new Resource
.
@param name The name of this resource (corresponds to the name attribute,
used for notifications to this resource).
@param run_context
The context of the Chef
run. Corresponds to run_context
.
Source
# File lib/chef/resource.rb, line 1211 def self.preview_resource(value = nil) @preview_resource = false unless defined?(@preview_resource) @preview_resource = value unless value.nil? @preview_resource end
Set or return if this resource is in preview mode.
This only has value in the resource_inspector to mark a resource as being new-to-chef-core. Its meaning is probably more equivalent to “experimental” in that the API might change even in minor versions due to bugfixing and is NOT considered “stable” yet.
@param value [nil, Boolean] If nil, get the current value. If not nil, set
the value of the flag.
@return [Boolean]
Source
# File lib/chef/resource.rb, line 1376 def self.provides(name, **options, &block) name = name.to_sym # deliberately do not go through the accessor here @resource_name = name if resource_name.nil? if chef_version_for_provides && !options.include?(:chef_version) options[:chef_version] = chef_version_for_provides end result = Chef.resource_handler_map.set(name, self, **options, &block) Chef::DSL::Resources.add_resource_dsl(name) result end
Mark this resource as providing particular DSL
.
Resources have an automatic DSL
based on their resource_name
, equivalent to ‘provides :resource_name` (providing the resource on all OS’s). If you declare a ‘provides` with the given resource_name
, it replaces that provides (so that you can provide your resource DSL
only on certain OS’s).
Source
# File lib/chef/resource.rb, line 1391 def self.provides?(node, resource_name) Chef::ResourceResolver.new(node, resource_name).provided_by?(self) end
Source
# File lib/chef/resource.rb, line 1599 def self.resource_for_node(short_name, node) klass = Chef::ResourceResolver.resolve(short_name, node: node) raise Chef::Exceptions::NoSuchResourceType.new(short_name, node) if klass.nil? klass end
Returns a resource based on a short_name and node
Parameters¶ ↑
- short_name<Symbol>
-
short_name of the resource (ie :directory)
- node<Chef::Node>
-
Node
object to look up platform and version in
Returns¶ ↑
- <Chef::Resource>
-
returns the proper
Chef::Resource
class
Source
# File lib/chef/resource.rb, line 1621 def self.resource_matching_short_name(short_name) Chef::ResourceResolver.resolve(short_name) end
Returns the class with the given resource_name.
NOTE: Chef::Resource.resource_matching_short_name
(:package) returns Chef::Resource::Package
, while on rhel the API call Chef::Resource.resource_for_node
(:package, node) will return Chef::Resource::YumPackage
– which is probably what you really want. This API should most likely be removed or changed to call resource_for_node.
Parameters¶ ↑
- short_name<Symbol>
-
short_name of the resource (ie :directory)
Returns¶ ↑
- <Chef::Resource>
-
returns the proper
Chef::Resource
class
Source
# File lib/chef/resource.rb, line 971 def self.resource_name(name = NOT_PASSED) # Setter if name != NOT_PASSED @resource_name = name.to_sym rescue nil end @resource_name = nil unless defined?(@resource_name) @resource_name end
The display name of this resource type, for printing purposes.
Call ‘resource_name nil` to remove the resource name
@param value [Symbol] The desired name of this resource type (e.g.
`execute`), or `nil` if this class is abstract and has no resource_name.
@return [Symbol] The name of this resource type (e.g. ‘:execute`).
Source
# File lib/chef/resource.rb, line 981 def self.resource_name=(name) resource_name(name) end
Source
# File lib/chef/resource.rb, line 1480 def self.skip_docs(skip_docs = "NOT_PASSED") if skip_docs != "NOT_PASSED" @skip_docs = skip_docs end @skip_docs end
Source
# File lib/chef/resource.rb, line 1329 def self.sorted_descendants @@sorted_descendants ||= descendants.sort_by(&:to_s) end
Source
# File lib/chef/resource.rb, line 810 def self.state_attrs(*names) state_properties(*names).map(&:name) end
Set or return the list of “state properties” implemented by the Resource
subclass.
Equivalent to calling state_properties and getting ‘state_properties.keys`.
@deprecated Use state_properties.keys instead. Note that when you declare
properties with `property`: properties are added to state_properties by default, and can be turned off with `desired_state: false` ```ruby property :x # part of desired state property :y, desired_state: false # not part of desired state ```
@param names [Array<Symbol>] A list of property names to set as desired
state.
@return [Array<Symbol>] All property names with desired state.
Source
# File lib/chef/resource.rb, line 989 def self.unified_mode(flag = nil) @unified_mode = Chef::Config[:resource_unified_mode_default] if !defined?(@unified_mode) || @unified_mode.nil? @unified_mode = flag unless flag.nil? !!@unified_mode end
If the resource’s action should run in separated compile/converge mode.
@param flag [Boolean] value to set unified_mode
to @return [Boolean] unified_mode
value
Source
# File lib/chef/resource.rb, line 1501 def self.use(partial) if partial =~ /^core::(.*)/ partial = $1 dirname = ::File.dirname(partial) basename = ::File.basename(partial, ".rb") basename = basename[1..] if basename.start_with?("_") class_eval IO.read(::File.expand_path("resource/#{dirname}/_#{basename}.rb", __dir__)) else dirname = ::File.dirname(partial) basename = ::File.basename(partial, ".rb") basename = basename[1..] if basename.start_with?("_") # Support recursive `use` callers = caller_locations used_from = if callers.first.label == "use" callers.detect { |caller| caller.label == "class_from_file" }.path else callers.first.path end fullpath = ::File.expand_path("#{dirname}/_#{basename}.rb", ::File.dirname(used_from)) class_eval IO.read(fullpath) end end
Use a partial code fragment. This can be used for code sharing between multiple resources.
Do not wrap the code fragment in a class or module. It also does not support the use of super to subclass any methods defined in the fragment, the methods will just be overwritten.
@param partial [String] the code fragment to eval against the class
Public Instance Methods
Source
# File lib/chef/resource.rb, line 150 def action(arg = nil) if arg arg = Array(arg).map(&:to_sym) arg.each do |action| validate( { action: action }, { action: { kind_of: Symbol, equal_to: allowed_actions } } ) end @action = arg else @action end end
The action or actions that will be taken when this resource is run.
@param arg [Array, Symbol] A list of actions (e.g. ‘:create`) @return [Array] the list of actions.
Source
# File lib/chef/resource.rb, line 1093 def action_description(action) provider_for_action(action).class.action_description(action) rescue Chef::Exceptions::ProviderNotFound # If a provider can't be found, there can be no description defined on the provider. nil rescue NameError => e # This can happen when attempting to load a provider in a platform-specific # environment where we have not required the necessary files yet raise unless /uninitialized constant/.match?(e.message) end
Retrieve the description for a resource’s action, if any description has been included in the definition.
@param action [Symbol,String] the action name @return the description of the action provided, or nil if no description was defined
Source
# File lib/chef/resource.rb, line 957 def after_created nil end
A hook called after a resource is created. Meant to be overridden by subclasses.
Source
# File lib/chef/resource.rb, line 892 def allowed_actions(value = NOT_PASSED) if value != NOT_PASSED self.allowed_actions = value end @allowed_actions end
Source
# File lib/chef/resource.rb, line 702 def as_json(*a) safe_ivars = instance_variables.map(&:to_sym) - FORBIDDEN_IVARS instance_vars = {} safe_ivars.each do |iv| instance_vars[iv.to_s.sub(/^@/, "")] = instance_variable_get(iv) end { "json_class" => self.class.name, "instance_vars" => instance_vars, } end
as_json
does most of the to_json
heavy lifted. It exists here in case activesupport is loaded. activesupport will call as_json
and skip over to_json. This ensure json is encoded as expected
Source
# File lib/chef/resource.rb, line 1409 def before_notifications run_context.before_notifications(self) end
Source
# File lib/chef/resource.rb, line 1530 def cookbook_version if cookbook_name && cookbook_name != "@recipe_files" run_context.cookbook_collection[cookbook_name] end end
The cookbook in which this Resource
was defined (if any).
@return Chef::CookbookVersion
The cookbook in which this Resource
was defined.
Source
# File lib/chef/resource.rb, line 1130 def current_value provider = provider_for_action(Array(action).first) if provider.whyrun_mode? && !provider.whyrun_supported? raise "Cannot retrieve #{self.class.current_resource} in why-run mode: #{provider} does not support why-run" end provider.load_current_resource provider.current_resource end
Get the current actual value of this resource.
This does not cache–a new value will be returned each time.
@return A new copy of the resource, with values filled in from the actual
current value.
Source
# File lib/chef/resource.rb, line 1119 def current_value_does_not_exist! raise Chef::Exceptions::CurrentValueDoesNotExist end
Call this in ‘load_current_value` to indicate that the value does not exist and that `current_resource` should therefore be `nil`.
Source
# File lib/chef/resource.rb, line 1556 def custom_exception_message(e) "#{self} (#{defined_at}) had an error: #{e.class.name}: #{e.message}" end
Preface an exception message with generic Resource
information.
@param e [StandardError] An exception with ‘e.message` @return [String] An exception message customized with class name.
Source
# File lib/chef/resource.rb, line 1560 def customize_exception(e) new_exception = e.exception(custom_exception_message(e)) new_exception.set_backtrace(e.backtrace) new_exception end
Source
# File lib/chef/resource.rb, line 1403 def declared_key return to_s if declared_type.nil? "#{declared_type}[#{@name}]" end
We usually want to store and reference resources by their declared type and not the actual type that was looked up by the Resolver (IE, “package” becomes YumPackage
class). If we have not been provided the declared key we want to fall back on the old to_s
key.
Source
# File lib/chef/resource.rb, line 1437 def defined_at # The following regexp should match these two sourceline formats: # /some/path/to/file.rb:80:in `wombat_tears' # C:/some/path/to/file.rb:80 in 1`wombat_tears' # extracting the path to the source file and the line number. if cookbook_name && recipe_name && source_line "#{cookbook_name}::#{recipe_name} line #{source_line_number}" elsif source_line "#{source_line_file} line #{source_line_number}" else "dynamically defined" end end
Source
# File lib/chef/resource.rb, line 175 def delayed_action(arg) arg = Array(arg).map(&:to_sym) arg.map do |action| validate( { action: action }, { action: { kind_of: Symbol, equal_to: allowed_actions } } ) # the resource effectively sends a delayed notification to itself run_context.add_delayed_action(Notification.new(self, action, self, run_context.unified_mode)) end end
Force a delayed notification into this resource’s run_context.
This should most likely be paired with action :nothing
@param arg [Array, Symbol] A list of actions (e.g. ‘:create`)
Source
# File lib/chef/resource.rb, line 1417 def delayed_notifications run_context.delayed_notifications(self) end
Source
# File lib/chef/resource.rb, line 489 def guard_interpreter(arg = nil) if arg.nil? @guard_interpreter || @default_guard_interpreter else set_or_return(:guard_interpreter, arg, kind_of: Symbol) end end
The guard interpreter that will be used to process ‘only_if` and `not_if` statements. If left unset, the default_guard_interpreter
will be used.
Must be a resource class like ‘Chef::Resource::Execute`, or a corresponding to the name of a resource. The resource must descend from `Chef::Resource::Execute`.
TODO this needs to be coerced on input so that retrieval is consistent.
@param arg [Class, Symbol
, String] The Guard interpreter resource class/
symbol/name.
@return [Class, Symbol
, String] The Guard interpreter resource.
Source
# File lib/chef/resource.rb, line 526 def identity result = {} identity_properties = self.class.identity_properties identity_properties.each do |property| result[property.name] = send(property.name) end return result.values.first if identity_properties.size == 1 result end
The value of the identity of this resource.
-
If there are no identity properties on the resource, ‘name` is returned.
-
If there is exactly one identity property on the resource, it is returned.
-
If there are more than one, they are returned in a hash.
@return [Object,Hash<Symbol,Object>] The identity of this resource.
Source
# File lib/chef/resource.rb, line 1413 def immediate_notifications run_context.immediate_notifications(self) end
Source
# File lib/chef/resource.rb, line 692 def inspect ivars = instance_variables.map(&:to_sym) - FORBIDDEN_IVARS ivars.inject("<#{self}") do |str, ivar| str << " #{ivar}: #{instance_variable_get(ivar).inspect}" end << ">" end
Source
# File lib/chef/resource.rb, line 556 def load_from(resource) resource.instance_variables.each do |iv| unless iv == :@source_line || iv == :@action || iv == :@not_if || iv == :@only_if instance_variable_set(iv, resource.instance_variable_get(iv)) end end end
Make this resource into an exact (shallow) copy of the other resource.
@param resource [Chef::Resource] The resource to copy from.
Source
# File lib/chef/resource.rb, line 1626 def lookup_provider_constant(name, action = :nothing) # XXX: "name" is probably a poor choice of name here, ideally this would be nil, but we need to # fix resources so that nil or empty names work (also solving the apt_update "doesn't matter one bit" # problem). WARNING: this string is not a public API and should not be referenced (e.g. in provides blocks) # and may change at any time. If you've found this comment you're also probably very lost and should maybe # consider using `declare_resource :whatever` instead of trying to set `provider :whatever` on a resource, or in some # other way reconsider what you're trying to do, since you're likely trying to force a bad design that we # can't/won't support. self.class.resource_for_node(name, node).new("name", run_context).provider_for_action(action).class end
@api private
Source
# File lib/chef/resource.rb, line 1341 def method_missing(method_symbol, *args, &block) if enclosing_provider && enclosing_provider.respond_to?(method_symbol) enclosing_provider.send(method_symbol, *args, &block) else raise NoMethodError, "undefined method `#{method_symbol}' for #{self.class}" end end
If an unknown method is invoked, determine whether the enclosing Provider’s lexical scope can fulfill the request. E.g. This happens when the Resource’s block invokes new_resource.
Source
Source
# File lib/chef/resource.rb, line 409 def not_if(command = nil, opts = {}, &block) if command || block_given? @not_if << Conditional.not_if(self, command, opts, &block) end @not_if end
A command or block that indicates whether to actually run this resource. The command or block is run just before the action actually executes, and the action will be skipped if the block returns true.
If a block is specified, it must return ‘false` in order for the Resource
to be executed.
If a command is specified, the resource’s guard_interpreter
will run the command and interpret the results according to ‘opts`. For example, the default `execute` resource will be treated as `false` if the command returns a non-zero exit code, and `true` if it returns 0. Thus, in the default case:
-
‘not_if “your command”` will perform the action only if `your command`
returns a non-zero code.
-
‘only_if “your command”, valid_exit_codes: [ 1, 2, 3 ]` will perform the action only if `your command` returns something other than 1, 2, or 3.
@param command [String] A string to execute. @param opts [Hash] Options control the execution of the command @param block [Proc] A ruby block to run. Ignored if a command is given.
Source
# File lib/chef/resource.rb, line 242 def notifies(action, resource_spec, timing = :delayed) # when using old-style resources(:template => "/foo.txt") style, you # could end up with multiple resources. validate_resource_spec!(resource_spec) resources = [ resource_spec ].flatten resources.each do |resource| case timing.to_s when "delayed" notifies_delayed(action, resource) when "immediate", "immediately" notifies_immediately(action, resource) when "before" notifies_before(action, resource) else raise ArgumentError, "invalid timing: #{timing} for notifies(#{action}, #{resources.inspect}, #{timing}) resource #{self} "\ "Valid timings are: :delayed, :immediate, :immediately, :before" end end true end
Sets up a notification that will run a particular action on another resource if and when this resource is updated by an action.
If the action does not update this resource, the notification never triggers.
Only one resource may be specified per notification.
‘delayed` notifications will only ever happen once per resource, so if multiple resources all notify a single resource to perform the same action, the action will only happen once. However, if they ask for different actions, each action will happen once, in the order they were updated.
‘immediate` notifications will cause the action to be triggered once per notification, regardless of how many other resources have triggered the notification as well.
@param action The action to run on the other resource. @param resource_spec [String, Hash, Chef::Resource
] The resource to run. @param timing [String, Symbol] When to notify. Has these values:
- `delayed`: Will run the action on the other resource after all other actions have been run. This is the default. - `immediate`, `immediately`: Will run the action on the other resource immediately (before any other action is run). - `before`: Will run the action on the other resource immediately *before* the action is actually run.
@example Resource
by string
file '/foo.txt' do content 'hi' notifies :create, 'file[/bar.txt]' end file '/bar.txt' do action :nothing content 'hi' end
@example Resource
by hash
file '/foo.txt' do content 'hi' notifies :create, file: '/bar.txt' end file '/bar.txt' do action :nothing content 'hi' end
@example Direct Resource
bar = file '/bar.txt' do action :nothing content 'hi' end file '/foo.txt' do content 'hi' notifies :create, bar end
Source
# File lib/chef/resource.rb, line 1295 def notifies_before(action, resource_spec) run_context.notifies_before(Notification.new(resource_spec, action, self, run_context.unified_mode)) end
Helper for notifies
Source
# File lib/chef/resource.rb, line 1305 def notifies_delayed(action, resource_spec) run_context.notifies_delayed(Notification.new(resource_spec, action, self, run_context.unified_mode)) end
Helper for notifies
Source
# File lib/chef/resource.rb, line 1300 def notifies_immediately(action, resource_spec) run_context.notifies_immediately(Notification.new(resource_spec, action, self, run_context.unified_mode)) end
Helper for notifies
Source
# File lib/chef/resource.rb, line 379 def only_if(command = nil, opts = {}, &block) if command || block_given? @only_if << Conditional.only_if(self, command, opts, &block) end @only_if end
A command or block that indicates whether to actually run this resource. The command or block is run just before the action actually executes, and the action will be skipped if the block returns false.
If a block is specified, it must return ‘true` in order for the Resource
to be executed.
If a command is specified, the resource’s guard_interpreter
will run the command and interpret the results according to ‘opts`. For example, the default `execute` resource will be treated as `false` if the command returns a non-zero exit code, and `true` if it returns 0. Thus, in the default case:
-
‘only_if “your command”` will perform the action only if `your command`
returns 0.
-
‘only_if “your command”, valid_exit_codes: [ 1, 2, 3 ]` will perform the action only if `your command` returns 1, 2, or 3.
@param command [String] A string to execute. @param opts [Hash] Options control the execution of the command @param block [Proc] A ruby block to run. Ignored if a command is given.
Source
# File lib/chef/resource.rb, line 777 def provider(arg = nil) klass = if arg.is_a?(String) || arg.is_a?(Symbol) lookup_provider_constant(arg) else arg end set_or_return(:provider, klass, kind_of: [ Class ]) end
The provider class for this resource.
If ‘action :x do … end` has been declared on this resource or its superclasses, this will return the `action_class`.
If this is not set, ‘provider_for_action` will dynamically determine the provider.
@param arg [String, Symbol
, Class] Sets the provider class for this resource.
If passed a String or Symbol, e.g. `:file` or `"file"`, looks up the provider based on the name.
@return The provider class for this resource.
Source
# File lib/chef/resource.rb, line 1544 def provider_for_action(action) provider_class = Chef::ProviderResolver.new(node, self, action).resolve provider = provider_class.new(self, run_context) provider.action = action provider end
Source
# File lib/chef/resource.rb, line 1280 def resolve_notification_references(always_raise = false) run_context.before_notifications(self).each do |n| n.resolve_resource_reference(run_context.resource_collection, true) end run_context.immediate_notifications(self).each do |n| n.resolve_resource_reference(run_context.resource_collection, always_raise) end run_context.delayed_notifications(self).each do |n| n.resolve_resource_reference(run_context.resource_collection, always_raise) end end
Iterates over all immediate and delayed notifications, calling resolve_resource_reference on each in turn, causing them to resolve lazy/forward references.
Source
# File lib/chef/resource.rb, line 641 def resource_initializing=(value) if value @resource_initializing = true else remove_instance_variable(:@resource_initializing) end end
Source
# File lib/chef/resource.rb, line 949 def resource_name @resource_name || self.class.resource_name end
The display name of this resource type, for printing purposes.
Will be used to print out the resource in messages, e.g. resource_name
@return [Symbol] The name of this resource type (e.g. ‘:execute`).
Source
# File lib/chef/resource.rb, line 573 def run_action(action, notification_type = nil, notifying_resource = nil) # reset state in case of multiple actions on the same resource. @elapsed_time = 0 start_time = Time.now events.resource_action_start(self, action, notification_type, notifying_resource) # Try to resolve lazy/forward references in notifications again to handle # the case where the resource was defined lazily (ie. in a ruby_block) resolve_notification_references validate_action(action) if Chef::Config[:verbose_logging] || logger.level == :debug # This can be noisy logger.info("Processing #{self} action #{action} (#{defined_at})") end # ensure that we don't leave @updated_by_last_action set to true # on accident updated_by_last_action(false) # Don't modify @retries directly and keep it intact, so that the # recipe_snippet from ResourceFailureInspector can print the value # that was set in the resource block initially. remaining_retries = retries begin return if should_skip?(action) with_umask do provider_for_action(action).run_action end rescue StandardError => e if ignore_failure logger.error("#{custom_exception_message(e)}; ignore_failure is set, continuing") events.resource_failed(self, action, e) elsif remaining_retries > 0 events.resource_failed_retriable(self, action, remaining_retries, e) remaining_retries -= 1 logger.info("Retrying execution of #{self}, #{remaining_retries} attempt#{"s" if remaining_retries > 1} left") sleep retry_delay retry else events.resource_failed(self, action, e) raise customize_exception(e) end end ensure @elapsed_time = Time.now - start_time # Reporting endpoint doesn't accept a negative resource duration so set it to 0. # A negative value can occur when a resource changes the system time backwards @elapsed_time = 0 if @elapsed_time < 0 events.resource_completed(self) end
Runs the given action on this resource, immediately.
@param action The action to run (e.g. ‘:create`) @param notification_type The notification type that triggered this (if any) @param notifying_resource The resource that triggered this notification (if any)
@raise Any error that occurs during the actual action.
Source
# File lib/chef/resource.rb, line 1576 def should_skip?(action) conditional_action = ConditionalActionNotNothing.new(action) conditionals = [ conditional_action ] + only_if + not_if conditionals.find do |conditional| if conditional.continue? false else events.resource_skipped(self, action, conditional) logger.debug("Skipping #{self} due to #{conditional.description}") true end end end
Evaluates not_if
and only_if
conditionals. Returns a falsey value if any of the conditionals indicate that this resource should be skipped, i.e., if an only_if
evaluates to false or a not_if
evaluates to true.
If this resource should be skipped, returns the first conditional that “fails” its check. Subsequent conditionals are not evaluated, so in general it’s not a good idea to rely on side effects from not_if
or only_if
commands/blocks being evaluated.
Also skips conditional checking when the action is :nothing
Source
# File lib/chef/resource.rb, line 1421 def source_line_file if source_line source_line.match(/(.*):(\d+):?.*$/).to_a[1] else nil end end
Source
# File lib/chef/resource.rb, line 1429 def source_line_number if source_line source_line.match(/(.*):(\d+):?.*$/).to_a[2] else nil end end
Source
# File lib/chef/resource.rb, line 506 def state_for_resource_reporter state = {} state_properties = self.class.state_properties state_properties.each do |property| if property.is_set?(self) state[property.name] = property.sensitive? ? "*sensitive value suppressed*" : send(property.name) end end state end
Get the value of the state attributes in this resource as a hash.
Does not include properties that are not set (unless they are identity properties).
@return [Hash{Symbol => Object}] A Hash of attribute => value for the
Resource class's `state_attrs`.
Source
# File lib/chef/resource.rb, line 341 def subscribes(action, resources, timing = :delayed) resources = [resources].flatten resources.each do |resource| validate_resource_spec!(resource) if resource.is_a?(String) resource = UnresolvedSubscribes.new(resource, run_context) end if resource.run_context.nil? resource.run_context = run_context end resource.notifies(action, self, timing) end true end
Subscribes to updates from other resources, causing a particular action to run on this resource when the other resource is updated.
If multiple resources are specified, this resource action will be run if any of them change.
This notification will only trigger once, no matter how many other resources are updated (or how many actions are run by a particular resource).
@param action The action to run on the other resource. @param resources [String, Resource
, Array[String, Resource]] The resources to subscribe to. @param timing [String, Symbol] When to notify. Has these values:
- `delayed`: An update will cause the action to run after all other actions have been run. This is the default. - `immediate`, `immediately`: The action will run immediately following the other resource being updated. - `before`: The action will run immediately before the other resource is updated.
@example Resources by string
file '/foo.txt' do content 'hi' action :nothing subscribes :create, 'file[/bar.txt]' end file '/bar.txt' do content 'hi' end
@example Direct resource
bar = file '/bar.txt' do content 'hi' end file '/foo.txt' do content 'hi' action :nothing subscribes :create, bar end
@example Multiple resources by string
file '/foo.txt' do content 'hi' action :nothing subscribes :create, [ 'file[/bar.txt]', 'file[/baz.txt]' ] end file '/bar.txt' do content 'hi' end file '/baz.txt' do content 'hi' end
@example Multiple resources
bar = file '/bar.txt' do content 'hi' end baz = file '/bar.txt' do content 'hi' end file '/foo.txt' do content 'hi' action :nothing subscribes :create, [ bar, baz ] end
Source
# File lib/chef/resource.rb, line 1643 def suppress_up_to_date_messages? false end
This is used to suppress the “(up to date)” message in the doc formatter for the log resource (where it is nonsensical).
This is not exactly a private API, but its doubtful there exist many other sane use cases for this.
Source
# File lib/chef/resource.rb, line 720 def to_h # Grab all current state, then any other ivars (backcompat) result = {} self.class.state_properties.each do |p| result[p.name] = p.get(self) end safe_ivars = instance_variables.map(&:to_sym) - FORBIDDEN_IVARS safe_ivars.each do |iv| key = iv.to_s.sub(/^@/, "").to_sym next if result.key?(key) result[key] = instance_variable_get(iv) end result end
Source
# File lib/chef/resource.rb, line 715 def to_json(*a) results = as_json Chef::JSONCompat.to_json(results, *a) end
Serialize this object as a hash
Source
# File lib/chef/resource.rb, line 653 def to_s "#{resource_name}[#{name}]" end
Generic Ruby
and Data Structure Stuff (for user)
Source
# File lib/chef/resource.rb, line 657 def to_text return "suppressed sensitive resource output" if sensitive text = "# Declared in #{@source_line}\n\n" text << "#{resource_name}(\"#{name}\") do\n" all_props = {} self.class.sensitive_properties.map do |p| all_props[p.name.to_s] = p.sensitive? ? '"*sensitive value suppressed*"' : value_to_text(p.get(self)) rescue Chef::Exceptions::ValidationFailed # This space left intentionally blank, the property was probably required or had an invalid default. end ivars = instance_variables.map(&:to_sym) - HIDDEN_IVARS ivars.each do |ivar| iv = ivar.to_s.sub(/^@/, "") if all_props.key?(iv) text << " #{iv} #{all_props[iv]}\n" elsif (value = instance_variable_get(ivar)) && !(value.respond_to?(:empty?) && value.empty?) text << " #{iv} #{value_to_text(value)}\n" end end [@not_if, @only_if].flatten.each do |conditional| text << " #{conditional.to_text}\n" end text << "end\n" end
Source
# File lib/chef/resource.rb, line 915 def updated? updated end
Whether or not this resource was updated during an action. If multiple actions are set on the resource, this will be ‘true` if any action caused an update to happen.
@return [Boolean] Whether the resource was updated during an action.
Source
# File lib/chef/resource.rb, line 927 def updated_by_last_action(true_or_false) @updated ||= true_or_false @updated_by_last_action = true_or_false end
Whether or not this resource was updated during the most recent action. This is set to ‘false` at the beginning of each action.
@param true_or_false [Boolean] Whether the resource was updated during the
current / most recent action.
@return [Boolean] Whether the resource was updated during the most recent action.
Source
# File lib/chef/resource.rb, line 938 def updated_by_last_action? @updated_by_last_action end
Whether or not this resource was updated during the most recent action. This is set to ‘false` at the beginning of each action.
@return [Boolean] Whether the resource was updated during the most recent action.
Source
# File lib/chef/resource.rb, line 1540 def validate_action(action) raise ArgumentError, "nil is not a valid action for resource #{self}" if action.nil? end
Source
# File lib/chef/resource.rb, line 1396 def validate_resource_spec!(resource_spec) run_context.resource_collection.validate_lookup_spec!(resource_spec) end
Helper for notifies
Source
# File lib/chef/resource.rb, line 688 def value_to_text(value) value.respond_to?(:to_text) ? value.to_text : value.inspect end
Source
# File lib/chef/resource.rb, line 627 def with_umask old_value = ::File.umask(umask.oct) if umask yield ensure ::File.umask(old_value) if umask end
Private Instance Methods
Source
# File lib/chef/resource/powershell_package_source.rb, line 313 def load_resource_state_script(source_name) <<-EOH $PSDefaultParameterValues = @{ "*:WarningAction" = "SilentlyContinue" } if(Get-PackageSource -Name '#{source_name}' -ErrorAction SilentlyContinue) { if ((Get-PackageSource -Name '#{source_name}').ProviderName -eq 'PowerShellGet') { (Get-PSRepository -Name '#{source_name}') | Select @{n='source_name';e={$_.Name}}, @{n='source_location';e={$_.SourceLocation}}, @{n='trusted';e={$_.Trusted}}, @{n='provider_name';e={$_.PackageManagementProvider}}, @{n='publish_location';e={$_.PublishLocation}}, @{n='script_source_location';e={$_.ScriptSourceLocation}}, @{n='script_publish_location';e={$_.ScriptPublishLocation}} } else { (Get-PackageSource -Name '#{source_name}') | Select @{n='source_name';e={$_.Name}}, @{n='new_name';e={$_.Name}}, @{n='source_location';e={$_.Location}}, @{n='provider_name';e={$_.ProviderName}}, @{n='trusted';e={$_.IsTrusted}}, @{n='publish_location';e={$_.PublishLocation}} } } EOH end