Class: Chef::Resource

Inherits:
Object show all
Extended by:
Mixin::ConvertToClassName
Includes:
DSL::DataQuery, DSL::PlatformIntrospection, 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/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/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/ruby_block.rb,
lib/chef/resource/subversion.rb,
lib/chef/resource/apt_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_platform_map.rb,
lib/chef/resource/cookbook_file.rb,
lib/chef/resource/pacman_package.rb,
lib/chef/resource/deploy_revision.rb,
lib/chef/resource/freebsd_package.rb,
lib/chef/resource/portage_package.rb,
lib/chef/resource/smartos_package.rb,
lib/chef/resource/solaris_package.rb,
lib/chef/resource/macports_package.rb,
lib/chef/resource/remote_directory.rb,
lib/chef/resource/timestamped_deploy.rb,
lib/chef/resource/easy_install_package.rb

Defined Under Namespace

Classes: AptPackage, Bash, Breakpoint, ChefGem, Conditional, CookbookFile, Cron, Csh, Deploy, DeployBranch, DeployRevision, Directory, DpkgPackage, EasyInstallPackage, Env, ErlCall, Execute, File, FreebsdPackage, GemPackage, Git, Group, HttpRequest, Ifconfig, IpsPackage, LWRPBase, Link, Log, MacportsPackage, Mdadm, Mount, Notification, Ohai, Package, PacmanPackage, Perl, PlatformMap, PortagePackage, Python, RegistryKey, RemoteDirectory, RemoteFile, Route, RpmPackage, Ruby, RubyBlock, Scm, Script, Service, SmartOSPackage, SolarisPackage, Subversion, Template, TimestampedDeploy, User, YumPackage

Constant Summary collapse

