chef 12.7.2 → 12.8.1

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

@@ -1,154 +1,154 @@
-#--
-# Author:: Daniel DeLeo (<dan@chef.io>)
-# Copyright:: Copyright 2012-2016, Chef Software 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
-          @backtrace_lines_in_cookbooks = nil
-          @file_lines = nil
-          @culprit_backtrace_entry = nil
-          @culprit_line = nil
-        end
-
-        def add_explanation(error_description)
-          error_description.section(exception.class.name, exception.message)
-
-          if found_error_in_cookbooks?
-            traceback = filtered_bt.map { |line| "  #{line}" }.join("\n")
-            error_description.section("Cookbook Trace:", traceback)
-            error_description.section("Relevant File Content:", context)
-          end
-
-          if exception_message_modifying_frozen?
-            msg = <<-MESSAGE
-            Ruby objects are often frozen to prevent further modifications
-            when they would negatively impact the process (e.g. values inside
-            Ruby's ENV class) or to prevent polluting other objects when default
-            values are passed by reference to many instances of an object (e.g.
-            the empty Array as a Chef resource default, passed by reference
-            to every instance of the resource).
-
-            Chef uses Object#freeze to ensure the default values of properties
-            inside Chef resources are not modified, so that when a new instance
-            of a Chef resource is created, and Object#dup copies values by
-            reference, the new resource is not receiving a default value that
-            has been by a previous instance of that resource.
-
-            Instead of modifying an object that contains a default value for all
-            instances of a Chef resource, create a new object and assign it to
-            the resource's parameter, e.g.:
-
-            fruit_basket = resource(:fruit_basket, 'default')
-
-            # BAD: modifies 'contents' object for all new fruit_basket instances
-            fruit_basket.contents << 'apple'
-
-            # GOOD: allocates new array only owned by this fruit_basket instance
-            fruit_basket.contents %w(apple)
-
-            MESSAGE
-
-            error_description.section("Additional information:", msg.gsub(/^ {6}/, ""))
-          end
-        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 ||= begin
-            bt_entry = filtered_bt.first
-            Chef::Log.debug("Backtrace entry for compile error: '#{bt_entry}'")
-            bt_entry
-          end
-        end
-
-        def culprit_line
-          @culprit_line ||= begin
-            line_number = culprit_backtrace_entry[/^(?:.\:)?[^:]+:([\d]+)/, 1].to_i
-            Chef::Log.debug("Line number of compile error: '#{line_number}'")
-            line_number
-          end
-        end
-
-        def culprit_file
-          @culprit_file ||= culprit_backtrace_entry[/^((?:.\:)?[^:]+):([\d]+)/, 1]
-        end
-
-        def filtered_bt
-          backtrace_lines_in_cookbooks.count > 0 ? backtrace_lines_in_cookbooks : exception.backtrace
-        end
-
-        def found_error_in_cookbooks?
-          !backtrace_lines_in_cookbooks.empty?
-        end
-
-        def backtrace_lines_in_cookbooks
-          @backtrace_lines_in_cookbooks ||=
-            begin
-              filters = Array(Chef::Config.cookbook_path).map { |p| /^#{Regexp.escape(p)}/i }
-              r = exception.backtrace.select { |line| filters.any? { |filter| line =~ filter } }
-              Chef::Log.debug("Filtered backtrace of compile error: #{r.join(",")}")
-              r
-            end
-        end
-
-        def exception_message_modifying_frozen?
-          exception.message.include?("can't modify frozen")
-        end
-
-      end
-
-    end
-  end
-end
+#--
+# Author:: Daniel DeLeo (<dan@chef.io>)
+# Copyright:: Copyright 2012-2016, Chef Software 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
+          @backtrace_lines_in_cookbooks = nil
+          @file_lines = nil
+          @culprit_backtrace_entry = nil
+          @culprit_line = nil
+        end
+
+        def add_explanation(error_description)
+          error_description.section(exception.class.name, exception.message)
+
+          if found_error_in_cookbooks?
+            traceback = filtered_bt.map { |line| "  #{line}" }.join("\n")
+            error_description.section("Cookbook Trace:", traceback)
+            error_description.section("Relevant File Content:", context)
+          end
+
+          if exception_message_modifying_frozen?
+            msg = <<-MESSAGE
+            Ruby objects are often frozen to prevent further modifications
+            when they would negatively impact the process (e.g. values inside
+            Ruby's ENV class) or to prevent polluting other objects when default
+            values are passed by reference to many instances of an object (e.g.
+            the empty Array as a Chef resource default, passed by reference
+            to every instance of the resource).
+
+            Chef uses Object#freeze to ensure the default values of properties
+            inside Chef resources are not modified, so that when a new instance
+            of a Chef resource is created, and Object#dup copies values by
+            reference, the new resource is not receiving a default value that
+            has been by a previous instance of that resource.
+
+            Instead of modifying an object that contains a default value for all
+            instances of a Chef resource, create a new object and assign it to
+            the resource's parameter, e.g.:
+
+            fruit_basket = resource(:fruit_basket, 'default')
+
+            # BAD: modifies 'contents' object for all new fruit_basket instances
+            fruit_basket.contents << 'apple'
+
+            # GOOD: allocates new array only owned by this fruit_basket instance
+            fruit_basket.contents %w(apple)
+
+            MESSAGE
+
+            error_description.section("Additional information:", msg.gsub(/^ {6}/, ""))
+          end
+        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 ||= begin
+            bt_entry = filtered_bt.first
+            Chef::Log.debug("Backtrace entry for compile error: '#{bt_entry}'")
+            bt_entry
+          end
+        end
+
+        def culprit_line
+          @culprit_line ||= begin
+            line_number = culprit_backtrace_entry[/^(?:.\:)?[^:]+:([\d]+)/, 1].to_i
+            Chef::Log.debug("Line number of compile error: '#{line_number}'")
+            line_number
+          end
+        end
+
+        def culprit_file
+          @culprit_file ||= culprit_backtrace_entry[/^((?:.\:)?[^:]+):([\d]+)/, 1]
+        end
+
+        def filtered_bt
+          backtrace_lines_in_cookbooks.count > 0 ? backtrace_lines_in_cookbooks : exception.backtrace
+        end
+
+        def found_error_in_cookbooks?
+          !backtrace_lines_in_cookbooks.empty?
+        end
+
+        def backtrace_lines_in_cookbooks
+          @backtrace_lines_in_cookbooks ||=
+            begin
+              filters = Array(Chef::Config.cookbook_path).map { |p| /^#{Regexp.escape(p)}/i }
+              r = exception.backtrace.select { |line| filters.any? { |filter| line =~ filter } }
+              Chef::Log.debug("Filtered backtrace of compile error: #{r.join(",")}")
+              r
+            end
+        end
+
+        def exception_message_modifying_frozen?
+          exception.message.include?("can't modify frozen")
+        end
+
+      end
+
+    end
+  end
+end

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

@@ -1,168 +1,168 @@
-#--
-# Author:: Daniel DeLeo (<dan@chef.io>)
-# Copyright:: Copyright 2012-2016, Chef Software, 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/formatters/error_inspectors/api_error_formatting"
-
-class Chef
-  module Formatters
-    module ErrorInspectors
-      class CookbookResolveErrorInspector
-
-        attr_reader :exception
-        attr_reader :expanded_run_list
-
-        include APIErrorFormatting
-
-        def initialize(expanded_run_list, exception)
-          @expanded_run_list = expanded_run_list
-          @exception = exception
-        end
-
-        def add_explanation(error_description)
-          case exception
-          when Net::HTTPServerException, Net::HTTPFatalError
-            humanize_http_exception(error_description)
-          when EOFError
-            describe_eof_error(error_description)
-          when *NETWORK_ERROR_CLASSES
-            describe_network_errors(error_description)
-          else
-            error_description.section("Unexpected Error:", "#{exception.class.name}: #{exception.message}")
-          end
-        end
-
-        def humanize_http_exception(error_description)
-          response = exception.response
-          case response
-          when Net::HTTPUnauthorized
-            # TODO: this is where you'd see conflicts b/c of username/clientname stuff
-            describe_401_error(error_description)
-          when Net::HTTPForbidden
-            # TODO: we're rescuing errors from Node.find_or_create
-            # * could be no write on nodes container
-            # * could be no read on the node
-            error_description.section("Authorization Error", <<-E)
-This client is not authorized to read some of the information required to
-access its cookbooks (HTTP 403).
-
-To access its cookbooks, a client needs to be able to read its environment and
-all of the cookbooks in its expanded run list.
-E
-            error_description.section("Expanded Run List:", expanded_run_list_ul)
-            error_description.section("Server Response:", format_rest_error)
-          when Net::HTTPPreconditionFailed
-            describe_412_error(error_description)
-          when Net::HTTPBadRequest
-            describe_400_error(error_description)
-          when Net::HTTPNotFound
-          when Net::HTTPInternalServerError
-            describe_500_error(error_description)
-          when Net::HTTPBadGateway, Net::HTTPServiceUnavailable
-            describe_503_error(error_description)
-          when Net::HTTPNotAcceptable
-            describe_406_error(error_description, response)
-          else
-            describe_http_error(error_description)
-          end
-        end
-
-        def describe_412_error(error_description)
-          explanation = ""
-          error_reasons = extract_412_error_message
-
-          # Prepare the error message if there is detailed information
-          # about individual cookbooks.
-          if !error_reasons.respond_to?(:key?)
-            explanation << error_reasons.to_s
-          else
-            if error_reasons.key?("non_existent_cookbooks") && !Array(error_reasons["non_existent_cookbooks"]).empty?
-              explanation << "The following cookbooks are required by the client but don't exist on the server:\n"
-              Array(error_reasons["non_existent_cookbooks"]).each do |cookbook|
-                explanation << "* #{cookbook}\n"
-              end
-              explanation << "\n"
-            end
-            if error_reasons.key?("cookbooks_with_no_versions") && !Array(error_reasons["cookbooks_with_no_versions"]).empty?
-              explanation << "The following cookbooks exist on the server, but there is no version that meets\nthe version constraints in this environment:\n"
-              Array(error_reasons["cookbooks_with_no_versions"]).each do |cookbook|
-                explanation << "* #{cookbook}\n"
-              end
-              explanation << "\n"
-            end
-          end
-
-          if !explanation.empty?
-            error_description.section("Missing Cookbooks:", explanation)
-          else
-            # If we don't have any cookbook details print a more
-            # generic error message.
-            if error_reasons.respond_to?(:key?) && error_reasons["message"]
-              explanation << "Error message: #{error_reasons["message"]}\n"
-            end
-
-            explanation << <<EOM
-You might be able to resolve this issue with:
-  1-) Removing cookbook versions that depend on deleted cookbooks.
-  2-) Removing unused cookbook versions.
-  3-) Pinning exact cookbook versions using environments.
-EOM
-            error_description.section("Cookbook dependency resolution error:", explanation)
-          end
-
-          error_description.section("Expanded Run List:", expanded_run_list_ul)
-        end
-
-        def expanded_run_list_ul
-          @expanded_run_list.map { |i| "* #{i}" }.join("\n")
-        end
-
-        # In my tests, the error from the server is double JSON encoded, but we
-        # should not rely on this not getting fixed.
-        #
-        # Return *should* be a Hash like this:
-        #   { "non_existent_cookbooks"     => ["nope"],
-        #     "cookbooks_with_no_versions" => [],
-        #     "message" => "Run list contains invalid items: no such cookbook nope."}
-        def extract_412_error_message
-          # Example:
-          # "{\"error\":[\"{\\\"non_existent_cookbooks\\\":[\\\"nope\\\"],\\\"cookbooks_with_no_versions\\\":[],\\\"message\\\":\\\"Run list contains invalid items: no such cookbook nope.\\\"}\"]}"
-
-          wrapped_error_message = attempt_json_parse(exception.response.body)
-          unless wrapped_error_message.kind_of?(Hash) && wrapped_error_message.key?("error")
-            return wrapped_error_message.to_s
-          end
-
-          error_description = Array(wrapped_error_message["error"]).first
-          if error_description.kind_of?(Hash)
-            return error_description
-          end
-          attempt_json_parse(error_description)
-        end
-
-        private
-
-        def attempt_json_parse(maybe_json_string)
-          Chef::JSONCompat.from_json(maybe_json_string)
-        rescue Exception
-          maybe_json_string
-        end
-
-      end
-    end
-  end
-end
+#--
+# Author:: Daniel DeLeo (<dan@chef.io>)
+# Copyright:: Copyright 2012-2016, Chef Software, 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/formatters/error_inspectors/api_error_formatting"
+
+class Chef
+  module Formatters
+    module ErrorInspectors
+      class CookbookResolveErrorInspector
+
+        attr_reader :exception
+        attr_reader :expanded_run_list
+
+        include APIErrorFormatting
+
+        def initialize(expanded_run_list, exception)
+          @expanded_run_list = expanded_run_list
+          @exception = exception
+        end
+
+        def add_explanation(error_description)
+          case exception
+          when Net::HTTPServerException, Net::HTTPFatalError
+            humanize_http_exception(error_description)
+          when EOFError
+            describe_eof_error(error_description)
+          when *NETWORK_ERROR_CLASSES
+            describe_network_errors(error_description)
+          else
+            error_description.section("Unexpected Error:", "#{exception.class.name}: #{exception.message}")
+          end
+        end
+
+        def humanize_http_exception(error_description)
+          response = exception.response
+          case response
+          when Net::HTTPUnauthorized
+            # TODO: this is where you'd see conflicts b/c of username/clientname stuff
+            describe_401_error(error_description)
+          when Net::HTTPForbidden
+            # TODO: we're rescuing errors from Node.find_or_create
+            # * could be no write on nodes container
+            # * could be no read on the node
+            error_description.section("Authorization Error", <<-E)
+This client is not authorized to read some of the information required to
+access its cookbooks (HTTP 403).
+
+To access its cookbooks, a client needs to be able to read its environment and
+all of the cookbooks in its expanded run list.
+E
+            error_description.section("Expanded Run List:", expanded_run_list_ul)
+            error_description.section("Server Response:", format_rest_error)
+          when Net::HTTPPreconditionFailed
+            describe_412_error(error_description)
+          when Net::HTTPBadRequest
+            describe_400_error(error_description)
+          when Net::HTTPNotFound
+          when Net::HTTPInternalServerError
+            describe_500_error(error_description)
+          when Net::HTTPBadGateway, Net::HTTPServiceUnavailable
+            describe_503_error(error_description)
+          when Net::HTTPNotAcceptable
+            describe_406_error(error_description, response)
+          else
+            describe_http_error(error_description)
+          end
+        end
+
+        def describe_412_error(error_description)
+          explanation = ""
+          error_reasons = extract_412_error_message
+
+          # Prepare the error message if there is detailed information
+          # about individual cookbooks.
+          if !error_reasons.respond_to?(:key?)
+            explanation << error_reasons.to_s
+          else
+            if error_reasons.key?("non_existent_cookbooks") && !Array(error_reasons["non_existent_cookbooks"]).empty?
+              explanation << "The following cookbooks are required by the client but don't exist on the server:\n"
+              Array(error_reasons["non_existent_cookbooks"]).each do |cookbook|
+                explanation << "* #{cookbook}\n"
+              end
+              explanation << "\n"
+            end
+            if error_reasons.key?("cookbooks_with_no_versions") && !Array(error_reasons["cookbooks_with_no_versions"]).empty?
+              explanation << "The following cookbooks exist on the server, but there is no version that meets\nthe version constraints in this environment:\n"
+              Array(error_reasons["cookbooks_with_no_versions"]).each do |cookbook|
+                explanation << "* #{cookbook}\n"
+              end
+              explanation << "\n"
+            end
+          end
+
+          if !explanation.empty?
+            error_description.section("Missing Cookbooks:", explanation)
+          else
+            # If we don't have any cookbook details print a more
+            # generic error message.
+            if error_reasons.respond_to?(:key?) && error_reasons["message"]
+              explanation << "Error message: #{error_reasons["message"]}\n"
+            end
+
+            explanation << <<EOM
+You might be able to resolve this issue with:
+  1-) Removing cookbook versions that depend on deleted cookbooks.
+  2-) Removing unused cookbook versions.
+  3-) Pinning exact cookbook versions using environments.
+EOM
+            error_description.section("Cookbook dependency resolution error:", explanation)
+          end
+
+          error_description.section("Expanded Run List:", expanded_run_list_ul)
+        end
+
+        def expanded_run_list_ul
+          @expanded_run_list.map { |i| "* #{i}" }.join("\n")
+        end
+
+        # In my tests, the error from the server is double JSON encoded, but we
+        # should not rely on this not getting fixed.
+        #
+        # Return *should* be a Hash like this:
+        #   { "non_existent_cookbooks"     => ["nope"],
+        #     "cookbooks_with_no_versions" => [],
+        #     "message" => "Run list contains invalid items: no such cookbook nope."}
+        def extract_412_error_message
+          # Example:
+          # "{\"error\":[\"{\\\"non_existent_cookbooks\\\":[\\\"nope\\\"],\\\"cookbooks_with_no_versions\\\":[],\\\"message\\\":\\\"Run list contains invalid items: no such cookbook nope.\\\"}\"]}"
+
+          wrapped_error_message = attempt_json_parse(exception.response.body)
+          unless wrapped_error_message.kind_of?(Hash) && wrapped_error_message.key?("error")
+            return wrapped_error_message.to_s
+          end
+
+          error_description = Array(wrapped_error_message["error"]).first
+          if error_description.kind_of?(Hash)
+            return error_description
+          end
+          attempt_json_parse(error_description)
+        end
+
+        private
+
+        def attempt_json_parse(maybe_json_string)
+          Chef::JSONCompat.from_json(maybe_json_string)
+        rescue Exception
+          maybe_json_string
+        end
+
+      end
+    end
+  end
+end