chef 12.18.31 → 13.0.118

data/lib/chef/formatters/error_mapper.rb

@@ -30,7 +30,7 @@ class Chef
         headline = "Chef encountered an error attempting to create the client \"#{node_name}\""
         description = ErrorDescription.new(headline)
         error_inspector.add_explanation(description)
-        return description
+        description
       end
 
       def self.node_load_failed(node_name, exception, config)
@@ -38,7 +38,7 @@ class Chef
         headline = "Chef encountered an error attempting to load the node data for \"#{node_name}\""
         description = ErrorDescription.new(headline)
         error_inspector.add_explanation(description)
-        return description
+        description
       end
 
       def self.run_list_expand_failed(node, exception)
@@ -46,7 +46,7 @@ class Chef
         headline = "Error expanding the run_list:"
         description = ErrorDescription.new(headline)
         error_inspector.add_explanation(description)
-        return description
+        description
       end
 
       def self.cookbook_resolution_failed(expanded_run_list, exception)
@@ -54,7 +54,7 @@ class Chef
         headline = "Error Resolving Cookbooks for Run List:"
         description = ErrorDescription.new(headline)
         error_inspector.add_explanation(description)
-        return description
+        description
       end
 
       def self.cookbook_sync_failed(cookbooks, exception)
@@ -62,7 +62,7 @@ class Chef
         headline = "Error Syncing Cookbooks:"
         description = ErrorDescription.new(headline)
         error_inspector.add_explanation(description)
-        return description
+        description
       end
 
       def self.resource_failed(resource, action, exception)
@@ -70,7 +70,7 @@ class Chef
         headline = "Error executing action `#{action}` on resource '#{resource}'"
         description = ErrorDescription.new(headline)
         error_inspector.add_explanation(description)
-        return description
+        description
       end
 
       def self.file_load_failed(path, exception)

data/lib/chef/guard_interpreter/default_guard_interpreter.rb

@@ -1,6 +1,6 @@
 #
 # Author:: Adam Edwards (<adamed@chef.io>)
-# Copyright:: Copyright 2014-2016, Chef Software, Inc.
+# Copyright:: Copyright 2014-2017, Chef Software Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -33,7 +33,9 @@ class Chef
       public
 
       def evaluate
-        shell_out(@command, @command_opts).status.success?
+        shell_out_with_systems_locale(@command, @command_opts).status.success?
+      # Timeout fails command rather than chef-client run, see:
+      #   https://tickets.opscode.com/browse/CHEF-2690
       rescue Chef::Exceptions::CommandTimeout
         Chef::Log.warn "Command '#{@command}' timed out"
         false

data/lib/chef/http/api_versions.rb

@@ -0,0 +1,54 @@
+#--
+# Copyright:: Copyright 2017, 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/server_api_versions"
+require "chef/json_compat"
+
+class Chef
+  class HTTP
+    # An HTTP middleware to retrieve and store the Chef Server's minimum
+    # and maximum supported API versions.
+    class APIVersions
+
+      def initialize(options = {})
+      end
+
+      def handle_request(method, url, headers = {}, data = false)
+        [method, url, headers, data]
+      end
+
+      def handle_response(http_response, rest_request, return_value)
+        if http_response.code == "406"
+          ServerAPIVersions.instance.reset!
+        end
+        if http_response.key?("x-ops-server-api-version")
+          ServerAPIVersions.instance.set_versions(JSONCompat.parse(http_response["x-ops-server-api-version"]))
+        end
+        [http_response, rest_request, return_value]
+      end
+
+      def stream_response_handler(response)
+        nil
+      end
+
+      def handle_stream_complete(http_response, rest_request, return_value)
+        [http_response, rest_request, return_value]
+      end
+
+    end
+  end
+end

data/lib/chef/http/authenticator.rb

@@ -30,6 +30,8 @@ class Chef
       attr_reader :raw_key
       attr_reader :attr_names
       attr_reader :auth_credentials
+      attr_reader :version_class
+      attr_reader :api_version
 
       attr_accessor :sign_request
 
@@ -39,15 +41,12 @@ class Chef
         @signing_key_filename = opts[:signing_key_filename]
         @key = load_signing_key(opts[:signing_key_filename], opts[:raw_key])
         @auth_credentials = AuthCredentials.new(opts[:client_name], @key)
-        if opts[:api_version]
-          @api_version = opts[:api_version]
-        else
-          @api_version = DEFAULT_SERVER_API_VERSION
-        end
+        @version_class = opts[:version_class]
+        @api_version = opts[:api_version]
       end
 
       def handle_request(method, url, headers = {}, data = false)
