Class: Chef::Resource

Inherits:
Object show all
Extended by:
Mixin::ConvertToClassName, Mixin::DescendantsTracker
Includes:
DSL::DataQuery, DSL::PlatformIntrospection, DSL::RebootPending, DSL::RegistryHelper, Mixin::ConvertToClassName, Mixin::Deprecation, Mixin::ParamsValidate
Defined in:
lib/chef/resource.rb,
lib/chef/resource/csh.rb,
lib/chef/resource/env.rb,
lib/chef/resource/git.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/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/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/conditional.rb,
lib/chef/resource/gem_package.rb,
lib/chef/resource/ips_package.rb,
lib/chef/resource/remote_file.rb,
lib/chef/resource/rpm_package.rb,
lib/chef/resource/yum_package.rb,
lib/chef/resource/dpkg_package.rb,
lib/chef/resource/http_request.rb,
lib/chef/resource/registry_key.rb,
lib/chef/resource/cookbook_file.rb,
lib/chef/resource/pacman_package.rb,
lib/chef/resource/windows_script.rb,
lib/chef/resource/deploy_revision.rb,
lib/chef/resource/freebsd_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/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/powershell_script.rb,
lib/chef/resource/timestamped_deploy.rb,
lib/chef/resource/easy_install_package.rb,
lib/chef/resource/whyrun_safe_ruby_block.rb,
lib/chef/resource/conditional_action_not_nothing.rb

Defined Under Namespace

Classes: AptPackage, Bash, Batch, BffPackage, Breakpoint, ChefGem, Conditional, ConditionalActionNotNothing, CookbookFile, Cron, Csh, Deploy, DeployBranch, DeployRevision, Directory, DpkgPackage, DscScript, EasyInstallPackage, Env, ErlCall, Execute, File, FreebsdPackage, GemPackage, Git, Group, HomebrewPackage, HttpRequest, Ifconfig, IpsPackage, LWRPBase, Link, Log, MacportsPackage, Mdadm, Mount, Notification, Ohai, Package, PacmanPackage, PaludisPackage, Perl, PortagePackage, PowershellScript, Python, Reboot, RegistryKey, RemoteDirectory, RemoteFile, Route, RpmPackage, Ruby, RubyBlock, Scm, Script, Service, SmartosPackage, SolarisPackage, Subversion, Template, TimestampedDeploy, User, WhyrunSafeRubyBlock, WindowsPackage, WindowsScript, WindowsService, YumPackage

Constant Summary collapse

FORBIDDEN_IVARS = 
[:@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]

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Mixin::ConvertToClassName

constantize, convert_to_class_name, convert_to_snake_case, filename_to_qualified_string, snake_case_basename

Methods included from Mixin::DescendantsTracker

descendants, descendants, direct_descendants, direct_descendants, find_descendants_by_name, find_descendants_by_name, inherited, store_inherited

Methods included from Mixin::Deprecation

#deprecated_ivar

Methods included from DSL::RebootPending

#reboot_pending?

Methods included from DSL::PlatformIntrospection

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

Methods included from DSL::RegistryHelper

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

Methods included from Mixin::ParamsValidate

#lazy, #set_or_return, #validate

Methods included from DSL::DataQuery

#data_bag, #data_bag_item, #search

Methods included from EncryptedDataBagItem::CheckEncrypted

#encrypted?

Constructor Details

#initialize(name, run_context = nil) ⇒ Resource

Each notify entry is a resource/action pair, modeled as an Struct with a #resource and #action member



229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
 
# File 'lib/chef/resource.rb', line 229

def initialize(name, run_context=nil)
  @name = name
  @run_context = run_context
  @noop = nil
  @before = nil
  @params = Hash.new
  @provider = nil
  @allowed_actions = [ :nothing ]
  @action = :nothing
  @updated = false
  @updated_by_last_action = false
  @supports = {}
  @ignore_failure = false
  @retries = 0
  @retry_delay = 2
  @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
  @sensitive = false
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.



292
293
294
295
296
297
298
 
# File 'lib/chef/resource.rb', line 292

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.to_s}' for #{self.class.to_s}"
  end
end

Instance Attribute Details

#allowed_actions ⇒ Object

Returns the value of attribute allowed_actions.



207
208
209
 
# File 'lib/chef/resource.rb', line 207

def allowed_actions
  @allowed_actions
end

#cookbook_name ⇒ Object

