class Chef::Formatters::Doc

Formatter similar to RSpec's documentation formatter. Uses indentation to show context.

Attributes

end_time[R]
failed_audits[R]
start_time[R]
successful_audits[R]

Public Class Methods

new(out, err) click to toggle source
Calls superclass method Chef::Formatters::Base.new
# File lib/chef/formatters/doc.rb, line 16
def initialize(out, err)
  super

  @updated_resources = 0
  @up_to_date_resources = 0
  @successful_audits = 0
  @failed_audits = 0
  @start_time = Time.now
  @end_time = @start_time
  @skipped_resources = 0
  @progress = {}
end

Public Instance Methods

audit_phase_complete(audit_output) click to toggle source
# File lib/chef/formatters/doc.rb, line 247
def audit_phase_complete(audit_output)
  puts_line audit_output
  puts_line "Auditing complete"
end
audit_phase_failed(error, audit_output) click to toggle source
# File lib/chef/formatters/doc.rb, line 252
def audit_phase_failed(error, audit_output)
  puts_line audit_output
  puts_line ""
  puts_line "Audit phase exception:"
  indent
  puts_line "#{error.message}"
  if error.backtrace
    error.backtrace.each do |l|
      puts_line l
    end
  end
end
audit_phase_start(run_status) click to toggle source

Called before audit phase starts

# File lib/chef/formatters/doc.rb, line 243
def audit_phase_start(run_status)
  puts_line "Starting audit phase"
end
control_example_failure(control_group_name, example_data, error) click to toggle source
# File lib/chef/formatters/doc.rb, line 269
def control_example_failure(control_group_name, example_data, error)
  @failed_audits += 1
end
control_example_success(control_group_name, example_data) click to toggle source
# File lib/chef/formatters/doc.rb, line 265
def control_example_success(control_group_name, example_data)
  @successful_audits += 1
end
converge_complete() click to toggle source

Called when the converge phase is finished.

# File lib/chef/formatters/doc.rb, line 233
def converge_complete
  unindent if @current_recipe
end
converge_failed(e) click to toggle source
# File lib/chef/formatters/doc.rb, line 237
def converge_failed(e)
  # Currently a failed converge is handled the same way as a successful converge
  converge_complete
end
converge_start(run_context) click to toggle source

Called before convergence starts

# File lib/chef/formatters/doc.rb, line 228
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 165
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 155
def cookbook_clean_start
end
cookbook_gem_failed(exception) click to toggle source

Called when cookbook gem installation fails

# File lib/chef/formatters/doc.rb, line 210
def cookbook_gem_failed(exception)
  unindent
end
cookbook_gem_finished() click to toggle source

Called when finished installing cookbook gems

# File lib/chef/formatters/doc.rb, line 205
def cookbook_gem_finished
  unindent
end
cookbook_gem_installing(gem, version) click to toggle source

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

# File lib/chef/formatters/doc.rb, line 195
def cookbook_gem_installing(gem, version)
  puts_line "- Installing #{gem} #{version}", :green
end
cookbook_gem_start(gems) click to toggle source

Called when starting to collect gems from the cookbooks

# File lib/chef/formatters/doc.rb, line 189
def cookbook_gem_start(gems)
  puts_line "Installing Cookbook Gems:"
  indent
end
cookbook_gem_using(gem, version) click to toggle source

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

# File lib/chef/formatters/doc.rb, line 200
def cookbook_gem_using(gem, version)
  puts_line "- Using #{gem} #{version}"
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 151
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 146
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 140
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 184
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 169
def cookbook_sync_start(cookbook_count)
  puts_line "Synchronizing Cookbooks:"
  indent
end
deprecation(message, location = caller(2..2)[0]) click to toggle source
Calls superclass method Chef::Formatters::Base#deprecation
# File lib/chef/formatters/doc.rb, line 417
def deprecation(message, location = caller(2..2)[0])
  if Chef::Config[:treat_deprecation_warnings_as_errors]
    super
  end

  # Save deprecations to the screen until the end
  if is_structured_deprecation?(message)
    url = message.url
    message = message.message
  end

  deprecations[message] ||= { url: url, locations: Set.new }
  deprecations[message][:locations] << location
end
elapsed_time() click to toggle source
# File lib/chef/formatters/doc.rb, line 29
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 220
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 389
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 394
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 382
def handlers_start(handler_count)
  puts ""
  puts "Running handlers:"
  indent
end
indent() click to toggle source
# File lib/chef/formatters/doc.rb, line 432
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 215
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 132
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