-        headers["X-Ops-Server-API-Version"] = @api_version
+        headers["X-Ops-Server-API-Version"] = request_version
         headers.merge!(authentication_headers(method, url, data, headers)) if sign_requests?
         [method, url, headers, data]
       end
@@ -64,6 +63,16 @@ class Chef
         [http_response, rest_request, return_value]
       end
 
+      def request_version
+        if version_class
+          version_class.best_request_version
+        elsif api_version
+          api_version
+        else
+          DEFAULT_SERVER_API_VERSION
+        end
+      end
+
       def sign_requests?
         auth_credentials.sign_requests? && @sign_request
       end

data/lib/chef/http/json_output.rb

@@ -1,7 +1,7 @@
 #--
 # Author:: Daniel DeLeo (<dan@chef.io>)
 # Author:: John Keiser (<jkeiser@chef.io>)
-# Copyright:: Copyright 2013-2016, Chef Software Inc.
+# Copyright:: Copyright 2013-2017, Chef Software Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -61,6 +61,9 @@ class Chef
           [http_response, rest_request, return_value]
         else
           Chef::Log.debug("Expected JSON response, but got content-type '#{http_response['content-type']}'")
+          if http_response.body
+            Chef::Log.debug("Response body contains:\n#{http_response.body.length < 256 ? http_response.body : http_response.body[0..256] + " [...truncated...]"}")
+          end
           return [http_response, rest_request, http_response.body.to_s]
         end
       end

data/lib/chef/http/socketless_chef_zero_client.rb

@@ -170,6 +170,7 @@ class Chef
           "QUERY_STRING"    => url.query,
           "SERVER_PORT"     => url.port,
           "HTTP_HOST"       => "localhost:#{url.port}",
+          "HTTP_X_OPS_SERVER_API_VERSION" => headers["X-Ops-Server-API-Version"],
           "rack.url_scheme" => "chefzero",
           "rack.input"      => StringIO.new(body_str),
         }

data/lib/chef/http/validate_content_length.rb

@@ -50,7 +50,7 @@ class Chef
 
       def handle_response(http_response, rest_request, return_value)
         validate(http_response, http_response.body.bytesize) if http_response && http_response.body
-        return [http_response, rest_request, return_value]
+        [http_response, rest_request, return_value]
       end
 
       def handle_stream_complete(http_response, rest_request, return_value)
@@ -63,7 +63,7 @@ class Chef
         # Make sure the counter is reset since this object might get used
         # again. See CHEF-5100
         @content_length_counter = nil
-        return [http_response, rest_request, return_value]
+        [http_response, rest_request, return_value]
       end
 
       def stream_response_handler(response)

data/lib/chef/http.rb

@@ -142,13 +142,26 @@ class Chef
     # Makes an HTTP request to +path+ with the given +method+, +headers+, and
     # +data+ (if applicable).
     def request(method, path, headers = {}, data = false)
+      http_attempts ||= 0
       url = create_url(path)
       method, url, headers, data = apply_request_middleware(method, url, headers, data)
 
       response, rest_request, return_value = send_http_request(method, url, headers, data)
       response, rest_request, return_value = apply_response_middleware(response, rest_request, return_value)
+
       response.error! unless success_response?(response)
       return_value
+
+    rescue Net::HTTPServerException => e
+      http_attempts += 1
+      response = e.response
+      if response.kind_of?(Net::HTTPNotAcceptable) && version_retries - http_attempts > 0
+        Chef::Log.debug("Negotiating protocol version with #{url}, retry #{http_attempts}/#{version_retries}")
+        sleep(http_retry_delay)
+        retry
+      else
+        raise
+      end
     rescue Exception => exception
       log_failed_request(response, return_value) unless response.nil?
 
@@ -159,6 +172,7 @@ class Chef
     end
 
     def streaming_request_with_progress(path, headers = {}, &progress_block)
+      http_attempts ||= 0
       url = create_url(path)
       response, rest_request, return_value = nil, nil, nil
       tempfile = nil
@@ -177,6 +191,16 @@ class Chef
         response.error!
       end
       tempfile
+    rescue Net::HTTPServerException => e
+      http_attempts += 1
+      response = e.response
+      if response.kind_of?(Net::HTTPNotAcceptable) && version_retries - http_attempts > 0
+        Chef::Log.debug("Negotiating protocol version with #{url}, retry #{http_attempts}/#{version_retries}")
+        sleep(http_retry_delay)
+        retry
+      else
+        raise
+      end
     rescue Exception => e
       log_failed_request(response, return_value) unless response.nil?
       if e.respond_to?(:chef_rest_request=)
