chef 14.2.0 → 14.3.37

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

@@ -56,12 +56,12 @@ class Chef
             # 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).
+            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.
+              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)
@@ -115,11 +115,11 @@ E
               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.
+            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

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

@@ -43,12 +43,12 @@ class Chef
           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.
+            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}"
+            error_description.section("Relevant Config Settings:", <<~E)
+              client_key        "#{api_key}"
 E
           when EOFError
             describe_eof_error(error_description)
@@ -69,13 +69,13 @@ E
             # 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).
+            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.
+            error_description.section("Possible Causes:", <<~E)
+              * Your client (#{username}) may have misconfigured authorization permissions.
 E
           when Net::HTTPBadRequest
             describe_400_error(error_description)
@@ -97,11 +97,11 @@ E
         # 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.
+          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}"
+          error_description.section("Relevant Config Settings:", <<~E)
+            chef_server_url "#{server_url}"
 E
         end
 

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

@@ -26,26 +26,26 @@ class Chef
           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}
+            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}"
+            error_description.section("Relevant Config Settings:", <<~E)
+              chef_server_url  "#{server_url}"
 
-If your chef_server_url is correct, your network could be down.
+              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.
+            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}"
+            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.
+            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)
@@ -59,50 +59,50 @@ E
           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.
+              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).
+              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}"
+              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.
+                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).
+            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.
+            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).
+            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.
+            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}"
+            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.
+            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
@@ -114,13 +114,13 @@ E
         end
 
         def username
-          #config[:node_name]
+          # config[:node_name]
           config[:validation_client_name]
         end
 
         def api_key
           config[:validation_key]
-          #config[:client_key]
+          # config[:client_key]
         end
 
         def server_url

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

@@ -43,7 +43,7 @@ class Chef
             error_description.section("Resource Declaration:", resource.sensitive ? "suppressed sensitive resource output" : recipe_snippet)
           end
 
-          error_description.section("Compiled Resource:", "#{resource.to_text}")
+          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.

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

@@ -36,10 +36,10 @@ class Chef
         def add_explanation(error_description)
           case exception
           when Errno::ECONNREFUSED, Timeout::Error, Errno::ETIMEDOUT, SocketError
-            error_description.section("Networking Error:", <<-E)
-#{exception.message}
+            error_description.section("Networking Error:", <<~E)
+              #{exception.message}
 
-Your chef_server_url may be misconfigured, or the network could be down.
+              Your chef_server_url may be misconfigured, or the network could be down.
 E
           when Net::HTTPServerException, Net::HTTPFatalError
             humanize_http_exception(error_description)
@@ -76,35 +76,35 @@ E
           response = exception.response
           case response
           when Net::HTTPUnauthorized
-            error_description.section("Authentication Error:", <<-E)
-Failed to authenticate to the chef server (http 401).
+            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}"
+            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.
+              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).
+            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.
+            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.
+            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

data/lib/chef/formatters/indentable_output_stream.rb

@@ -35,19 +35,19 @@ class Chef
       # cause indentation but will not move to the next line yet (future 'print'
       # and 'puts' statements will stay on this line).
       def start_line(string, *args)
-        print(string, from_args(args, :start_line => true))
+        print(string, from_args(args, start_line: true))
       end
 
       # Print a line.  This will continue from the last start_line or print,
       # or start a new line and indent if necessary.
       def puts(string, *args)
-        print(string, from_args(args, :end_line => true))
+        print(string, from_args(args, end_line: true))
       end
 
       # Print an entire line from start to end.  This will terminate any existing
       # lines and cause indentation.
       def puts_line(string, *args)
-        print(string, from_args(args, :start_line => true, :end_line => true))
+        print(string, from_args(args, start_line: true, end_line: true))
       end
 
       # Print a raw chunk
@@ -103,7 +103,7 @@ class Chef
         if colors.size == 1 && colors[0].kind_of?(Hash)
           merge_options.merge(colors[0])
         else
-          merge_options.merge({ :colors => colors })
+          merge_options.merge({ colors: colors })
         end
       end
 

data/lib/chef/guard_interpreter/resource_guard_interpreter.rb

@@ -36,15 +36,15 @@ class Chef
         # Only execute and script resources and use guard attributes.
         # The command to be executed on them are passed via different attributes.
         # Script resources use code attribute and execute resources use
-        # command attribute. Moreover script resources are also execute
+        # command property. Moreover script resources are also execute
         # resources. Here we make sure @command is assigned to the right
         # attribute by checking the type of the resources.
         # We need to make sure we check for Script first because any resource
         # that can get to here is an Execute resource.
         if @resource.is_a? Chef::Resource::Script
-          block_attributes = @command_opts.merge({ :code => @command })
+          block_attributes = @command_opts.merge({ code: @command })
         else
-          block_attributes = @command_opts.merge({ :command => @command })
+          block_attributes = @command_opts.merge({ command: @command })
         end
 
         # Handles cases like powershell_script where default

data/lib/chef/handler/json_file.rb

@@ -41,7 +41,7 @@ class Chef
         savetime = Time.now.strftime("%Y%m%d%H%M%S")
         File.open(File.join(config[:path], "chef-run-report-#{savetime}.json"), "w") do |file|
 
