Class: Chef::Formatters::Doc

Inherits:
Base show all
Defined in:
lib/chef/formatters/doc.rb

Overview

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

Instance Attribute Summary collapse

Attributes inherited from Base

#err, #out, #output

Instance Method Summary collapse

Methods inherited from Base

#attribute_file_load_failed, #attribute_file_loaded, cli_name, #cookbook_sync_failed, #definition_file_load_failed, #definition_file_loaded, #display_error, #file_load_failed, #indent_by, #is_formatter?, #is_structured_deprecation?, #library_file_load_failed, #library_file_loaded, #lwrp_file_load_failed, #lwrp_file_loaded, #print, #puts, #puts_line, #recipe_file_load_failed, #recipe_file_loaded, #recipe_not_found, #registration_failed, #run_list_expand_failed, #start_line

Methods included from ErrorMapper

cookbook_resolution_failed, cookbook_sync_failed, file_load_failed, node_load_failed, registration_failed, resource_failed, run_list_expand_failed

Methods inherited from EventDispatch::Base

#action_collection_registration, #attribute_changed, #attribute_file_load_failed, #attribute_file_loaded, #attribute_load_complete, #attribute_load_start, #cookbook_compilation_complete, #cookbook_compilation_start, #cookbook_sync_failed, #definition_file_load_failed, #definition_file_loaded, #definition_load_complete, #definition_load_start, #library_file_load_failed, #library_file_loaded, #library_load_complete, #lwrp_file_load_failed, #lwrp_file_loaded, #lwrp_load_complete, #lwrp_load_start, #msg, #node_load_success, #ohai_plugin_file_load_failed, #ohai_plugin_file_loaded, #ohai_plugin_load_complete, #ohai_plugin_load_start, #recipe_file_load_failed, #recipe_file_loaded, #recipe_load_start, #recipe_not_found, #registration_failed, #resource_after_state_loaded, #resource_completed, #run_list_expand_failed, #run_list_expanded, #run_started, #stream_closed, #stream_opened

Constructor Details

#initialize(out, err) ⇒ Doc

Returns a new instance of Doc.


16
17
18
19
20
21
22
23
24
25
# 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

Instance Attribute Details

#end_timeObject (readonly)

Returns the value of attribute end_time


12
13
14
# File 'lib/chef/formatters/doc.rb', line 12

def end_time
  @end_time
end

#start_timeObject (readonly)

Returns the value of attribute start_time


12
13
14
# File 'lib/chef/formatters/doc.rb', line 12

def start_time
  @start_time
end

Instance Method Details

#converge_completeObject

Called when the converge phase is finished.


212
213
214
# File 'lib/chef/formatters/doc.rb', line 212

def converge_complete
  unindent if @current_recipe
end

#converge_failed(e) ⇒ Object


216
217
218
219
# File 'lib/chef/formatters/doc.rb', line 216

def converge_failed(e)
  # Currently a failed converge is handled the same way as a successful converge
  converge_complete
end

#converge_start(run_context) ⇒ Object

Called before convergence starts


207
208
209
# File 'lib/chef/formatters/doc.rb', line 207

def converge_start(run_context)
  puts_line "Converging #{run_context.resource_collection.all_resources.size} resources"
end

#cookbook_clean_completeObject

Called when cookbook cleaning is finished.


148
# File 'lib/chef/formatters/doc.rb', line 148

def cookbook_clean_complete; end

#cookbook_clean_startObject

Called before unneeded cookbooks are removed


140
# File 'lib/chef/formatters/doc.rb', line 140

def cookbook_clean_start; end

#cookbook_gem_failed(exception) ⇒ Object

Called when cookbook gem installation fails


191
192
193
# File 'lib/chef/formatters/doc.rb', line 191

def cookbook_gem_failed(exception)
  unindent
end

#cookbook_gem_finishedObject

Called when finished installing cookbook gems


186
187
188
# File 'lib/chef/formatters/doc.rb', line 186

def cookbook_gem_finished
  unindent
end

#cookbook_gem_installing(gem, version) ⇒ Object

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


176
177
178
# File 'lib/chef/formatters/doc.rb', line 176

def cookbook_gem_installing(gem, version)
  puts_line "- Installing #{gem} #{version}", :green
end

#cookbook_gem_start(gems) ⇒ Object

Called when starting to collect gems from the cookbooks


170
171
172
173
# File 'lib/chef/formatters/doc.rb', line 170

def cookbook_gem_start(gems)
  puts_line "Installing Cookbook Gems:"
  indent
end

#cookbook_gem_using(gem, version) ⇒ Object

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


181
182
183
# File 'lib/chef/formatters/doc.rb', line 181

def cookbook_gem_using(gem, version)
  puts_line "- Using #{gem} #{version}"
end

#cookbook_resolution_complete(cookbook_collection) ⇒ Object