@@ -195,6 +219,7 @@ class Chef
     # @yield [tempfile] block to process the tempfile
     # @yieldparams [tempfile<Tempfile>] tempfile
     def streaming_request(path, headers = {})
+      http_attempts ||= 0
       url = create_url(path)
       response, rest_request, return_value = nil, nil, nil
       tempfile = nil
@@ -222,6 +247,16 @@ class Chef
         end
       end
       tempfile
+    rescue Net::HTTPServerException => e
+      http_attempts += 1
+      response = e.response
+      if response.kind_of?(Net::HTTPNotAcceptable) && version_retries - http_attempts > 0
+        Chef::Log.debug("Negotiating protocol version with #{url}, retry #{http_attempts}/#{version_retries}")
+        sleep(http_retry_delay)
+        retry
+      else
+        raise
+      end
     rescue Exception => e
       log_failed_request(response, return_value) unless response.nil?
       if e.respond_to?(:chef_rest_request=)
@@ -413,6 +448,10 @@ class Chef
       end
     end
 
+    def version_retries
+      @version_retries ||= options[:version_class].possible_requests
+    end
+
     # @api private
     def http_retry_delay
       config[:http_retry_delay]

data/lib/chef/json_compat.rb

@@ -26,32 +26,13 @@ class Chef
   class JSONCompat
     JSON_MAX_NESTING = 1000
 
-    JSON_CLASS = "json_class".freeze
-
-    CHEF_APICLIENT          = "Chef::ApiClient".freeze
-    CHEF_CHECKSUM           = "Chef::Checksum".freeze
-    CHEF_COOKBOOKVERSION    = "Chef::CookbookVersion".freeze
-    CHEF_DATABAG            = "Chef::DataBag".freeze
-    CHEF_DATABAGITEM        = "Chef::DataBagItem".freeze
-    CHEF_ENVIRONMENT        = "Chef::Environment".freeze
-    CHEF_NODE               = "Chef::Node".freeze
-    CHEF_ROLE               = "Chef::Role".freeze
-    CHEF_SANDBOX            = "Chef::Sandbox".freeze
-    CHEF_RESOURCE           = "Chef::Resource".freeze
-    CHEF_RESOURCECOLLECTION = "Chef::ResourceCollection".freeze
-    CHEF_RESOURCESET        = "Chef::ResourceCollection::ResourceSet".freeze
-    CHEF_RESOURCELIST       = "Chef::ResourceCollection::ResourceList".freeze
-    CHEF_RUNLISTEXPANSION   = "Chef::RunListExpansion".freeze
-
     class <<self
 
       # API to use to avoid create_addtions
       def parse(source, opts = {})
-        begin
-          FFI_Yajl::Parser.parse(source, opts)
-        rescue FFI_Yajl::ParseError => e
-          raise Chef::Exceptions::JSON::ParseError, e.message
-        end
+        FFI_Yajl::Parser.parse(source, opts)
+      rescue FFI_Yajl::ParseError => e
+        raise Chef::Exceptions::JSON::ParseError, e.message
       end
 
       # Just call the JSON gem's parse method with a modified :max_nesting field
@@ -65,48 +46,13 @@ class Chef
           raise Chef::Exceptions::JSON::ParseError, "Top level JSON object must be a Hash or Array. (actual: #{obj.class})"
         end
 
-        # The old default in the json gem (which we are mimicing because we
-        # sadly rely on this misfeature) is to "create additions" i.e., convert
-        # JSON objects into ruby objects. Explicit :create_additions => false
-        # is required to turn it off.
-        if opts[:create_additions].nil? || opts[:create_additions]
-          map_to_rb_obj(obj)
-        else
-          obj
-        end
-      end
-
-      # Look at an object that's a basic type (from json parse) and convert it
-      # to an instance of Chef classes if desired.
-      def map_to_rb_obj(json_obj)
-        case json_obj
-        when Hash
-          mapped_hash = map_hash_to_rb_obj(json_obj)
-          if json_obj.has_key?(JSON_CLASS) && (class_to_inflate = class_for_json_class(json_obj[JSON_CLASS]))
-            class_to_inflate.json_create(mapped_hash)
-          else
-            mapped_hash
-          end
-        when Array
-          json_obj.map { |e| map_to_rb_obj(e) }
-        else
-          json_obj
-        end
-      end
-
-      def map_hash_to_rb_obj(json_hash)
-        json_hash.each do |key, value|
-          json_hash[key] = map_to_rb_obj(value)
-        end
-        json_hash
+        obj
       end
 
       def to_json(obj, opts = nil)
