class Chef::EventDispatch::Base

EventDispatch::Base

EventDispatch::Base is a completely abstract base class that defines the API used by both the classes that collect event information and those that process them.

Public Instance Methods

attribute_changed(precedence, keys, value) click to toggle source

Called when an attribute is changed by simple assignment

# File lib/chef/event_dispatch/base.rb, line 441
def attribute_changed(precedence, keys, value)
end
attribute_file_load_failed(path, exception) click to toggle source

Called when an attribute file fails to load.

# File lib/chef/event_dispatch/base.rb, line 223
def attribute_file_load_failed(path, exception)
end
attribute_file_loaded(path) click to toggle source

Called after the attribute file is loaded

# File lib/chef/event_dispatch/base.rb, line 219
def attribute_file_loaded(path)
end
attribute_load_complete() click to toggle source

Called when attribute file loading is finished

# File lib/chef/event_dispatch/base.rb, line 227
def attribute_load_complete
end
attribute_load_start(attribute_file_count) click to toggle source

Called before attribute files are loaded

# File lib/chef/event_dispatch/base.rb, line 215
def attribute_load_start(attribute_file_count)
end
audit_phase_complete(audit_output) click to toggle source

Called when audit phase successfully finishes

# File lib/chef/event_dispatch/base.rb, line 288
def audit_phase_complete(audit_output)
end
audit_phase_failed(exception, audit_output) click to toggle source

Called if there is an uncaught exception during the audit phase. The audit runner should be catching and handling errors from the examples, so this is only uncaught errors (like bugs in our handling code)

# File lib/chef/event_dispatch/base.rb, line 294
def audit_phase_failed(exception, audit_output)
end
audit_phase_start(run_status) click to toggle source

Called before audit phase starts

# File lib/chef/event_dispatch/base.rb, line 284
def audit_phase_start(run_status)
end
control_example_failure(control_group_name, example_data, error) click to toggle source

An example in a `control_group` block failed with the provided error

# File lib/chef/event_dispatch/base.rb, line 306
def control_example_failure(control_group_name, example_data, error)
end
control_example_success(control_group_name, example_data) click to toggle source

An example in a `control_group` block completed successfully

# File lib/chef/event_dispatch/base.rb, line 302
def control_example_success(control_group_name, example_data)
end
control_group_started(name) click to toggle source

Signifies the start of a `control_group` block with a defined name

# File lib/chef/event_dispatch/base.rb, line 298
def control_group_started(name)
end
converge_complete() click to toggle source

Called when the converge phase is finished.

# File lib/chef/event_dispatch/base.rb, line 271
def converge_complete
end
converge_failed(exception) click to toggle source

Called if the converge phase fails

# File lib/chef/event_dispatch/base.rb, line 275
def converge_failed(exception)
end
converge_start(run_context) click to toggle source

Called before convergence starts

# File lib/chef/event_dispatch/base.rb, line 267
def converge_start(run_context)
end
cookbook_clean_complete() click to toggle source

Called when cookbook cleaning is finished.

# File lib/chef/event_dispatch/base.rb, line 119
def cookbook_clean_complete
end
cookbook_clean_start() click to toggle source

Called before unneeded cookbooks are removed

# File lib/chef/event_dispatch/base.rb, line 109
def cookbook_clean_start
end
cookbook_gem_failed(exception) click to toggle source

Called when cookbook gem installation fails

# File lib/chef/event_dispatch/base.rb, line 159
def cookbook_gem_failed(exception)
end
cookbook_gem_finished() click to toggle source

Called when finished installing cookbook gems

# File lib/chef/event_dispatch/base.rb, line 155
def cookbook_gem_finished
end
cookbook_gem_installing(gem, version) click to toggle source

Called when the result of installing the bundle is to install the gem

# File lib/chef/event_dispatch/base.rb, line 147
def cookbook_gem_installing(gem, version)
end
cookbook_gem_start(gems) click to toggle source

Called when starting to collect gems from the cookbooks

# File lib/chef/event_dispatch/base.rb, line 143
def cookbook_gem_start(gems)
end
cookbook_gem_using(gem, version) click to toggle source

Called when the result of installing the bundle is to use the gem

# File lib/chef/event_dispatch/base.rb, line 151
def cookbook_gem_using(gem, version)
end
cookbook_resolution_complete(cookbook_collection) click to toggle source

Called when the cookbook collection is returned from the server.

# File lib/chef/event_dispatch/base.rb, line 105
def cookbook_resolution_complete(cookbook_collection)
end
cookbook_resolution_failed(expanded_run_list, exception) click to toggle source

