Class: Chef::Resource

Inherits:
Object
  • Object
show all
Extended by:
Mixin::ConvertToClassName
Includes:
Mixin::CheckHelper, Mixin::ConvertToClassName, Mixin::Deprecation, Mixin::Language, 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/erl_call.rb,
lib/chef/resource/ifconfig.rb,
lib/chef/resource/template.rb,
lib/chef/resource/directory.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/gem_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/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/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, CookbookFile, Cron, Csh, Deploy, DeployBranch, DeployRevision, Directory, DpkgPackage, EasyInstallPackage, Env, ErlCall, Execute, File, FreebsdPackage, GemPackage, Git, Group, HttpRequest, Ifconfig, Link, Log, MacportsPackage, Mdadm, Mount, Notification, Ohai, Package, PacmanPackage, Perl, PortagePackage, Python, RemoteDirectory, RemoteFile, Route, RpmPackage, Ruby, RubyBlock, Scm, Script, Service, SolarisPackage, Subversion, Template, TimestampedDeploy, User, YumPackage

Constant Summary collapse

HIDDEN_IVARS = 
[:@allowed_actions, :@resource_name, :@source_line, :@run_context, :@name, :@node]

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 Mixin::Language

#data_bag, #data_bag_item, #platform?, #search, #value_for_platform

Methods included from Mixin::ParamsValidate

#set_or_return, #validate

Methods included from Mixin::CheckHelper

#set_if_args

Constructor Details

#initialize(name, run_context = nil) ⇒ Resource

Returns a new instance of Resource.



101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
 
# File 'lib/chef/resource.rb', line 101

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
  @not_if = nil
  @not_if_args = {}
  @only_if = nil
  @only_if_args = {}
  @immediate_notifications = Array.new
  @delayed_notifications = Array.new
  @source_line = nil
  @retries = 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.



141
142
143
144
145
146
147
 
# File 'lib/chef/resource.rb', line 141

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.



83
84
85
 
# File 'lib/chef/resource.rb', line 83

def allowed_actions
  @allowed_actions
end

#cookbook_name ⇒ Object

Returns the value of attribute cookbook_name.



85
86
87
 
# File 'lib/chef/resource.rb', line 85

def cookbook_name
  @cookbook_name
end

#delayed_notifications ⇒ Object (readonly)

Returns the value of attribute delayed_notifications.



99
100
101
 
# File 'lib/chef/resource.rb', line 99

def delayed_notifications
  @delayed_notifications
end

#enclosing_provider ⇒ Object

Returns the value of attribute enclosing_provider.



87
88
89
 
# File 'lib/chef/resource.rb', line 87

def enclosing_provider
  @enclosing_provider
end

#immediate_notifications ⇒ Object (readonly)

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



98
99
100
 
# File 'lib/chef/resource.rb', line 98

def immediate_notifications
  @immediate_notifications
end

#not_if_args ⇒ Object (readonly)

Returns the value of attribute not_if_args.



93
94
95
 
# File 'lib/chef/resource.rb', line 93

def not_if_args
  @not_if_args
end

#only_if_args ⇒ Object (readonly)

Returns the value of attribute only_if_args.



94
95
96
 
# File 'lib/chef/resource.rb', line 94

def only_if_args
  @only_if_args
end

#params ⇒ Object

Returns the value of attribute params.



81
82
83
 
# File 'lib/chef/resource.rb', line 81

def params
  @params
end

#provider(arg = nil) ⇒ Object

Returns the value of attribute provider.



82
83
84
 
# File 'lib/chef/resource.rb', line 82

def provider
  @provider
end

#recipe_name ⇒ Object

Returns the value of attribute recipe_name.



86
87
88
 
# File 'lib/chef/resource.rb', line 86

def recipe_name
  @recipe_name
end

#resource_name ⇒ Object (readonly)

Returns the value of attribute resource_name.



92
93
94
 
# File 'lib/chef/resource.rb', line 92

def resource_name
  @resource_name
end

#run_context ⇒ Object

Returns the value of attribute run_context.



84
85
86
 
# File 'lib/chef/resource.rb', line 84

def run_context
  @run_context
end

#source_line ⇒ Object

Returns the value of attribute source_line.



88
89
90
 
# File 'lib/chef/resource.rb', line 88

def source_line
  @source_line
end

#updated ⇒ Object

Returns the value of attribute updated.



90
91
92
 
# File 'lib/chef/resource.rb', line 90

def updated
  @updated
end

Class Method Details

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



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

def attribute(attr_name, validation_opts={})
  # This atrocity is the only way to support 1.8 and 1.9 at the same time
  # When you're ready to drop 1.8 support, do this:
  # define_method attr_name.to_sym do |arg=nil|
  # etc.
  shim_method=<<-SHIM
  def #{attr_name}(arg=nil)
    _set_or_return_#{attr_name}(arg)
  end
  SHIM
  class_eval(shim_method)
  
  define_method("_set_or_return_#{attr_name.to_s}".to_sym) do |arg|
    set_or_return(attr_name.to_sym, arg, validation_opts)
  end
