Class: Chef::Resource
- Inherits:
-
Object
- Object
- Chef::Resource
- Extended by:
- Mixin::ConvertToClassName, Mixin::Provides
- Includes:
- DSL::DataQuery, DSL::RebootPending, DSL::RegistryHelper, DSL::Universal, Mixin::ConvertToClassName, Mixin::Deprecation, Mixin::Properties
- Defined in:
- lib/chef/resource.rb,
lib/chef/resource/csh.rb,
lib/chef/resource/env.rb,
lib/chef/resource/git.rb,
lib/chef/resource/ksh.rb,
lib/chef/resource/log.rb,
lib/chef/resource/scm.rb,
lib/chef/resource/bash.rb,
lib/chef/resource/cron.rb,
lib/chef/resource/file.rb,
lib/chef/resource/link.rb,
lib/chef/resource/ohai.rb,
lib/chef/resource/perl.rb,
lib/chef/resource/ruby.rb,
lib/chef/resource/user.rb,
lib/chef/resource/batch.rb,
lib/chef/resource/group.rb,
lib/chef/resource/mdadm.rb,
lib/chef/resource/mount.rb,
lib/chef/resource/route.rb,
lib/chef/resource/deploy.rb,
lib/chef/resource/python.rb,
lib/chef/resource/reboot.rb,
lib/chef/resource/script.rb,
lib/chef/resource/execute.rb,
lib/chef/resource/launchd.rb,
lib/chef/resource/package.rb,
lib/chef/resource/service.rb,
lib/chef/resource/chef_gem.rb,
lib/chef/resource/erl_call.rb,
lib/chef/resource/ifconfig.rb,
lib/chef/resource/template.rb,
lib/chef/resource/directory.rb,
lib/chef/resource/lwrp_base.rb,
lib/chef/resource/apt_update.rb,
lib/chef/resource/breakpoint.rb,
lib/chef/resource/dsc_script.rb,
lib/chef/resource/ruby_block.rb,
lib/chef/resource/subversion.rb,
lib/chef/resource/apt_package.rb,
lib/chef/resource/bff_package.rb,
lib/chef/resource/cab_package.rb,
lib/chef/resource/conditional.rb,
lib/chef/resource/dnf_package.rb,
lib/chef/resource/gem_package.rb,
lib/chef/resource/ips_package.rb,
lib/chef/resource/msu_package.rb,
lib/chef/resource/osx_profile.rb,
lib/chef/resource/remote_file.rb,
lib/chef/resource/rpm_package.rb,
lib/chef/resource/yum_package.rb,
lib/chef/resource/action_class.rb,
lib/chef/resource/dpkg_package.rb,
lib/chef/resource/dsc_resource.rb,
lib/chef/resource/http_request.rb,
lib/chef/resource/registry_key.rb,
lib/chef/resource/systemd_unit.rb,
lib/chef/resource/user/pw_user.rb,
lib/chef/resource/windows_task.rb,
lib/chef/resource/cookbook_file.rb,
lib/chef/resource/user/aix_user.rb,
lib/chef/resource/apt_repository.rb,
lib/chef/resource/macosx_service.rb,
lib/chef/resource/pacman_package.rb,
lib/chef/resource/user/dscl_user.rb,
lib/chef/resource/windows_script.rb,
lib/chef/resource/yum_repository.rb,
lib/chef/resource/zypper_package.rb,
lib/chef/resource/deploy_revision.rb,
lib/chef/resource/freebsd_package.rb,
lib/chef/resource/openbsd_package.rb,
lib/chef/resource/paludis_package.rb,
lib/chef/resource/portage_package.rb,
lib/chef/resource/smartos_package.rb,
lib/chef/resource/solaris_package.rb,
lib/chef/resource/user/linux_user.rb,
lib/chef/resource/windows_package.rb,
lib/chef/resource/windows_service.rb,
lib/chef/resource/homebrew_package.rb,
lib/chef/resource/macports_package.rb,
lib/chef/resource/remote_directory.rb,
lib/chef/resource/file/verification.rb,
lib/chef/resource/powershell_script.rb,
lib/chef/resource/user/solaris_user.rb,
lib/chef/resource/user/windows_user.rb,
lib/chef/resource/chocolatey_package.rb,
lib/chef/resource/powershell_package.rb,
lib/chef/resource/timestamped_deploy.rb,
lib/chef/resource/resource_notification.rb,
lib/chef/resource/whyrun_safe_ruby_block.rb,
lib/chef/resource/conditional_action_not_nothing.rb,
lib/chef/resource/file/verification/systemd_unit.rb
Direct Known Subclasses
AptRepository, AptUpdate, Breakpoint, Cron, Deploy, Directory, DscResource, DscScript, Env, ErlCall, Execute, File, Group, HttpRequest, Ifconfig, LWRPBase, Launchd, Link, Log, Mdadm, Mount, Ohai, OsxProfile, Package, Reboot, RegistryKey, Route, RubyBlock, Scm, Service, SystemdUnit, UnresolvedSubscribes, User, WindowsTask, YumRepository
Defined Under Namespace
Classes: ActionClass, AptPackage, AptRepository, AptUpdate, Bash, Batch, BffPackage, Breakpoint, CabPackage, ChefGem, ChocolateyPackage, Conditional, ConditionalActionNotNothing, CookbookFile, Cron, Csh, Deploy, DeployBranch, DeployRevision, Directory, DnfPackage, DpkgPackage, DscResource, DscScript, Env, ErlCall, Execute, File, FreebsdPackage, GemPackage, Git, Group, HomebrewPackage, HttpRequest, Ifconfig, IpsPackage, Ksh, LWRPBase, Launchd, Link, Log, MacosxService, MacportsPackage, Mdadm, Mount, MsuPackage, Notification, Ohai, OpenbsdPackage, OsxProfile, Package, PacmanPackage, PaludisPackage, Perl, PortagePackage, PowershellPackage, PowershellScript, Python, Reboot, RegistryKey, RemoteDirectory, RemoteFile, Route, RpmPackage, Ruby, RubyBlock, Scm, Script, Service, SmartosPackage, SolarisPackage, Subversion, SystemdUnit, Template, TimestampedDeploy, UnresolvedSubscribes, User, WhyrunSafeRubyBlock, WindowsPackage, WindowsScript, WindowsService, WindowsTask, YumPackage, YumRepository, ZypperPackage
Constant Summary collapse
- FORBIDDEN_IVARS =
Internal Resource Interface (for Chef)
[:@run_context, :@not_if, :@only_if, :@enclosing_provider]
- HIDDEN_IVARS =
[:@allowed_actions, :@resource_name, :@source_line, :@run_context, :@name, :@not_if, :@only_if, :@elapsed_time, :@enclosing_provider]
- @@sorted_descendants =
This classvariable is part of a private API. You should avoid using this classvariable if possible, as it may be removed or be changed in the future.
Deprecated.We memoize a sorted version of descendants so that resource lookups don't have to sort all the things, all the time. This was causing performance issues in test runs, and probably in real life as well.
nil
Instance Attribute Summary collapse
-
#allowed_actions(value = NOT_PASSED) ⇒ Array<Symbol>
The list of actions this Resource is allowed to have.
-
#cookbook_name ⇒ String
The cookbook this resource was declared in.
-
#declared_type ⇒ String
The actual name that was used to create this resource.
-
#default_guard_interpreter ⇒ Class, ...
readonly
The guard interpreter that will be used to process
only_if
andnot_if
statements by default. -
#elapsed_time ⇒ Integer
readonly
The time it took (in seconds) to run the most recently-run action.
-
#enclosing_provider ⇒ Chef::Provider
The provider this resource was declared in (if it was declared in an LWRP).
-
#params ⇒ Object
XXX: this is required for definition params inside of the scope of a subresource to work correctly.
-
#recipe_name ⇒ String
The recipe this resource was declared in.
-
#resource_initializing ⇒ Object
private
If we are currently initializing the resource, this will be true.
-
#run_context ⇒ Chef::RunContext
where the context for the current Chef run is stored, including the node and the resource collection.
-
#source_line ⇒ String
The source line where this resource was declared.
-
#updated ⇒ Boolean
readonly
Whether or not this resource was updated during an action.
Class Method Summary collapse
-
.action(action, &recipe_block) ⇒ Object
Define an action on this resource.
-
.action_class(&block) ⇒ Object
The action class is a
Chef::Provider
which is created at Resource class evaluation time when the Custom Resource is being constructed. -
.allowed_actions(*actions) ⇒ Array<Symbol>
The list of allowed actions for the resource.
- .allowed_actions=(value) ⇒ Object
-
.custom_resource? ⇒ Boolean
Returns true or false based on if the resource is a custom resource.
-
.declare_action_class ⇒ Object
private
Ensure the action class actually gets created.
-
.default_action(action_name = NOT_PASSED) ⇒ Array<Symbol>
The action that will be run if no other action is specified.
- .default_action=(action_name) ⇒ Object
- .from_hash(o) ⇒ Object
- .from_json(j) ⇒ Object
-
.identity_attr(name = nil) ⇒ Symbol
deprecated
Deprecated.
identity_property
should be used instead. -
.identity_property(name = nil) ⇒ Symbol
Set the identity of this resource to a particular property.
- .inherited(child) ⇒ Object
-
.is_custom_resource! ⇒ Object
private
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).
- .json_create(o) ⇒ Object
-
.load_current_value(&load_block) ⇒ Object
Define a method to load up this resource's properties with the current actual values.
-
.provides(name, **options, &block) ⇒ Object
Mark this resource as providing particular DSL.
- .provides?(node, resource_name) ⇒ Boolean
- .remove_canonical_dsl ⇒ Object
-
.resource_for_node(short_name, node) ⇒ Object
Returns a resource based on a short_name and node.
-
.resource_matching_short_name(short_name) ⇒ Object
Returns the class with the given resource_name.
-
.resource_name(name = NOT_PASSED) ⇒ Symbol
The display name of this resource type, for printing purposes.
- .resource_name=(name) ⇒ Object
- .sorted_descendants ⇒ Object
-
.state_attrs(*names) ⇒ Array<Symbol>
deprecated
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 withdesired_state: false
property :x # part of desired state property :y, desired_state: false # not part of desired state
-
.use_automatic_resource_name ⇒ Object
Use the class name as the resource name.
Instance Method Summary collapse
-
#action(arg = nil) ⇒ Array[Symbol]
The action or actions that will be taken when this resource is run.
-
#action= ⇒ Array[Symbol]
The action or actions that will be taken when this resource is run.
-
#after_created ⇒ Object
A hook called after a resource is created.
-
#as_json(*a) ⇒ Object
as_json does most of the to_json heavy lifted.
- #before_notifications ⇒ Object
-
#cookbook_version ⇒ Object
The cookbook in which this Resource was defined (if any).
-
#current_value ⇒ Object
Get the current actual value of this resource.
-
#current_value_does_not_exist! ⇒ Object
Call this in
load_current_value
to indicate that the value does not exist and thatcurrent_resource
should therefore benil
. -
#custom_exception_message(e) ⇒ String
Preface an exception message with generic Resource information.
- #customize_exception(e) ⇒ Object
-
#declared_key ⇒ Object
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).
- #defined_at ⇒ Object
-
#delayed_action(arg) ⇒ Object
Force a delayed notification into this resource's run_context.
- #delayed_notifications ⇒ Object
- #events ⇒ Object
-
#guard_interpreter(arg = nil) ⇒ Class, ...
The guard interpreter that will be used to process
only_if
andnot_if
statements. -
#identity ⇒ Object, Hash<Symbol,Object>
The value of the identity of this resource.
-
#ignore_failure ⇒ Object
(also: #epic_fail)
Whether to ignore failures.
- #immediate_notifications ⇒ Object
-
#initialize(name, run_context = nil) ⇒ Resource
constructor
Create a new Resource.
- #inspect ⇒ Object
-
#load_from(resource) ⇒ Object
Make this resource into an exact (shallow) copy of the other resource.
- #lookup_provider_constant(name, action = :nothing) ⇒ Object private
-
#method_missing(method_symbol, *args, &block) ⇒ Object
If an unknown method is invoked, determine whether the enclosing Provider's lexical scope can fulfill the request.
-
#name ⇒ String
The name of this particular resource.
-
#node ⇒ Chef::Node
The node the current Chef run is using.
-
#not_if(command = nil, opts = {}, &block) ⇒ Object
A command or block that indicates whether to actually run this resource.
-
#notifies(action, resource_spec, timing = :delayed) ⇒ Object
Sets up a notification that will run a particular action on another resource if and when this resource is updated by an action.
-
#notifies_before(action, resource_spec) ⇒ Object
Helper for #notifies.
-
#notifies_delayed(action, resource_spec) ⇒ Object
Helper for #notifies.
-
#notifies_immediately(action, resource_spec) ⇒ Object
Helper for #notifies.
-
#only_if(command = nil, opts = {}, &block) ⇒ Object
A command or block that indicates whether to actually run this resource.
-
#provider(arg = nil) ⇒ Object
The provider class for this resource.
- #provider=(arg) ⇒ Object
- #provider_for_action(action) ⇒ Object
-
#resolve_notification_references ⇒ Object
Iterates over all immediate and delayed notifications, calling resolve_resource_reference on each in turn, causing them to resolve lazy/forward references.
-
#resource_name ⇒ Symbol
The display name of this resource type, for printing purposes.
-
#resources(*args) ⇒ Object
Find existing resources by searching the list of existing resources.
-
#retries ⇒ Integer
The number of times to retry this resource if it fails by throwing an exception while running an action.
-
#retry_delay ⇒ Integer
The number of seconds to wait between retries.
-
#run_action(action, notification_type = nil, notifying_resource = nil) ⇒ Object
Runs the given action on this resource, immediately.
-
#sensitive ⇒ Boolean
Whether to treat this resource's data as sensitive.
-
#should_skip?(action) ⇒ Boolean
Evaluates not_if and only_if conditionals.
- #source_line_file ⇒ Object
- #source_line_number ⇒ Object
-
#state_for_resource_reporter ⇒ Hash{Symbol => Object}
Get the value of the state attributes in this resource as a hash.
-
#subscribes(action, resources, timing = :delayed) ⇒ Object
Subscribes to updates from other resources, causing a particular action to run on this resource when the other resource is updated.
- #to_hash ⇒ Object
-
#to_json(*a) ⇒ Object
Serialize this object as a hash.
-
#to_s ⇒ Object
Generic Ruby and Data Structure Stuff (for user).
- #to_text ⇒ Object
-
#updated? ⇒ Boolean
Whether or not this resource was updated during an action.
-
#updated_by_last_action(true_or_false) ⇒ Boolean
Whether or not this resource was updated during the most recent action.
-
#updated_by_last_action? ⇒ Boolean
Whether or not this resource was updated during the most recent action.
- #validate_action(action) ⇒ Object
-
#validate_resource_spec!(resource_spec) ⇒ Object
Helper for #notifies.
- #value_to_text(value) ⇒ Object
Methods included from Mixin::ConvertToClassName
constantize, convert_to_class_name, convert_to_snake_case, filename_to_qualified_string, normalize_snake_case_name, snake_case_basename
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::Deprecation
#deprecated_attr, #deprecated_attr_reader, #deprecated_attr_writer, #deprecated_ivar
Methods included from Mixin::Properties
included, #property_is_set?, #reset_property
Methods included from Mixin::ParamsValidate
#lazy, #set_or_return, #validate
Methods included from Mixin::ShellOut
#a_to_s, #clean_array, #shell_out, #shell_out!, #shell_out_compact, #shell_out_compact!, #shell_out_compact_timeout, #shell_out_compact_timeout!, #shell_out_with_systems_locale, #shell_out_with_systems_locale!
Methods included from Mixin::PathSanity
#enforce_path_sanity, #sanitized_path
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
Methods included from DSL::RebootPending
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
Methods included from EncryptedDataBagItem::CheckEncrypted
Constructor Details
#initialize(name, run_context = nil) ⇒ Resource
Create a new Resource.
131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 |
# File 'lib/chef/resource.rb', line 131 def initialize(name, run_context = nil) name(name) unless name.nil? @run_context = run_context @before = nil @params = Hash.new @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 # 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 end |
Dynamic Method Handling
This class handles dynamic methods through the method_missing method
#method_missing(method_symbol, *args, &block) ⇒ Object
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.
1289 1290 1291 1292 1293 1294 1295 |
# File 'lib/chef/resource.rb', line 1289 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 |
Instance Attribute Details
#allowed_actions(value = NOT_PASSED) ⇒ Array<Symbol>
The list of actions this Resource is allowed to have. Setting action
will fail unless it is in this list. Default: [ :nothing ]
860 861 862 |
# File 'lib/chef/resource.rb', line 860 def allowed_actions @allowed_actions end |
#cookbook_name ⇒ String
1194 1195 1196 |
# File 'lib/chef/resource.rb', line 1194 def cookbook_name @cookbook_name end |
#declared_type ⇒ String
1218 1219 1220 |
# File 'lib/chef/resource.rb', line 1218 def declared_type @declared_type end |
#default_guard_interpreter ⇒ Class, ... (readonly)
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.
851 852 853 |
# File 'lib/chef/resource.rb', line 851 def default_guard_interpreter @default_guard_interpreter end |
#elapsed_time ⇒ Integer (readonly)
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.
action. Not cumulative.
462 463 464 |
# File 'lib/chef/resource.rb', line 462 def elapsed_time @elapsed_time end |
#enclosing_provider ⇒ Chef::Provider
1203 1204 1205 |
# File 'lib/chef/resource.rb', line 1203 def enclosing_provider @enclosing_provider end |
#params ⇒ Object
XXX: this is required for definition params inside of the scope of a subresource to work correctly.
1186 1187 1188 |
# File 'lib/chef/resource.rb', line 1186 def params @params end |
#recipe_name ⇒ String
1197 1198 1199 |
# File 'lib/chef/resource.rb', line 1197 def recipe_name @recipe_name end |
#resource_initializing ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
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.
620 621 622 |
# File 'lib/chef/resource.rb', line 620 def resource_initializing @resource_initializing end |
#run_context ⇒ Chef::RunContext
where the context for the current Chef run is stored, including the node and the resource collection.
1191 1192 1193 |
# File 'lib/chef/resource.rb', line 1191 def run_context @run_context end |
#source_line ⇒ String
1210 1211 1212 |
# File 'lib/chef/resource.rb', line 1210 def source_line @source_line end |
#updated ⇒ Boolean (readonly)
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.
875 876 877 |
# File 'lib/chef/resource.rb', line 875 def updated @updated end |
Class Method Details
.action(action, &recipe_block) ⇒ Object
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.
1066 1067 1068 1069 1070 1071 1072 |
# File 'lib/chef/resource.rb', line 1066 def self.action(action, &recipe_block) action = action.to_sym declare_action_class action_class.action(action, &recipe_block) self.allowed_actions += [ action ] default_action action if Array(default_action) == [:nothing] end |
.action_class(&block) ⇒ Object
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 indiates 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 whatevs.
If a block is passed, the action_class is always created and the block is run inside it.
1125 1126 1127 1128 1129 |
# File 'lib/chef/resource.rb', line 1125 def self.action_class(&block) @action_class ||= declare_action_class @action_class.class_eval(&block) if block @action_class end |
.allowed_actions(*actions) ⇒ Array<Symbol>
The list of allowed actions for the resource.
990 991 992 993 994 995 996 997 998 |
# File 'lib/chef/resource.rb', line 990 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 |
.allowed_actions=(value) ⇒ Object
1000 1001 1002 |
# File 'lib/chef/resource.rb', line 1000 def self.allowed_actions=(value) @allowed_actions = value.uniq end |
.custom_resource? ⇒ Boolean
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.
1135 1136 1137 |
# File 'lib/chef/resource.rb', line 1135 def self.custom_resource? false end |
.declare_action_class ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
Ensure the action class actually gets created. This is called
when the user does action :x do ... end
.
1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 |
# File 'lib/chef/resource.rb', line 1156 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 |
.default_action(action_name = NOT_PASSED) ⇒ Array<Symbol>
The action that will be run if no other action is specified.
Setting default_action will automatially add the action to allowed_actions, if it isn't already there.
Defaults to [:nothing].
1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 |
# File 'lib/chef/resource.rb', line 1017 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 @default_action @default_action elsif superclass.respond_to?(:default_action) superclass.default_action else [:nothing] end end |
.default_action=(action_name) ⇒ Object
1032 1033 1034 |
# File 'lib/chef/resource.rb', line 1032 def self.default_action=(action_name) default_action action_name end |
.from_hash(o) ⇒ Object
710 711 712 713 714 715 716 |
# File 'lib/chef/resource.rb', line 710 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 |
.from_json(j) ⇒ Object
722 723 724 |
# File 'lib/chef/resource.rb', line 722 def self.from_json(j) from_hash(Chef::JSONCompat.parse(j)) end |
.identity_attr(name = nil) ⇒ Symbol
identity_property
should be used instead.
Set a property as the "identity attribute" for this resource.
Identical to calling #identity_property.first.key.
832 833 834 835 836 |
# File 'lib/chef/resource.rb', line 832 def self.identity_attr(name = nil) property = identity_property(name) return nil if !property property.name end |
.identity_property(name = nil) ⇒ Symbol
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
.
property :x, identity: true # part of identity
property :y # not part of identity
810 811 812 813 814 815 816 |
# File 'lib/chef/resource.rb', line 810 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 { |r| r.name }.join(", ")})." end result.first end |
.inherited(child) ⇒ Object
1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 |
# File 'lib/chef/resource.rb', line 1275 def self.inherited(child) super @@sorted_descendants = nil # set resource_name automatically if it's not set if child.name && !child.resource_name if child.name =~ /^Chef::Resource::(\w+)$/ child.resource_name(convert_to_snake_case($1)) end end end |
.is_custom_resource! ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
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)
1145 1146 1147 1148 1149 |
# File 'lib/chef/resource.rb', line 1145 def self.is_custom_resource! define_singleton_method :custom_resource? do true end end |
.json_create(o) ⇒ Object
718 719 720 |
# File 'lib/chef/resource.rb', line 718 def self.json_create(o) from_hash(o) end |
.load_current_value(&load_block) ⇒ Object
Define a method to load up this resource's properties with the current actual values.
1081 1082 1083 |
# File 'lib/chef/resource.rb', line 1081 def self.load_current_value(&load_block) define_method(:load_current_value!, &load_block) end |
.provides(name, **options, &block) ⇒ Object
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).
1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 |
# File 'lib/chef/resource.rb', line 1305 def self.provides(name, **, &block) name = name.to_sym # `provides :resource_name, os: 'linux'`) needs to remove the old # canonical DSL before adding the new one. if @resource_name && name == @resource_name remove_canonical_dsl end result = Chef.resource_handler_map.set(name, self, , &block) Chef::DSL::Resources.add_resource_dsl(name) result end |
.provides?(node, resource_name) ⇒ Boolean
1319 1320 1321 |
# File 'lib/chef/resource.rb', line 1319 def self.provides?(node, resource_name) Chef::ResourceResolver.new(node, resource_name).provided_by?(self) end |
.remove_canonical_dsl ⇒ Object
1491 1492 1493 1494 1495 1496 1497 1498 |
# File 'lib/chef/resource.rb', line 1491 def self.remove_canonical_dsl if @resource_name remaining = Chef.resource_handler_map.delete_canonical(@resource_name, self) if !remaining Chef::DSL::Resources.remove_resource_dsl(@resource_name) end end end |
.resource_for_node(short_name, node) ⇒ Object
Returns a resource based on a short_name and node
==== Parameters
short_name
=== Returns Chef::Resource:: returns the proper Chef::Resource class
1453 1454 1455 1456 1457 |
# File 'lib/chef/resource.rb', line 1453 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 |
.resource_matching_short_name(short_name) ⇒ Object
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
=== Returns Chef::Resource:: returns the proper Chef::Resource class
1475 1476 1477 |
# File 'lib/chef/resource.rb', line 1475 def self.resource_matching_short_name(short_name) Chef::ResourceResolver.resolve(short_name, canonical: true) end |
.resource_name(name = NOT_PASSED) ⇒ Symbol
The display name of this resource type, for printing purposes.
This also automatically calls "provides" to provide DSL with the given name.
resource_name defaults to your class name.
Call resource_name nil
to remove the resource name (and any
corresponding DSL).
946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 |
# File 'lib/chef/resource.rb', line 946 def self.resource_name(name = NOT_PASSED) # Setter if name != NOT_PASSED remove_canonical_dsl # Set the resource_name and call provides if name name = name.to_sym # If our class is not already providing this name, provide it. if !Chef::ResourceResolver.includes_handler?(name, self) provides name, canonical: true end @resource_name = name else @resource_name = nil end end @resource_name end |
.resource_name=(name) ⇒ Object
966 967 968 |
# File 'lib/chef/resource.rb', line 966 def self.resource_name=(name) resource_name(name) end |
.sorted_descendants ⇒ Object
1271 1272 1273 |
# File 'lib/chef/resource.rb', line 1271 def self.sorted_descendants @@sorted_descendants ||= descendants.sort_by { |x| x.to_s } end |
.state_attrs(*names) ⇒ Array<Symbol>
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
property :x # part of desired state
property :y, desired_state: false # not part of desired state
Set or return the list of "state properties" implemented by the Resource subclass.
Equivalent to calling #state_properties and getting state_properties.keys
.
782 783 784 |
# File 'lib/chef/resource.rb', line 782 def self.state_attrs(*names) state_properties(*names).map { |property| property.name } end |
.use_automatic_resource_name ⇒ Object
Use the class name as the resource name.
Munges the last part of the class name from camel case to snake case, and sets the resource_name to that:
A::B::BlahDBlah -> blah_d_blah
978 979 980 981 |
# File 'lib/chef/resource.rb', line 978 def self.use_automatic_resource_name automatic_name = convert_to_snake_case(name.split("::")[-1]) resource_name automatic_name end |
Instance Method Details
#action(arg = nil) ⇒ Array[Symbol]
The action or actions that will be taken when this resource is run.
160 161 162 163 164 165 166 167 168 169 170 171 172 173 |
# File 'lib/chef/resource.rb', line 160 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 |
#action= ⇒ Array[Symbol]
The action or actions that will be taken when this resource is run. Alias for normal assigment syntax.
176 177 178 179 180 181 182 183 184 185 186 187 188 189 |
# File 'lib/chef/resource.rb', line 176 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 |
#after_created ⇒ Object
A hook called after a resource is created. Meant to be overriden by subclasses.
926 927 928 |
# File 'lib/chef/resource.rb', line 926 def after_created nil end |
#as_json(*a) ⇒ Object
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
677 678 679 680 681 682 683 684 685 686 687 |
# File 'lib/chef/resource.rb', line 677 def as_json(*a) safe_ivars = instance_variables.map { |ivar| ivar.to_sym } - FORBIDDEN_IVARS instance_vars = Hash.new 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 |
#before_notifications ⇒ Object
1336 1337 1338 |
# File 'lib/chef/resource.rb', line 1336 def before_notifications run_context.before_notifications(self) end |
#cookbook_version ⇒ Object
The cookbook in which this Resource was defined (if any).
1383 1384 1385 1386 1387 |
# File 'lib/chef/resource.rb', line 1383 def cookbook_version if cookbook_name run_context.cookbook_collection[cookbook_name] end end |
#current_value ⇒ Object
Get the current actual value of this resource.
This does not cache--a new value will be returned each time.
1103 1104 1105 1106 1107 1108 1109 1110 |
# File 'lib/chef/resource.rb', line 1103 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 |
#current_value_does_not_exist! ⇒ Object
Call this in load_current_value
to indicate that the value does not
exist and that current_resource
should therefore be nil
.
1091 1092 1093 |
# File 'lib/chef/resource.rb', line 1091 def current_value_does_not_exist! raise Chef::Exceptions::CurrentValueDoesNotExist end |
#custom_exception_message(e) ⇒ String
Preface an exception message with generic Resource information.
1410 1411 1412 |
# File 'lib/chef/resource.rb', line 1410 def (e) "#{self} (#{defined_at}) had an error: #{e.class.name}: #{e.message}" end |
#customize_exception(e) ⇒ Object
1414 1415 1416 1417 1418 |
# File 'lib/chef/resource.rb', line 1414 def customize_exception(e) new_exception = e.exception((e)) new_exception.set_backtrace(e.backtrace) new_exception end |
#declared_key ⇒ Object
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.
1331 1332 1333 1334 |
# File 'lib/chef/resource.rb', line 1331 def declared_key return to_s if declared_type.nil? "#{declared_type}[#{@name}]" end |
#defined_at ⇒ Object
1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 |
# File 'lib/chef/resource.rb', line 1364 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 |
#delayed_action(arg) ⇒ Object
Force a delayed notification into this resource's run_context.
This should most likely be paired with action :nothing
185 186 187 188 189 190 191 192 193 194 195 |
# File 'lib/chef/resource.rb', line 185 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)) end end |
#delayed_notifications ⇒ Object
1344 1345 1346 |
# File 'lib/chef/resource.rb', line 1344 def delayed_notifications run_context.delayed_notifications(self) end |
#events ⇒ Object
1389 1390 1391 |
# File 'lib/chef/resource.rb', line 1389 def events run_context.events end |
#guard_interpreter(arg = nil) ⇒ Class, ...
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.
478 479 480 481 482 483 484 |
# File 'lib/chef/resource.rb', line 478 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 |
#identity ⇒ Object, Hash<Symbol,Object>
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.
515 516 517 518 519 520 521 522 523 |
# File 'lib/chef/resource.rb', line 515 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 |
#ignore_failure ⇒ Object Also known as: epic_fail
Whether to ignore failures. If set to true
, and this resource when an
action is run, the resource will be marked as failed but no exception will
be thrown (and no error will be output). Defaults to false
.
TODO ignore_failure and retries seem to be mutually exclusive; I doubt that was intended.
536 |
# File 'lib/chef/resource.rb', line 536 property :ignore_failure, [ TrueClass, FalseClass ], default: false, desired_state: false |
#immediate_notifications ⇒ Object
1340 1341 1342 |
# File 'lib/chef/resource.rb', line 1340 def immediate_notifications run_context.immediate_notifications(self) end |
#inspect ⇒ Object
667 668 669 670 671 672 |
# File 'lib/chef/resource.rb', line 667 def inspect ivars = instance_variables.map { |ivar| ivar.to_sym } - FORBIDDEN_IVARS ivars.inject("<#{self}") do |str, ivar| str << " #{ivar}: #{instance_variable_get(ivar).inspect}" end << ">" end |
#load_from(resource) ⇒ Object
Make this resource into an exact (shallow) copy of the other resource.
548 549 550 551 552 553 554 |
# File 'lib/chef/resource.rb', line 548 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 |
#lookup_provider_constant(name, action = :nothing) ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 |
# File 'lib/chef/resource.rb', line 1480 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 |
#name ⇒ String
The name of this particular resource.
This special resource attribute is set automatically from the declaration of the resource, e.g.
execute 'Vitruvius' do command 'ls' end
Will set the name to "Vitruvius".
This is also used in to_s to show the resource name, e.g. execute[Vitruvius]
.
This is also used for resource notifications and subscribes in the same manner.
This will coerce any object into a string via #to_s. Arrays are a special case
so that package ["foo", "bar"]
becomes package[foo, bar] instead of the more
awkward package[["foo", "bar"]]
that #to_s would produce.
87 |
# File 'lib/chef/resource.rb', line 87 property :name, String, coerce: proc { |v| v.is_a?(Array) ? v.join(", ") : v.to_s }, desired_state: false, required: true |
#node ⇒ Chef::Node
The node the current Chef run is using.
Corresponds to run_context.node
.
96 97 98 |
# File 'lib/chef/resource.rb', line 96 def node run_context && run_context.node end |
#not_if(command = nil, opts = {}, &block) ⇒ Object
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 ifyour command
returns a non-zero code.only_if "your command", valid_exit_codes: [ 1, 2, 3 ]
will perform the action only ifyour command
returns something other than 1, 2, or 3.
418 419 420 421 422 423 |
# File 'lib/chef/resource.rb', line 418 def not_if(command = nil, opts = {}, &block) if command || block_given? @not_if << Conditional.not_if(self, command, opts, &block) end @not_if end |
#notifies(action, resource_spec, timing = :delayed) ⇒ Object
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.
252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 |
# File 'lib/chef/resource.rb', line 252 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 |
#notifies_before(action, resource_spec) ⇒ Object
Helper for #notifies
1237 1238 1239 |
# File 'lib/chef/resource.rb', line 1237 def notifies_before(action, resource_spec) run_context.notifies_before(Notification.new(resource_spec, action, self)) end |
#notifies_delayed(action, resource_spec) ⇒ Object
Helper for #notifies
1247 1248 1249 |
# File 'lib/chef/resource.rb', line 1247 def notifies_delayed(action, resource_spec) run_context.notifies_delayed(Notification.new(resource_spec, action, self)) end |
#notifies_immediately(action, resource_spec) ⇒ Object
Helper for #notifies
1242 1243 1244 |
# File 'lib/chef/resource.rb', line 1242 def notifies_immediately(action, resource_spec) run_context.notifies_immediately(Notification.new(resource_spec, action, self)) end |
#only_if(command = nil, opts = {}, &block) ⇒ Object
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 ifyour command
returns 0.only_if "your command", valid_exit_codes: [ 1, 2, 3 ]
will perform the action only ifyour command
returns 1, 2, or 3.
388 389 390 391 392 393 |
# File 'lib/chef/resource.rb', line 388 def only_if(command = nil, opts = {}, &block) if command || block_given? @only_if << Conditional.only_if(self, command, opts, &block) end @only_if end |
#provider(arg = nil) ⇒ Object
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.
749 750 751 752 753 754 755 756 |
# File 'lib/chef/resource.rb', line 749 def provider(arg = nil) klass = if arg.kind_of?(String) || arg.kind_of?(Symbol) lookup_provider_constant(arg) else arg end set_or_return(:provider, klass, kind_of: [ Class ]) end |
#provider=(arg) ⇒ Object
758 759 760 |
# File 'lib/chef/resource.rb', line 758 def provider=(arg) provider(arg) end |
#provider_for_action(action) ⇒ Object
1397 1398 1399 1400 1401 1402 |
# File 'lib/chef/resource.rb', line 1397 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 |
#resolve_notification_references ⇒ Object
Iterates over all immediate and delayed notifications, calling resolve_resource_reference on each in turn, causing them to resolve lazy/forward references.
1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 |
# File 'lib/chef/resource.rb', line 1224 def resolve_notification_references run_context.before_notifications(self).each do |n| n.resolve_resource_reference(run_context.resource_collection) end run_context.immediate_notifications(self).each do |n| n.resolve_resource_reference(run_context.resource_collection) end run_context.delayed_notifications(self).each do |n| n.resolve_resource_reference(run_context.resource_collection) end end |
#resource_name ⇒ Symbol
The display name of this resource type, for printing purposes.
Will be used to print out the resource in messages, e.g. resource_name[name]
918 919 920 |
# File 'lib/chef/resource.rb', line 918 def resource_name @resource_name || self.class.resource_name end |
#resources(*args) ⇒ Object
Find existing resources by searching the list of existing resources. Possible forms are:
find(:file => "foobar") find(:file => [ "foobar", "baz" ]) find("file[foobar]", "file[baz]") find("file[foobar,baz]")
Calls run_context.resource_collection.find(*args)
116 117 118 |
# File 'lib/chef/resource.rb', line 116 def resources(*args) run_context.resource_collection.find(*args) end |
#retries ⇒ Integer
The number of times to retry this resource if it fails by throwing an exception while running an action. Default: 0
When the retries have run out, the Resource will throw the last exception.
435 |
# File 'lib/chef/resource.rb', line 435 property :retries, Integer, default: 0, desired_state: false |
#retry_delay ⇒ Integer
The number of seconds to wait between retries. Default: 2.
443 |
# File 'lib/chef/resource.rb', line 443 property :retry_delay, Integer, default: 2, desired_state: false |
#run_action(action, notification_type = nil, notifying_resource = nil) ⇒ Object
Runs the given action on this resource, immediately.
565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 |
# File 'lib/chef/resource.rb', line 565 def run_action(action, notification_type = nil, = 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, ) # 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] || Chef::Log.level == :debug # This can be noisy Chef::Log.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) provider_for_action(action).run_action rescue StandardError => e if ignore_failure Chef::Log.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 Chef::Log.info("Retrying execution of #{self}, #{remaining_retries} attempt(s) 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 |
#sensitive ⇒ Boolean
Whether to treat this resource's data as sensitive. If set, no resource data will be displayed in log output.
452 |
# File 'lib/chef/resource.rb', line 452 property :sensitive, [ TrueClass, FalseClass ], default: false, desired_state: false |
#should_skip?(action) ⇒ Boolean
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
1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 |
# File 'lib/chef/resource.rb', line 1430 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) Chef::Log.debug("Skipping #{self} due to #{conditional.description}") true end end end |
#source_line_file ⇒ Object
1348 1349 1350 1351 1352 1353 1354 |
# File 'lib/chef/resource.rb', line 1348 def source_line_file if source_line source_line.match(/(.*):(\d+):?.*$/).to_a[1] else nil end end |
#source_line_number ⇒ Object
1356 1357 1358 1359 1360 1361 1362 |
# File 'lib/chef/resource.rb', line 1356 def source_line_number if source_line source_line.match(/(.*):(\d+):?.*$/).to_a[2] else nil end end |
#state_for_resource_reporter ⇒ Hash{Symbol => Object}
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).
495 496 497 498 499 500 501 502 503 504 |
# File 'lib/chef/resource.rb', line 495 def state_for_resource_reporter state = {} state_properties = self.class.state_properties state_properties.each do |property| if property.identity? || property.is_set?(self) state[property.name] = property.sensitive? ? "*sensitive value suppressed*" : send(property.name) end end state end |
#subscribes(action, resources, timing = :delayed) ⇒ Object
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).
351 352 353 354 355 356 357 358 359 360 361 362 363 |
# File 'lib/chef/resource.rb', line 351 def subscribes(action, resources, timing = :delayed) resources = [resources].flatten resources.each do |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 |
#to_hash ⇒ Object
695 696 697 698 699 700 701 702 703 704 705 706 707 708 |
# File 'lib/chef/resource.rb', line 695 def to_hash # 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 { |ivar| ivar.to_sym } - FORBIDDEN_IVARS safe_ivars.each do |iv| key = iv.to_s.sub(/^@/, "").to_sym next if result.has_key?(key) result[key] = instance_variable_get(iv) end result end |
#to_json(*a) ⇒ Object
Serialize this object as a hash
690 691 692 693 |
# File 'lib/chef/resource.rb', line 690 def to_json(*a) results = as_json Chef::JSONCompat.to_json(results, *a) end |
#to_s ⇒ Object
Generic Ruby and Data Structure Stuff (for user)
633 634 635 |
# File 'lib/chef/resource.rb', line 633 def to_s "#{resource_name}[#{name}]" end |
#to_text ⇒ Object
637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 |
# File 'lib/chef/resource.rb', line 637 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.state_properties.map do |p| all_props[p.name.to_s] = p.sensitive? ? '"*sensitive value suppressed*"' : value_to_text(p.get(self)) end ivars = instance_variables.map { |ivar| ivar.to_sym } - HIDDEN_IVARS ivars.each do |ivar| iv = ivar.to_s.sub(/^@/, "") if all_props.keys.include?(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 |
#updated? ⇒ Boolean
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.
884 885 886 |
# File 'lib/chef/resource.rb', line 884 def updated? updated end |
#updated_by_last_action(true_or_false) ⇒ Boolean
Whether or not this resource was updated during the most recent action.
This is set to false
at the beginning of each action.
896 897 898 899 |
# File 'lib/chef/resource.rb', line 896 def updated_by_last_action(true_or_false) @updated ||= true_or_false @updated_by_last_action = true_or_false end |
#updated_by_last_action? ⇒ Boolean
Whether or not this resource was updated during the most recent action.
This is set to false
at the beginning of each action.
907 908 909 |
# File 'lib/chef/resource.rb', line 907 def updated_by_last_action? @updated_by_last_action end |
#validate_action(action) ⇒ Object
1393 1394 1395 |
# File 'lib/chef/resource.rb', line 1393 def validate_action(action) raise ArgumentError, "nil is not a valid action for resource #{self}" if action.nil? end |
#validate_resource_spec!(resource_spec) ⇒ Object
Helper for #notifies
1324 1325 1326 |
# File 'lib/chef/resource.rb', line 1324 def validate_resource_spec!(resource_spec) run_context.resource_collection.validate_lookup_spec!(resource_spec) end |
#value_to_text(value) ⇒ Object
663 664 665 |
# File 'lib/chef/resource.rb', line 663 def value_to_text(value) value.respond_to?(:to_text) ? value.to_text : value.inspect end |