-          #ensure start time and end time are output in the json properly in the event activesupport happens to be on the system
+          # ensure start time and end time are output in the json properly in the event activesupport happens to be on the system
           run_data = data
           run_data[:start_time] = run_data[:start_time].to_s
           run_data[:end_time] = run_data[:end_time].to_s

data/lib/chef/http/auth_credentials.rb

@@ -50,8 +50,8 @@ class Chef
         host = request_params.delete(:host) || "localhost"
 
         sign_obj = Mixlib::Authentication::SignedHeaderAuth.signing_object(request_params)
-        signed = sign_obj.sign(key, use_ssh_agent: @use_ssh_agent).merge({ :host => host })
-        signed.inject({}) { |memo, kv| memo["#{kv[0].to_s.upcase}"] = kv[1]; memo }
+        signed = sign_obj.sign(key, use_ssh_agent: @use_ssh_agent).merge({ host: host })
+        signed.inject({}) { |memo, kv| memo[(kv[0].to_s.upcase).to_s] = kv[1]; memo }
       end
 
     end

data/lib/chef/http/authenticator.rb

@@ -24,7 +24,7 @@ class Chef
   class HTTP
     class Authenticator
 
-      DEFAULT_SERVER_API_VERSION = "1"
+      DEFAULT_SERVER_API_VERSION = "1".freeze
 
       attr_reader :signing_key_filename
       attr_reader :raw_key
@@ -104,11 +104,11 @@ class Chef
 
       def authentication_headers(method, url, json_body = nil, headers = nil)
         request_params = {
-          :http_method => method,
-          :path => url.path,
-          :body => json_body,
-          :host => "#{url.host}:#{url.port}",
-          :headers => headers,
+          http_method: method,
+          path: url.path,
+          body: json_body,
+          host: "#{url.host}:#{url.port}",
+          headers: headers,
         }
         request_params[:body] ||= ""
         auth_credentials.signature_headers(request_params)

data/lib/chef/http/cookie_manager.rb

@@ -33,7 +33,7 @@ class Chef
 
       def handle_request(method, url, headers = {}, data = false)
         @host, @port = url.host, url.port
-        if @cookies.has_key?("#{@host}:#{@port}")
+        if @cookies.key?("#{@host}:#{@port}")
           headers["Cookie"] = @cookies["#{@host}:#{@port}"]
         end
         [method, url, headers, data]

data/lib/chef/http/http_request.rb

@@ -27,7 +27,7 @@ require "net/http"
 # However, in ohai before 0.6.0, the version is defined
 # in ohai, not ohai/version
 begin
-  require "ohai/version" #used in user agent string.
+  require "ohai/version" # used in user agent string.
 rescue LoadError
   require "ohai"
 end
@@ -40,7 +40,7 @@ class Chef
 
       engine = defined?(RUBY_ENGINE) ? RUBY_ENGINE : "ruby"
 
-      UA_COMMON = "/#{::Chef::VERSION} (#{engine}-#{RUBY_VERSION}-p#{RUBY_PATCHLEVEL}; ohai-#{Ohai::VERSION}; #{RUBY_PLATFORM}; +https://chef.io)"
+      UA_COMMON = "/#{::Chef::VERSION} (#{engine}-#{RUBY_VERSION}-p#{RUBY_PATCHLEVEL}; ohai-#{Ohai::VERSION}; #{RUBY_PLATFORM}; +https://chef.io)".freeze
       DEFAULT_UA = "Chef Client" << UA_COMMON
 
       USER_AGENT = "User-Agent".freeze
@@ -152,7 +152,7 @@ class Chef
       end
 
       def configure_http_request(request_body = nil)
-        req_path = "#{path}"
+        req_path = (path).to_s
         req_path << "?#{query}" if query
 
         @http_request = case method.to_s.downcase

data/lib/chef/http/json_input.rb

@@ -36,7 +36,7 @@ class Chef
           headers.delete_if { |key, _value| key.casecmp("content-type") == 0 }
           headers["Content-Type"] = "application/json"
           json_opts = {}
-          json_opts[:validate_utf8] = opts[:validate_utf8] if opts.has_key?(:validate_utf8)
+          json_opts[:validate_utf8] = opts[:validate_utf8] if opts.key?(:validate_utf8)
           data = Chef::JSONCompat.to_json(data, json_opts)
           # Force encoding to binary to fix SSL related EOFErrors
           # cf. http://tickets.opscode.com/browse/CHEF-2363

data/lib/chef/http/json_to_model_output.rb

@@ -26,7 +26,7 @@ class Chef
     # a `json_class` key.
     class JSONToModelOutput < JSONOutput
       def initialize(opts = {})
-        opts[:inflate_json_class] = true if !opts.has_key?(:inflate_json_class)
+        opts[:inflate_json_class] = true if !opts.key?(:inflate_json_class)
         super
       end
     end

data/lib/chef/http/socketless_chef_zero_client.rb

@@ -131,7 +131,7 @@ class Chef
         505 => "HTTP Version Not Supported",
         507 => "Insufficient Storage",
         511 => "Network Authentication Required",
-      }
+      }.freeze
 
       STATUS_MESSAGE.each_value { |v| v.freeze }
       STATUS_MESSAGE.freeze