chef 18.0.169-x64-mingw-ucrt

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

@@ -0,0 +1,129 @@
+#--
+# Author:: Daniel DeLeo (<dan@chef.io>)
+# Copyright:: Copyright (c) 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_relative "api_error_formatting"
+require "chef-utils/dist" unless defined?(ChefUtils::Dist)
+
+class Chef
+  module Formatters
+    module ErrorInspectors
+
+      # == APIErrorInspector
+      # Wraps exceptions caused by API calls to the server.
+      class NodeLoadErrorInspector
+
+        include APIErrorFormatting
+
+        attr_reader :exception
+        attr_reader :node_name
+        attr_reader :config
+
+        def initialize(node_name, exception, config)
+          @node_name = node_name
+          @exception = exception
+          @config = config
+        end
+
+        def add_explanation(error_description)
+          case exception
+          when Net::HTTPClientException, Net::HTTPFatalError
+            humanize_http_exception(error_description)
+          when Chef::Exceptions::PrivateKeyMissing
+            error_description.section("Private Key Not Found:", <<~E)
+              Your private key could not be loaded. If the key file exists, ensure that it is
+              readable by #{ChefUtils::Dist::Infra::PRODUCT}.
+            E
+            error_description.section("Relevant Config Settings:", <<~E)
+              client_key        "#{api_key}"
+            E
+          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)
+              Your client is not authorized to load the node data (HTTP 403).
+            E
+            error_description.section("Server Response:", format_rest_error)
+
+            error_description.section("Possible Causes:", <<~E)
+              * Your client (#{username}) may have misconfigured authorization permissions.
+            E
+          when Net::HTTPBadRequest
+            describe_400_error(error_description)
+          when Net::HTTPNotFound
+            describe_404_error(error_description)
+          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
+
+        # Custom 404 error messaging. Users sometimes see 404s when they have
+        # misconfigured server URLs, and the wrong one redirects to the new
+        # one, e.g., PUT http://wrong.url/nodes/node-name becomes a GET after a
+        # redirect.
+        def describe_404_error(error_description)
+          error_description.section("Resource Not Found:", <<~E)
+            The #{ChefUtils::Dist::Server::PRODUCT} returned a HTTP 404. This usually indicates that your chef_server_url is incorrect.
+          E
+          error_description.section("Relevant Config Settings:", <<~E)
+            chef_server_url "#{server_url}"
+          E
+        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
+end

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

@@ -0,0 +1,148 @@
+require "chef-utils/dist" unless defined?(ChefUtils::Dist)
+
+class Chef
+  module Formatters
+    module ErrorInspectors
+      # == RegistrationErrorInspector
+      # Wraps exceptions that occur during the client registration process and
+      # suggests possible causes.
+      #--
+      # TODO: Lots of duplication with the node_load_error_inspector, just
+      # slightly tweaked to talk about validation keys instead of other keys.
+      class RegistrationErrorInspector
+        include APIErrorFormatting
+
+        attr_reader :exception
+        attr_reader :node_name
+        attr_reader :config
+
+        def initialize(node_name, exception, config)
+          @node_name = node_name
+          @exception = exception
+          @config = config
+        end
+
+        def add_explanation(error_description)
+          case exception
+          when Net::HTTPClientException, Net::HTTPFatalError
+            humanize_http_exception(error_description)
+          when Errno::ECONNREFUSED, Timeout::Error, Errno::ETIMEDOUT, SocketError
+            error_description.section("Network Error:", <<~E)
+              There was a network error connecting to the #{ChefUtils::Dist::Server::PRODUCT}:
+              #{exception.message}
+            E
+            error_description.section("Relevant Config Settings:", <<~E)
+              chef_server_url  "#{server_url}"
+
+              If your chef_server_url is correct, your network could be down.
+            E
+          when Chef::Exceptions::PrivateKeyMissing
+            error_description.section("Private Key Not Found:", <<~E)
+              Your private key could not be loaded. If the key file exists, ensure that it is
+              readable by #{ChefUtils::Dist::Infra::PRODUCT}.
+            E
+            error_description.section("Relevant Config Settings:", <<~E)
+              validation_key "#{api_key}"
+            E
+          when Chef::Exceptions::InvalidRedirect
+            error_description.section("Invalid Redirect:", <<~E)
+              Change your #{ChefUtils::Dist::Server::PRODUCT} location in client.rb to the #{ChefUtils::Dist::Server::PRODUCT}'s FQDN to avoid unwanted redirections.
+            E
+          when EOFError
+            describe_eof_error(error_description)
+          else
+            "#{exception.class.name}: #{exception.message}"
+          end
+        end
+
+        def humanize_http_exception(error_description)
+          response = exception.response
+          case response
+          when Net::HTTPUnauthorized
+            if clock_skew?
+              error_description.section("Authentication Error:", <<~E)
+                Failed to authenticate to the #{ChefUtils::Dist::Server::PRODUCT} (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 #{ChefUtils::Dist::Server::PRODUCT} (http 401).
+              E
+
+              error_description.section("Server Response:", format_rest_error)
+              error_description.section("Relevant Config Settings:", <<~E)
+                chef_server_url         "#{server_url}"
+                validation_client_name  "#{username}"
+                validation_key          "#{api_key}"
+
+                If these settings are correct, your validation_key may be invalid.
+              E
+            end
+          when Net::HTTPForbidden
+            error_description.section("Authorization Error:", <<~E)
+              Your validation client is not authorized to create the client for this node on the #{ChefUtils::Dist::Server::PRODUCT} (HTTP 403).
+            E
+            error_description.section("Possible Causes:", <<~E)
+              * There may already be a client named "#{config[:node_name]}"
+              * Your validation client (#{username}) may have misconfigured authorization permissions.
+            E
+          when Net::HTTPBadRequest
+            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)
+          when Net::HTTPNotFound
+            error_description.section("Resource Not Found:", <<~E)
+              The #{ChefUtils::Dist::Server::PRODUCT} returned a HTTP 404. This usually indicates that your chef_server_url configuration is incorrect.
+            E
+            error_description.section("Relevant Config Settings:", <<~E)
+              chef_server_url "#{server_url}"
+            E
+          when Net::HTTPNotAcceptable
+            describe_406_error(error_description, response)
+          when Net::HTTPInternalServerError
+            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)
+          when Net::HTTPBadGateway, Net::HTTPServiceUnavailable
+            error_description.section("Server Unavailable", "The #{ChefUtils::Dist::Server::PRODUCT} is temporarily unavailable")
+            error_description.section("Server Response:", format_rest_error)
+          else
+            error_description.section("Unexpected API Request Failure:", format_rest_error)
+          end
+        end
+
+        def username
+          # config[:node_name]
+          config[:validation_client_name]
+        end
+
+        def api_key
+          config[:validation_key]
+          # config[:client_key]
+        end
+
+        def server_url
+          config[:chef_server_url]
+        end
+
+        def clock_skew?
+          exception.response.body =~ /synchronize the clock/i
+        end
+
+        # Parses JSON from the error response sent by Chef Server and returns the
+        # error message
+        #--
+        # TODO: this code belongs in Chef::REST
+        def format_rest_error
+          Array(Chef::JSONCompat.from_json(exception.response.body)["error"]).join("; ")
+        rescue Exception
+          exception.response.body
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,125 @@
+#--
+# Author:: Daniel DeLeo (<dan@chef.io>)
+# Author:: Tyler Cloke (<tyler@chef.io>)
+# Copyright:: Copyright (c) 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-utils" unless defined?(ChefUtils::CANARY)
+
+class Chef
+  module Formatters
+    module ErrorInspectors
+      class ResourceFailureInspector
+
+        attr_reader :resource
+        attr_reader :action
+        attr_reader :exception
+
+        def initialize(resource, action, exception)
+          @resource = resource
+          @action = action
+          @exception = exception
+        end
+
+        def add_explanation(error_description)
+          error_description.section(exception.class.name, exception.message)
+
+          unless filtered_bt.empty?
+            error_description.section("Cookbook Trace: (most recent call first)", filtered_bt.join("\n"))
+          end
+
+          unless dynamic_resource?
+            error_description.section("Resource Declaration:", resource.sensitive ? "suppressed sensitive resource output" : recipe_snippet)
+          end
+
+          error_description.section("Compiled Resource:", (resource.to_text).to_s)
+
+          # Template errors get wrapped in an exception class that can show the relevant template code,
+          # so add them to the error output.
+          if exception.respond_to?(:source_listing)
+            error_description.section("Template Context:", "#{exception.source_location}\n#{exception.source_listing}")
+          end
+
+          if ChefUtils.windows?
+            require_relative "../../win32/security"
+
+            unless Chef::ReservedNames::Win32::Security.has_admin_privileges?
+              error_description.section("Missing Windows Admin Privileges", "#{ChefUtils::Dist::Infra::CLIENT} doesn't have administrator privileges. This can be a possible reason for the resource failure.")
+            end
+          end
+        end
+
+        def recipe_snippet
+          return nil if dynamic_resource?
+
+          @snippet ||= if (file = parse_source) && (line = parse_line(file))
+                         return nil unless ::File.exist?(file)
+
+                         lines = IO.readlines(file)
+
+                         relevant_lines = ["# In #{file}\n\n"]
+
+                         current_line = line - 1
+                         current_line = 0 if current_line < 0
+                         nesting = 0
+
+                         loop do
+
+                           # low rent parser. try to gracefully handle nested blocks in resources
+                           nesting += 1 if /\s+do\s*/.match?(lines[current_line])
+                           nesting -= 1 if /end\s*$/.match?(lines[current_line])
+
+                           relevant_lines << format_line(current_line, lines[current_line])
+
+                           break if lines[current_line + 1].nil?
+                           break if current_line >= (line + 50)
+                           break if nesting <= 0
+
+                           current_line += 1
+                         end
+                         relevant_lines << format_line(current_line + 1, lines[current_line + 1]) if lines[current_line + 1]
+                         relevant_lines.join("")
+                       end
+        end
+
+        def dynamic_resource?
+          !resource.source_line
+        end
+
+        def filtered_bt
+          filters = Array(Chef::Config.cookbook_path).map { |p| /^#{Regexp.escape(p)}/ }
+          exception.backtrace.select { |line| filters.any? { |filter| line =~ filter } }
+        end
+
+        private
+
+        def format_line(line_nr, line)
+          # Print line number as 1-indexed not zero
+          line_nr_string = (line_nr + 1).to_s.rjust(3) + ": "
+          line_nr_string + line
+        end
+
+        def parse_source
+          resource.source_line[/^((\w:)?[^:]+):(\d+)/, 1]
+        end
+
+        def parse_line(source)
+          resource.source_line[/^#{Regexp.escape(source)}:(\d+)/, 1].to_i
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,122 @@
+#--
+# Author:: Daniel DeLeo (<dan@chef.io>)
+# Author:: Tyler Cloke (<tyler@chef.io>)
+# Copyright:: Copyright (c) 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_relative "api_error_formatting"
+require "chef-utils/dist" unless defined?(ChefUtils::Dist)
+
+class Chef
+  module Formatters
+    module ErrorInspectors
+      class RunListExpansionErrorInspector
+
+        include APIErrorFormatting
+
+        attr_reader :exception
+        attr_reader :node
+
+        def initialize(node, exception)
+          @node, @exception = node, exception
+        end
+
+        def add_explanation(error_description)
+          case exception
+          when Errno::ECONNREFUSED, Timeout::Error, Errno::ETIMEDOUT, SocketError
+            error_description.section("Networking Error:", <<~E)
+              #{exception.message}
+
+              Your chef_server_url may be misconfigured, or the network could be down.
+            E
+          when Net::HTTPClientException, Net::HTTPFatalError
+            humanize_http_exception(error_description)
+          when Chef::Exceptions::MissingRole
+            describe_missing_role(error_description)
+          when EOFError
+            describe_eof_error(error_description)
+          else
+            error_description.section("Unexpected Error:", "#{exception.class.name}: #{exception.message}")
+          end
+        end
+
+        def describe_missing_role(error_description)
+          error_description.section("Missing Role(s) in Run List:", missing_roles_explained)
+          original_run_list = node.run_list.map { |item| "* #{item}" }.join("\n")
+          error_description.section("Original Run List", original_run_list)
+        end
+
+        def missing_roles_explained
+          run_list_expansion.missing_roles_with_including_role.map do |role, includer|
+            "* #{role} included by '#{includer}'"
+          end.join("\n")
+        end
+
+        def run_list_expansion
+          exception.expansion
+        end
+
+        def config
+          Chef::Config
+        end
+
+        def humanize_http_exception(error_description)
+          response = exception.response
+          case response
+          when Net::HTTPUnauthorized
+            error_description.section("Authentication Error:", <<~E)
+              Failed to authenticate to the #{ChefUtils::Dist::Server::PRODUCT} (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
+          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)
+              Your client is not authorized to load one or more of your roles (HTTP 403).
+            E
+            error_description.section("Server Response:", format_rest_error)
+
+            error_description.section("Possible Causes:", <<~E)
+              * Your client (#{username}) may have misconfigured authorization permissions.
+            E
+          when Net::HTTPNotAcceptable
+            describe_406_error(error_description, response)
+          when Net::HTTPInternalServerError
+            error_description.section("Unknown Server Error:", <<~E)
+              The server had a fatal error attempting to load a role.
+            E
+            error_description.section("Server Response:", format_rest_error)
+          when Net::HTTPBadGateway, Net::HTTPServiceUnavailable
+            error_description.section("Server Unavailable", "The #{ChefUtils::Dist::Server::PRODUCT} is temporarily unavailable")
+            error_description.section("Server Response:", format_rest_error)
+          else
+            error_description.section("Unexpected API Request Failure:", format_rest_error)
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/chef/formatters/error_inspectors.rb

@@ -0,0 +1,19 @@
+require_relative "error_inspectors/node_load_error_inspector"
+require_relative "error_inspectors/registration_error_inspector"
+require_relative "error_inspectors/compile_error_inspector"
+require_relative "error_inspectors/resource_failure_inspector"
+require_relative "error_inspectors/run_list_expansion_error_inspector"
+require_relative "error_inspectors/cookbook_resolve_error_inspector"
+require_relative "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_mapper.rb

@@ -0,0 +1,85 @@
+#--
+# Author:: Tyler Cloke (<tyler@chef.io>)
+# Copyright:: Copyright (c) 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
+    # == Formatters::ErrorMapper
+    # Collection of methods for creating and returning
+    # Formatters::ErrorDescription objects based on node,
+    # exception, and configuration information.
+    module ErrorMapper
+
+      # Failed to register this client with the server.
+      def self.registration_failed(node_name, exception, config)
+        error_inspector = ErrorInspectors::RegistrationErrorInspector.new(node_name, exception, config)
+        headline = "Chef Infra Client encountered an error attempting to create the client \"#{node_name}\""
+        description = ErrorDescription.new(headline)
+        error_inspector.add_explanation(description)
+        description
+      end
+
+      def self.node_load_failed(node_name, exception, config)
+        error_inspector = ErrorInspectors::NodeLoadErrorInspector.new(node_name, exception, config)
+        headline = "Chef Infra Client encountered an error attempting to load the node data for \"#{node_name}\""
+        description = ErrorDescription.new(headline)
+        error_inspector.add_explanation(description)
+        description
+      end
+
+      def self.run_list_expand_failed(node, exception)
+        error_inspector = ErrorInspectors::RunListExpansionErrorInspector.new(node, exception)
+        headline = "Error expanding the run_list:"
+        description = ErrorDescription.new(headline)
+        error_inspector.add_explanation(description)
+        description
+      end
+
+      def self.cookbook_resolution_failed(expanded_run_list, exception)
+        error_inspector = ErrorInspectors::CookbookResolveErrorInspector.new(expanded_run_list, exception)
+        headline = "Error Resolving Cookbooks for Run List:"
+        description = ErrorDescription.new(headline)
+        error_inspector.add_explanation(description)
+        description
+      end
+
+      def self.cookbook_sync_failed(cookbooks, exception)
+        error_inspector = ErrorInspectors::CookbookSyncErrorInspector.new(cookbooks, exception)
+        headline = "Error Syncing Cookbooks:"
+        description = ErrorDescription.new(headline)
+        error_inspector.add_explanation(description)
+        description
+      end
+
+      def self.resource_failed(resource, action, exception)
+        error_inspector = ErrorInspectors::ResourceFailureInspector.new(resource, action, exception)
+        headline = "Error executing action `#{action}` on resource '#{resource}'"
+        description = ErrorDescription.new(headline)
+        error_inspector.add_explanation(description)
+        description
+      end
+
+      def self.file_load_failed(path, exception)
+        error_inspector = ErrorInspectors::CompileErrorInspector.new(path, exception)
+        headline = "Recipe Compile Error" + ( path ? " in #{path}" : "" )
+        description = ErrorDescription.new(headline)
+        error_inspector.add_explanation(description)
+        description
+      end
+    end
+  end
+end