microwave 11.400.3 → 11.400.4

data/lib/chef/formatters/base.rb

@@ -0,0 +1,250 @@
+#
+# Author:: Tyler Cloke (<tyler@opscode.com>)
+#
+# Copyright:: Copyright (c) 2012 Opscode, Inc.
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require 'chef/event_dispatch/base'
+require 'chef/formatters/error_inspectors'
+require 'chef/formatters/error_descriptor'
+require 'chef/formatters/error_mapper'
+
+class Chef
+
+  # == Chef::Formatters
+  # Formatters handle printing output about the progress/status of a chef
+  # client run to the user's screen.
+  module Formatters
+
+    class UnknownFormatter < StandardError; end
+
+    def self.formatters_by_name
+      @formatters_by_name ||= {}
+    end
+
+    def self.register(name, formatter)
+      formatters_by_name[name.to_s] = formatter
+    end
+
+    def self.by_name(name)
+      formatters_by_name[name]
+    end
+
+    def self.available_formatters
+      formatters_by_name.keys
+    end
+
+    #--
+    # TODO: is it too clever to be defining new() on a module like this?
+    def self.new(name, out, err)
+      formatter_class = by_name(name.to_s) or
+        raise UnknownFormatter, "No output formatter found for #{name} (available: #{available_formatters.join(', ')})"
+
+      formatter_class.new(out, err)
+    end
+
+    # == Outputter
+    # Handles basic printing tasks like colorizing.
+    # --
+    # TODO: Duplicates functionality from knife, upfactor.
+    class Outputter
+
+      attr_reader :out
+      attr_reader :err
+
+      def initialize(out, err)
+        @out, @err = out, err
+      end
+
+      def highline
+        @highline ||= begin
+          require 'highline'
+          HighLine.new
+        end
+      end
+
+      def color(string, *colors)
+        if Chef::Config[:color]
+          @out.print highline.color(string, *colors)
+        else
+          @out.print string
+        end
+      end
+
+      alias :print :color
+
+      def puts(string, *colors)
+        if Chef::Config[:color]
+          @out.puts highline.color(string, *colors)
+        else
+          @out.puts string
+        end
+      end
+
+    end
+
+
+    # == Formatters::Base
+    # Base class that all formatters should inherit from.
+    class Base < EventDispatch::Base
+
+      include ErrorMapper
+
+      def self.cli_name(name)
+        Chef::Formatters.register(name, self)
+      end
+
+      attr_reader :out
+      attr_reader :err
+      attr_reader :output
+
+      def initialize(out, err)
+        @output = Outputter.new(out, err)
+      end
+
+      def puts(*args)
+        @output.puts(*args)
+      end
+
+      def print(*args)
+        @output.print(*args)
+      end
+
+      # Input: a Formatters::ErrorDescription object.
+      # Outputs error to SDOUT.
+      def display_error(description)
+        puts("")
+        description.display(output)
+      end
+
+      def registration_failed(node_name, exception, config)
+        #A Formatters::ErrorDescription object
+        description = ErrorMapper.registration_failed(node_name, exception, config)
+        display_error(description)
+      end
+
+      def node_load_failed(node_name, exception, config)
+        description = ErrorMapper.node_load_failed(node_name, exception, config)
+        display_error(description)
+      end
+
+      def run_list_expand_failed(node, exception)
+        description = ErrorMapper.run_list_expand_failed(node, exception)
+        display_error(description)
+      end
+
+      def cookbook_resolution_failed(expanded_run_list, exception)
+        description = ErrorMapper.cookbook_resolution_failed(expanded_run_list, exception)
+        display_error(description)
+      end
+
+      def cookbook_sync_failed(cookbooks, exception)
+        description = ErrorMapper.cookbook_sync_failed(cookbooks, exception)
+        display_error(description)
+      end
+
+      def resource_failed(resource, action, exception)
+        description = ErrorMapper.resource_failed(resource, action, exception)
+        display_error(description)
+      end
+
+      # Generic callback for any attribute/library/lwrp/recipe file in a
+      # cookbook getting loaded. The per-filetype callbacks for file load are
+      # overriden so that they call this instead. This means that a subclass of
+      # Formatters::Base can implement #file_loaded to do the same thing for
+      # every kind of file that Chef loads from a recipe instead of
+      # implementing all the per-filetype callbacks.
+      def file_loaded(path)
+      end
+
+      # Generic callback for any attribute/library/lwrp/recipe file throwing an
+      # exception when loaded. Default behavior is to use CompileErrorInspector
+      # to print contextual info about the failure.
+      def file_load_failed(path, exception)
+        description = ErrorMapper.file_load_failed(path, exception)
+        display_error(description)
+      end
+
+      def recipe_not_found(exception)
+        description = ErrorMapper.file_load_failed(nil, exception)
+        display_error(description)
+      end
+
+      # Delegates to #file_loaded
+      def library_file_loaded(path)
+        file_loaded(path)
+      end
+
+      # Delegates to #file_load_failed
+      def library_file_load_failed(path, exception)
+        file_load_failed(path, exception)
+      end
+
+      # Delegates to #file_loaded
+      def lwrp_file_loaded(path)
+        file_loaded(path)
+      end
+
+      # Delegates to #file_load_failed
+      def lwrp_file_load_failed(path, exception)
+        file_load_failed(path, exception)
+      end
+
+      # Delegates to #file_loaded
+      def attribute_file_loaded(path)
+        file_loaded(path)
+      end
+
+      # Delegates to #file_load_failed
+      def attribute_file_load_failed(path, exception)
+        file_load_failed(path, exception)
+      end
+
+      # Delegates to #file_loaded
+      def definition_file_loaded(path)
+        file_loaded(path)
+      end
+
+      # Delegates to #file_load_failed
+      def definition_file_load_failed(path, exception)
+        file_load_failed(path, exception)
+      end
+
+      # Delegates to #file_loaded
+      def recipe_file_loaded(path)
+        file_loaded(path)
+      end
+
+      # Delegates to #file_load_failed
+      def recipe_file_load_failed(path, exception)
+        file_load_failed(path, exception)
+      end
+
+    end
+
+
+    # == NullFormatter
+    # Formatter that doesn't actually produce any ouput. You can use this to
+    # disable the use of output formatters.
+    class NullFormatter < Base
+
+      cli_name(:null)
+
+    end
+
+  end
+end
+