Returns the value of attribute cookbook_name.



209
210
211
 
# File 'lib/chef/resource.rb', line 209

def cookbook_name
  @cookbook_name
end

#default_guard_interpreter ⇒ Object (readonly)

Returns the value of attribute default_guard_interpreter.



224
225
226
 
# File 'lib/chef/resource.rb', line 224

def default_guard_interpreter
  @default_guard_interpreter
end

#elapsed_time ⇒ Object (readonly)

Returns the value of attribute elapsed_time.



222
223
224
 
# File 'lib/chef/resource.rb', line 222

def elapsed_time
  @elapsed_time
end

#enclosing_provider ⇒ Object

Returns the value of attribute enclosing_provider.



211
212
213
 
# File 'lib/chef/resource.rb', line 211

def enclosing_provider
  @enclosing_provider
end

#not_if_args ⇒ Object (readonly)

Returns the value of attribute not_if_args.



219
220
221
 
# File 'lib/chef/resource.rb', line 219

def not_if_args
  @not_if_args
end

#only_if_args ⇒ Object (readonly)

Returns the value of attribute only_if_args.



220
221
222
 
# File 'lib/chef/resource.rb', line 220

def only_if_args
  @only_if_args
end

#params ⇒ Object

Returns the value of attribute params.



205
206
207
 
# File 'lib/chef/resource.rb', line 205

def params
  @params
end

#provider(arg = nil) ⇒ Object

Returns the value of attribute provider.



206
207
208
 
# File 'lib/chef/resource.rb', line 206

def provider
  @provider
end

#recipe_name ⇒ Object

Returns the value of attribute recipe_name.



210
211
212
 
# File 'lib/chef/resource.rb', line 210

def recipe_name
  @recipe_name
end

#resource_name ⇒ Object (readonly)

Returns the value of attribute resource_name.



218
219
220
 
# File 'lib/chef/resource.rb', line 218

def resource_name
  @resource_name
end

#retries(arg = nil) ⇒ Object

Returns the value of attribute retries.



213
214
215
 
# File 'lib/chef/resource.rb', line 213

def retries
  @retries
end

#retry_delay(arg = nil) ⇒ Object

Returns the value of attribute retry_delay.



214
215
216
 
# File 'lib/chef/resource.rb', line 214

def retry_delay
  @retry_delay
end

#run_context ⇒ Object

Returns the value of attribute run_context.



208
209
210
 
# File 'lib/chef/resource.rb', line 208

def run_context
  @run_context
end

#source_line ⇒ Object

Returns the value of attribute source_line.



212
213
214
 
# File 'lib/chef/resource.rb', line 212

def source_line
  @source_line
end

#updated ⇒ Object

Returns the value of attribute updated.



216
217
218
 
# File 'lib/chef/resource.rb', line 216

def updated
  @updated
end

Class Method Details

.dsl_name ⇒ Object 



201
202
203
 
# File 'lib/chef/resource.rb', line 201

def self.dsl_name
  convert_to_snake_case(name, 'Chef::Resource')
end

.identity_attr(attr_name = nil) ⇒ Object

Set or return the “identity attribute” for this resource class. This is generally going to be the “name attribute” for this resource. In other words, the resource type plus this attribute uniquely identify a given bit of state that chef manages. For a File resource, this would be the path, for a package resource, it will be the package name. This will show up in chef-client’s audit records as a searchable field.



189
190
191
192
193
194
195
196
197
198
199
 
# File 'lib/chef/resource.rb', line 189

def self.identity_attr(attr_name=nil)
  @identity_attr ||= nil
  @identity_attr = attr_name if attr_name

  # If this class doesn't have an identity attr, we'll defer to the superclass:
  if @identity_attr || !superclass.respond_to?(:identity_attr)
    @identity_attr
  else
    superclass.identity_attr
  end
end

.json_create(o) ⇒ Object 



735
736
737
738
739
740
741
 
# File 'lib/chef/resource.rb', line 735

def self.json_create(o)
  resource = self.new(o["instance_vars"]["@name"])
  o["instance_vars"].each do |k,v|
    resource.instance_variable_set("@#{k}".to_sym, v)
  end
  resource
end

.node_map ⇒ Object 



760
761
762
 
# File 'lib/chef/resource.rb', line 760

def self.node_map
  @@node_map ||= NodeMap.new
end

.provider_base(arg = nil) ⇒ Object

