Class: ChefSpec::ChefFormatter

Inherits:
Chef::Formatters::Base
  • Object
show all
Defined in:
lib/chefspec/formatter.rb

Instance Method Summary collapse

Instance Method Details

#attribute_file_load_failed(path, exception) ⇒ Object

Called when an attribute file fails to load.



143
144
145
 
# File 'lib/chefspec/formatter.rb', line 143

def attribute_file_load_failed(path, exception)
  file_load_failed(path, exception)
end

#attribute_file_loaded(path) ⇒ Object

Called after the attribute file is loaded



140
 
# File 'lib/chefspec/formatter.rb', line 140

def attribute_file_loaded(path); end

#attribute_load_complete ⇒ Object

Called when attribute file loading is finished



148
 
# File 'lib/chefspec/formatter.rb', line 148

def attribute_load_complete; end

#attribute_load_start(attribute_file_count) ⇒ Object

Called before attribute files are loaded



137
 
# File 'lib/chefspec/formatter.rb', line 137

def attribute_load_start(attribute_file_count); end

#converge_complete ⇒ Object

Called when the converge phase is finished.



190
 
# File 'lib/chefspec/formatter.rb', line 190

def converge_complete; end

#converge_start(run_context) ⇒ Object

Called before convergence starts



187
 
# File 'lib/chefspec/formatter.rb', line 187

def converge_start(run_context); end

#cookbook_clean_complete ⇒ Object

Called when cookbook cleaning is finished.



86
 
# File 'lib/chefspec/formatter.rb', line 86

def cookbook_clean_complete; end

#cookbook_clean_start ⇒ Object

Called before unneeded cookbooks are removed



78
 
# File 'lib/chefspec/formatter.rb', line 78

def cookbook_clean_start; end

#cookbook_resolution_complete(cookbook_collection) ⇒ Object

Called when the cookbook collection is returned from the server.



75
 
# File 'lib/chefspec/formatter.rb', line 75

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.



67
68
69
70
71
72
 
# File 'lib/chefspec/formatter.rb', line 67

def cookbook_resolution_failed(expanded_run_list, exception)
  expecting_exception(exception) do
    description = Chef::Formatters::ErrorMapper.cookbook_resolution_failed(expanded_run_list, exception)
    display_error(description)
  end
end

#cookbook_resolution_start(expanded_run_list) ⇒ Object

Called before the cookbook collection is fetched from the server.



63
 
# File 'lib/chefspec/formatter.rb', line 63

def cookbook_resolution_start(expanded_run_list); end

#cookbook_sync_complete ⇒ Object

Called after all cookbooks have been sync’d.



106
 
# File 'lib/chefspec/formatter.rb', line 106

def cookbook_sync_complete; end

#cookbook_sync_failed(cookbooks, exception) ⇒ Object

Called when an error occurs during cookbook sync



98
99
100
101
102
103
 
# File 'lib/chefspec/formatter.rb', line 98

def cookbook_sync_failed(cookbooks, exception)
  expecting_exception(exception) do
    description = Chef::Formatters::ErrorMapper.cookbook_sync_failed(cookbooks, exception)
    display_error(description)
  end
end

#cookbook_sync_start(cookbook_count) ⇒ Object

Called before cookbook sync starts



89
 
# File 'lib/chefspec/formatter.rb', line 89

def cookbook_sync_start(cookbook_count); end

#definition_file_load_failed(path, exception) ⇒ Object

Called when a resource definition file fails to load



157
158
159
 
# File 'lib/chefspec/formatter.rb', line 157

def definition_file_load_failed(path, exception)
  file_load_failed(path, exception)
end

#definition_file_loaded(path) ⇒ Object

Called when a resource definition has been loaded



154
 
# File 'lib/chefspec/formatter.rb', line 154

def definition_file_loaded(path); end

#definition_load_complete ⇒ Object

Called when resource defintions are done loading



162
 
# File 'lib/chefspec/formatter.rb', line 162

def definition_load_complete; end

#definition_load_start(definition_file_count) ⇒ Object

