Class: Chef::EventDispatch::Base

Inherits:
Object
  • Object
show all
Defined in:
lib/chef/event_dispatch/base.rb

Overview

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.

Instance Method Summary collapse

Instance Method Details

#attribute_file_load_failed(path, exception) ⇒ Object

Called when an attribute file fails to load.



207
208
 
# File 'lib/chef/event_dispatch/base.rb', line 207

def attribute_file_load_failed(path, exception)
end

#attribute_file_loaded(path) ⇒ Object

Called after the attribute file is loaded



203
204
 
# File 'lib/chef/event_dispatch/base.rb', line 203

def attribute_file_loaded(path)
end

#attribute_load_complete ⇒ Object

Called when attribute file loading is finished



211
212
 
# File 'lib/chef/event_dispatch/base.rb', line 211

def attribute_load_complete
end

#attribute_load_start(attribute_file_count) ⇒ Object

Called before attribute files are loaded



199
200
 
# File 'lib/chef/event_dispatch/base.rb', line 199

def attribute_load_start(attribute_file_count)
end

#audit_phase_complete(audit_output) ⇒ Object

Called when audit phase successfully finishes



272
273
 
# File 'lib/chef/event_dispatch/base.rb', line 272

def audit_phase_complete(audit_output)
end

#audit_phase_failed(exception, audit_output) ⇒ Object

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)



278
279
 
# File 'lib/chef/event_dispatch/base.rb', line 278

def audit_phase_failed(exception, audit_output)
end

#audit_phase_start(run_status) ⇒ Object

Called before audit phase starts



268
269
 
# File 'lib/chef/event_dispatch/base.rb', line 268

def audit_phase_start(run_status)
end

#control_example_failure(control_group_name, example_data, error) ⇒ Object

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



290
291
 
# File 'lib/chef/event_dispatch/base.rb', line 290

def control_example_failure(control_group_name, example_data, error)
end

#control_example_success(control_group_name, example_data) ⇒ Object