Called when the cookbook collection is returned from the server.


137
# File 'lib/chef/formatters/doc.rb', line 137

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.


132
133
134
# File 'lib/chef/formatters/doc.rb', line 132

def cookbook_resolution_failed(expanded_run_list, exception)
  super
end

#cookbook_resolution_start(expanded_run_list) ⇒ Object

Called before the cookbook collection is fetched from the server.


126
127
128
# File 'lib/chef/formatters/doc.rb', line 126

def cookbook_resolution_start(expanded_run_list)
  puts_line "resolving cookbooks for run list: #{expanded_run_list.inspect}"
end

#cookbook_sync_completeObject

Called after all cookbooks have been sync'd.


165
166
167
# File 'lib/chef/formatters/doc.rb', line 165

def cookbook_sync_complete
  unindent
end

#cookbook_sync_start(cookbook_count) ⇒ Object

Called before cookbook sync starts


151
152
153
154
# File 'lib/chef/formatters/doc.rb', line 151

def cookbook_sync_start(cookbook_count)
  puts_line "Synchronizing Cookbooks:"
  indent
end

#deprecation(deprecation, _location = nil) ⇒ Object

Log a deprecation warning object.

Parameters:

  • deprecation (Chef::Deprecated::Base)

    Deprecation object to log. In previous versions, this could be a string. Don't do that anymore.

  • location (Object)

    Unused, present only for compatibility.


366
367
368
369
370
371
372
373
374
# File 'lib/chef/formatters/doc.rb', line 366

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

#elapsed_timeObject


27
28
29
# File 'lib/chef/formatters/doc.rb', line 27

def elapsed_time
  end_time - start_time
end

#file_loaded(path) ⇒ Object

Called after a file in a cookbook is loaded.


201
# File 'lib/chef/formatters/doc.rb', line 201

def file_loaded(path); end

#handler_executed(handler) ⇒ Object

Called after an individual handler has run


335
336
337
# File 'lib/chef/formatters/doc.rb', line 335

def handler_executed(handler)
  puts_line "- #{handler.class.name}"
end

#handlers_completedObject

Called after all handlers have executed


340
341
342
343
# File 'lib/chef/formatters/doc.rb', line 340

def handlers_completed
  unindent
  puts_line "Running handlers complete\n"
end

#handlers_start(handler_count) ⇒ Object

Called before handlers run


328
329
330
331
332
# File 'lib/chef/formatters/doc.rb', line 328

def handlers_start(handler_count)
  puts ""
  puts "Running handlers:"
  indent
end

#indentObject


376
377
378
# File 'lib/chef/formatters/doc.rb', line 376

def indent
  indent_by(2)
end

#library_load_start(file_count) ⇒ Object

Called when cookbook loading starts.


196
197
198
# File 'lib/chef/formatters/doc.rb', line 196

def library_load_start(file_count)
  puts_line "Compiling Cookbooks..."
end

#node_load_completed(node, expanded_run_list, config) ⇒ Object

Default and override attrs from roles have been computed, but not yet applied. Normal attrs from JSON have been added to the node.


119
# File 'lib/chef/formatters/doc.rb', line 119

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


113
114
115
# File 'lib/chef/formatters/doc.rb', line 113

def node_load_failed(node_name, exception, config)
  super
end

#node_load_start(node_name, config) ⇒ Object


110
# File 'lib/chef/formatters/doc.rb', line 110

def node_load_start(node_name, config); end

#ohai_completed(node) ⇒ Object

Called right after ohai runs.


98
# File 'lib/chef/formatters/doc.rb', line 98

def ohai_completed(node); end

#output_record(line) ⇒ Object


287
# File 'lib/chef/formatters/doc.rb', line 287

def output_record(line); end

#policyfile_loaded(policy) ⇒ Object


121
122
123
# File 'lib/chef/formatters/doc.rb', line 121

def policyfile_loaded(policy)
  puts_line "Using policy '#{policy["name"]}' at revision '#{policy["revision_id"]}'"
end

#pretty_elapsed_timeObject


31
32
33
34
35
36
37
38
39
40
41
# 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

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

Called when an assertion declared by a provider fails


356
357
358
359
360
361
362
363
# File 'lib/chef/formatters/doc.rb', line 356

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_completeObject

Called when recipes have been loaded.


204
# File 'lib/chef/formatters/doc.rb', line 204

def recipe_load_complete; end

#registration_completedObject


108
# File 'lib/chef/formatters/doc.rb', line 108

def registration_completed; end

#registration_start(node_name, config) ⇒ Object

About to attempt to register as +node_name+


104
105
106
# 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

#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.


145
# File 'lib/chef/formatters/doc.rb', line 145

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.


222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
# File 'lib/chef/formatters/doc.rb', line 222

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) ⇒ Object


282
283
284
285
# File 'lib/chef/formatters/doc.rb', line 282

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) ⇒ Object