end

.build_from_file(cookbook_name, filename) ⇒ Object 



460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
 
# File 'lib/chef/resource.rb', line 460

def build_from_file(cookbook_name, filename)
  rname = filename_to_qualified_string(cookbook_name, filename)

  # Add log entry if we override an existing light-weight resource.
  class_name = convert_to_class_name(rname)
  overriding = Chef::Resource.const_defined?(class_name)
  Chef::Log.info("#{class_name} light-weight resource already initialized -- overriding!") if overriding
    
  new_resource_class = Class.new self do |cls|
    
    # default initialize method that ensures that when initialize is finally
    # wrapped (see below), super is called in the event that the resource
    # definer does not implement initialize
    def initialize(name, run_context)
      super(name, run_context)
    end
    
    @actions_to_create = []
    
    class << cls
      include Chef::Mixin::FromFile
      
      def actions_to_create
        @actions_to_create
      end
      
      define_method(:actions) do |*action_names|
        actions_to_create.push(*action_names)
      end
    end
    
    # load resource definition from file
    cls.class_from_file(filename)
    
    # create a new constructor that wraps the old one and adds the actions
    # specified in the DSL
    old_init = instance_method(:initialize)

    define_method(:initialize) do |name, *optional_args|
      args_run_context = optional_args.shift
      @resource_name = rname.to_sym
      old_init.bind(self).call(name, args_run_context)
      allowed_actions.push(self.class.actions_to_create).flatten!
    end
  end
  
  # register new class as a Chef::Resource
  class_name = convert_to_class_name(rname)
  Chef::Resource.const_set(class_name, new_resource_class)
  Chef::Log.debug("Loaded contents of #{filename} into a resource named #{rname} defined in Chef::Resource::#{class_name}")
  
  new_resource_class
end

.json_create(o) ⇒ Object 



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

def 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

.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



521
522
523
524
 
# File 'lib/chef/resource.rb', line 521

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

Instance Method Details

#action(arg = nil) ⇒ Object 



185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
 
# File 'lib/chef/resource.rb', line 185

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

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



254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
 
# File 'lib/chef/resource.rb', line 254

def add_notification(action, resources, timing=:delayed)
  resources = [resources].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

#epic_fail(arg = nil) ⇒ Object 



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

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

#ignore_failure(arg = nil) ⇒ Object 



219
220
221
222
223
224
225
 
# File 'lib/chef/resource.rb', line 219

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

#is(*args) ⇒ Object 



307
308
309
310
311
312
313
 
# File 'lib/chef/resource.rb', line 307

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

#load_prior_resource ⇒ Object 



149
150
151
152
153
154
155
156
157
158
159
160
161
162
 
# File 'lib/chef/resource.rb', line 149

def load_prior_resource
  begin
    prior_resource = run_context.resource_collection.lookup(self.to_s)
    Chef::Log.debug("Setting #{self.to_s} to the state of the prior #{self.to_s}")
    prior_resource.instance_variables.each do |iv|
      unless iv.to_sym == :@source_line || iv.to_sym == :@action
        self.instance_variable_set(iv, prior_resource.instance_variable_get(iv))
      end
    end
    true
  rescue Chef::Exceptions::ResourceNotFound => e
    true
  end
end

#name(name = nil) ⇒ Object 



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

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

#node ⇒ Object 



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

def node
  run_context && run_context.node
end

#noop(tf = nil) ⇒ Object 



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

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

#not_if(arg = nil, args = {}, &blk) ⇒ Object 



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

def not_if(arg=nil, args = {}, &blk)
  if Kernel.block_given?
    @not_if = blk
    @not_if_args = args
  else
    @not_if = arg if arg
    @not_if_args = args if arg
  end
  @not_if
end

#notifies(*args) ⇒ Object 



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

def notifies(*args)
  unless ( args.size > 0 && args.size < 4)
    raise ArgumentError, "Wrong number of arguments for notifies: should be 1-3 arguments, you gave #{args.inspect}"
  end

  if args.size > 1 # notifies(:action, resource) OR notifies(:action, resource, :immediately)
    add_notification(*args)
  else
    # This syntax is so weird. surely people will just give us one hash?
    notifications = args.flatten
    notifications.each do |resources_notifications|
      resources_notifications.each do |resource, notification|
        action, timing = notification[0], notification[1]
        Chef::Log.debug "adding notification from resource #{self} to `#{resource.inspect}' => `#{notification.inspect}'"
        add_notification(action, resource, timing)
      end
    end 
  end
rescue NoMethodError
  Chef::Log.fatal("Error processing notifies(#{args.inspect}) on #{self}")
  raise
end

#notifies_delayed(action, resource_spec) ⇒ Object 



