class Chef::Formatters::Doc
Formatter similar to RSpec's documentation formatter. Uses indentation to show context.
Attributes
Public Class Methods
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 @start_time = Time.now @end_time = @start_time @skipped_resources = 0 @progress = {} end
Public Instance Methods
Called when the converge phase is finished.
# File lib/chef/formatters/doc.rb, line 222 def converge_complete unindent if @current_recipe end
# File lib/chef/formatters/doc.rb, line 226 def converge_failed(e) # Currently a failed converge is handled the same way as a successful converge converge_complete end
Called before convergence starts
# File lib/chef/formatters/doc.rb, line 217 def converge_start(run_context) puts_line "Converging #{run_context.resource_collection.all_resources.size} resources" end
Called when cookbook cleaning is finished.
# File lib/chef/formatters/doc.rb, line 154 def cookbook_clean_complete end
Called before unneeded cookbooks are removed
# File lib/chef/formatters/doc.rb, line 144 def cookbook_clean_start end
Called when cookbook gem installation fails
# File lib/chef/formatters/doc.rb, line 199 def cookbook_gem_failed(exception) unindent end
Called when finished installing cookbook gems
# File lib/chef/formatters/doc.rb, line 194 def cookbook_gem_finished unindent end
Called when the result of installing the bundle is to install the gem
# File lib/chef/formatters/doc.rb, line 184 def cookbook_gem_installing(gem, version) puts_line "- Installing #{gem} #{version}", :green end
Called when starting to collect gems from the cookbooks
# File lib/chef/formatters/doc.rb, line 178 def cookbook_gem_start(gems) puts_line "Installing Cookbook Gems:" indent end
Called when the result of installing the bundle is to use the gem
# File lib/chef/formatters/doc.rb, line 189 def cookbook_gem_using(gem, version) puts_line "- Using #{gem} #{version}" end
Called when the cookbook collection is returned from the server.
# File lib/chef/formatters/doc.rb, line 140 def cookbook_resolution_complete(cookbook_collection) end
Called when there is an error getting the cookbook collection from the server.
Chef::Formatters::Base#cookbook_resolution_failed
# File lib/chef/formatters/doc.rb, line 135 def cookbook_resolution_failed(expanded_run_list, exception) super end
Called before the cookbook collection is fetched from the server.
# File lib/chef/formatters/doc.rb, line 129 def cookbook_resolution_start(expanded_run_list) puts_line "resolving cookbooks for run list: #{expanded_run_list.inspect}" end
Called after all cookbooks have been sync'd.
# File lib/chef/formatters/doc.rb, line 173 def cookbook_sync_complete unindent end
Called before cookbook sync starts
# File lib/chef/formatters/doc.rb, line 158 def cookbook_sync_start(cookbook_count) puts_line "Synchronizing Cookbooks:" indent end
(see Base#deprecation
)
Chef::Formatters::Base#deprecation
# File lib/chef/formatters/doc.rb, line 376 def deprecation(deprecation, _location = nil) if Chef::Config[:treat_deprecation_warnings_as_errors] super elsif !deprecation.silenced? # Save non-silenced deprecations to the screen until the end. deprecations[deprecation.message] ||= { url: deprecation.url, locations: Set.new } deprecations[deprecation.message][:locations] << deprecation.location end end
# File lib/chef/formatters/doc.rb, line 27 def elapsed_time end_time - start_time end
Called after a file in a cookbook is loaded.
# File lib/chef/formatters/doc.rb, line 209 def file_loaded(path) end
Called after an individual handler has run
# File lib/chef/formatters/doc.rb, line 347 def handler_executed(handler) puts_line "- #{handler.class.name}" end
Called after all handlers have executed
# File lib/chef/formatters/doc.rb, line 352 def handlers_completed unindent puts_line "Running handlers complete\n" end
Called before handlers run
# File lib/chef/formatters/doc.rb, line 340 def handlers_start(handler_count) puts "" puts "Running handlers:" indent end
# File lib/chef/formatters/doc.rb, line 386 def indent indent_by(2) end
Called when cookbook loading starts.
# File lib/chef/formatters/doc.rb, line 204 def library_load_start(file_count) puts_line "Compiling Cookbooks..." end
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 121 def node_load_completed(node, expanded_run_list, config) end
Failed to load node data from the server
Chef::Formatters::Base#node_load_failed
# File lib/chef/formatters/doc.rb, line 115 def node_load_failed(node_name, exception, config) super end
# File lib/chef/formatters/doc.rb, line 111 def node_load_start(node_name, config) end
Called right after ohai runs.
# File lib/chef/formatters/doc.rb, line 96 def ohai_completed(node) end
# File lib/chef/formatters/doc.rb, line 299 def output_record(line) end
# File lib/chef/formatters/doc.rb, line 124 def policyfile_loaded(policy) puts_line "Using policy '#{policy["name"]}' at revision '#{policy["revision_id"]}'" end
# File lib/chef/formatters/doc.rb, line 31 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
Called when an assertion declared by a provider fails
# File lib/chef/formatters/doc.rb, line 367 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
Called when recipes have been loaded.
# File lib/chef/formatters/doc.rb, line 213 def recipe_load_complete end
# File lib/chef/formatters/doc.rb, line 108 def registration_completed end
About to attempt to register as node_name
# File lib/chef/formatters/doc.rb, line 104 def registration_start(node_name, config) puts_line "Creating a new client identity for #{node_name} using the validator key." end
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 150 def removed_cookbook_file(path) end
Called before action is executed on a resource.
# File lib/chef/formatters/doc.rb, line 232 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
# File lib/chef/formatters/doc.rb, line 294 def resource_bypassed(resource, action, provider) puts " (Skipped: whyrun not supported by provider #{provider.class.name})", stream: resource unindent end
Called when resource current state load is skipped due to the provider not supporting whyrun mode.
# File lib/chef/formatters/doc.rb, line 331 def resource_current_state_load_bypassed(resource, action, current_resource) puts_line("* Whyrun not supported for #{resource}, bypassing load.", :yellow) end
Called after load_current_resource has run.
# File lib/chef/formatters/doc.rb, line 284 def resource_current_state_loaded(resource, action, current_resource) end
Called when a resource fails and will not be retried.
Chef::Formatters::Base#resource_failed
# File lib/chef/formatters/doc.rb, line 270 def resource_failed(resource, action, exception) super unindent end
Called when a resource fails, but will retry.
# File lib/chef/formatters/doc.rb, line 266 def resource_failed_retriable(resource, action, retry_count, exception) end
Called when a resource action has been skipped b/c of a conditional
# File lib/chef/formatters/doc.rb, line 276 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
Called when a resource has no converge actions, e.g., it was already correct.
# File lib/chef/formatters/doc.rb, line 288 def resource_up_to_date(resource, action) @up_to_date_resources += 1 puts " (up to date)", stream: resource unindent end
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 305 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
# File lib/chef/formatters/doc.rb, line 250 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
Called after a resource has been completely converged.
# File lib/chef/formatters/doc.rb, line 323 def resource_updated(resource, action) @updated_resources += 1 unindent puts "\n" end
# File lib/chef/formatters/doc.rb, line 53 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::Dist::PRODUCT} finished, #{@updated_resources}/#{total_resources} resources would have been updated" else puts_line "#{Chef::Dist::PRODUCT} finished, #{@updated_resources}/#{total_resources} resources updated in #{pretty_elapsed_time}" end end
# File lib/chef/formatters/doc.rb, line 86 def run_failed(exception) @end_time = Time.now if Chef::Config[:why_run] puts_line "#{Chef::Dist::PRODUCT} failed. #{@updated_resources} resources would have been updated" else puts_line "#{Chef::Dist::PRODUCT} failed. #{@updated_resources} resources updated in #{pretty_elapsed_time}" end end
# File lib/chef/formatters/doc.rb, line 43 def run_start(version, run_status) puts_line "Starting #{Chef::Dist::PRODUCT}, version #{version}" puts_line "Targeting node: #{Chef::Config.target_mode.host}" if Chef::Config.target_mode? puts_line "OpenSSL FIPS 140 mode enabled" if Chef::Config[:fips] end
Already have a client key, assuming this node has registered.
# File lib/chef/formatters/doc.rb, line 100 def skipping_registration(node_name, config) end
# File lib/chef/formatters/doc.rb, line 335 def stream_output(stream, output, options = {}) print(output, { stream: stream }.merge(options)) end
Called when cookbook cookbook
has been sync'd
# File lib/chef/formatters/doc.rb, line 164 def synchronized_cookbook(cookbook_name, cookbook) puts_line "- #{cookbook.name} (#{cookbook.version})" end
# File lib/chef/formatters/doc.rb, line 49 def total_resources @up_to_date_resources + @updated_resources + @skipped_resources end
# File lib/chef/formatters/doc.rb, line 390 def unindent indent_by(-2) end
Called when an individual file in a cookbook has been updated
# File lib/chef/formatters/doc.rb, line 169 def updated_cookbook_file(cookbook_name, path) end
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 359 def whyrun_assumption(action, resource, message) return unless message [ message ].flatten.each do |line| start_line("* #{line}", :yellow) end end
Protected Instance Methods
# File lib/chef/formatters/doc.rb, line 396 def deprecations @deprecations ||= {} end