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.



177
178
 
# File 'lib/chef/event_dispatch/base.rb', line 177

def attribute_file_load_failed(path, exception)
end

#attribute_file_loaded(path) ⇒ Object

Called after the attribute file is loaded



173
174
 
# File 'lib/chef/event_dispatch/base.rb', line 173

def attribute_file_loaded(path)
end

#attribute_load_complete ⇒ Object

Called when attribute file loading is finished



181
182
 
# File 'lib/chef/event_dispatch/base.rb', line 181

def attribute_load_complete
end

#attribute_load_start(attribute_file_count) ⇒ Object

Called before attribute files are loaded



169
170
 
# File 'lib/chef/event_dispatch/base.rb', line 169

def attribute_load_start(attribute_file_count)
end

#audit_phase_complete ⇒ Object

Called when audit phase successfully finishes



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

def audit_phase_complete
end

#audit_phase_failed(exception) ⇒ 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)



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

def audit_phase_failed(exception)
end

#audit_phase_start(run_status) ⇒ Object

Called before audit phase starts



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

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



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

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



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

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



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

def control_group_started(name)
end

#converge_complete ⇒ Object

Called when the converge phase is finished.



225
226
 
# File 'lib/chef/event_dispatch/base.rb', line 225

def converge_complete
end

#converge_failed(exception) ⇒ Object

Called if the converge phase fails



229
230
 
# File 'lib/chef/event_dispatch/base.rb', line 229

def converge_failed(exception)
end

#converge_start(run_context) ⇒ Object

Called before convergence starts



221
222
 
# File 'lib/chef/event_dispatch/base.rb', line 221

def converge_start(run_context)
end

#cookbook_clean_complete ⇒ Object

Called when cookbook cleaning is finished.



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

def cookbook_clean_complete
end

#cookbook_clean_start ⇒ Object

Called before unneeded cookbooks are removed



99
100
 
# File 'lib/chef/event_dispatch/base.rb', line 99

def cookbook_clean_start
end

#cookbook_resolution_complete(cookbook_collection) ⇒ Object

Called when the cookbook collection is returned from the server.



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

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.



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

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.



86
87
 
# File 'lib/chef/event_dispatch/base.rb', line 86

def cookbook_resolution_start(expanded_run_list)
end

#cookbook_sync_complete ⇒ Object

Called after all cookbooks have been sync’d.



129
130
 
# File 'lib/chef/event_dispatch/base.rb', line 129

def cookbook_sync_complete
end

#cookbook_sync_failed(cookbooks, exception) ⇒ Object

Called when an error occurs during cookbook sync



125
126
 
# File 'lib/chef/event_dispatch/base.rb', line 125

def cookbook_sync_failed(cookbooks, exception)
end

#cookbook_sync_start(cookbook_count) ⇒ Object

Called before cookbook sync starts



113
114
 
# File 'lib/chef/event_dispatch/base.rb', line 113

def cookbook_sync_start(cookbook_count)
end

#definition_file_load_failed(path, exception) ⇒ Object

Called when a resource definition file fails to load



193
194
 
# File 'lib/chef/event_dispatch/base.rb', line 193

def definition_file_load_failed(path, exception)
end

#definition_file_loaded(path) ⇒ Object

Called when a resource definition has been loaded



189
190
 
# File 'lib/chef/event_dispatch/base.rb', line 189

def definition_file_loaded(path)
end

#definition_load_complete ⇒ Object

Called when resource definitions are done loading



197
198
 
# File 'lib/chef/event_dispatch/base.rb', line 197

def definition_load_complete
end

#definition_load_start(definition_file_count) ⇒ Object

Called before resource definitions are loaded



185
186
 
# File 'lib/chef/event_dispatch/base.rb', line 185

def definition_load_start(definition_file_count)
end

#handler_executed(handler) ⇒ Object

Called after an individual handler has run



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

def handler_executed(handler)
end

#handlers_completed ⇒ Object

Called after all handlers have executed



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

def handlers_completed
end

#handlers_start(handler_count) ⇒ Object

Called before handlers run



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

def handlers_start(handler_count)
end

#library_file_load_failed(path, exception) ⇒ Object

Called when a library file has an error on load.



145
146
 
# File 'lib/chef/event_dispatch/base.rb', line 145

def library_file_load_failed(path, exception)
end

#library_file_loaded(path) ⇒ Object

Called when library file has been loaded



141
142
 
# File 'lib/chef/event_dispatch/base.rb', line 141

def library_file_loaded(path)
end

#library_load_complete ⇒ Object

Called when library file loading has finished



149
150
 
# File 'lib/chef/event_dispatch/base.rb', line 149

def library_load_complete
end

#library_load_start(file_count) ⇒ Object

