class ChefSpec::ChefFormatter

Public Instance Methods

attribute_file_load_failed(path, exception) click to toggle source

Called when an attribute file fails to load.

# File lib/chefspec/formatter.rb, line 155
def attribute_file_load_failed(path, exception)
  file_load_failed(path, exception)
end
attribute_file_loaded(path) click to toggle source

Called after the attribute file is loaded

# File lib/chefspec/formatter.rb, line 152
def attribute_file_loaded(path); end
attribute_load_complete() click to toggle source

Called when attribute file loading is finished

# File lib/chefspec/formatter.rb, line 160
def attribute_load_complete; end
attribute_load_start(attribute_file_count) click to toggle source

Called before attribute files are loaded

# File lib/chefspec/formatter.rb, line 149
def attribute_load_start(attribute_file_count); end
converge_complete() click to toggle source

Called when the converge phase is finished.

# File lib/chefspec/formatter.rb, line 202
def converge_complete; end
converge_start(run_context) click to toggle source

Called before convergence starts

# File lib/chefspec/formatter.rb, line 199
def converge_start(run_context); end
cookbook_clean_complete() click to toggle source

Called when cookbook cleaning is finished.

# File lib/chefspec/formatter.rb, line 86
def cookbook_clean_complete; end
cookbook_clean_start() click to toggle source

Called before unneeded cookbooks are removed

# File lib/chefspec/formatter.rb, line 78
def cookbook_clean_start; end
cookbook_resolution_complete(cookbook_collection) click to toggle source

Called when the cookbook collection is returned from the server.

# File lib/chefspec/formatter.rb, line 75
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/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) click to toggle source

Called before the cookbook collection is fetched from the server.

# File lib/chefspec/formatter.rb, line 63
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/chefspec/formatter.rb, line 106
def cookbook_sync_complete; end
cookbook_sync_failed(cookbooks, exception) click to toggle source

Called when an error occurs during cookbook sync

# 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) click to toggle source

Called before cookbook sync starts

# File lib/chefspec/formatter.rb, line 89
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/chefspec/formatter.rb, line 169
def definition_file_load_failed(path, exception)
  file_load_failed(path, exception)
end
definition_file_loaded(path) click to toggle source

Called when a resource definition has been loaded

# File lib/chefspec/formatter.rb, line 166
def definition_file_loaded(path); end
definition_load_complete() click to toggle source

Called when resource defintions are done loading

# File lib/chefspec/formatter.rb, line 174
def definition_load_complete; end
definition_load_start(definition_file_count) click to toggle source

Called before resource definitions are loaded

# File lib/chefspec/formatter.rb, line 163
def definition_load_start(definition_file_count); end
handler_executed(handler) click to toggle source

Called after an individual handler has run

# File lib/chefspec/formatter.rb, line 250
def handler_executed(handler); end
handlers_completed() click to toggle source

Called after all handlers have executed

# File lib/chefspec/formatter.rb, line 253
def handlers_completed; end
handlers_start(handler_count) click to toggle source

Called before handlers run

# File lib/chefspec/formatter.rb, line 247
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/chefspec/formatter.rb, line 115
def library_file_load_failed(path, exception)
  file_load_failed(path, exception)
end
library_file_loaded(path) click to toggle source

Called when library file has been loaded

# File lib/chefspec/formatter.rb, line 112
def library_file_loaded(path); end
library_load_complete() click to toggle source

Called when library file loading has finished

# File lib/chefspec/formatter.rb, line 120
def library_load_complete; end
library_load_start(file_count) click to toggle source

Called when library file loading starts

# File lib/chefspec/formatter.rb, line 109
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/chefspec/formatter.rb, line 129
def lwrp_file_load_failed(path, exception)
  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/chefspec/formatter.rb, line 126
def lwrp_file_loaded(path); end
lwrp_load_complete() click to toggle source

Called when LWRPs are finished loading

# File lib/chefspec/formatter.rb, line 134
def lwrp_load_complete; end
lwrp_load_start(lwrp_file_count) click to toggle source

Called when LWRP loading starts

# File lib/chefspec/formatter.rb, line 123
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/chefspec/formatter.rb, line 267
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/chefspec/formatter.rb, line 60
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/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) click to toggle source

Called before Chef client loads the node data from the server

