chef 12.22.1 → 12.22.3

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

@@ -1,82 +1,82 @@
-#--
-# 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
-
-      # == CookbookSyncErrorInspector
-      # Generates human-friendly explanations for errors encountered during
-      # cookbook sync.
-      #--
-      # TODO: Not sure what errors are commonly seen during cookbook sync, so
-      # the messaging is kinda generic.
-      class CookbookSyncErrorInspector
-
-        include APIErrorFormatting
-
-        attr_reader :exception
-        attr_reader :cookbooks
-
-        def initialize(cookbooks, exception)
-          @cookbooks, @exception = cookbooks, 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 config
-          Chef::Config
-        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::HTTPBadRequest
-            describe_400_error(error_description)
-          when Net::HTTPNotFound
-          when Net::HTTPInternalServerError
-            describe_500_error(error_description)
-          when Net::HTTPBadGateway, Net::HTTPServiceUnavailable, Net::HTTPGatewayTimeOut
-            describe_503_error(error_description)
-          when Net::HTTPNotAcceptable
-            describe_406_error(error_description, response)
-          else
-            describe_http_error(error_description)
-          end
-        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
+
+      # == CookbookSyncErrorInspector
+      # Generates human-friendly explanations for errors encountered during
+      # cookbook sync.
+      #--
+      # TODO: Not sure what errors are commonly seen during cookbook sync, so
+      # the messaging is kinda generic.
+      class CookbookSyncErrorInspector
+
+        include APIErrorFormatting
+
+        attr_reader :exception
+        attr_reader :cookbooks
+
+        def initialize(cookbooks, exception)
+          @cookbooks, @exception = cookbooks, 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 config
+          Chef::Config
+        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::HTTPBadRequest
+            describe_400_error(error_description)
+          when Net::HTTPNotFound
+          when Net::HTTPInternalServerError
+            describe_500_error(error_description)
+          when Net::HTTPBadGateway, Net::HTTPServiceUnavailable, Net::HTTPGatewayTimeOut
+            describe_503_error(error_description)
+          when Net::HTTPNotAcceptable
+            describe_406_error(error_description, response)
+          else
+            describe_http_error(error_description)
+          end
+        end
+
+      end
+    end
+  end
+end

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

@@ -1,128 +1,128 @@
-#--
-# 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
-
-      # == 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::HTTPServerException, 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 chef-client.
-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 server 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
+#--
+# 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
+
+      # == 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::HTTPServerException, 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 chef-client.
+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 server 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

@@ -1,147 +1,147 @@
-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::HTTPServerException, 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 Chef Server:
-#{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 chef-client.
-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 server location in client.rb to the server'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 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}"
-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 (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 server 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
-          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 Chef Server 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
+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::HTTPServerException, 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 Chef Server:
+#{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 chef-client.
+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 server location in client.rb to the server'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 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}"
+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 (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 server 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
+          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 Chef Server 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