Files

Class/Module Index [+]

Quicksearch

Chef::Formatters::Doc

Attributes

end_time[R]
start_time[R]

Public Class Methods

new(out, err) click to toggle source
# File lib/chef/formatters/doc.rb, line 14
def initialize(out, err)
  super

  @updated_resources = 0
  @up_to_date_resources = 0
  @start_time = Time.now
  @end_time = @start_time
end

Public Instance Methods

converge_complete() click to toggle source

Called when the converge phase is finished.

# File lib/chef/formatters/doc.rb, line 150
def converge_complete
  unindent if @current_recipe
end
converge_start(run_context) click to toggle source

Called before convergence starts

# File lib/chef/formatters/doc.rb, line 145
def converge_start(run_context)
  puts_line "Converging #{run_context.resource_collection.all_resources.size} resources"
end
cookbook_clean_complete() click to toggle source

Called when cookbook cleaning is finished.

# File lib/chef/formatters/doc.rb, line 108
def cookbook_clean_complete
end
cookbook_clean_start() click to toggle source

Called before unneeded cookbooks are removed

# File lib/chef/formatters/doc.rb, line 98
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/chef/formatters/doc.rb, line 94
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/formatters/doc.rb, line 89
def cookbook_resolution_failed(expanded_run_list, exception)
  super
end
cookbook_resolution_start(expanded_run_list) click to toggle source

Called before the cookbook collection is fetched from the server.

# File lib/chef/formatters/doc.rb, line 83
def cookbook_resolution_start(expanded_run_list)
  puts_line "resolving cookbooks for run list: #{expanded_run_list.inspect}"
end
cookbook_sync_complete() click to toggle source

Called after all cookbooks have been sync’d.

# File lib/chef/formatters/doc.rb, line 127
def cookbook_sync_complete
  unindent
end
cookbook_sync_start(cookbook_count) click to toggle source

Called before cookbook sync starts

# File lib/chef/formatters/doc.rb, line 112
def cookbook_sync_start(cookbook_count)
  puts_line "Synchronizing Cookbooks:"
  indent
end
elapsed_time() click to toggle source
# File lib/chef/formatters/doc.rb, line 23
def elapsed_time
  end_time - start_time
end
file_loaded(path) click to toggle source

Called after a file in a cookbook is loaded.

# File lib/chef/formatters/doc.rb, line 137
def file_loaded(path)
end
handler_executed(handler) click to toggle source

Called after an individual handler has run

# File lib/chef/formatters/doc.rb, line 255
def handler_executed(handler)
  puts_line "- #{handler.class.name}"
end
handlers_completed() click to toggle source

Called after all handlers have executed

# File lib/chef/formatters/doc.rb, line 260
def handlers_completed
  unindent
  puts_line "Running handlers complete\n"
end
handlers_start(handler_count) click to toggle source

Called before handlers run

# File lib/chef/formatters/doc.rb, line 248
def handlers_start(handler_count)
  puts ''
  puts "Running handlers:"
  indent
end
indent() click to toggle source
# File lib/chef/formatters/doc.rb, line 283
def indent
  indent_by(2)
end
library_load_start(file_count) click to toggle source

Called when cookbook loading starts.

# File lib/chef/formatters/doc.rb, line 132
def library_load_start(file_count)
  puts_line "Compiling Cookbooks..."
end
node_load_completed(node, expanded_run_list, config) click to toggle source

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/formatters/doc.rb, line 79
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/formatters/doc.rb, line 73
def node_load_failed(node_name, exception, config)
  super
end
node_load_start(node_name, config) click to toggle source
# File lib/chef/formatters/doc.rb, line 69
def node_load_start(node_name, config)
end
ohai_completed(node) click to toggle source

Called right after ohai runs.

# File lib/chef/formatters/doc.rb, line 54
def ohai_completed(node)
end
output_record(line) click to toggle source
# File lib/chef/formatters/doc.rb, line 206
def output_record(line)

end
provider_requirement_failed(action, resource, exception, message) click to toggle source

Called when an assertion declared by a provider fails

# File lib/chef/formatters/doc.rb, line 275
def provider_requirement_failed(action, resource, exception, message)
  return unless message
  color = Chef::Config[:why_run] ? :yellow : :red
  [ message ].flatten.each do |line|
    start_line("* #{line}", color)
  end
end
recipe_load_complete() click to toggle source

Called when recipes have been loaded.

# File lib/chef/formatters/doc.rb, line 141
def recipe_load_complete
end
registration_completed() click to toggle source
# File lib/chef/formatters/doc.rb, line 66
def registration_completed
end
registration_start(node_name, config) click to toggle source

About to attempt to register as node_name