Called when library file loading starts



137
138
 
# File 'lib/chef/event_dispatch/base.rb', line 137

def library_load_start(file_count)
end

#lwrp_file_load_failed(path, exception) ⇒ Object

Called after a LWR or LWP file errors on load



161
162
 
# File 'lib/chef/event_dispatch/base.rb', line 161

def lwrp_file_load_failed(path, exception)
end

#lwrp_file_loaded(path) ⇒ Object

Called after a LWR or LWP has been loaded



157
158
 
# File 'lib/chef/event_dispatch/base.rb', line 157

def lwrp_file_loaded(path)
end

#lwrp_load_complete ⇒ Object

Called when LWRPs are finished loading



165
166
 
# File 'lib/chef/event_dispatch/base.rb', line 165

def lwrp_load_complete
end

#lwrp_load_start(lwrp_file_count) ⇒ Object

Called when LWRP loading starts



153
154
 
# File 'lib/chef/event_dispatch/base.rb', line 153

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.



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

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.



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

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



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

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



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

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

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

Called when an assertion declared by a provider fails



342
343
 
# File 'lib/chef/event_dispatch/base.rb', line 342

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

#recipe_file_load_failed(path, exception) ⇒ Object

Called after a recipe file fails to load



209
210
 
# File 'lib/chef/event_dispatch/base.rb', line 209

def recipe_file_load_failed(path, exception)
end

#recipe_file_loaded(path) ⇒ Object

Called after the recipe has been loaded



205
206
 
# File 'lib/chef/event_dispatch/base.rb', line 205

def recipe_file_loaded(path)
end

#recipe_load_complete ⇒ Object

Called when recipes have been loaded.



217
218
 
# File 'lib/chef/event_dispatch/base.rb', line 217

def recipe_load_complete
end

#recipe_load_start(recipe_count) ⇒ Object

Called before recipes are loaded



201
202
 
# File 'lib/chef/event_dispatch/base.rb', line 201

def recipe_load_start(recipe_count)
end

#recipe_not_found(exception) ⇒ Object

Called when a recipe cannot be resolved



213
214
 
# File 'lib/chef/event_dispatch/base.rb', line 213

def recipe_not_found(exception)
end

#registration_completed ⇒ Object 



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

def registration_completed
end

#registration_failed(node_name, exception, config) ⇒ Object

Failed to register this client with the server.



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

def registration_failed(node_name, exception, config)
end

#registration_start(node_name, config) ⇒ Object

About to attempt to register as node_name



55
56
 
# File 'lib/chef/event_dispatch/base.rb', line 55

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.



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

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.



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

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



297
298
 
# File 'lib/chef/event_dispatch/base.rb', line 297

def resource_bypassed(resource, action, current_resource)
end

#resource_completed(resource) ⇒ Object

Called when a resource action has been completed



284
285
 
# File 'lib/chef/event_dispatch/base.rb', line 284

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.



293
294
 
# File 'lib/chef/event_dispatch/base.rb', line 293

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.



288
289
 
# File 'lib/chef/event_dispatch/base.rb', line 288

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.



276
277
 
# File 'lib/chef/event_dispatch/base.rb', line 276

def resource_failed(resource, action, exception)
end

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

Called when a resource fails, but will retry.



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

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



280
281
 
# File 'lib/chef/event_dispatch/base.rb', line 280

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.



301
302
 
# File 'lib/chef/event_dispatch/base.rb', line 301

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.



307
308
 
# File 'lib/chef/event_dispatch/base.rb', line 307

def resource_update_applied(resource, action, update)
end

#resource_updated(resource, action) ⇒ Object

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



312
313
 
# File 'lib/chef/event_dispatch/base.rb', line 312

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



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

def run_list_expand_failed(node, exception)
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

Already have a client key, assuming this node has registered.



51
52
 
# File 'lib/chef/event_dispatch/base.rb', line 51

def skipping_registration(node_name, config)
end

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

A stream has closed.



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

def stream_closed(stream, options = {})
end

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

A stream has opened.



316
317
 
# File 'lib/chef/event_dispatch/base.rb', line 316

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.



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

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

#synchronized_cookbook(cookbook_name) ⇒ Object

Called when cookbook cookbook_name has been sync’d



117
118
 
# File 'lib/chef/event_dispatch/base.rb', line 117

def synchronized_cookbook(cookbook_name)
end

#updated_cookbook_file(cookbook_name, path) ⇒ Object

Called when an individual file in a cookbook has been updated



121
122
 
# File 'lib/chef/event_dispatch/base.rb', line 121

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



347
348
 
# File 'lib/chef/event_dispatch/base.rb', line 347

def whyrun_assumption(action, resource, message)
end