283
284
285
 
# File 'lib/chef/resource.rb', line 283

def notifies_delayed(action, resource_spec)
  @delayed_notifications << Notification.new(resource_spec, action, self)
end

#notifies_immediately(action, resource_spec) ⇒ Object 



279
280
281
 
# File 'lib/chef/resource.rb', line 279

def notifies_immediately(action, resource_spec)
  @immediate_notifications << Notification.new(resource_spec, action, self)
end

#only_if(arg = nil, args = {}, &blk) ⇒ Object 



355
356
357
358
359
360
361
362
363
364
 
# File 'lib/chef/resource.rb', line 355

def only_if(arg=nil, args = {}, &blk)
  if Kernel.block_given?
    @only_if = blk
    @only_if_args = args
  else
    @only_if = arg if arg
    @only_if_args = args if arg
  end
  @only_if
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.



274
275
276
277
 
# File 'lib/chef/resource.rb', line 274

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

#resources(*args) ⇒ Object 



287
288
289
 
# File 'lib/chef/resource.rb', line 287

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

#retries(retry_count = nil) ⇒ Object 



299
300
301
302
303
304
305
 
# File 'lib/chef/resource.rb', line 299

def retries(retry_count=nil)
  set_or_return(
    :retries,
    retry_count,
    :kind_of => Fixnum
  )
end

#run_action(action) ⇒ Object 



377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
 
# File 'lib/chef/resource.rb', line 377

def run_action(action)
  # ensure that we don't leave @updated_by_last_action set to true
  # on accident
  updated_by_last_action(false)

  # Check if this resource has an only_if block -- if it does,
  # evaluate the only_if block and skip the resource if
  # appropriate.
  if only_if
    unless Chef::Mixin::Command.only_if(only_if, only_if_args)
      Chef::Log.debug("Skipping #{self} due to only_if")
      return
    end
  end

  # Check if this resource has a not_if block -- if it does,
  # evaluate the not_if block and skip the resource if
  # appropriate.
  if not_if
    unless Chef::Mixin::Command.not_if(not_if, not_if_args)
      Chef::Log.debug("Skipping #{self} due to not_if")
      return
    end
  end

  provider = Chef::Platform.provider_for_resource(self)
  provider.load_current_resource
  runs = 0
  begin
    provider.send("action_#{action}")
  rescue Chef::Exceptions::Exec, Timeout::Error
    if @retries > runs
      runs += 1
      Chef::Log.warn("Error running action #{action}, retrying (#{runs} of #{@retries} retries): #{$!.message}")
      retry
    else
      raise
    end
  end
end

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



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

def subscribes(action, resources, timing=:delayed)
  resources = [resources].flatten
  resources.each do |resource|
    resource.notifies(action, self, timing)
  end
  true
end

#supports(args = {}) ⇒ Object 



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

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

#to_hash ⇒ Object 



346
347
348
349
350
351
352
353
 
# File 'lib/chef/resource.rb', line 346

def to_hash
  instance_vars = Hash.new
  self.instance_variables.each do |iv|
    key = iv.to_s.sub(/^@/,'').to_sym
    instance_vars[key] = self.instance_variable_get(iv) unless (key == :run_context) || (key == :node)
  end
  instance_vars
end

#to_json(*a) ⇒ Object

Serialize this object as a hash



332
333
334
335
336
337
338
339
340
341
342
343
344
 
# File 'lib/chef/resource.rb', line 332

def to_json(*a)
  instance_vars = Hash.new
  self.instance_variables.each do |iv|
    unless iv == "@run_context"
      instance_vars[iv] = self.instance_variable_get(iv) 
    end
  end
  results = {
    'json_class' => self.class.name,
    'instance_vars' => instance_vars
  }
  results.to_json(*a)
end

#to_s ⇒ Object 



315
316
317
 
# File 'lib/chef/resource.rb', line 315

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

#to_text ⇒ Object 



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

def to_text
  ivars = instance_variables.map { |ivar| ivar.to_sym } - HIDDEN_IVARS
  text = "# Declared in #{@source_line}\n"
  text << convert_to_snake_case(self.class.name, 'Chef::Resource') + "(\"#{name}\") do\n"
  ivars.each do |ivar|
    if (value = instance_variable_get(ivar)) && !(value.respond_to?(:empty?) && value.empty?)
      text << "  #{ivar.to_s.sub(/^@/,'')}(#{value.inspect})\n"
    end
  end
  text << "end\n"
end

#updated? ⇒ Boolean

Returns:

  • (Boolean) 


427
428
429
 
# File 'lib/chef/resource.rb', line 427

def updated?
  updated
end

#updated_by_last_action(true_or_false) ⇒ Object 



418
419
420
421
 
# File 'lib/chef/resource.rb', line 418

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) 


423
424
425
 
# File 'lib/chef/resource.rb', line 423

def updated_by_last_action?
  @updated_by_last_action
end