Class: Chef::Formatters::Doc

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

Overview

– TODO: not sold on the name, but the output is similar to what rspec calls “specdoc”

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

#attribute_file_load_failed, #attribute_file_loaded, #attribute_load_complete, #attribute_load_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, #recipe_file_load_failed, #recipe_file_loaded, #recipe_load_start, #recipe_not_found, #registration_failed, #resource_completed, #run_list_expand_failed, #run_started, #stream_closed, #stream_opened

Constructor Details

#initialize(out, err) ⇒ Doc

Returns a new instance of Doc.



14
15
16
17
18
19
20
21
 
# 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

Instance Attribute Details

#end_time ⇒ Object (readonly)

Returns the value of attribute end_time.



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

def end_time
  @end_time
end

#start_time ⇒ Object (readonly)

Returns the value of attribute start_time.



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

def start_time
  @start_time
end

Instance Method Details

#converge_complete ⇒ Object

Called when the converge phase is finished.



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

def converge_complete
  unindent if @current_recipe
end

#converge_start(run_context) ⇒ Object

Called before convergence starts



145
146
147
 
# 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 ⇒ Object

Called when cookbook cleaning is finished.



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

def cookbook_clean_complete
end

#cookbook_clean_start ⇒ Object

Called before unneeded cookbooks are removed



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

def cookbook_clean_start
end

#cookbook_resolution_complete(cookbook_collection) ⇒ Object

Called when the cookbook collection is returned from the server.



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

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.



89
90
91
 
# File 'lib/chef/formatters/doc.rb', line 89

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.



83
84
85
 
# 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 ⇒ Object

Called after all cookbooks have been sync’d.



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

def cookbook_sync_complete
  unindent
end

#cookbook_sync_start(cookbook_count) ⇒ Object

Called before cookbook sync starts



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

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

#elapsed_time ⇒ Object 



23
24
25
 
# File 'lib/chef/formatters/doc.rb', line 23

def elapsed_time
  end_time - start_time
end

#file_loaded(path) ⇒ Object

Called after a file in a cookbook is loaded.



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

def file_loaded(path)
end

#handler_executed(handler) ⇒ Object

Called after an individual handler has run



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

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

#handlers_completed ⇒ Object

Called after all handlers have executed



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

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

#handlers_start(handler_count) ⇒ Object

Called before handlers run



248
249
250
251
252
 
# File 'lib/chef/formatters/doc.rb', line 248

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

#indent ⇒ Object 



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

def indent
  indent_by(2)
end

#library_load_start(file_count) ⇒ Object

Called when cookbook loading starts.



132
133
134
 
# 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) ⇒ Object

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



79
80
 
# 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) ⇒ Object

Failed to load node data from the server



73
74
75
 
# File 'lib/chef/formatters/doc.rb', line 73

def node_load_failed(node_name, exception, config)
  super
end

#node_load_start(node_name, config) ⇒ Object 



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

def node_load_start(node_name, config)
end

#ohai_completed(node) ⇒ Object

Called right after ohai runs.



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

def ohai_completed(node)
end

#output_record(line) ⇒ Object 



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

def output_record(line)

end

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

Called when an assertion declared by a provider fails



275
276
277
278
279
280
281
 
# 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 ⇒ Object

Called when recipes have been loaded.



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

def recipe_load_complete
end

#registration_completed ⇒ Object 



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

def registration_completed
end

#registration_start(node_name, config) ⇒ Object

About to attempt to register as node_name



62
63
64
 
# 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) ⇒ 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.



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

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.



155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
 
# 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) ⇒ Object 



201
202
203
204
 
# 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) ⇒ Object

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



239
240
241
 
# 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) ⇒ Object

Called after #load_current_resource has run.



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

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.



178
179
180
181
 
# 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) ⇒ Object

Called when a resource fails, but will retry.



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

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



184
185
186
187
188
 
# 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) ⇒ Object

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



195
196
197
198
199
 
# 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) ⇒ 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.



213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
 
# 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) ⇒ Object

Called after a resource has been completely converged.



231
232
233
234
235
 
# File 'lib/chef/formatters/doc.rb', line 231

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

#run_completed(node) ⇒ Object 



35
36
37
38
39
40
41
42
 
# 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) ⇒ Object 



44
45
46
47
48
49
50
51
 
# 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) ⇒ Object 



27
28
29
 
# 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) ⇒ Object

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



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

def skipping_registration(node_name, config)
end

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



243
244
245
 
# 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) ⇒ Object

Called when cookbook cookbook_name has been sync’d



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

def synchronized_cookbook(cookbook_name)
  puts_line "- #{cookbook_name}"
end

#total_resources ⇒ Object 



31
32
33
 
# File 'lib/chef/formatters/doc.rb', line 31

def total_resources
  @up_to_date_resources + @updated_resources
end

#unindent ⇒ Object 



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

def unindent
  indent_by(-2)
end

#updated_cookbook_file(cookbook_name, path) ⇒ Object

Called when an individual file in a cookbook has been updated



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

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



267
268
269
270
271
272
 
# 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