data/lib/chef/formatters/doc.rb

@@ -0,0 +1,236 @@
+require 'chef/formatters/base'
+require 'chef/config'
+
+class Chef
+  module Formatters
+    #--
+    # TODO: not sold on the name, but the output is similar to what rspec calls
+    # "specdoc"
+    class Doc < Formatters::Base
+
+      cli_name(:doc)
+
+      def initialize(out, err)
+        super
+
+        @updated_resources = 0
+      end
+
+      def run_start(version)
+        puts "Starting Chef Client, version #{version}"
+      end
+
+      def run_completed(node)
+        if Chef::Config[:why_run]
+          puts "Chef Client finished, #{@updated_resources} resources would have been updated"
+        else
+          puts "Chef Client finished, #{@updated_resources} resources updated"
+        end
+      end
+
+      def run_failed(exception)
+        if Chef::Config[:why_run]
+          puts "Chef Client failed. #{@updated_resources} resources would have been updated"
+        else
+          puts "Chef Client failed. #{@updated_resources} resources updated"
+        end
+      end
+
+      # Called right after ohai runs.
+      def ohai_completed(node)
+      end
+
+      # Already have a client key, assuming this node has registered.
+      def skipping_registration(node_name, config)
+      end
+
+      # About to attempt to register as +node_name+
+      def registration_start(node_name, config)
+        puts "Creating a new client identity for #{node_name} using the validator key."
+      end
+
+      def registration_completed
+      end
+
+      def node_load_start(node_name, config)
+      end
+
+      # Failed to load node data from the server
+      def node_load_failed(node_name, exception, config)
+        super
+      end
+
+      # Default and override attrs from roles have been computed, but not yet applied.
+      # Normal attrs from JSON have been added to the node.
+      def node_load_completed(node, expanded_run_list, config)
+      end
+
+      # Called before the cookbook collection is fetched from the server.
+      def cookbook_resolution_start(expanded_run_list)
+        puts "resolving cookbooks for run list: #{expanded_run_list.inspect}"
+      end
+
+      # Called when there is an error getting the cookbook collection from the
+      # server.
+      def cookbook_resolution_failed(expanded_run_list, exception)
+        super
+      end
+
+      # Called when the cookbook collection is returned from the server.
+      def cookbook_resolution_complete(cookbook_collection)
+      end
+
+      # Called before unneeded cookbooks are removed
+      def cookbook_clean_start
+      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.
+      def removed_cookbook_file(path)
+      end
+
+      # Called when cookbook cleaning is finished.
+      def cookbook_clean_complete
+      end
+
+      # Called before cookbook sync starts
+      def cookbook_sync_start(cookbook_count)
+        puts "Synchronizing Cookbooks:"
+      end
+
+      # Called when cookbook +cookbook_name+ has been sync'd
+      def synchronized_cookbook(cookbook_name)
+        puts "  - #{cookbook_name}"
+      end
+
+      # Called when an individual file in a cookbook has been updated
+      def updated_cookbook_file(cookbook_name, path)
+      end
+
+      # Called after all cookbooks have been sync'd.
+      def cookbook_sync_complete
+      end
+
+      # Called when cookbook loading starts.
+      def library_load_start(file_count)
+        puts "Compiling Cookbooks..."
+      end
+
+      # Called after a file in a cookbook is loaded.
+      def file_loaded(path)
+      end
+
+      # Called when recipes have been loaded.
+      def recipe_load_complete
+      end
+
+      # Called before convergence starts
+      def converge_start(run_context)
+        puts "Converging #{run_context.resource_collection.all_resources.size} resources"
+      end
+
+      # Called when the converge phase is finished.
+      def converge_complete
+      end
+
+      # Called before action is executed on a resource.
+      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
+          puts "Recipe: #{resource_recipe}"
+          @current_recipe = resource_recipe
+        end
+        # TODO: info about notifies
+        print "  * #{resource} action #{action}"
+      end
+
+      # Called when a resource fails, but will retry.
+      def resource_failed_retriable(resource, action, retry_count, exception)
+      end
+
+      # Called when a resource fails and will not be retried.
+      def resource_failed(resource, action, exception)
+        super
+      end
+
+      # Called when a resource action has been skipped b/c of a conditional
+      def resource_skipped(resource, action, conditional)
+        # TODO: more info about conditional
+        puts " (skipped due to #{conditional.positivity})"
+      end
+
+      # Called after #load_current_resource has run.
+      def resource_current_state_loaded(resource, action, current_resource)
+      end
+
+      # Called when a resource has no converge actions, e.g., it was already correct.
+      def resource_up_to_date(resource, action)
+        puts " (up to date)"
+      end
+
+      def resource_bypassed(resource, action, provider)
+        puts " (Skipped: whyrun not supported by provider #{provider.class.name})"
+      end
+
+      def output_record(line)
+
+      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.
+      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
+            @output.color "\n    - #{prefix}#{line}", :green
+          elsif line.kind_of? Array 
+            # Expanded output - delta 
+            # @todo should we have a resource_update_delta callback? 
+            line.each do |detail|
+              @output.color "\n        #{detail}", :white
+            end
+          end
+        end
+      end
+
+      # Called after a resource has been completely converged.
+      def resource_updated(resource, action)
+        @updated_resources += 1
+        puts "\n"
+      end
+
+      # Called when resource current state load is skipped due to the provider
+      # not supporting whyrun mode.
+      def resource_current_state_load_bypassed(resource, action, current_resource)
+        @output.color("\n    * Whyrun not supported for #{resource}, bypassing load.", :yellow)
+      end
+
+      # Called when a provider makes an assumption after a failed assertion
+      # in whyrun mode, in order to allow execution to continue
+      def whyrun_assumption(action, resource, message) 
+        return unless message
+        [ message ].flatten.each do |line|
+          @output.color("\n    * #{line}", :yellow)
+        end
+      end
+
+      # Called when an assertion declared by a provider fails
+      def provider_requirement_failed(action, resource, exception, message)
+        return unless message
+        color = Chef::Config[:why_run] ? :yellow : :red
+        [ message ].flatten.each do |line|
+          @output.color("\n    * #{line}", color)
+        end
+      end
+    end
+  end
+end