Called when resource current state load is skipped due to the provider not supporting whyrun mode.


319
320
321
# File 'lib/chef/formatters/doc.rb', line 319

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) ⇒ Object

Called after #load_current_resource has run.


273
# File 'lib/chef/formatters/doc.rb', line 273

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.


259
260
261
262
# File 'lib/chef/formatters/doc.rb', line 259

def resource_failed(resource, action, exception)
  super
  unindent
end

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

Called when a resource fails, but will retry.


256
# File 'lib/chef/formatters/doc.rb', line 256

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


265
266
267
268
269
270
# File 'lib/chef/formatters/doc.rb', line 265

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) ⇒ Object

Called when a resource has no converge actions, e.g., it was already correct.


276
277
278
279
280
# File 'lib/chef/formatters/doc.rb', line 276

def resource_up_to_date(resource, action)
  @up_to_date_resources += 1
  puts " (up to date)", stream: resource unless resource.suppress_up_to_date_messages?
  unindent
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.


292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
# File 'lib/chef/formatters/doc.rb', line 292

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.is_a? String
      start_line "- #{prefix}#{line}", :green
    elsif line.is_a? 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) ⇒ Object


240
241
242
243
244
245
246
247
248
249
250
251
252
253
# File 'lib/chef/formatters/doc.rb', line 240

def resource_update_progress(resource, current, total, interval)
  @progress[resource] ||= -1

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

  if percent_complete && 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) ⇒ Object

Called after a resource has been completely converged.


311
312
313
314
315
# File 'lib/chef/formatters/doc.rb', line 311

def resource_updated(resource, action)
  @updated_resources += 1
  unindent
  puts "\n"
end

#run_completed(node) ⇒ Object


54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
# File 'lib/chef/formatters/doc.rb', line 54

def run_completed(node)
  @end_time = Time.now
  # Print out deprecations.
  unless deprecations.empty?
    puts_line ""
    puts_line "Deprecation warnings that must be addressed before upgrading to Chef Infra #{Chef::VERSION.to_i + 1}:"
    puts_line ""
    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 "#{ChefUtils::Dist::Infra::PRODUCT} finished, #{@updated_resources}/#{total_resources} resources would have been updated"
  else
    puts_line "#{ChefUtils::Dist::Infra::PRODUCT} finished, #{@updated_resources}/#{total_resources} resources updated in #{pretty_elapsed_time}"
  end
end

#run_failed(exception) ⇒ Object


88
89
90
91
92
93
94
95
# File 'lib/chef/formatters/doc.rb', line 88

def run_failed(exception)
  @end_time = Time.now
  if Chef::Config[:why_run]
    puts_line "#{ChefUtils::Dist::Infra::PRODUCT} failed. #{@updated_resources} resources would have been updated"
  else
    puts_line "#{ChefUtils::Dist::Infra::PRODUCT} failed. #{@updated_resources} resources updated in #{pretty_elapsed_time}"
  end
end

#run_start(version, run_status) ⇒ Object


43
44
45
46
47
48
# File 'lib/chef/formatters/doc.rb', line 43

def run_start(version, run_status)
  puts_line "Starting #{ChefUtils::Dist::Infra::PRODUCT}, version #{version}"
  puts_line "Patents: #{ChefUtils::Dist::Org::PATENTS}"
  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

#skipping_registration(node_name, config) ⇒ Object

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


101
# File 'lib/chef/formatters/doc.rb', line 101

def skipping_registration(node_name, config); end

#stream_output(stream, output, options = {}) ⇒ Object


323
324
325
# File 'lib/chef/formatters/doc.rb', line 323

def stream_output(stream, output, options = {})
  print(output, { stream: stream }.merge(options))
end

#synchronized_cookbook(cookbook_name, cookbook) ⇒ Object

Called when cookbook +cookbook+ has been sync'd


157
158
159
# File 'lib/chef/formatters/doc.rb', line 157

def synchronized_cookbook(cookbook_name, cookbook)
  puts_line "- #{cookbook.name} (#{cookbook.version})"
end

#total_resourcesObject


50
51
52
# File 'lib/chef/formatters/doc.rb', line 50

def total_resources
  @up_to_date_resources + @updated_resources + @skipped_resources
end

#unindentObject


380
381
382
# File 'lib/chef/formatters/doc.rb', line 380

def unindent
  indent_by(-2)
end

#updated_cookbook_file(cookbook_name, path) ⇒ Object

Called when an individual file in a cookbook has been updated


162
# File 'lib/chef/formatters/doc.rb', line 162

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


347
348
349
350
351
352
353
# File 'lib/chef/formatters/doc.rb', line 347

def whyrun_assumption(action, resource, message)
  return unless message

  [ message ].flatten.each do |line|
    start_line("* #{line}", :yellow)
  end
end