An example in a ‘control_group` block completed successfully



286
287
 
# File 'lib/chef/event_dispatch/base.rb', line 286

def control_example_success(control_group_name, example_data)
end

#control_group_started(name) ⇒ Object

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



282
283
 
# File 'lib/chef/event_dispatch/base.rb', line 282

def control_group_started(name)
end

#converge_complete ⇒ Object

Called when the converge phase is finished.



255
256
 
# File 'lib/chef/event_dispatch/base.rb', line 255

def converge_complete
end

#converge_failed(exception) ⇒ Object

Called if the converge phase fails



259
260
 
# File 'lib/chef/event_dispatch/base.rb', line 259

def converge_failed(exception)
end

#converge_start(run_context) ⇒ Object

Called before convergence starts



251
252
 
# File 'lib/chef/event_dispatch/base.rb', line 251

def converge_start(run_context)
end

#cookbook_clean_complete ⇒ Object

Called when cookbook cleaning is finished.



119
120
 
# File 'lib/chef/event_dispatch/base.rb', line 119

def cookbook_clean_complete
end

#cookbook_clean_start ⇒ Object

Called before unneeded cookbooks are removed



109
110
 
# File 'lib/chef/event_dispatch/base.rb', line 109

def cookbook_clean_start
end

#cookbook_gem_failed(exception) ⇒ Object

Called when cookbook gem installation fails



159
160
 
# File 'lib/chef/event_dispatch/base.rb', line 159

def cookbook_gem_failed(exception)
end

#cookbook_gem_finished ⇒ Object

Called when finished installing cookbook gems



155
156
 
# File 'lib/chef/event_dispatch/base.rb', line 155

def cookbook_gem_finished
end

#cookbook_gem_installing(gem, version) ⇒ Object

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



147
148
 
# File 'lib/chef/event_dispatch/base.rb', line 147

def cookbook_gem_installing(gem, version)
end

#cookbook_gem_start(gems) ⇒ Object

Called when starting to collect gems from the cookbooks



143
144
 
# File 'lib/chef/event_dispatch/base.rb', line 143

def cookbook_gem_start(gems)
end

#cookbook_gem_using(gem, version) ⇒ Object

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



151
152
 
# File 'lib/chef/event_dispatch/base.rb', line 151

def cookbook_gem_using(gem, version)
end

#cookbook_resolution_complete(cookbook_collection) ⇒ Object

Called when the cookbook collection is returned from the server.



105
106
 
# File 'lib/chef/event_dispatch/base.rb', line 105

def cookbook_resolution_complete(cookbook_collection)
end

#cookbook_resolution_failed(expanded_run_list, exception) ⇒ Object

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



101
102
 
# File 'lib/chef/event_dispatch/base.rb', line 101

def cookbook_resolution_failed(expanded_run_list, exception)
end

#cookbook_resolution_start(expanded_run_list) ⇒ Object

Called before the cookbook collection is fetched from the server.



96
97
 
# File 'lib/chef/event_dispatch/base.rb', line 96

def cookbook_resolution_start(expanded_run_list)
end

#cookbook_sync_complete ⇒ Object

Called after all cookbooks have been sync’d.



139
140
 
# File 'lib/chef/event_dispatch/base.rb', line 139

def cookbook_sync_complete
end

#cookbook_sync_failed(cookbooks, exception) ⇒ Object

Called when an error occurs during cookbook sync



135
136
 
# File 'lib/chef/event_dispatch/base.rb', line 135

def cookbook_sync_failed(cookbooks, exception)
end

#cookbook_sync_start(cookbook_count) ⇒ Object

Called before cookbook sync starts



123
124
 
# File 'lib/chef/event_dispatch/base.rb', line 123

def cookbook_sync_start(cookbook_count)
end

#definition_file_load_failed(path, exception) ⇒ Object

Called when a resource definition file fails to load



223
224
 
# File 'lib/chef/event_dispatch/base.rb', line 223

def definition_file_load_failed(path, exception)
end

#definition_file_loaded(path) ⇒ Object

Called when a resource definition has been loaded



219
220
 
# File 'lib/chef/event_dispatch/base.rb', line 219

def definition_file_loaded(path)
end

#definition_load_complete ⇒ Object

Called when resource definitions are done loading



227
228
 
# File 'lib/chef/event_dispatch/base.rb', line 227

def definition_load_complete
end

#definition_load_start(definition_file_count) ⇒ Object

Called before resource definitions are loaded



215
216
 
# File 'lib/chef/event_dispatch/base.rb', line 215

def definition_load_start(definition_file_count)
end

#deprecation(message, location = caller(2..2)[0]) ⇒ Object

Emit a message about something being deprecated.



410
411
 
# File 'lib/chef/event_dispatch/base.rb', line 410

def deprecation(message, location = caller(2..2)[0])
end

#handler_executed(handler) ⇒ Object

Called after an individual handler has run



393
394
 
# File 'lib/chef/event_dispatch/base.rb', line 393

def handler_executed(handler)
end

#handlers_completed ⇒ Object

Called after all handlers have executed



397
398
 
# File 'lib/chef/event_dispatch/base.rb', line 397

def handlers_completed
end

#handlers_start(handler_count) ⇒ Object

Called before handlers run



389
390
 
# File 'lib/chef/event_dispatch/base.rb', line 389

def handlers_start(handler_count)
end

#library_file_load_failed(path, exception) ⇒ Object

Called when a library file has an error on load.



175
176
 
# File 'lib/chef/event_dispatch/base.rb', line 175

def library_file_load_failed(path, exception)
end

#library_file_loaded(path) ⇒ Object

Called when library file has been loaded



171
172
 
# File 'lib/chef/event_dispatch/base.rb', line 171

def library_file_loaded(path)
end

#library_load_complete ⇒ Object

Called when library file loading has finished



179
180
 
# File 'lib/chef/event_dispatch/base.rb', line 179

def library_load_complete
end

#library_load_start(file_count) ⇒ Object

Called when library file loading starts



167
168
 
# File 'lib/chef/event_dispatch/base.rb', line 167

def library_load_start(file_count)
end

#lwrp_file_load_failed(path, exception) ⇒ Object

Called after a LWR or LWP file errors on load



191
192
 
# File 'lib/chef/event_dispatch/base.rb', line 191

def lwrp_file_load_failed(path, exception)
end

#lwrp_file_loaded(path) ⇒ Object

Called after a LWR or LWP has been loaded



187
188
 
# File 'lib/chef/event_dispatch/base.rb', line 187

def lwrp_file_loaded(path)
end

#lwrp_load_complete ⇒ Object

Called when LWRPs are finished loading



195
196
 
# File 'lib/chef/event_dispatch/base.rb', line 195

def lwrp_load_complete
end

#lwrp_load_start(lwrp_file_count) ⇒ Object

Called when LWRP loading starts



183
184
 
# File 'lib/chef/event_dispatch/base.rb', line 183

def lwrp_load_start(lwrp_file_count)
end

#msg(message) ⇒ Object

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.



421
422
 
# File 'lib/chef/event_dispatch/base.rb', line 421

def msg(message)
end

#node_load_completed(node, expanded_run_list, config) ⇒ Object

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.



87
88
 
# 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) ⇒ Object

Failed to load node data from the server



77
78
 
# File 'lib/chef/event_dispatch/base.rb', line 77

def node_load_failed(node_name, exception, config)
end

#node_load_start(node_name, config) ⇒ Object

Called before Chef client loads the node data from the server



71
72
 
# File 'lib/chef/event_dispatch/base.rb', line 71

def node_load_start(node_name, config)
end

#ohai_completed(node) ⇒ Object

Called right after ohai runs.



47
48
 
# File 'lib/chef/event_dispatch/base.rb', line 47

def ohai_completed(node)
end

#policyfile_loaded(policy) ⇒ Object

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



92
93
 
# File 'lib/chef/event_dispatch/base.rb', line 92

def policyfile_loaded(policy)
end

#provider_requirement_failed(action, resource, exception, message) ⇒ Object

Called when an assertion declared by a provider fails



401
402
 
# File 'lib/chef/event_dispatch/base.rb', line 401

def provider_requirement_failed(action, resource, exception, message)
end

#recipe_file_load_failed(path, exception) ⇒ Object

Called after a recipe file fails to load



239
240
 
# File 'lib/chef/event_dispatch/base.rb', line 239

def recipe_file_load_failed(path, exception)
end

#recipe_file_loaded(path) ⇒ Object

Called after the recipe has been loaded



235
236
 
# File 'lib/chef/event_dispatch/base.rb', line 235

def recipe_file_loaded(path)
end

#recipe_load_complete ⇒ Object

Called when recipes have been loaded.



247
248
 
# File 'lib/chef/event_dispatch/base.rb', line 247

def recipe_load_complete
end

#recipe_load_start(recipe_count) ⇒ Object

Called before recipes are loaded



231
232
 
# File 'lib/chef/event_dispatch/base.rb', line 231

def recipe_load_start(recipe_count)
end

#recipe_not_found(exception) ⇒ Object

Called when a recipe cannot be resolved



243
244
 
# File 'lib/chef/event_dispatch/base.rb', line 243

def recipe_not_found(exception)
end

#registration_completed ⇒ Object

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



63
64
 
# File 'lib/chef/event_dispatch/base.rb', line 63

def registration_completed
end

#registration_failed(node_name, exception, config) ⇒ Object

Failed to register this client with the server.



67
68
 
# File 'lib/chef/event_dispatch/base.rb', line 67

def registration_failed(node_name, exception, config)
end

#registration_start(node_name, config) ⇒ Object

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



58
59
 
# File 'lib/chef/event_dispatch/base.rb', line 58

def registration_start(node_name, config)
end

#removed_cookbook_file(path) ⇒ Object

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.



115
116
 
# 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) ⇒ Object

Called before action is executed on a resource.



321
322
 
# File 'lib/chef/event_dispatch/base.rb', line 321

def resource_action_start(resource, action, notification_type = nil, notifier = nil)
end

#resource_bypassed(resource, action, current_resource) ⇒ Object

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



338
339
 
# File 'lib/chef/event_dispatch/base.rb', line 338

def resource_bypassed(resource, action, current_resource)
end

#resource_completed(resource) ⇒ Object

Called when a resource action has been completed



371
372
 
# File 'lib/chef/event_dispatch/base.rb', line 371

def resource_completed(resource)
end

#resource_current_state_load_bypassed(resource, action, current_resource) ⇒ Object

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



334
335
 
# File 'lib/chef/event_dispatch/base.rb', line 334

def resource_current_state_load_bypassed(resource, action, current_resource)
end

#resource_current_state_loaded(resource, action, current_resource) ⇒ Object

Called after #load_current_resource has run.



329
330
 
# File 'lib/chef/event_dispatch/base.rb', line 329

def resource_current_state_loaded(resource, action, current_resource)
end

#resource_failed(resource, action, exception) ⇒ Object

Called when a resource fails and will not be retried.



358
359
 
# File 'lib/chef/event_dispatch/base.rb', line 358

def resource_failed(resource, action, exception)
end

#resource_failed_retriable(resource, action, retry_count, exception) ⇒ Object

Called when a resource fails, but will retry.



354
355
 
# File 'lib/chef/event_dispatch/base.rb', line 354

def resource_failed_retriable(resource, action, retry_count, exception)
end

#resource_skipped(resource, action, conditional) ⇒ Object

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



325
326
 
# File 'lib/chef/event_dispatch/base.rb', line 325

def resource_skipped(resource, action, conditional)
end

#resource_up_to_date(resource, action) ⇒ Object

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



367
368
 
# File 'lib/chef/event_dispatch/base.rb', line 367

def resource_up_to_date(resource, action)
end

#resource_update_applied(resource, action, update) ⇒ Object

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.



344
345
 
# File 'lib/chef/event_dispatch/base.rb', line 344

def resource_update_applied(resource, action, update)
end

#resource_update_progress(resource, current, total, interval) ⇒ Object

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.



350
351
 
# File 'lib/chef/event_dispatch/base.rb', line 350

def resource_update_progress(resource, current, total, interval)
end

#resource_updated(resource, action) ⇒ Object

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



363
364
 
# File 'lib/chef/event_dispatch/base.rb', line 363

def resource_updated(resource, action)
end

#run_completed(node) ⇒ Object

Called at the end a successful Chef run.



39
40
 
# File 'lib/chef/event_dispatch/base.rb', line 39

def run_completed(node)
end

#run_failed(exception) ⇒ Object

Called at the end of a failed Chef run.



43
44
 
# File 'lib/chef/event_dispatch/base.rb', line 43

def run_failed(exception)
end

#run_list_expand_failed(node, exception) ⇒ Object

Error expanding the run list



81
82
 
# File 'lib/chef/event_dispatch/base.rb', line 81

def run_list_expand_failed(node, exception)
end

#run_list_expanded(run_list_expansion) ⇒ Object 



413
414
 
# File 'lib/chef/event_dispatch/base.rb', line 413

def run_list_expanded(run_list_expansion)
end

#run_start(version) ⇒ Object

Called at the very start of a Chef Run



32
33
 
# File 'lib/chef/event_dispatch/base.rb', line 32

def run_start(version)
end

#run_started(run_status) ⇒ Object 



35
36
 
# File 'lib/chef/event_dispatch/base.rb', line 35

def run_started(run_status)
end

#skipping_registration(node_name, config) ⇒ Object

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.



53
54
 
# File 'lib/chef/event_dispatch/base.rb', line 53

def skipping_registration(node_name, config)
end

#stream_closed(stream, options = {}) ⇒ Object

A stream has closed.



379
380
 
# File 'lib/chef/event_dispatch/base.rb', line 379

def stream_closed(stream, options = {})
end

#stream_opened(stream, options = {}) ⇒ Object

A stream has opened.



375
376
 
# File 'lib/chef/event_dispatch/base.rb', line 375

def stream_opened(stream, options = {})
end

#stream_output(stream, output, options = {}) ⇒ Object

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.



385
386
 
# File 'lib/chef/event_dispatch/base.rb', line 385

def stream_output(stream, output, options = {})
end

#synchronized_cookbook(cookbook_name, cookbook) ⇒ Object

Called when cookbook cookbook has been sync’d



127
128
 
# File 'lib/chef/event_dispatch/base.rb', line 127

def synchronized_cookbook(cookbook_name, cookbook)
end

#updated_cookbook_file(cookbook_name, path) ⇒ Object

Called when an individual file in a cookbook has been updated



131
132
 
# File 'lib/chef/event_dispatch/base.rb', line 131

def updated_cookbook_file(cookbook_name, path)
end

#whyrun_assumption(action, resource, message) ⇒ Object

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



406
407
 
# File 'lib/chef/event_dispatch/base.rb', line 406

def whyrun_assumption(action, resource, message)
end