-        begin
-          FFI_Yajl::Encoder.encode(obj, opts)
-        rescue FFI_Yajl::EncodeError => e
-          raise Chef::Exceptions::JSON::EncodeError, e.message
-        end
+        FFI_Yajl::Encoder.encode(obj, opts)
+      rescue FFI_Yajl::EncodeError => e
+        raise Chef::Exceptions::JSON::EncodeError, e.message
       end
 
       def to_json_pretty(obj, opts = nil)
@@ -117,48 +63,6 @@ class Chef
         to_json(obj, options_map).chomp
       end
 
-      # Map +json_class+ to a Class object. We use a +case+ instead of a Hash
-      # assigned to a constant because otherwise this file could not be loaded
-      # until all the constants were defined, which means you'd have to load
-      # the world to get json, which would make knife very slow.
-      def class_for_json_class(json_class)
-        case json_class
-        when CHEF_APICLIENT
-          Chef::ApiClient
-        when CHEF_CHECKSUM
-          Chef::Checksum
-        when CHEF_COOKBOOKVERSION
-          Chef::CookbookVersion
-        when CHEF_DATABAG
-          Chef::DataBag
-        when CHEF_DATABAGITEM
-          Chef::DataBagItem
-        when CHEF_ENVIRONMENT
-          Chef::Environment
-        when CHEF_NODE
-          Chef::Node
-        when CHEF_ROLE
-          Chef::Role
-        when CHEF_SANDBOX
-          # a falsey return here will disable object inflation/"create
-          # additions" in the caller. In Chef 11 this is correct, we just have
-          # a dummy Chef::Sandbox class for compat with Chef 10 servers.
-          false
-        when CHEF_RESOURCE
-          Chef::Resource
-        when CHEF_RESOURCECOLLECTION
-          Chef::ResourceCollection
-        when CHEF_RESOURCESET
-          Chef::ResourceCollection::ResourceSet
-        when CHEF_RESOURCELIST
-          Chef::ResourceCollection::ResourceList
-        when /^Chef::Resource/
-          Chef::Resource.find_descendants_by_name(json_class)
-        else
-          raise Chef::Exceptions::JSON::ParseError, "Unsupported `json_class` type '#{json_class}'"
-        end
-      end
-
     end
   end
 end

data/lib/chef/key.rb

@@ -155,7 +155,7 @@ class Chef
       result = chef_rest.post("#{api_base}/#{@actor}/keys", payload)
       # append the private key to the current key if the server returned one,
       # since the POST endpoint just returns uri and private_key if needed.
-      new_key = self.to_hash
+      new_key = to_hash
       new_key["private_key"] = result["private_key"] if result["private_key"]
       Chef::Key.from_hash(new_key)
     end
@@ -178,9 +178,9 @@ class Chef
       new_key = chef_rest.put("#{api_base}/#{@actor}/keys/#{put_name}", to_hash)
       # if the server returned a public_key, remove the create_key field, as we now have a key
       if new_key["public_key"]
-        self.delete_create_key
+        delete_create_key
       end
-      Chef::Key.from_hash(self.to_hash.merge(new_key))
+      Chef::Key.from_hash(to_hash.merge(new_key))
     end
 
     def save
@@ -222,19 +222,14 @@ class Chef
         Chef::Key.from_hash(Chef::JSONCompat.from_json(json))
       end
 
-      def json_create(json)
-        Chef.deprecated(:json_auto_inflate, "Auto inflation of JSON data is deprecated. Please use Chef::Key#from_json or one of the load_by methods.")
-        Chef::Key.from_json(json)
-      end
-
       def list_by_user(actor, inflate = false)
         keys = Chef::ServerAPI.new(Chef::Config[:chef_server_root]).get("users/#{actor}/keys")
-        self.list(keys, actor, :load_by_user, inflate)
+        list(keys, actor, :load_by_user, inflate)
       end
 
       def list_by_client(actor, inflate = false)
         keys = Chef::ServerAPI.new(Chef::Config[:chef_server_url]).get("clients/#{actor}/keys")
-        self.list(keys, actor, :load_by_client, inflate)
+        list(keys, actor, :load_by_client, inflate)
       end
 
       def load_by_user(actor, key_name)