Called before resource definitions are loaded



151
 
# File 'lib/chefspec/formatter.rb', line 151

def definition_load_start(definition_file_count); end

#handler_executed(handler) ⇒ Object

Called after an individual handler has run



238
 
# File 'lib/chefspec/formatter.rb', line 238

def handler_executed(handler); end

#handlers_completed ⇒ Object

Called after all handlers have executed



241
 
# File 'lib/chefspec/formatter.rb', line 241

def handlers_completed; end

#handlers_start(handler_count) ⇒ Object

Called before handlers run



235
 
# File 'lib/chefspec/formatter.rb', line 235

def handlers_start(handler_count); end

#library_file_load_failed(path, exception) ⇒ Object

Called when a library file has an error on load.



115
116
117
 
# File 'lib/chefspec/formatter.rb', line 115

def library_file_load_failed(path, exception)
  file_load_failed(path, exception)
end

#library_file_loaded(path) ⇒ Object

Called when library file has been loaded



112
 
# File 'lib/chefspec/formatter.rb', line 112

def library_file_loaded(path); end

#library_load_complete ⇒ Object

Called when library file loading has finished



120
 
# File 'lib/chefspec/formatter.rb', line 120

def library_load_complete; end

#library_load_start(file_count) ⇒ Object

Called when library file loading starts



109
 
# File 'lib/chefspec/formatter.rb', line 109

def library_load_start(file_count); end

#lwrp_file_load_failed(path, exception) ⇒ Object

Called after a LWR or LWP file errors on load



129
130
131
 
# File 'lib/chefspec/formatter.rb', line 129

def lwrp_file_load_failed(path, exception)
  file_load_failed(path, exception)
end

#lwrp_file_loaded(path) ⇒ Object

Called after a LWR or LWP has been loaded



126
 
# File 'lib/chefspec/formatter.rb', line 126

def lwrp_file_loaded(path); end

#lwrp_load_complete ⇒ Object

Called when LWRPs are finished loading



134
 
# File 'lib/chefspec/formatter.rb', line 134

def lwrp_load_complete; end

#lwrp_load_start(lwrp_file_count) ⇒ Object

Called when LWRP loading starts



123
 
# File 'lib/chefspec/formatter.rb', line 123

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.



255
 
# File 'lib/chefspec/formatter.rb', line 255

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.



60
 
# File 'lib/chefspec/formatter.rb', line 60

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



42
43
44
45
46
47
 
# File 'lib/chefspec/formatter.rb', line 42

def node_load_failed(node_name, exception, config)
  expecting_exception(exception) do
    description = Chef::Formatters::ErrorMapper.node_load_failed(node_name, exception, config)
    display_error(description)
  end
end

#node_load_start(node_name, config) ⇒ Object

Called before Chef client loads the node data from the server



39
 
# File 'lib/chefspec/formatter.rb', line 39

def node_load_start(node_name, config); end

#ohai_completed(node) ⇒ Object

Called right after ohai runs.



20
 
# File 'lib/chefspec/formatter.rb', line 20

def ohai_completed(node); end

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

Called when an assertion declared by a provider fails



244
 
# File 'lib/chefspec/formatter.rb', line 244

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

#recipe_file_load_failed(path, exception) ⇒ Object

Called after a recipe file fails to load



171
172
173
 
# File 'lib/chefspec/formatter.rb', line 171

def recipe_file_load_failed(path, exception)
  file_load_failed(path, exception)
end

#recipe_file_loaded(path) ⇒ Object

Called after the recipe has been loaded



168
 
# File 'lib/chefspec/formatter.rb', line 168

def recipe_file_loaded(path); end

#recipe_load_complete ⇒ Object

Called when recipes have been loaded.



184
 
# File 'lib/chefspec/formatter.rb', line 184

def recipe_load_complete; end

#recipe_load_start(recipe_count) ⇒ Object

Called before recipes are loaded



165
 
# File 'lib/chefspec/formatter.rb', line 165

def recipe_load_start(recipe_count); end

#recipe_not_found(exception) ⇒ Object