Calls superclass method Chef::Formatters::Base#node_load_failed
# File lib/chef/formatters/doc.rb, line 126
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 122
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 107
def ohai_completed(node)
end
output_record(line) click to toggle source
# File lib/chef/formatters/doc.rb, line 341
def output_record(line)
end
policyfile_loaded(policy) click to toggle source
# File lib/chef/formatters/doc.rb, line 135
def policyfile_loaded(policy)
  puts_line "Using policy '#{policy["name"]}' at revision '#{policy["revision_id"]}'"
end
pretty_elapsed_time() click to toggle source
# File lib/chef/formatters/doc.rb, line 33
def pretty_elapsed_time
  time = elapsed_time
  if time < 60
    message = Time.at(time).utc.strftime("%S seconds")
  elsif time < 3600
    message = Time.at(time).utc.strftime("%M minutes %S seconds")
  else
    message = Time.at(time).utc.strftime("%H hours %M minutes %S seconds")
  end
  message
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 409
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 224
def recipe_load_complete
end
registration_completed() click to toggle source
# File lib/chef/formatters/doc.rb, line 119
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 115
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 161
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 274
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 336
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 373
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 326
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.

Calls superclass method Chef::Formatters::Base#resource_failed
# File lib/chef/formatters/doc.rb, line 312
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 308
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 318
def resource_skipped(resource, action, conditional)
  @skipped_resources += 1
  # 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 330
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 347
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_update_progress(resource, current, total, interval) click to toggle source
# File lib/chef/formatters/doc.rb, line 292
def resource_update_progress(resource, current, total, interval)
  @progress[resource] ||= 0

  percent_complete = (current.to_f / total.to_f * 100).to_i

  if percent_complete > @progress[resource]

    @progress[resource] = percent_complete

    if percent_complete % interval == 0
      start_line " - Progress: #{percent_complete}%", :green
    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 365
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 58
def run_completed(node)
  @end_time = Time.now
  # Print out deprecations.
  if !deprecations.empty?
    puts_line ""
    puts_line "Deprecated features used!"
    deprecations.each do |message, details|
      locations = details[:locations]
      if locations.size == 1
        puts_line "  #{message} at 1 location:"
      else
        puts_line "  #{message} at #{locations.size} locations:"
      end
      locations.each do |location|
        prefix = "    - "
        Array(location).each do |line|
          puts_line "#{prefix}#{line}"
          prefix = "      "
        end
      end
      unless details[:url].nil?
        puts_line "   See #{details[:url]} for further details."
      end
    end
    puts_line ""
  end
  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 #{pretty_elapsed_time}"
    if total_audits > 0
      puts_line "  #{successful_audits}/#{total_audits} controls succeeded"
    end
  end
end
run_failed(exception) click to toggle source
# File lib/chef/formatters/doc.rb, line 94
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 #{pretty_elapsed_time}"
    if total_audits > 0
      puts_line "  #{successful_audits} controls succeeded"
    end
  end
end
run_start(version) click to toggle source
# File lib/chef/formatters/doc.rb, line 45
def run_start(version)
  puts_line "Starting Chef Client, version #{version}"
  puts_line "OpenSSL FIPS 140 mode enabled" if Chef::Config[:fips]
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 111
def skipping_registration(node_name, config)
end
stream_output(stream, output, options = {}) click to toggle source
# File lib/chef/formatters/doc.rb, line 377
def stream_output(stream, output, options = {})
  print(output, { :stream => stream }.merge(options))
end
synchronized_cookbook(cookbook_name, cookbook) click to toggle source

Called when cookbook cookbook has been sync'd

# File lib/chef/formatters/doc.rb, line 175
def synchronized_cookbook(cookbook_name, cookbook)
  puts_line "- #{cookbook.name} (#{cookbook.version})"
end
total_audits() click to toggle source
# File lib/chef/formatters/doc.rb, line 54
def total_audits
  successful_audits + failed_audits
end
total_resources() click to toggle source
# File lib/chef/formatters/doc.rb, line 50
def total_resources
  @up_to_date_resources + @updated_resources + @skipped_resources
end
unindent() click to toggle source
# File lib/chef/formatters/doc.rb, line 436
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 180
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 401
def whyrun_assumption(action, resource, message)
  return unless message
  [ message ].flatten.each do |line|
    start_line("* #{line}", :yellow)
  end
end

Protected Instance Methods

deprecations() click to toggle source
# File lib/chef/formatters/doc.rb, line 442
def deprecations
  @deprecations ||= {}
end