# File lib/chefspec/formatter.rb, line 39
def node_load_start(node_name, config); end
ohai_completed(node) click to toggle source

Called right after ohai runs.

# File lib/chefspec/formatter.rb, line 20
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/chefspec/formatter.rb, line 143
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/chefspec/formatter.rb, line 140
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/chefspec/formatter.rb, line 146
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/chefspec/formatter.rb, line 137
def ohai_plugin_load_start(file_count); end
provider_requirement_failed(action, resource, exception, message) click to toggle source

Called when an assertion declared by a provider fails

# File lib/chefspec/formatter.rb, line 256
def provider_requirement_failed(action, resource, exception, message); end
recipe_file_load_failed(path, exception) click to toggle source

Called after a recipe file fails to load

# File lib/chefspec/formatter.rb, line 183
def recipe_file_load_failed(path, exception)
  file_load_failed(path, exception)
end
recipe_file_loaded(path) click to toggle source

Called after the recipe has been loaded

# File lib/chefspec/formatter.rb, line 180
def recipe_file_loaded(path); end
recipe_load_complete() click to toggle source

Called when recipes have been loaded.

# File lib/chefspec/formatter.rb, line 196
def recipe_load_complete; end
recipe_load_start(recipe_count) click to toggle source

Called before recipes are loaded

# File lib/chefspec/formatter.rb, line 177
def recipe_load_start(recipe_count); end
recipe_not_found(exception) click to toggle source

Called when a recipe cannot be resolved

# File lib/chefspec/formatter.rb, line 188
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() click to toggle source
# File lib/chefspec/formatter.rb, line 28
def registration_completed; end
registration_failed(node_name, exception, config) click to toggle source

Failed to register this client with the server.

# 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) click to toggle source

About to attempt to register as node_name

# File lib/chefspec/formatter.rb, line 26
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/chefspec/formatter.rb, line 83
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/chefspec/formatter.rb, line 205
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/chefspec/formatter.rb, line 232
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/chefspec/formatter.rb, line 222
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/chefspec/formatter.rb, line 229
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/chefspec/formatter.rb, line 225
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/chefspec/formatter.rb, line 211
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) click to toggle source

Called when a resource fails, but will retry.

# File lib/chefspec/formatter.rb, line 208
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/chefspec/formatter.rb, line 219
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/chefspec/formatter.rb, line 235
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/chefspec/formatter.rb, line 240
def resource_update_applied(resource, action, update); 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/chefspec/formatter.rb, line 244
def resource_updated(resource, action); end
run_completed(node) click to toggle source

Called at the end a successful Chef run.

# File lib/chefspec/formatter.rb, line 14
def run_completed(node); end
run_failed(exception) click to toggle source

Called at the end of a failed Chef run.

# File lib/chefspec/formatter.rb, line 17
def run_failed(exception); end
run_list_expand_failed(node, exception) click to toggle source

Error expanding the run list

# 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) click to toggle source

Called at the very start of a Chef Run

# File lib/chefspec/formatter.rb, line 9
def run_start(version); end
run_started(run_status) click to toggle source
# File lib/chefspec/formatter.rb, line 11
def run_started(run_status); end
skipping_registration(node_name, config) click to toggle source

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

# File lib/chefspec/formatter.rb, line 23
def skipping_registration(node_name, config); end
synchronized_cookbook(cookbook_name) click to toggle source

Called when cookbook cookbook_name has been sync’d

# File lib/chefspec/formatter.rb, line 92
def synchronized_cookbook(cookbook_name); end
updated_cookbook_file(cookbook_name, path) click to toggle source

Called when an individual file in a cookbook has been updated

# File lib/chefspec/formatter.rb, line 95
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/chefspec/formatter.rb, line 260
def whyrun_assumption(action, resource, message); end

Private Instance Methods

expecting_exception(exception) { || ... } click to toggle source
# File lib/chefspec/formatter.rb, line 278
def expecting_exception(exception, &block)
  yield unless ChefSpec::ExpectException.new(exception).expected?
end
file_load_failed(path, exception) click to toggle source
# File lib/chefspec/formatter.rb, line 271
def file_load_failed(path, exception)
  expecting_exception(exception) do
    description = Chef::Formatters::ErrorMapper.file_load_failed(path, exception)
    display_error(description)
  end
end