Called when there is an error getting the cookbook collection from the server.

# File lib/chef/event_dispatch/base.rb, line 101
def cookbook_resolution_failed(expanded_run_list, exception)
end
cookbook_resolution_start(expanded_run_list) click to toggle source

Called before the cookbook collection is fetched from the server.

# File lib/chef/event_dispatch/base.rb, line 96
def cookbook_resolution_start(expanded_run_list)
end
cookbook_sync_complete() click to toggle source

Called after all cookbooks have been sync'd.

# File lib/chef/event_dispatch/base.rb, line 139
def cookbook_sync_complete
end
cookbook_sync_failed(cookbooks, exception) click to toggle source

Called when an error occurs during cookbook sync

# File lib/chef/event_dispatch/base.rb, line 135
def cookbook_sync_failed(cookbooks, exception)
end
cookbook_sync_start(cookbook_count) click to toggle source

Called before cookbook sync starts

# File lib/chef/event_dispatch/base.rb, line 123
def cookbook_sync_start(cookbook_count)
end
definition_file_load_failed(path, exception) click to toggle source

Called when a resource definition file fails to load

# File lib/chef/event_dispatch/base.rb, line 239
def definition_file_load_failed(path, exception)
end
definition_file_loaded(path) click to toggle source

Called when a resource definition has been loaded

# File lib/chef/event_dispatch/base.rb, line 235
def definition_file_loaded(path)
end
definition_load_complete() click to toggle source

Called when resource definitions are done loading

# File lib/chef/event_dispatch/base.rb, line 243
def definition_load_complete
end
definition_load_start(definition_file_count) click to toggle source

Called before resource definitions are loaded

# File lib/chef/event_dispatch/base.rb, line 231
def definition_load_start(definition_file_count)
end
deprecation(message, location = caller(2..2)[0]) click to toggle source

Emit a message about something being deprecated.

# File lib/chef/event_dispatch/base.rb, line 426
def deprecation(message, location = caller(2..2)[0])
end
handler_executed(handler) click to toggle source

Called after an individual handler has run

# File lib/chef/event_dispatch/base.rb, line 409
def handler_executed(handler)
end
handlers_completed() click to toggle source

Called after all handlers have executed

# File lib/chef/event_dispatch/base.rb, line 413
def handlers_completed
end
handlers_start(handler_count) click to toggle source

Called before handlers run

# File lib/chef/event_dispatch/base.rb, line 405
def handlers_start(handler_count)
end
library_file_load_failed(path, exception) click to toggle source

Called when a library file has an error on load.

# File lib/chef/event_dispatch/base.rb, line 175
def library_file_load_failed(path, exception)
end
library_file_loaded(path) click to toggle source

Called when library file has been loaded

# File lib/chef/event_dispatch/base.rb, line 171
def library_file_loaded(path)
end
library_load_complete() click to toggle source

Called when library file loading has finished

# File lib/chef/event_dispatch/base.rb, line 179
def library_load_complete
end
library_load_start(file_count) click to toggle source

Called when library file loading starts

# File lib/chef/event_dispatch/base.rb, line 167
def library_load_start(file_count)
end
lwrp_file_load_failed(path, exception) click to toggle source

Called after a LWR or LWP file errors on load

# File lib/chef/event_dispatch/base.rb, line 191
def lwrp_file_load_failed(path, exception)
end
lwrp_file_loaded(path) click to toggle source

Called after a LWR or LWP has been loaded

# File lib/chef/event_dispatch/base.rb, line 187
def lwrp_file_loaded(path)
end
lwrp_load_complete() click to toggle source

Called when LWRPs are finished loading

# File lib/chef/event_dispatch/base.rb, line 195
def lwrp_load_complete
end
lwrp_load_start(lwrp_file_count) click to toggle source

Called when LWRP loading starts

# File lib/chef/event_dispatch/base.rb, line 183
def lwrp_load_start(lwrp_file_count)
end
msg(message) click to toggle source

An uncategorized message. This supports the case that a user needs to pass output that doesn't fit into one of the callbacks above. Note that there's no semantic information about the content or importance of the message. That means that if you're using this too often, you should add a callback for it.

# File lib/chef/event_dispatch/base.rb, line 437
def msg(message)
end
node_load_completed(node, expanded_run_list, config) click to toggle source

Called after Chef client has loaded the node data. Default and override attrs from roles have been computed, but not yet applied. Normal attrs from JSON have been added to the node.

# File lib/chef/event_dispatch/base.rb, line 87
def node_load_completed(node, expanded_run_list, config)
end
node_load_failed(node_name, exception, config) click to toggle source

