Class: Chef::Formatters::Minimal

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

Overview

Formatters::Minimal

Shows the progress of the chef run by printing single characters, and displays a summary of updates at the conclusion of the run. For events that don't have meaningful status information (loading a file, syncing a cookbook) a dot is printed. For resources, a dot, 'S' or 'U' is printed if the resource is up to date, skipped by not_if/only_if, or updated, respectively.

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, #library_file_load_failed, #library_file_loaded, #lwrp_file_load_failed, #lwrp_file_loaded, #print, #puts, #recipe_file_load_failed, #recipe_file_loaded, #recipe_not_found, #run_list_expand_failed

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, #provider_requirement_failed, #recipe_file_load_failed, #recipe_file_loaded, #recipe_load_start, #recipe_not_found, #resource_bypassed, #resource_completed, #resource_current_state_load_bypassed, #run_list_expand_failed, #whyrun_assumption

Constructor Details

#initialize(out, err) ⇒ Minimal

Returns a new instance of Minimal.


24
25
26
27
28
# File 'lib/chef/formatters/minimal.rb', line 24

def initialize(out, err)
  super
  @updated_resources = []
  @updates_by_resource = Hash.new {|h, k| h[k] = []}
end

Instance Attribute Details

#updated_resourcesObject (readonly)

Returns the value of attribute updated_resources


20
21
22
# File 'lib/chef/formatters/minimal.rb', line 20

def updated_resources
  @updated_resources
end

#updates_by_resourceObject (readonly)

Returns the value of attribute updates_by_resource


21
22
23
# File 'lib/chef/formatters/minimal.rb', line 21

def updates_by_resource
  @updates_by_resource
end

Instance Method Details

#converge_completeObject

Called when the converge phase is finished.


151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
# File 'lib/chef/formatters/minimal.rb', line 151

def converge_complete
  puts "\n"
  puts "System converged."
  if updated_resources.empty?
    puts "no resources updated"
  else
    puts "\n"
    puts "resources updated this run:"
    updated_resources.each do |resource|
      puts "* #{resource.to_s}"
      updates_by_resource[resource.name].flatten.each do |update|
        puts "  - #{update}"
      end
      puts "\n"
    end
  end
end

#converge_start(run_context) ⇒ Object

Called before convergence starts


146
147
148
# File 'lib/chef/formatters/minimal.rb', line 146

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

#cookbook_clean_completeObject

Called when cookbook cleaning is finished.


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

def cookbook_clean_complete
end

#cookbook_clean_startObject

Called before unneeded cookbooks are removed – TODO: Should be called in CookbookVersion.sync_cookbooks


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

def cookbook_clean_start
end

#cookbook_resolution_complete(cookbook_collection) ⇒ Object

Called when the cookbook collection is returned from the server.


88
89
# File 'lib/chef/formatters/minimal.rb', line 88

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.


84
85
# File 'lib/chef/formatters/minimal.rb', line 84

def cookbook_resolution_failed(expanded_run_list, exception)
end

#cookbook_resolution_start(expanded_run_list) ⇒ Object

Called before the cookbook collection is fetched from the server.


78
79
80
# File 'lib/chef/formatters/minimal.rb', line 78

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

#cookbook_sync_completeObject

Called after all cookbooks have been sync'd.


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

def cookbook_sync_complete
  puts "done."
end

#cookbook_sync_start(cookbook_count) ⇒ Object

Called before cookbook sync starts


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

def cookbook_sync_start(cookbook_count)
  puts "Synchronizing cookbooks"
end

#file_load_failed(path, exception) ⇒ Object


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

def file_load_failed(path, exception)
  super
end

#file_loaded(path) ⇒ Object

Called after a file in a cookbook is loaded.


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

def file_loaded(path)
  print '.'
end

#handler_executed(handler) ⇒ Object

Called after an individual handler has run


217
218
# File 'lib/chef/formatters/minimal.rb', line 217

def handler_executed(handler)
end

#handlers_completedObject

