chef 10.12.0 → 10.14.0.beta.1

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[:whyrun]
+          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[:whyrun]
+          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

data/lib/chef/formatters/error_inspectors.rb

@@ -0,0 +1,19 @@
+require 'chef/formatters/error_inspectors/node_load_error_inspector'
+require "chef/formatters/error_inspectors/registration_error_inspector"
+require 'chef/formatters/error_inspectors/compile_error_inspector'
+require 'chef/formatters/error_inspectors/resource_failure_inspector'
+require 'chef/formatters/error_inspectors/run_list_expansion_error_inspector'
+require 'chef/formatters/error_inspectors/cookbook_resolve_error_inspector'
+require "chef/formatters/error_inspectors/cookbook_sync_error_inspector"
+
+class Chef
+  module Formatters
+
+    # == ErrorInspectors
+    # Error inspectors wrap exceptions and contextual information. They
+    # generate diagnostic messages about possible causes of the error for user
+    # consumption.
+    module ErrorInspectors
+    end
+  end
+end

data/lib/chef/formatters/error_inspectors/api_error_formatting.rb

@@ -0,0 +1,111 @@
+#--
+# Author:: Daniel DeLeo (<dan@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.
+#
+
+class Chef
+  module Formatters
+
+    module APIErrorFormatting
+
+      NETWORK_ERROR_CLASSES = [Errno::ECONNREFUSED, Timeout::Error, Errno::ETIMEDOUT, SocketError]
+
+      def describe_network_errors(error_description)
+        error_description.section("Networking Error:",<<-E)
+#{exception.message}
+
+Your chef_server_url may be misconfigured, or the network could be down.
+E
+        error_description.section("Relevant Config Settings:",<<-E)
+chef_server_url  "#{server_url}"
+E
+      end
+
+      def describe_401_error(error_description)
+        if clock_skew?
+          error_description.section("Authentication Error:",<<-E)
+Failed to authenticate to the chef server (http 401).
+The request failed because your clock has drifted by more than 15 minutes.
+Syncing your clock to an NTP Time source should resolve the issue.
+E
+        else
+          error_description.section("Authentication Error:",<<-E)
+Failed to authenticate to the chef server (http 401).
+E
+
+          error_description.section("Server Response:", format_rest_error)
+          error_description.section("Relevant Config Settings:",<<-E)
+chef_server_url   "#{server_url}"
+node_name         "#{username}"
+client_key        "#{api_key}"
+
+If these settings are correct, your client_key may be invalid.
+E
+        end
+      end
+
+      def describe_400_error(error_description)
+        error_description.section("Invalid Request Data:",<<-E)
+The data in your request was invalid (HTTP 400).
+E
+        error_description.section("Server Response:",format_rest_error)
+      end
+
+      def describe_500_error(error_description)
+        error_description.section("Unknown Server Error:",<<-E)
+The server had a fatal error attempting to load the node data.
+E
+        error_description.section("Server Response:", format_rest_error)
+      end
+
+      def describe_503_error(error_description)
+        error_description.section("Server Unavailable","The Chef Server is temporarily unavailable")
+        error_description.section("Server Response:", format_rest_error)
+      end
+
+
+      # Fallback for unexpected/uncommon http errors
+      def describe_http_error(error_description)
+        error_description.section("Unexpected API Request Failure:", format_rest_error)
+      end
+
+      # Parses JSON from the error response sent by Chef Server and returns the
+      # error message
+      def format_rest_error
+        Array(Chef::JSONCompat.from_json(exception.response.body)["error"]).join('; ')
+      rescue Exception
+        exception.response.body
+      end
+
+      def username
+        config[:node_name]
+      end
+
+      def api_key
+        config[:client_key]
+      end
+
+      def server_url
+        config[:chef_server_url]
+      end
+
+      def clock_skew?
+        exception.response.body =~ /synchronize the clock/i
+      end
+
+    end
+  end
+end

data/lib/chef/formatters/error_inspectors/compile_error_inspector.rb

@@ -0,0 +1,90 @@
+#--
+# Author:: Daniel DeLeo (<dan@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.
+#
+
+class Chef
+  module Formatters
+    module ErrorInspectors
+
+      # == CompileErrorInspector
+      # Wraps exceptions that occur during the compile phase of a Chef run and
+      # tries to find the code responsible for the error.
+      class CompileErrorInspector
+
+        attr_reader :path
+        attr_reader :exception
+
+        def initialize(path, exception)
+          @path, @exception = path, exception
+        end
+
+        def add_explanation(error_description)
+          error_description.section(exception.class.name, exception.message)
+
+          traceback = filtered_bt.map {|line| "  #{line}"}.join("\n")
+          error_description.section("Cookbook Trace:", traceback)
+          error_description.section("Relevant File Content:", context)
+        end
+
+        def context
+          context_lines = []
+          context_lines << "#{culprit_file}:\n\n"
+          Range.new(display_lower_bound, display_upper_bound).each do |i|
+            line_nr = (i + 1).to_s.rjust(3)
+            indicator = (i + 1) == culprit_line ? ">> " : ":  "
+            context_lines << "#{line_nr}#{indicator}#{file_lines[i]}"
+          end
+          context_lines.join("")
+        end
+
+        def display_lower_bound
+          lower = (culprit_line - 8)
+          lower = 0 if lower < 0
+          lower
+        end
+
+        def display_upper_bound
+          upper = (culprit_line + 8)
+          upper = file_lines.size if upper > file_lines.size
+          upper
+        end
+
+        def file_lines
+          @file_lines ||= IO.readlines(culprit_file)
+        end
+
+        def culprit_backtrace_entry
+          @culprit_backtrace_entry ||= filtered_bt.first
+        end
+
+        def culprit_line
+          @culprit_line ||= culprit_backtrace_entry[/^[^:]+:([\d]+)/,1].to_i
+        end
+
+        def culprit_file
+          @culprit_file ||= culprit_backtrace_entry[/^([^:]+):([\d]+)/,1]
+        end
+
+        def filtered_bt
+          exception.backtrace.select {|l| l =~ /^#{Chef::Config.file_cache_path}/ }
+        end
+
+      end
+
+    end
+  end
+end