Failed to load node data from the server

# File lib/chef/event_dispatch/base.rb, line 77
def node_load_failed(node_name, exception, config)
end
node_load_start(node_name, config) click to toggle source

Called before Chef client loads the node data from the server

# File lib/chef/event_dispatch/base.rb, line 71
def node_load_start(node_name, config)
end
ohai_completed(node) click to toggle source

Called right after ohai runs.

# File lib/chef/event_dispatch/base.rb, line 47
def ohai_completed(node)
end
ohai_plugin_file_load_failed(path, exception) click to toggle source

Called when an ohai plugin file has an error on load.

# File lib/chef/event_dispatch/base.rb, line 207
def ohai_plugin_file_load_failed(path, exception)
end
ohai_plugin_file_loaded(path) click to toggle source

Called when an ohai plugin file has been loaded

# File lib/chef/event_dispatch/base.rb, line 203
def ohai_plugin_file_loaded(path)
end
ohai_plugin_load_complete() click to toggle source

Called when an ohai plugin file loading has finished

# File lib/chef/event_dispatch/base.rb, line 211
def ohai_plugin_load_complete
end
ohai_plugin_load_start(file_count) click to toggle source

Called when an ohai plugin file loading starts

# File lib/chef/event_dispatch/base.rb, line 199
def ohai_plugin_load_start(file_count)
end
policyfile_loaded(policy) click to toggle source

Called after the Policyfile was loaded. This event only occurs when chef is in policyfile mode.

# File lib/chef/event_dispatch/base.rb, line 92
def policyfile_loaded(policy)
end
provider_requirement_failed(action, resource, exception, message) click to toggle source

Called when an assertion declared by a provider fails

# File lib/chef/event_dispatch/base.rb, line 417
def provider_requirement_failed(action, resource, exception, message)
end
recipe_file_load_failed(path, exception, recipe) click to toggle source

Called after a recipe file fails to load

# File lib/chef/event_dispatch/base.rb, line 255
def recipe_file_load_failed(path, exception, recipe)
end
recipe_file_loaded(path, recipe) click to toggle source

Called after the recipe has been loaded

# File lib/chef/event_dispatch/base.rb, line 251
def recipe_file_loaded(path, recipe)
end
recipe_load_complete() click to toggle source

Called when recipes have been loaded.

# File lib/chef/event_dispatch/base.rb, line 263
def recipe_load_complete
end
recipe_load_start(recipe_count) click to toggle source

Called before recipes are loaded

# File lib/chef/event_dispatch/base.rb, line 247
def recipe_load_start(recipe_count)
end
recipe_not_found(exception) click to toggle source

Called when a recipe cannot be resolved

# File lib/chef/event_dispatch/base.rb, line 259
def recipe_not_found(exception)
end
registration_completed() click to toggle source

Successfully created the private key and registered this client with the server.

# File lib/chef/event_dispatch/base.rb, line 63
def registration_completed
end
registration_failed(node_name, exception, config) click to toggle source

Failed to register this client with the server.

# File lib/chef/event_dispatch/base.rb, line 67
def registration_failed(node_name, exception, config)
end
registration_start(node_name, config) click to toggle source

About to attempt to create a private key registered to the server with client node_name.

# File lib/chef/event_dispatch/base.rb, line 58
def registration_start(node_name, config)
end
removed_cookbook_file(path) click to toggle source

Called after the file at path is removed. It may be removed if the cookbook containing it was removed from the run list, or if the file was removed from the cookbook.

# File lib/chef/event_dispatch/base.rb, line 115
def removed_cookbook_file(path)
end
resource_action_start(resource, action, notification_type = nil, notifier = nil) click to toggle source

Called before action is executed on a resource.

# File lib/chef/event_dispatch/base.rb, line 337
def resource_action_start(resource, action, notification_type = nil, notifier = nil)
end
resource_bypassed(resource, action, current_resource) click to toggle source

Called when evaluating a resource that does not support whyrun in whyrun mode

# File lib/chef/event_dispatch/base.rb, line 354
def resource_bypassed(resource, action, current_resource)
end
resource_completed(resource) click to toggle source

Called when a resource action has been completed

# File lib/chef/event_dispatch/base.rb, line 387
def resource_completed(resource)
end
resource_current_state_load_bypassed(resource, action, current_resource) click to toggle source

Called when resource current state load is skipped due to the provider not supporting whyrun mode.