Resources that want providers namespaced somewhere other than Chef::Provider can set the namespace with provider_base Ex:

class MyResource < Chef::Resource
  provider_base Chef::Provider::Deploy
  # ...other stuff
end



755
756
757
758
 
# File 'lib/chef/resource.rb', line 755

def self.provider_base(arg=nil)
  @provider_base ||= arg
  @provider_base ||= Chef::Provider
end

.provides(short_name, opts = {}, &block) ⇒ Object

Maps a short_name (and optionally a platform and version) to a Chef::Resource. This allows finer grained per platform resource attributes and the end of overloaded resource definitions (I’m looking at you Chef::Resource::Package) Ex:

class WindowsFile < Chef::Resource
  provides :file, os: "linux", platform_family: "rhel", platform: "redhat"
  provides :file, os: "!windows
  provides :file, os: [ "linux", "aix" ]
  provides :file, os: "solaris2" do |node|
    node['platform_version'].to_f <= 5.11
  end
  # ...other stuff
end



779
780
781
782
783
784
785
786
787
788
789
 
# File 'lib/chef/resource.rb', line 779

def self.provides(short_name, opts={}, &block)
  short_name_sym = short_name
  if short_name.kind_of?(String)
    # YAGNI: this is probably completely unnecessary and can be removed?
    Chef::Log.warn "[DEPRECATION] Passing a String to Chef::Resource#provides will be removed"
    short_name.downcase!
    short_name.gsub!(/\s/, "_")
    short_name_sym = short_name.to_sym
  end
  node_map.set(short_name_sym, constantize(self.name), opts, &block)
end

.resource_for_node(short_name, node) ⇒ Object

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

Raises:



799
800
801
802
803
804
 
# File 'lib/chef/resource.rb', line 799

def self.resource_for_node(short_name, node)
  klass = node_map.get(node, short_name) ||
    resource_matching_short_name(short_name)
  raise Chef::Exceptions::NoSuchResourceType.new(short_name, node) if klass.nil?
  klass
end

.resource_matching_short_name(short_name) ⇒ Object

Returns the class of a Chef::Resource based on the short name

Parameters

short_name<Symbol>

short_name of the resource (ie :directory)

Returns

<Chef::Resource>

returns the proper Chef::Resource class



812
813
814
815
816
817
818
819
 
# File 'lib/chef/resource.rb', line 812

def self.resource_matching_short_name(short_name)
  begin
    rname = convert_to_class_name(short_name.to_s)
    Chef::Resource.const_get(rname)
  rescue NameError
    nil
  end
end

.state_attrs(*attr_names) ⇒ Object

Set or return the list of “state attributes” implemented by the Resource subclass. State attributes are attributes that describe the desired state of the system, such as file permissions or ownership. In general, state attributes are attributes that could be populated by examining the state of the system (e.g., File.stat can tell you the permissions on an existing file). Contrarily, attributes that are not “state attributes” usually modify the way Chef itself behaves, for example by providing additional options for a package manager to use when installing a package.

This list is used by the Chef client auditing system to extract information from resources to describe changes made to the system.



171
172
173
174
175
176
177
178
179
180
181
 
# File 'lib/chef/resource.rb', line 171

def self.state_attrs(*attr_names)
  @state_attrs ||= []
  @state_attrs = attr_names unless attr_names.empty?

  # Return *all* state_attrs that this class has, including inherited ones
  if superclass.respond_to?(:state_attrs)
    superclass.state_attrs + @state_attrs
  else
    @state_attrs
  end
end

.strict_const_defined?(const) ⇒ Boolean

Returns:

  • (Boolean) 


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

def self.strict_const_defined?(const)
  const_defined?(const)
end

Instance Method Details

#action(arg = nil) ⇒ Object 



341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
 
# File 'lib/chef/resource.rb', line 341

def action(arg=nil)
  if arg
    action_list = arg.kind_of?(Array) ? arg : [ arg ]
    action_list = action_list.collect { |a| a.to_sym }
    action_list.each do |action|
      validate(
        {
          :action => action,
        },
        {
          :action => { :kind_of => Symbol, :equal_to => @allowed_actions },
        }
      )
    end
    @action = action_list
  else
    @action
  end
end

#after_created ⇒ Object

Hook to allow a resource to run specific code after creation



744
745
746
 
# File 'lib/chef/resource.rb', line 744

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