data/lib/chef/knife/bootstrap/templates/chef-full.erb

@@ -182,21 +182,21 @@ fi
 mkdir -p /etc/chef
 
 <% if client_pem -%>
-cat > /etc/chef/client.pem <<EOP
+cat > /etc/chef/client.pem <<'EOP'
 <%= ::File.read(::File.expand_path(client_pem)) %>
 EOP
 chmod 0600 /etc/chef/client.pem
 <% end -%>
 
 <% if validation_key -%>
-cat > /etc/chef/validation.pem <<EOP
+cat > /etc/chef/validation.pem <<'EOP'
 <%= validation_key %>
 EOP
 chmod 0600 /etc/chef/validation.pem
 <% end -%>
 
 <% if encrypted_data_bag_secret -%>
-cat > /etc/chef/encrypted_data_bag_secret <<EOP
+cat > /etc/chef/encrypted_data_bag_secret <<'EOP'
 <%= encrypted_data_bag_secret %>
 EOP
 chmod 0600 /etc/chef/encrypted_data_bag_secret
@@ -212,17 +212,17 @@ mkdir -p /etc/chef/trusted_certs
 mkdir -p /etc/chef/ohai/hints
 
 <% @chef_config[:knife][:hints].each do |name, hash| -%>
-cat > /etc/chef/ohai/hints/<%= name %>.json <<EOP
+cat > /etc/chef/ohai/hints/<%= name %>.json <<'EOP'
 <%= Chef::JSONCompat.to_json(hash) %>
 EOP
 <% end -%>
 <% end -%>
 
-cat > /etc/chef/client.rb <<EOP
+cat > /etc/chef/client.rb <<'EOP'
 <%= config_content %>
 EOP
 
-cat > /etc/chef/first-boot.json <<EOP
+cat > /etc/chef/first-boot.json <<'EOP'
 <%= Chef::JSONCompat.to_json(first_boot) %>
 EOP
 

data/lib/chef/knife/bootstrap.rb

@@ -67,6 +67,11 @@ class Chef
         :description => "The ssh gateway",
         :proc => Proc.new { |key| Chef::Config[:knife][:ssh_gateway] = key }
 
+      option :ssh_gateway_identity,
+        :long => "--ssh-gateway-identity SSH_GATEWAY_IDENTITY",
+        :description => "The SSH identity file used for gateway authentication",
+        :proc => Proc.new { |key| Chef::Config[:knife][:ssh_gateway_identity] = key }
+
       option :forward_agent,
         :short => "-A",
         :long => "--forward-agent",
@@ -438,6 +443,7 @@ class Chef
         ssh.config[:ssh_password] = config[:ssh_password]
         ssh.config[:ssh_port] = config[:ssh_port]
         ssh.config[:ssh_gateway] = config[:ssh_gateway]
+        ssh.config[:ssh_gateway_identity] = config[:ssh_gateway_identity]
         ssh.config[:forward_agent] = config[:forward_agent]
         ssh.config[:ssh_identity_file] = config[:ssh_identity_file] || config[:identity_file]
         ssh.config[:manual] = true

data/lib/chef/knife/configure.rb

@@ -1,6 +1,6 @@
 #
 # Author:: Adam Jacob (<adam@chef.io>)
-# Copyright:: Copyright 2009-2016, Chef Software Inc.
+# Copyright:: Copyright 2009-2017, Chef Software Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -75,8 +75,6 @@ class Chef
 
         ::File.open(config[:config_file], "w") do |f|
           f.puts <<-EOH
-log_level                :info
-log_location             STDOUT
 node_name                '#{new_client_name}'
 client_key               '#{new_client_key}'
 validation_client_name   '#{validation_client_name}'

data/lib/chef/knife/configure_client.rb

@@ -1,6 +1,6 @@
 #
 # Author:: Adam Jacob (<adam@chef.io>)
-# Copyright:: Copyright 2009-2016, Chef Software Inc.
+# Copyright:: Copyright 2009-2017, Chef Software Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -34,8 +34,6 @@ class Chef
         FileUtils.mkdir_p(@config_dir)
         ui.info("Writing client.rb")
         File.open(File.join(@config_dir, "client.rb"), "w") do |file|
-          file.puts("log_level        :info")
-          file.puts("log_location     STDOUT")
           file.puts("chef_server_url  '#{Chef::Config[:chef_server_url]}'")
           file.puts("validation_client_name '#{Chef::Config[:validation_client_name]}'")
         end