Class: Chef::RunContext
- Inherits:
-
Object
- Object
- Chef::RunContext
- Includes:
- Deprecated
- Defined in:
- lib/chef/run_context.rb,
lib/chef/run_context/cookbook_compiler.rb
Overview
Chef::RunContext
Value object that loads and tracks the context of a Chef run
Direct Known Subclasses
Defined Under Namespace
Modules: Deprecated Classes: ChildRunContext, CookbookCompiler
Instance Attribute Summary collapse
-
#audits ⇒ Object
readonly
The list of control groups to execute during the audit phase.
-
#before_notification_collection ⇒ Hash[String, Array[Chef::Resource::Notification]]
readonly
A Hash containing the before notifications triggered by resources during the converge phase of the chef run.
-
#cookbook_collection ⇒ Chef::CookbookCollection
readonly
The set of cookbooks involved in this run.
-
#definitions ⇒ Array[Chef::ResourceDefinition]
readonly
Resource Definitions for this run.
-
#delayed_actions ⇒ Array[Chef::Resource::Notification]
readonly
An Array containing the delayed (end of run) notifications triggered by resources during the converge phase of the chef run.
-
#delayed_notification_collection ⇒ Hash[String, Array[Chef::Resource::Notification]]
readonly
A Hash containing the delayed (end of run) notifications triggered by resources during the converge phase of the chef run.
-
#events ⇒ Chef::EventDispatch::Dispatcher
readonly
Event dispatcher for this run.
-
#immediate_notification_collection ⇒ Hash[String, Array[Chef::Resource::Notification]]
readonly
A Hash containing the immediate notifications triggered by resources during the converge phase of the chef run.
-
#node ⇒ Chef::Node
readonly
The node for this run.
-
#parent_run_context ⇒ Chef::RunContext
readonly
The parent run context.
-
#reboot_info ⇒ Hash
Hash of factoids for a reboot request.
-
#resource_collection ⇒ Chef::ResourceCollection
The collection of resources intended to be converged (and able to be notified).
Instance Method Summary collapse
-
#add_delayed_action(notification) ⇒ Object
Adds a delayed action to the
delayed_actions
. -
#before_notifications(resource) ⇒ Array[Notification]
Get the list of before notifications sent by the given resource.
- #cancel_reboot ⇒ Object
-
#create_child ⇒ Object
Create a child RunContext.
-
#delayed_notifications(resource) ⇒ Array[Notification]
Get the list of delayed (end of run) notifications sent by the given resource.
-
#has_cookbook_file_in_cookbook?(cookbook, cb_file_name) ⇒ Boolean
Find out if the cookbook has the given file.
-
#has_template_in_cookbook?(cookbook, template_name) ⇒ Boolean
Find out if the cookbook has the given template.
-
#immediate_notifications(resource) ⇒ Array[Notification]
Get the list of immediate notifications sent by the given resource.
-
#include_recipe(*recipe_names, current_cookbook: nil) ⇒ Object
Evaluates the recipes
recipe_names
. -
#initialize(node, cookbook_collection, events) ⇒ RunContext
constructor
Creates a new Chef::RunContext object and populates its fields.
-
#initialize_child_state ⇒ Object
Initialize state that applies to both Chef::RunContext and Chef::ChildRunContext.
-
#load(run_list_expansion) ⇒ Object
Triggers the compile phase of the chef run.
-
#load_recipe(recipe_name, current_cookbook: nil) ⇒ Object
Evaluates the recipe
recipe_name
. -
#load_recipe_file(recipe_file) ⇒ Chef::Recipe
Load the given recipe from a filename.
-
#loaded_attribute(cookbook, attribute_file) ⇒ Object
Mark a given attribute file as having been loaded.
-
#loaded_attributes ⇒ Array[String]
A list of all attributes files that have been loaded.
-
#loaded_fully_qualified_attribute?(cookbook, attribute_file) ⇒ Boolean
Find out if a given attribute file has been loaded.
-
#loaded_fully_qualified_recipe?(cookbook, recipe) ⇒ Boolean
Find out if a given recipe has been loaded.
-
#loaded_recipe(cookbook, recipe) ⇒ Object
Mark a given recipe as having been loaded.
-
#loaded_recipe?(recipe) ⇒ Boolean
Find out if a given recipe has been loaded.
-
#loaded_recipes ⇒ Array[String]
A list of all recipes that have been loaded.
-
#notifies_before(notification) ⇒ Object
Adds an before notification to the
before_notification_collection
. -
#notifies_delayed(notification) ⇒ Object
Adds a delayed notification to the
delayed_notification_collection
. -
#notifies_immediately(notification) ⇒ Object
Adds an immediate notification to the
immediate_notification_collection
. -
#open_stream(name: nil, **options) {|stream| ... } ⇒ EventDispatch::EventsOutputStream
Open a stream object that can be printed into and will dispatch to events.
- #reboot_requested? ⇒ Boolean
-
#request_reboot(reboot_info) ⇒ Object
there are options for how to handle multiple calls to these functions: 1.
-
#resolve_attribute(cookbook_name, attr_file_name) ⇒ String
Look up an attribute filename.
-
#unreachable_cookbook?(cookbook_name) ⇒ Boolean
Find out whether the given cookbook is in the cookbook dependency graph.
Methods included from Deprecated
#audits=, #delayed_notification_collection=, #immediate_notification_collection=
Constructor Details
#initialize(node, cookbook_collection, events) ⇒ RunContext
Creates a new Chef::RunContext object and populates its fields. This object gets used by the Chef Server to generate a fully compiled recipe list for a node.
150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 |
# File 'lib/chef/run_context.rb', line 150 def initialize(node, cookbook_collection, events) @node = node @cookbook_collection = cookbook_collection @events = events node.run_context = self node.set_cookbook_attribute @definitions = Hash.new @loaded_recipes_hash = {} @loaded_attributes_hash = {} @reboot_info = {} @cookbook_compiler = nil @delayed_actions = [] initialize_child_state end |
Instance Attribute Details
#audits ⇒ Object (readonly)
The list of control groups to execute during the audit phase
100 101 102 |
# File 'lib/chef/run_context.rb', line 100 def audits @audits end |
#before_notification_collection ⇒ Hash[String, Array[Chef::Resource::Notification]] (readonly)
A Hash containing the before notifications triggered by resources during the converge phase of the chef run.
113 114 115 |
# File 'lib/chef/run_context.rb', line 113 def before_notification_collection @before_notification_collection end |
#cookbook_collection ⇒ Chef::CookbookCollection (readonly)
The set of cookbooks involved in this run
51 52 53 |
# File 'lib/chef/run_context.rb', line 51 def cookbook_collection @cookbook_collection end |
#definitions ⇒ Array[Chef::ResourceDefinition] (readonly)
Resource Definitions for this run. Populated when the files in definitions/
are evaluated (this is triggered by #load).
59 60 61 |
# File 'lib/chef/run_context.rb', line 59 def definitions @definitions end |
#delayed_actions ⇒ Array[Chef::Resource::Notification] (readonly)
An Array containing the delayed (end of run) notifications triggered by resources during the converge phase of the chef run.
139 140 141 |
# File 'lib/chef/run_context.rb', line 139 def delayed_actions @delayed_actions end |
#delayed_notification_collection ⇒ Hash[String, Array[Chef::Resource::Notification]] (readonly)
A Hash containing the delayed (end of run) notifications triggered by resources during the converge phase of the chef run.
131 132 133 |
# File 'lib/chef/run_context.rb', line 131 def delayed_notification_collection @delayed_notification_collection end |
#events ⇒ Chef::EventDispatch::Dispatcher (readonly)
Event dispatcher for this run.
66 67 68 |
# File 'lib/chef/run_context.rb', line 66 def events @events end |
#immediate_notification_collection ⇒ Hash[String, Array[Chef::Resource::Notification]] (readonly)
A Hash containing the immediate notifications triggered by resources during the converge phase of the chef run.
122 123 124 |
# File 'lib/chef/run_context.rb', line 122 def immediate_notification_collection @immediate_notification_collection end |
#node ⇒ Chef::Node (readonly)
The node for this run
44 45 46 |
# File 'lib/chef/run_context.rb', line 44 def node @node end |
#parent_run_context ⇒ Chef::RunContext (readonly)
The parent run context.
85 86 87 |
# File 'lib/chef/run_context.rb', line 85 def parent_run_context @parent_run_context end |
#reboot_info ⇒ Hash
Hash of factoids for a reboot request.
73 74 75 |
# File 'lib/chef/run_context.rb', line 73 def reboot_info @reboot_info end |
#resource_collection ⇒ Chef::ResourceCollection
The collection of resources intended to be converged (and able to be notified).
95 96 97 |
# File 'lib/chef/run_context.rb', line 95 def resource_collection @resource_collection end |
Instance Method Details
#add_delayed_action(notification) ⇒ Object
Adds a delayed action to the delayed_actions
.
230 231 232 233 234 235 236 237 |
# File 'lib/chef/run_context.rb', line 230 def add_delayed_action(notification) if delayed_actions.any? { |existing_notification| existing_notification.duplicates?(notification) } Chef::Log.info( "#{notification.} not queuing delayed action #{notification.action} on #{notification.resource}"\ " (delayed), as it's already been queued") else delayed_actions << notification end end |
#before_notifications(resource) ⇒ Array[Notification]
Get the list of before notifications sent by the given resource.
244 245 246 |
# File 'lib/chef/run_context.rb', line 244 def before_notifications(resource) return before_notification_collection[resource.declared_key] end |
#cancel_reboot ⇒ Object
543 544 545 546 |
# File 'lib/chef/run_context.rb', line 543 def cancel_reboot Chef::Log.info "Changing reboot status from #{reboot_info.inspect} to {}" @reboot_info = {} end |
#create_child ⇒ Object
Create a child RunContext.
555 556 557 |
# File 'lib/chef/run_context.rb', line 555 def create_child ChildRunContext.new(self) end |
#delayed_notifications(resource) ⇒ Array[Notification]
Get the list of delayed (end of run) notifications sent by the given resource.
263 264 265 |
# File 'lib/chef/run_context.rb', line 263 def delayed_notifications(resource) return delayed_notification_collection[resource.declared_key] end |
#has_cookbook_file_in_cookbook?(cookbook, cb_file_name) ⇒ Boolean
Find out if the cookbook has the given file.
489 490 491 492 |
# File 'lib/chef/run_context.rb', line 489 def has_cookbook_file_in_cookbook?(cookbook, cb_file_name) cookbook = cookbook_collection[cookbook] cookbook.has_cookbook_file_for_node?(node, cb_file_name) end |
#has_template_in_cookbook?(cookbook, template_name) ⇒ Boolean
Find out if the cookbook has the given template.
474 475 476 477 |
# File 'lib/chef/run_context.rb', line 474 def has_template_in_cookbook?(cookbook, template_name) cookbook = cookbook_collection[cookbook] cookbook.has_template_for_node?(node, template_name) end |
#immediate_notifications(resource) ⇒ Array[Notification]
Get the list of immediate notifications sent by the given resource.
253 254 255 |
# File 'lib/chef/run_context.rb', line 253 def immediate_notifications(resource) return immediate_notification_collection[resource.declared_key] end |
#include_recipe(*recipe_names, current_cookbook: nil) ⇒ Object
Evaluates the recipes recipe_names
. Used by DSL::IncludeRecipe
280 281 282 283 284 285 286 287 288 |
# File 'lib/chef/run_context.rb', line 280 def include_recipe(*recipe_names, current_cookbook: nil) result_recipes = Array.new recipe_names.flatten.each do |recipe_name| if result = load_recipe(recipe_name, current_cookbook: current_cookbook) result_recipes << result end end result_recipes end |
#initialize_child_state ⇒ Object
Initialize state that applies to both Chef::RunContext and Chef::ChildRunContext
182 183 184 185 186 187 188 189 |
# File 'lib/chef/run_context.rb', line 182 def initialize_child_state @audits = {} @resource_collection = Chef::ResourceCollection.new(self) @before_notification_collection = Hash.new { |h, k| h[k] = [] } @immediate_notification_collection = Hash.new { |h, k| h[k] = [] } @delayed_notification_collection = Hash.new { |h, k| h[k] = [] } @delayed_actions = [] end |
#load(run_list_expansion) ⇒ Object
Triggers the compile phase of the chef run.
174 175 176 177 |
# File 'lib/chef/run_context.rb', line 174 def load(run_list_expansion) @cookbook_compiler = CookbookCompiler.new(self, run_list_expansion, events) cookbook_compiler.compile end |
#load_recipe(recipe_name, current_cookbook: nil) ⇒ Object
Evaluates the recipe recipe_name
. Used by DSL::IncludeRecipe
TODO I am sort of confused why we have both this and include_recipe …
I don't see anything different beyond accepting and returning an
array of recipes.
305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 |
# File 'lib/chef/run_context.rb', line 305 def load_recipe(recipe_name, current_cookbook: nil) Chef::Log.debug("Loading recipe #{recipe_name} via include_recipe") cookbook_name, recipe_short_name = Chef::Recipe.parse_recipe_name(recipe_name, current_cookbook: current_cookbook) if unreachable_cookbook?(cookbook_name) # CHEF-4367 Chef::Log.warn(<<-ERROR_MESSAGE) MissingCookbookDependency: Recipe `#{recipe_name}` is not in the run_list, and cookbook '#{cookbook_name}' is not a dependency of any cookbook in the run_list. To load this recipe, first add a dependency on cookbook '#{cookbook_name}' in the cookbook you're including it from in that cookbook's metadata. ERROR_MESSAGE end if loaded_fully_qualified_recipe?(cookbook_name, recipe_short_name) Chef::Log.debug("I am not loading #{recipe_name}, because I have already seen it.") false else loaded_recipe(cookbook_name, recipe_short_name) node.loaded_recipe(cookbook_name, recipe_short_name) cookbook = cookbook_collection[cookbook_name] cookbook.load_recipe(recipe_short_name, self) end end |
#load_recipe_file(recipe_file) ⇒ Chef::Recipe
Load the given recipe from a filename.
340 341 342 343 344 345 346 347 348 349 |
# File 'lib/chef/run_context.rb', line 340 def load_recipe_file(recipe_file) if !File.exist?(recipe_file) raise Chef::Exceptions::RecipeNotFound, "could not find recipe file #{recipe_file}" end Chef::Log.debug("Loading recipe file #{recipe_file}") recipe = Chef::Recipe.new("@recipe_files", recipe_file, self) recipe.from_file(recipe_file) recipe end |
#loaded_attribute(cookbook, attribute_file) ⇒ Object
Mark a given attribute file as having been loaded.
457 458 459 |
# File 'lib/chef/run_context.rb', line 457 def loaded_attribute(cookbook, attribute_file) loaded_attributes_hash["#{cookbook}::#{attribute_file}"] = true end |
#loaded_attributes ⇒ Array[String]
A list of all attributes files that have been loaded.
Stored internally using a Hash, so order is predictable.
TODO is the above statement true in a 1.9+ ruby world? Is it relevant?
400 401 402 |
# File 'lib/chef/run_context.rb', line 400 def loaded_attributes loaded_attributes_hash.keys end |
#loaded_fully_qualified_attribute?(cookbook, attribute_file) ⇒ Boolean
Find out if a given attribute file has been loaded.
447 448 449 |
# File 'lib/chef/run_context.rb', line 447 def loaded_fully_qualified_attribute?(cookbook, attribute_file) loaded_attributes_hash.has_key?("#{cookbook}::#{attribute_file}") end |
#loaded_fully_qualified_recipe?(cookbook, recipe) ⇒ Boolean
Find out if a given recipe has been loaded.
412 413 414 |
# File 'lib/chef/run_context.rb', line 412 def loaded_fully_qualified_recipe?(cookbook, recipe) loaded_recipes_hash.has_key?("#{cookbook}::#{recipe}") end |
#loaded_recipe(cookbook, recipe) ⇒ Object
Mark a given recipe as having been loaded.
435 436 437 |
# File 'lib/chef/run_context.rb', line 435 def loaded_recipe(cookbook, recipe) loaded_recipes_hash["#{cookbook}::#{recipe}"] = true end |
#loaded_recipe?(recipe) ⇒ Boolean
Find out if a given recipe has been loaded.
424 425 426 427 |
# File 'lib/chef/run_context.rb', line 424 def loaded_recipe?(recipe) cookbook, recipe_name = Chef::Recipe.parse_recipe_name(recipe) loaded_fully_qualified_recipe?(cookbook, recipe_name) end |
#loaded_recipes ⇒ Array[String]
A list of all recipes that have been loaded.
This is stored internally as a Hash, so ordering is predictable.
TODO is the above statement true in a 1.9+ ruby world? Is it relevant?
386 387 388 |
# File 'lib/chef/run_context.rb', line 386 def loaded_recipes loaded_recipes_hash.keys end |
#notifies_before(notification) ⇒ Object
Adds an before notification to the before_notification_collection
.
196 197 198 199 200 201 |
# File 'lib/chef/run_context.rb', line 196 def notifies_before(notification) # Note for the future, notification.notifying_resource may be an instance # of Chef::Resource::UnresolvedSubscribes when calling {Resource#subscribes} # with a string value. before_notification_collection[notification..declared_key] << notification end |
#notifies_delayed(notification) ⇒ Object
Adds a delayed notification to the delayed_notification_collection
.
220 221 222 223 224 225 |
# File 'lib/chef/run_context.rb', line 220 def notifies_delayed(notification) # Note for the future, notification.notifying_resource may be an instance # of Chef::Resource::UnresolvedSubscribes when calling {Resource#subscribes} # with a string value. delayed_notification_collection[notification..declared_key] << notification end |
#notifies_immediately(notification) ⇒ Object
Adds an immediate notification to the immediate_notification_collection
.
208 209 210 211 212 213 |
# File 'lib/chef/run_context.rb', line 208 def notifies_immediately(notification) # Note for the future, notification.notifying_resource may be an instance # of Chef::Resource::UnresolvedSubscribes when calling {Resource#subscribes} # with a string value. immediate_notification_collection[notification..declared_key] << notification end |
#open_stream(name: nil, **options) {|stream| ... } ⇒ EventDispatch::EventsOutputStream
Open a stream object that can be printed into and will dispatch to events
518 519 520 521 522 523 524 525 526 527 528 529 |
# File 'lib/chef/run_context.rb', line 518 def open_stream(name: nil, **) stream = EventDispatch::EventsOutputStream.new(events, name: name, **) if block_given? begin yield stream ensure stream.close end else stream end end |
#reboot_requested? ⇒ Boolean
548 549 550 |
# File 'lib/chef/run_context.rb', line 548 def reboot_requested? reboot_info.size > 0 end |
#request_reboot(reboot_info) ⇒ Object
there are options for how to handle multiple calls to these functions:
-
first call always wins (never change reboot_info once set).
-
last call always wins (happily change reboot_info whenever).
-
raise an exception on the first conflict.
-
disable reboot after this run if anyone ever calls :cancel.
-
raise an exception on any second call.
-
?
538 539 540 541 |
# File 'lib/chef/run_context.rb', line 538 def request_reboot(reboot_info) Chef::Log.info "Changing reboot status from #{self.reboot_info.inspect} to #{reboot_info.inspect}" @reboot_info = reboot_info end |
#resolve_attribute(cookbook_name, attr_file_name) ⇒ String
Look up an attribute filename.
364 365 366 367 368 369 370 371 372 |
# File 'lib/chef/run_context.rb', line 364 def resolve_attribute(cookbook_name, attr_file_name) cookbook = cookbook_collection[cookbook_name] raise Chef::Exceptions::CookbookNotFound, "could not find cookbook #{cookbook_name} while loading attribute #{name}" unless cookbook attribute_filename = cookbook.attribute_filenames_by_short_filename[attr_file_name] raise Chef::Exceptions::AttributeNotFound, "could not find filename for attribute #{attr_file_name} in cookbook #{cookbook_name}" unless attribute_filename attribute_filename end |
#unreachable_cookbook?(cookbook_name) ⇒ Boolean
Find out whether the given cookbook is in the cookbook dependency graph.
502 503 504 |
# File 'lib/chef/run_context.rb', line 502 def unreachable_cookbook?(cookbook_name) cookbook_compiler.unreachable_cookbook?(cookbook_name) end |