533
534
535
536
537
538
539
540
541
542
543
 
# File 'lib/chef/resource.rb', line 533

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

#cookbook_version ⇒ Object 



618
619
620
621
622
 
# File 'lib/chef/resource.rb', line 618

def cookbook_version
  if cookbook_name
    run_context.cookbook_collection[cookbook_name]
  end
end

#custom_exception_message(e) ⇒ Object 



688
689
690
 
# File 'lib/chef/resource.rb', line 688

def custom_exception_message(e)
  "#{self} (#{defined_at}) had an error: #{e.class.name}: #{e.message}"
end

#customize_exception(e) ⇒ Object 



692
693
694
695
696
 
# File 'lib/chef/resource.rb', line 692

def customize_exception(e)
  new_exception = e.exception(custom_exception_message(e))
  new_exception.set_backtrace(e.backtrace)
  new_exception
end

#defined_at ⇒ Object 



603
604
605
606
607
608
609
610
611
612
613
614
615
616
 
# File 'lib/chef/resource.rb', line 603

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.
  (file, line_no) = source_line.match(/(.*):(\d+):?.*$/).to_a[1,2] if source_line
  if cookbook_name && recipe_name && source_line
    "#{cookbook_name}::#{recipe_name} line #{line_no}"
  elsif source_line
    "#{file} line #{line_no}"
  else
    "dynamically defined"
  end
end

#delayed_notifications ⇒ Object 



468
469
470
 
# File 'lib/chef/resource.rb', line 468

def delayed_notifications
  run_context.delayed_notifications(self)
end

#epic_fail(arg = nil) ⇒ Object 



409
410
411
 
# File 'lib/chef/resource.rb', line 409

def epic_fail(arg=nil)
  ignore_failure(arg)
end

#events ⇒ Object 



624
625
626
 
# File 'lib/chef/resource.rb', line 624

def events
  run_context.events
end

#guard_interpreter(arg = nil) ⇒ Object 



413
414
415
416
417
418
419
420
421
422
423
 
# File 'lib/chef/resource.rb', line 413

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

Returns the value of the identity attribute, if declared. Falls back to #name if no identity attribute is declared.



269
270
271
272
273
274
275
 
# File 'lib/chef/resource.rb', line 269

def identity
  if identity_attr = self.class.identity_attr
    send(identity_attr)
  else
    name
  end
end

#ignore_failure(arg = nil) ⇒ Object 



377
378
379
380
381
382
383
 
# File 'lib/chef/resource.rb', line 377

def ignore_failure(arg=nil)
  set_or_return(
    :ignore_failure,
    arg,
    :kind_of => [ TrueClass, FalseClass ]
  )
end

#immediate_notifications ⇒ Object 



464
465
466
 
# File 'lib/chef/resource.rb', line 464

def immediate_notifications
  run_context.immediate_notifications(self)
end

#inspect ⇒ Object 



523
524
525
526
527
528
 
# File 'lib/chef/resource.rb', line 523

def inspect
  ivars = instance_variables.map { |ivar| ivar.to_sym } - FORBIDDEN_IVARS
  ivars.inject("<#{to_s}") do |str, ivar|
    str << " #{ivar}: #{instance_variable_get(ivar).inspect}"
  end << ">"
end

#is(*args) ⇒ Object 



494
495
496
497
498
499
500
 
# File 'lib/chef/resource.rb', line 494

def is(*args)
  if args.size == 1
    args.first
  else
    return *args
  end
end

#load_prior_resource(resource_type, instance_name) ⇒ Object 



300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
 
# File 'lib/chef/resource.rb', line 300

def load_prior_resource(resource_type, instance_name)
  begin
    key = ::Chef::ResourceCollection::ResourceSet.create_key(resource_type, instance_name)
    prior_resource = run_context.resource_collection.lookup(key)
    # if we get here, there is a prior resource (otherwise we'd have jumped
    # to the rescue clause).
    Chef::Log.warn("Cloning resource attributes for #{key} from prior resource (CHEF-3694)")
    Chef::Log.warn("Previous #{prior_resource}: #{prior_resource.source_line}") if prior_resource.source_line
    Chef::Log.warn("Current  #{self}: #{self.source_line}") if self.source_line
    prior_resource.instance_variables.each do |iv|
      unless iv.to_sym == :@source_line || iv.to_sym == :@action || iv.to_sym == :@not_if || iv.to_sym == :@only_if
        self.instance_variable_set(iv, prior_resource.instance_variable_get(iv))
      end
    end
    true
  rescue Chef::Exceptions::ResourceNotFound
    true
  end