FORBIDDEN_IVARS = 
[:@run_context, :@node, :@not_if, :@only_if, :@enclosing_provider]
HIDDEN_IVARS = 
[:@allowed_actions, :@resource_name, :@source_line, :@run_context, :@name, :@node, :@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

convert_to_class_name, convert_to_snake_case, filename_to_qualified_string, snake_case_basename

Methods included from Mixin::Deprecation

#deprecated_ivar

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

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

Methods included from Mixin::ParamsValidate

#set_or_return, #validate

Methods included from DSL::DataQuery

#data_bag, #data_bag_item, #search

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



200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
 
# File 'lib/chef/resource.rb', line 200

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
  @elapsed_time = 0

  @node = run_context ? deprecated_ivar(run_context.node, :node, :warn) : nil
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.



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

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.



180
181
182
 
# File 'lib/chef/resource.rb', line 180

def allowed_actions
  @allowed_actions
end

#cookbook_name ⇒ Object

Returns the value of attribute cookbook_name.



182
183
184
 
# File 'lib/chef/resource.rb', line 182

def cookbook_name
  @cookbook_name
end

#elapsed_time ⇒ Object (readonly)

Returns the value of attribute elapsed_time.



195
196
197
 
# File 'lib/chef/resource.rb', line 195

def elapsed_time
  @elapsed_time
end

#enclosing_provider ⇒ Object

Returns the value of attribute enclosing_provider.



184
185
186
 
# File 'lib/chef/resource.rb', line 184

def enclosing_provider
  @enclosing_provider
end

#not_if_args ⇒ Object (readonly)

Returns the value of attribute not_if_args.



192
193
194
 
# File 'lib/chef/resource.rb', line 192

def not_if_args
  @not_if_args
end

#only_if_args ⇒ Object (readonly)

Returns the value of attribute only_if_args.



193
194
195
 
# File 'lib/chef/resource.rb', line 193

def only_if_args
  @only_if_args
end

#params ⇒ Object

Returns the value of attribute params.



178
179
180
 
# File 'lib/chef/resource.rb', line 178

def params
  @params
end

#provider(arg = nil) ⇒ Object

Returns the value of attribute provider.



179
180
181
 
# File 'lib/chef/resource.rb', line 179

def provider
  @provider
end

#recipe_name ⇒ Object

Returns the value of attribute recipe_name.



183
184
185
 
# File 'lib/chef/resource.rb', line 183

def recipe_name
  @recipe_name
end

#resource_name ⇒ Object (readonly)

Returns the value of attribute resource_name.



191
192
193
 
# File 'lib/chef/resource.rb', line 191

def resource_name
  @resource_name
end

#retries(arg = nil) ⇒ Object

Returns the value of attribute retries.



186
187
188
 
# File 'lib/chef/resource.rb', line 186

def retries
  @retries
end

#retry_delay(arg = nil) ⇒ Object

Returns the value of attribute retry_delay.



187
188
189
 
# File 'lib/chef/resource.rb', line 187

def retry_delay
  @retry_delay
end

#run_context ⇒ Object

Returns the value of attribute run_context.



181
182
183
 
# File 'lib/chef/resource.rb', line 181

def run_context
  @run_context
end

#source_line ⇒ Object

Returns the value of attribute source_line.



185
186
187
 
# File 'lib/chef/resource.rb', line 185

def source_line
  @source_line
end

#updated ⇒ Object

Returns the value of attribute updated.



189
190
191
 
# File 'lib/chef/resource.rb', line 189

def updated
  @updated
end

Class Method Details

.dsl_name ⇒ Object 



174
175
176
 
# File 'lib/chef/resource.rb', line 174

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.



162
163
164
165
166
167
168
169
170
171
172
 
# File 'lib/chef/resource.rb', line 162

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 



665
666
667
668
669
670
671
 
# File 'lib/chef/resource.rb', line 665

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

.platform_map ⇒ Object 



690
691
692
 
# File 'lib/chef/resource.rb', line 690

def self.platform_map
  @@platform_map ||= PlatformMap.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



685
686
687
688
 
# File 'lib/chef/resource.rb', line 685

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

.provides(short_name, opts = {}) ⇒ 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, :on_platforms => ["windows"]
  # ...other stuff
end

TODO: 2011-11-02 schisamo - platform_version support



705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
 
# File 'lib/chef/resource.rb', line 705

def self.provides(short_name, opts={})
  short_name_sym = short_name
  if short_name.kind_of?(String)
    short_name.downcase!
    short_name.gsub!(/\s/, "_")
    short_name_sym = short_name.to_sym
  end
  if opts.has_key?(:on_platforms)
    platforms = [opts[:on_platforms]].flatten
    platforms.each do |p|
      p = :default if :all == p.to_sym
      platform_map.set(
        :platform => p.to_sym,
        :short_name => short_name_sym,
        :resource => self
      )
    end
  else
    platform_map.set(
      :short_name => short_name_sym,
      :resource => self
    )
  end
end

.resource_for_node(short_name, node) ⇒ Object

Returns a resource based on a short_name and a node’s platform and version.

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



753
754
755
756
757
758
759
760
 
# File 'lib/chef/resource.rb', line 753

def self.resource_for_node(short_name, node)
  begin
    platform, version = Chef::Platform.find_platform_and_version(node)
  rescue ArgumentError
  end
  resource = resource_for_platform(short_name, platform, version)
  resource
end

.resource_for_platform(short_name, platform = nil, version = nil) ⇒ Object

Returns a resource based on a short_name anda platform and version.

Parameters

short_name<Symbol>

short_name of the resource (ie :directory)

platform<Symbol,String>

platform name

version<String>

platform version

Returns

<Chef::Resource>

returns the proper Chef::Resource class



740
741
742
 
# File 'lib/chef/resource.rb', line 740

def self.resource_for_platform(short_name, platform=nil, version=nil)
  platform_map.get(short_name, platform, version)
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.



144
145
146
147
148
149
150
151
152
153
154
 
# File 'lib/chef/resource.rb', line 144

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

Instance Method Details

#action(arg = nil) ⇒ Object 



306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
 
# File 'lib/chef/resource.rb', line 306

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



674
675
676
 
# File 'lib/chef/resource.rb', line 674

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



470
471
472
473
474
475
476
477
478
479
480
 
# File 'lib/chef/resource.rb', line 470

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 



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

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

#customize_exception(e) ⇒ Object 



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

def customize_exception(e)
  new_exception = e.exception("#{self} (#{defined_at}) had an error: #{e.class.name}: #{e.message}")
  new_exception.set_backtrace(e.backtrace)
  new_exception
end

#defined_at ⇒ Object 



540
541
542
543
544
545
546
547
548
549
550
551
552
553
 
# File 'lib/chef/resource.rb', line 540

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 



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

def delayed_notifications
  run_context.delayed_notifications(self)
end

#epic_fail(arg = nil) ⇒ Object 



366
367
368
 
# File 'lib/chef/resource.rb', line 366

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

#events ⇒ Object 



561
562
563
 
# File 'lib/chef/resource.rb', line 561

def events
  run_context.events
end

#identity ⇒ Object

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



234
235
236
237
238
239
240
 
# File 'lib/chef/resource.rb', line 234

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

#ignore_failure(arg = nil) ⇒ Object 



342
343
344
345
346
347
348
 
# File 'lib/chef/resource.rb', line 342

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

#immediate_notifications ⇒ Object 



406
407
408
 
# File 'lib/chef/resource.rb', line 406

def immediate_notifications
  run_context.immediate_notifications(self)
end

#inspect ⇒ Object 



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

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 



432
433
434
435
436
437
438
 
# File 'lib/chef/resource.rb', line 432

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

#load_prior_resource ⇒ Object 



266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
 
# File 'lib/chef/resource.rb', line 266

def load_prior_resource
  begin
    prior_resource = run_context.resource_collection.lookup(self.to_s)
    # 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 #{self.to_s} 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 



326
327
328
329
330
331
332
 
# File 'lib/chef/resource.rb', line 326

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 



251
252
253
 
# File 'lib/chef/resource.rb', line 251

def node
  run_context && run_context.node
end

#noop(tf = nil) ⇒ Object 



334
335
336
337
338
339
340
 
# File 'lib/chef/resource.rb', line 334

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.



533
534
535
536
537
538
 
# File 'lib/chef/resource.rb', line 533

def not_if(command=nil, opts={}, &block)
  if command || block_given?
    @not_if << Conditional.not_if(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.



371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
 
# File 'lib/chef/resource.rb', line 371

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



402
403
404
 
# File 'lib/chef/resource.rb', line 402

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

#notifies_immediately(action, resource_spec) ⇒ Object 



398
399
400
 
# File 'lib/chef/resource.rb', line 398

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.



512
513
514
515
516
517
 
# File 'lib/chef/resource.rb', line 512

def only_if(command=nil, opts={}, &block)
  if command || block_given?
    @only_if << Conditional.only_if(command, opts, &block)
  end
  @only_if
end

#provider_for_action(action) ⇒ Object 



611
612
613
614
615
616
617
618
619
620
621
622
 
# File 'lib/chef/resource.rb', line 611

def provider_for_action(action)
  # leverage new platform => short_name => resource
  # which requires explicitly setting provider in
  # resource class
  if self.provider
    provider = self.provider.new(self, self.run_context)
    provider.action = action
    provider
  else # fall back to old provider resolution
    Chef::Platform.provider_for_resource(self, action)
  end
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.



393
394
395
396
 
# File 'lib/chef/resource.rb', line 393

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 



414
415
416
 
# File 'lib/chef/resource.rb', line 414

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

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



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
 
# File 'lib/chef/resource.rb', line 565

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)

  begin
    return if should_skip?(action)
    provider_for_action(action).run_action
  rescue Exception => e
    if ignore_failure
      Chef::Log.error("#{self} (#{defined_at}) had an error: #{e.message}; ignore_failure is set, continuing")
      events.resource_failed(self, action, e)
    elsif retries > 0
      events.resource_failed_retriable(self, action, retries, e)
      @retries -= 1
      Chef::Log.info("Retrying execution of #{self}, #{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
    events.resource_completed(self)
  end
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.

Returns:

  • (Boolean) 


637
638
639
640
641
642
643
644
645
646
647
648
649
650
 
# File 'lib/chef/resource.rb', line 637

def should_skip?(action)
  conditionals = only_if + not_if
  return false if conditionals.empty?

  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.



225
226
227
228
229
230
 
# File 'lib/chef/resource.rb', line 225

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 



418
419
420
421
422
423
424
425
426
427
428
429
430
 
# File 'lib/chef/resource.rb', line 418

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 



285
286
287
288
289
290
291
 
# File 'lib/chef/resource.rb', line 285

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

#to_hash ⇒ Object 



488
489
490
491
492
493
494
495
496
 
# File 'lib/chef/resource.rb', line 488

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



483
484
485
486
 
# File 'lib/chef/resource.rb', line 483

def to_json(*a)
  results = as_json
  results.to_json(*a)
end

#to_s ⇒ Object 



440
441
442
 
# File 'lib/chef/resource.rb', line 440

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

#to_text ⇒ Object 



444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
 
# File 'lib/chef/resource.rb', line 444

def to_text
  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) 


661
662
663
 
# File 'lib/chef/resource.rb', line 661

def updated?
  updated
end

#updated_by_last_action(true_or_false) ⇒ Object 



652
653
654
655
 
# File 'lib/chef/resource.rb', line 652

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) 


657
658
659
 
# File 'lib/chef/resource.rb', line 657

def updated_by_last_action?
  @updated_by_last_action
end

#validate_action(action) ⇒ Object

Raises:

  • (ArgumentError) 


607
608
609
 
# File 'lib/chef/resource.rb', line 607

def validate_action(action)
  raise ArgumentError, "nil is not a valid action for resource #{self}" if action.nil?
end