# File lib/chef/event_dispatch/base.rb, line 350
def resource_current_state_load_bypassed(resource, action, current_resource)
end
resource_current_state_loaded(resource, action, current_resource) click to toggle source

Called after load_current_resource has run.

# File lib/chef/event_dispatch/base.rb, line 345
def resource_current_state_loaded(resource, action, current_resource)
end
resource_failed(resource, action, exception) click to toggle source

Called when a resource fails and will not be retried.

# File lib/chef/event_dispatch/base.rb, line 374
def resource_failed(resource, action, exception)
end
resource_failed_retriable(resource, action, retry_count, exception) click to toggle source

Called when a resource fails, but will retry.

# File lib/chef/event_dispatch/base.rb, line 370
def resource_failed_retriable(resource, action, retry_count, exception)
end
resource_skipped(resource, action, conditional) click to toggle source

Called when a resource action has been skipped b/c of a conditional

# File lib/chef/event_dispatch/base.rb, line 341
def resource_skipped(resource, action, conditional)
end
resource_up_to_date(resource, action) click to toggle source

Called when a resource has no converge actions, e.g., it was already correct.

# File lib/chef/event_dispatch/base.rb, line 383
def resource_up_to_date(resource, action)
end
resource_update_applied(resource, action, update) click to toggle source

Called when a change has been made to a resource. May be called multiple times per resource, e.g., a file may have its content updated, and then its permissions updated.

# File lib/chef/event_dispatch/base.rb, line 360
def resource_update_applied(resource, action, update)
end
resource_update_progress(resource, current, total, interval) click to toggle source

Called when a progress notification should be sent to the user to indicate the overall progress of a long running operation, such as a large file download.

# File lib/chef/event_dispatch/base.rb, line 366
def resource_update_progress(resource, current, total, interval)
end
resource_updated(resource, action) click to toggle source

Called after a resource has been completely converged, but only if modifications were made.

# File lib/chef/event_dispatch/base.rb, line 379
def resource_updated(resource, action)
end
run_completed(node, run_status) click to toggle source

Called at the end a successful Chef run.

# File lib/chef/event_dispatch/base.rb, line 39
def run_completed(node, run_status)
end
run_failed(exception, run_status) click to toggle source

Called at the end of a failed Chef run.

# File lib/chef/event_dispatch/base.rb, line 43
def run_failed(exception, run_status)
end
run_list_expand_failed(node, exception) click to toggle source

Error expanding the run list

# File lib/chef/event_dispatch/base.rb, line 81
def run_list_expand_failed(node, exception)
end
run_list_expanded(run_list_expansion) click to toggle source
# File lib/chef/event_dispatch/base.rb, line 429
def run_list_expanded(run_list_expansion)
end
run_start(version) click to toggle source

Called at the very start of a Chef Run

# File lib/chef/event_dispatch/base.rb, line 32
def run_start(version)
end
run_started(run_status) click to toggle source
# File lib/chef/event_dispatch/base.rb, line 35
def run_started(run_status)
end
skipping_registration(node_name, config) click to toggle source

Announce that we're not going to register the client. Generally because we already have the private key, or because we're deliberately not using a key.

# File lib/chef/event_dispatch/base.rb, line 53
def skipping_registration(node_name, config)
end
stream_closed(stream, options = {}) click to toggle source

A stream has closed.

# File lib/chef/event_dispatch/base.rb, line 395
def stream_closed(stream, options = {})
end
stream_opened(stream, options = {}) click to toggle source

A stream has opened.

# File lib/chef/event_dispatch/base.rb, line 391
def stream_opened(stream, options = {})
end
stream_output(stream, output, options = {}) click to toggle source

A chunk of data from a stream. The stream is managed by “stream,” which can be any tag whatsoever. Data in different “streams” may not be placed on the same line or even sent to the same console.

# File lib/chef/event_dispatch/base.rb, line 401
def stream_output(stream, output, options = {})
end
synchronized_cookbook(cookbook_name, cookbook) click to toggle source

Called when cookbook cookbook has been sync'd

# File lib/chef/event_dispatch/base.rb, line 127
def synchronized_cookbook(cookbook_name, cookbook)
end
updated_cookbook_file(cookbook_name, path) click to toggle source

Called when an individual file in a cookbook has been updated

# File lib/chef/event_dispatch/base.rb, line 131
def updated_cookbook_file(cookbook_name, path)
end
whyrun_assumption(action, resource, message) click to toggle source

Called when a provider makes an assumption after a failed assertion in whyrun mode, in order to allow execution to continue

# File lib/chef/event_dispatch/base.rb, line 422
def whyrun_assumption(action, resource, message)
end