# File lib/chef/formatters/doc.rb, line 62
def registration_start(node_name, config)
  puts_line "Creating a new client identity for #{node_name} using the validator key."
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/formatters/doc.rb, line 104
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/formatters/doc.rb, line 155
def resource_action_start(resource, action, notification_type=nil, notifier=nil)
  if resource.cookbook_name && resource.recipe_name
    resource_recipe = "#{resource.cookbook_name}::#{resource.recipe_name}"
  else
    resource_recipe = "<Dynamically Defined Resource>"
  end

  if resource_recipe != @current_recipe && !resource.enclosing_provider
    unindent if @current_recipe
    puts_line "Recipe: #{resource_recipe}"
    @current_recipe = resource_recipe
    indent
  end
  # TODO: info about notifies
  start_line "* #{resource} action #{action}", :stream => resource
  indent
end
resource_bypassed(resource, action, provider) click to toggle source
# File lib/chef/formatters/doc.rb, line 201
def resource_bypassed(resource, action, provider)
  puts " (Skipped: whyrun not supported by provider #{provider.class.name})", :stream => resource
  unindent
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/formatters/doc.rb, line 239
def resource_current_state_load_bypassed(resource, action, current_resource)
  puts_line("* Whyrun not supported for #{resource}, bypassing load.", :yellow)
end
resource_current_state_loaded(resource, action, current_resource) click to toggle source

Called after load_current_resource has run.

# File lib/chef/formatters/doc.rb, line 191
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/formatters/doc.rb, line 178
def resource_failed(resource, action, exception)
  super
  unindent
end
resource_failed_retriable(resource, action, retry_count, exception) click to toggle source

Called when a resource fails, but will retry.

# File lib/chef/formatters/doc.rb, line 174
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/formatters/doc.rb, line 184
def resource_skipped(resource, action, conditional)
  # TODO: more info about conditional
  puts " (skipped due to #{conditional.short_description})", :stream => resource
  unindent
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/formatters/doc.rb, line 195
def resource_up_to_date(resource, action)
  @up_to_date_resources+= 1
  puts " (up to date)", :stream => resource
  unindent
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/formatters/doc.rb, line 213
def resource_update_applied(resource, action, update)
  prefix = Chef::Config[:why_run] ? "Would " : ""
  Array(update).each do |line|
    next if line.nil?
    output_record line
    if line.kind_of? String
      start_line "- #{prefix}#{line}", :green
    elsif line.kind_of? Array
      # Expanded output - delta
      # @todo should we have a resource_update_delta callback?
      line.each do |detail|
        start_line detail, :white
      end
    end
  end
end
resource_updated(resource, action) click to toggle source

Called after a resource has been completely converged.

# File lib/chef/formatters/doc.rb, line 231
def resource_updated(resource, action)
  @updated_resources += 1
  unindent
  puts "\n"
end
run_completed(node) click to toggle source
# File lib/chef/formatters/doc.rb, line 35
def run_completed(node)
  @end_time = Time.now
  if Chef::Config[:why_run]
    puts_line "Chef Client finished, #{@updated_resources}/#{total_resources} resources would have been updated"
  else
    puts_line "Chef Client finished, #{@updated_resources}/#{total_resources} resources updated in #{elapsed_time} seconds"
  end
end
run_failed(exception) click to toggle source
# File lib/chef/formatters/doc.rb, line 44
def run_failed(exception)
  @end_time = Time.now
  if Chef::Config[:why_run]
    puts_line "Chef Client failed. #{@updated_resources} resources would have been updated"
  else
    puts_line "Chef Client failed. #{@updated_resources} resources updated in #{elapsed_time} seconds"
  end
end
run_start(version) click to toggle source
# File lib/chef/formatters/doc.rb, line 27
def run_start(version)
  puts_line "Starting Chef Client, version #{version}"
end
skipping_registration(node_name, config) click to toggle source

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

# File lib/chef/formatters/doc.rb, line 58
def skipping_registration(node_name, config)
end
stream_output(stream, output, options = {}) click to toggle source
# File lib/chef/formatters/doc.rb, line 243
def stream_output(stream, output, options = {})
  print(output, { :stream => stream }.merge(options))
end
synchronized_cookbook(cookbook_name) click to toggle source

Called when cookbook cookbook_name has been sync’d

# File lib/chef/formatters/doc.rb, line 118
def synchronized_cookbook(cookbook_name)
  puts_line "- #{cookbook_name}"
end
total_resources() click to toggle source
# File lib/chef/formatters/doc.rb, line 31
def total_resources
  @up_to_date_resources + @updated_resources
end
unindent() click to toggle source
# File lib/chef/formatters/doc.rb, line 287
def unindent
  indent_by(-2)
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/formatters/doc.rb, line 123
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/formatters/doc.rb, line 267
def whyrun_assumption(action, resource, message)
  return unless message
  [ message ].flatten.each do |line|
    start_line("* #{line}", :yellow)
  end
end

[Validate]

Generated with the Darkfish Rdoc Generator 2.