end

#name(name = nil) ⇒ Object 



361
362
363
364
365
366
367
 
# File 'lib/chef/resource.rb', line 361

def name(name=nil)
  if !name.nil?
    raise ArgumentError, "name must be a string!" unless name.kind_of?(String)
    @name = name
  end
  @name
end

#node ⇒ Object 



285
286
287
 
# File 'lib/chef/resource.rb', line 285

def node
  run_context && run_context.node
end

#noop(tf = nil) ⇒ Object 



369
370
371
372
373
374
375
 
# File 'lib/chef/resource.rb', line 369

def noop(tf=nil)
  if !tf.nil?
    raise ArgumentError, "noop must be true or false!" unless tf == true || tf == false
    @noop = tf
  end
  @noop
end

#not_if(command = nil, opts = {}, &block) ⇒ Object

If command is a block, returns false if the block returns true, true if it returns false. (“Do not run this resource if the block is true”)

If the command is not a block, executes the command. If it returns a 0 exitstatus, returns false. (“Do not run this resource if the command returns 0”)

Parameters

command<String>

A a string to execute.

opts<Hash>

Options control the execution of the command

block<Proc>

A ruby block to run. Ignored if a command is given.

Evaluation

  • evaluates to true if the block is false, or if the command returns a non-zero exit status.

  • evaluates to false if the block is true, or if the command returns a 0 exit status.



596
597
598
599
600
601
 
# File 'lib/chef/resource.rb', line 596

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 from this resource to the resource specified by resource_spec.



426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
 
# File 'lib/chef/resource.rb', line 426

def notifies(action, resource_spec, timing=:delayed)
  # when using old-style resources(:template => "/foo.txt") style, you
  # could end up with multiple resources.
  resources = [ resource_spec ].flatten
  resources.each do |resource|

    validate_resource_spec!(resource_spec)

    case timing.to_s
    when 'delayed'
      notifies_delayed(action, resource)
    when 'immediate', 'immediately'
      notifies_immediately(action, resource)
    else
      raise ArgumentError,  "invalid timing: #{timing} for notifies(#{action}, #{resources.inspect}, #{timing}) resource #{self} "\
                            "Valid timings are: :delayed, :immediate, :immediately"
    end
  end

  true
end

#notifies_delayed(action, resource_spec) ⇒ Object 



460
461
462
 
# File 'lib/chef/resource.rb', line 460

def notifies_delayed(action, resource_spec)
  run_context.notifies_delayed(Notification.new(resource_spec, action, self))
end

#notifies_immediately(action, resource_spec) ⇒ Object 



456
457
458
 
# File 'lib/chef/resource.rb', line 456

def notifies_immediately(action, resource_spec)
  run_context.notifies_immediately(Notification.new(resource_spec, action, self))
end

#only_if(command = nil, opts = {}, &block) ⇒ Object

If command is a block, returns true if the block returns true, false if it returns false. (“Only run this resource if the block is true”)

If the command is not a block, executes the command. If it returns any status other than 0, it returns false (clearly, a 0 status code is true)

Parameters

command<String>

A a string to execute.

opts<Hash>

Options control the execution of the command

block<Proc>

A ruby block to run. Ignored if a command is given.

Evaluation

  • evaluates to true if the block is true, or if the command returns 0

  • evaluates to false if the block is false, or if the command returns a non-zero exit code.



575
576
577
578
579
580
 
# File 'lib/chef/resource.rb', line 575

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_for_action(action) ⇒ Object 



682
683
684
685
686
 
# File 'lib/chef/resource.rb', line 682

def provider_for_action(action)
  provider = Chef::ProviderResolver.new(node, self, action).resolve.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.



451
452
453
454
 
# File 'lib/chef/resource.rb', line 451

def resolve_notification_references
  run_context.immediate_notifications(self).each { |n| n.resolve_resource_reference(run_context.resource_collection) }
  run_context.delayed_notifications(self).each {|n| n.resolve_resource_reference(run_context.resource_collection) }
end

#resources(*args) ⇒ Object 



472
473
474
 
# File 'lib/chef/resource.rb', line 472

def resources(*args)
  run_context.resource_collection.find(*args)
end