Called when a recipe cannot be resolved



176
177
178
179
180
181
 
# File 'lib/chefspec/formatter.rb', line 176

def recipe_not_found(exception)
  expecting_exception(exception) do
    description = Chef::Formatters::ErrorMapper.file_load_failed(nil, exception)
    display_error(description)
  end
end

#registration_completed ⇒ Object 



28
 
# File 'lib/chefspec/formatter.rb', line 28

def registration_completed; end

#registration_failed(node_name, exception, config) ⇒ Object

Failed to register this client with the server.



31
32
33
34
35
36
 
# File 'lib/chefspec/formatter.rb', line 31

def registration_failed(node_name, exception, config)
  expecting_exception(exception) do
    description = Chef::Formatters::ErrorMapper.registration_failed(node_name, exception, config)
    display_error(description)
  end
end

#registration_start(node_name, config) ⇒ Object

About to attempt to register as node_name



26
 
# File 'lib/chefspec/formatter.rb', line 26

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.



83
 
# File 'lib/chefspec/formatter.rb', line 83

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.



193
 
# File 'lib/chefspec/formatter.rb', line 193

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



220
 
# File 'lib/chefspec/formatter.rb', line 220

def resource_bypassed(resource, action, current_resource); end

#resource_completed(resource) ⇒ Object

Called when a resource action has been completed



210
 
# File 'lib/chefspec/formatter.rb', line 210

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.



217
 
# File 'lib/chefspec/formatter.rb', line 217

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.



213
 
# File 'lib/chefspec/formatter.rb', line 213

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.



199
200
201
202
203
204
 
# File 'lib/chefspec/formatter.rb', line 199

def resource_failed(resource, action, exception)
  expecting_exception(exception) do
    description = Chef::Formatters::ErrorMapper.resource_failed(resource, action, exception)
    display_error(description)
  end
end

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

Called when a resource fails, but will retry.



196
 
# File 'lib/chefspec/formatter.rb', line 196

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



207
 
# File 'lib/chefspec/formatter.rb', line 207

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.



223
 
# File 'lib/chefspec/formatter.rb', line 223

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.



228
 
# File 'lib/chefspec/formatter.rb', line 228

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.



232
 
# File 'lib/chefspec/formatter.rb', line 232

def resource_updated(resource, action); end

#run_completed(node) ⇒ Object

Called at the end a successful Chef run.



14
 
# File 'lib/chefspec/formatter.rb', line 14

def run_completed(node); end

#run_failed(exception) ⇒ Object

Called at the end of a failed Chef run.



17
 
# File 'lib/chefspec/formatter.rb', line 17

def run_failed(exception); end

#run_list_expand_failed(node, exception) ⇒ Object

Error expanding the run list



50
51
52
53
54
55
 
# File 'lib/chefspec/formatter.rb', line 50

def run_list_expand_failed(node, exception)
  expecting_exception(exception) do
    description = Chef::Formatters::ErrorMapper.run_list_expand_failed(node, exception)
    display_error(description)
  end
end

#run_start(version) ⇒ Object

Called at the very start of a Chef Run



9
 
# File 'lib/chefspec/formatter.rb', line 9

def run_start(version); end

#run_started(run_status) ⇒ Object 



11
 
# File 'lib/chefspec/formatter.rb', line 11

def run_started(run_status); end

#skipping_registration(node_name, config) ⇒ Object

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



23
 
# File 'lib/chefspec/formatter.rb', line 23

def skipping_registration(node_name, config); end

#synchronized_cookbook(cookbook_name) ⇒ Object

Called when cookbook cookbook_name has been sync’d



92
 
# File 'lib/chefspec/formatter.rb', line 92

def synchronized_cookbook(cookbook_name); end

#updated_cookbook_file(cookbook_name, path) ⇒ Object

Called when an individual file in a cookbook has been updated



95
 
# File 'lib/chefspec/formatter.rb', line 95

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



248
 
# File 'lib/chefspec/formatter.rb', line 248

def whyrun_assumption(action, resource, message); end