Called after all handlers have executed


221
222
# File 'lib/chef/formatters/minimal.rb', line 221

def handlers_completed
end

#handlers_start(handler_count) ⇒ Object

Called before handlers run


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

def handlers_start(handler_count)
end

#library_load_start(file_count) ⇒ Object

Called when cookbook loading starts.


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

def library_load_start(file_count)
  puts "Compiling cookbooks"
end

#msg(message) ⇒ Object

An uncategorized message. This supports the case that a user needs to pass output that doesn't fit into one of the callbacks above. Note that there's no semantic information about the content or importance of the message. That means that if you're using this too often, you should add a callback for it.


229
230
# File 'lib/chef/formatters/minimal.rb', line 229

def msg(message)
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.


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

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


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

def node_load_failed(node_name, exception, config)
end

#node_load_start(node_name, config) ⇒ Object


65
66
# File 'lib/chef/formatters/minimal.rb', line 65

def node_load_start(node_name, config)
end

#ohai_completed(node) ⇒ Object

Called right after ohai runs.


46
47
# File 'lib/chef/formatters/minimal.rb', line 46

def ohai_completed(node)
end

#recipe_load_completeObject

Called when recipes have been loaded.


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

def recipe_load_complete
  puts "done."
end

#registration_completedObject


57
58
# File 'lib/chef/formatters/minimal.rb', line 57

def registration_completed
end

#registration_failed(node_name, exception, config) ⇒ Object

Failed to register this client with the server.


61
62
63
# File 'lib/chef/formatters/minimal.rb', line 61

def registration_failed(node_name, exception, config)
  super
end

#registration_start(node_name, config) ⇒ Object

About to attempt to register as node_name


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

def registration_start(node_name, config)
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.


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

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.


170
171
# File 'lib/chef/formatters/minimal.rb', line 170

def resource_action_start(resource, action, notification_type=nil, notifier=nil)
end

#resource_current_state_loaded(resource, action, current_resource) ⇒ Object

Called after #load_current_resource has run.


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

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
# File 'lib/chef/formatters/minimal.rb', line 178

def resource_failed(resource, action, exception)
end

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

Called when a resource fails, but will retry.


174
175
# File 'lib/chef/formatters/minimal.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


182
183
184
# File 'lib/chef/formatters/minimal.rb', line 182

def resource_skipped(resource, action, conditional)
  print "S"
end

#resource_up_to_date(resource, action) ⇒ Object

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


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

def resource_up_to_date(resource, action)
  print "."
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.


202
203
204
# File 'lib/chef/formatters/minimal.rb', line 202

def resource_update_applied(resource, action, update)
  @updates_by_resource[resource.name] << Array(update)[0]
end

#resource_updated(resource, action) ⇒ Object

Called after a resource has been completely converged.


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

def resource_updated(resource, action)
  updated_resources << resource
  print "U"
end

#run_completed(node) ⇒ Object

Called at the end of the Chef run.


36
37
38
# File 'lib/chef/formatters/minimal.rb', line 36

def run_completed(node)
  puts "chef client finished, #{@updated_resources.size} resources updated"
end

#run_failed(exception) ⇒ Object

called at the end of a failed run


41
42
43
# File 'lib/chef/formatters/minimal.rb', line 41

def run_failed(exception)
  puts "chef client failed. #{@updated_resources.size} resources updated"
end

#run_start(version) ⇒ Object

Called at the very start of a Chef Run


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

def run_start(version)
  puts "Starting Chef Client, version #{version}"
end

#skipping_registration(node_name, config) ⇒ Object

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


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

def skipping_registration(node_name, config)
end

#synchronized_cookbook(cookbook_name) ⇒ Object

Called when cookbook cookbook_name has been sync'd


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

def synchronized_cookbook(cookbook_name)
  print "."
end

#updated_cookbook_file(cookbook_name, path) ⇒ Object

Called when an individual file in a cookbook has been updated


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

def updated_cookbook_file(cookbook_name, path)
end