#run_action(action, notification_type = nil, notifying_resource = nil) ⇒ Object 



628
629
630
631
632
633
634
635
636
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
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
 
# File 'lib/chef/resource.rb', line 628

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] || 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 Exception => 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
  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
end

#sensitive(arg = nil) ⇒ Object 



401
402
403
404
405
406
407
 
# File 'lib/chef/resource.rb', line 401

def sensitive(arg=nil)
  set_or_return(
    :sensitive,
    arg,
    :kind_of => [ TrueClass, FalseClass ]
  )
end

#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

Returns:

  • (Boolean) 


707
708
709
710
711
712
713
714
715
716
717
718
719
720
 
# File 'lib/chef/resource.rb', line 707

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

#state ⇒ Object

Returns a Hash of attribute => value for the state attributes declared in the resource’s class definition.



260
261
262
263
264
265
 
# File 'lib/chef/resource.rb', line 260

def state
  self.class.state_attrs.inject({}) do |state_attrs, attr_name|
    state_attrs[attr_name] = send(attr_name)
    state_attrs
  end
end

#subscribes(action, resources, timing = :delayed) ⇒ Object 



476
477
478
479
480
481
482
483
484
485
486
487
488
 
# File 'lib/chef/resource.rb', line 476

def subscribes(action, resources, timing=:delayed)
  resources = [resources].flatten
  resources.each do |resource|
    if resource.is_a?(String)
      resource = Chef::Resource.new(resource, run_context)
    end
    if resource.run_context.nil?
      resource.run_context = run_context
    end
    resource.notifies(action, self, timing)
  end
  true
end

#supports(args = {}) ⇒ Object 



320
321
322
323
324
325
326
 
# File 'lib/chef/resource.rb', line 320

def supports(args={})
  if args.any?
    @supports = args
  else
    @supports
  end
end

#to_hash ⇒ Object 



551
552
553
554
555
556
557
558
559
 
# File 'lib/chef/resource.rb', line 551

def to_hash
  safe_ivars = instance_variables.map { |ivar| ivar.to_sym } - FORBIDDEN_IVARS
  instance_vars = Hash.new
  safe_ivars.each do |iv|
    key = iv.to_s.sub(/^@/,'').to_sym
    instance_vars[key] = instance_variable_get(iv)
  end
  instance_vars
end

#to_json(*a) ⇒ Object

Serialize this object as a hash



546
547
548
549
 
# File 'lib/chef/resource.rb', line 546

def to_json(*a)
  results = as_json
  Chef::JSONCompat.to_json(results, *a)
end

#to_s ⇒ Object 



502
503
504
 
# File 'lib/chef/resource.rb', line 502

def to_s
  "#{@resource_name}[#{@name}]"
end

#to_text ⇒ Object 



506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
 
# File 'lib/chef/resource.rb', line 506

def to_text
  return "suppressed sensitive resource output" if sensitive
  ivars = instance_variables.map { |ivar| ivar.to_sym } - HIDDEN_IVARS
  text = "# Declared in #{@source_line}\n\n"
  text << self.class.dsl_name + "(\"#{name}\") do\n"
  ivars.each do |ivar|
    if (value = instance_variable_get(ivar)) && !(value.respond_to?(:empty?) && value.empty?)
      value_string = value.respond_to?(:to_text) ? value.to_text : value.inspect
      text << "  #{ivar.to_s.sub(/^@/,'')} #{value_string}\n"
    end
  end
  [@not_if, @only_if].flatten.each do |conditional|
    text << "  #{conditional.to_text}\n"
  end
  text << "end\n"
end

#updated? ⇒ Boolean

Returns:

  • (Boolean) 


731
732
733
 
# File 'lib/chef/resource.rb', line 731

def updated?
  updated
end

#updated_by_last_action(true_or_false) ⇒ Object 



722
723
724
725
 
# File 'lib/chef/resource.rb', line 722

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

Returns:

  • (Boolean) 


727
728
729
 
# File 'lib/chef/resource.rb', line 727

def updated_by_last_action?
  @updated_by_last_action
end

#validate_action(action) ⇒ Object

Raises:

  • (ArgumentError) 


678
679
680
 
# File 'lib/chef/resource.rb', line 678

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 



490
491
492
 
# File 'lib/chef/resource.rb', line 490

def validate_resource_spec!(resource_spec)
  run_context.resource_collection.validate_lookup_spec!(resource_spec)
end