chef 12.6.0 → 12.7.2

data/lib/chef/chef_fs/knife.rb

@@ -1,6 +1,6 @@
 #
-# Author:: John Keiser (<jkeiser@opscode.com>)
-# Copyright:: Copyright (c) 2012 Opscode, Inc.
+# Author:: John Keiser (<jkeiser@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");
@@ -16,8 +16,8 @@
 # limitations under the License.
 #
 
-require 'chef/knife'
-require 'pathname'
+require "chef/knife"
+require "pathname"
 
 class Chef
   module ChefFS
@@ -25,11 +25,11 @@ class Chef
       # Workaround for CHEF-3932
       def self.deps
         super do
-          require 'chef/config'
-          require 'chef/chef_fs/parallelizer'
-          require 'chef/chef_fs/config'
-          require 'chef/chef_fs/file_pattern'
-          require 'chef/chef_fs/path_utils'
+          require "chef/config"
+          require "chef/chef_fs/parallelizer"
+          require "chef/chef_fs/config"
+          require "chef/chef_fs/file_pattern"
+          require "chef/chef_fs/path_utils"
           yield
         end
       end
@@ -45,16 +45,16 @@ class Chef
       end
 
       option :repo_mode,
-        :long => '--repo-mode MODE',
+        :long => "--repo-mode MODE",
         :description => "Specifies the local repository layout.  Values: static, everything, hosted_everything.  Default: everything/hosted_everything"
 
       option :chef_repo_path,
-        :long => '--chef-repo-path PATH',
-        :description => 'Overrides the location of chef repo. Default is specified by chef_repo_path in the config'
+        :long => "--chef-repo-path PATH",
+        :description => "Overrides the location of chef repo. Default is specified by chef_repo_path in the config"
 
       option :concurrency,
-        :long => '--concurrency THREADS',
-        :description => 'Maximum number of simultaneous requests to send (default: 10)'
+        :long => "--concurrency THREADS",
+        :description => "Maximum number of simultaneous requests to send (default: 10)"
 
       def configure_chef
         super
@@ -111,7 +111,7 @@ class Chef
           end
           # Use the original path because we can't be sure.
           inferred_path = arg
-        elsif arg[0,1] == '~'
+        elsif arg[0, 1] == "~"
           # Let's be nice and fix it if possible - but warn the user.
           ui.warn("A path relative to a user home directory has been provided: #{arg}")
           ui.warn("Paths provided need to be rooted at the chef-repo being considered or be relative paths.")
@@ -145,7 +145,7 @@ class Chef
       end
 
       def discover_repo_dir(dir)
-        %w(.chef cookbooks data_bags environments roles).each do |subdir|
+        %w{.chef cookbooks data_bags environments roles}.each do |subdir|
           return dir if File.directory?(File.join(dir, subdir))
         end
         # If this isn't it, check the parent

data/lib/chef/chef_fs/parallelizer.rb

@@ -1,5 +1,5 @@
-require 'thread'
-require 'chef/chef_fs/parallelizer/parallel_enumerable'
+require "thread"
+require "chef/chef_fs/parallelizer/parallel_enumerable"
 
 class Chef
   module ChefFS
@@ -54,7 +54,7 @@ class Chef
 
       def resize(to_threads, wait = true, timeout = nil)
         if to_threads < num_threads
-          threads_to_stop = @threads[to_threads..num_threads-1]
+          threads_to_stop = @threads[to_threads..num_threads - 1]
           @threads = @threads.slice(0, to_threads)
           threads_to_stop.each do |thread|
             @stop_thread[thread] = true

data/lib/chef/chef_fs/parallelizer/flatten_enumerable.rb

@@ -23,7 +23,7 @@ class Chef
         def flatten(value, levels, &block)
           if levels != 0 && value.respond_to?(:each) && !value.is_a?(String)
             value.each do |child|
-              flatten(child, levels.nil? ? levels : levels-1, &block)
+              flatten(child, levels.nil? ? levels : levels - 1, &block)
             end
           else
             block.call(value)

data/lib/chef/chef_fs/parallelizer/parallel_enumerable.rb

@@ -1,4 +1,4 @@
-require 'chef/chef_fs/parallelizer/flatten_enumerable'
+require "chef/chef_fs/parallelizer/flatten_enumerable"
 
 class Chef
   module ChefFS
@@ -92,7 +92,7 @@ class Chef
           end
         end
 
-        def first(n=nil)
+        def first(n = nil)
           if n
             restricted_copy(@input_enumerable.first(n)).to_a
           else
@@ -266,7 +266,7 @@ class Chef
           begin
             output = @block.call(input)
             @unconsumed_output.push([ output, index, input, :result ])
-          rescue
+          rescue StandardError, ScriptError
             if @options[:stop_on_exception]
               @unconsumed_input.clear
             end

data/lib/chef/chef_fs/path_utils.rb

@@ -1,6 +1,6 @@
 #
-# Author:: John Keiser (<jkeiser@opscode.com>)
-# Copyright:: Copyright (c) 2012 Opscode, Inc.
+# Author:: John Keiser (<jkeiser@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");
@@ -16,8 +16,8 @@
 # limitations under the License.
 #
 
-require 'chef/chef_fs'
-require 'pathname'
+require "chef/chef_fs"
+require "pathname"
 
 class Chef
   module ChefFS
@@ -45,9 +45,9 @@ class Chef
         # Determine if it started with a slash
         absolute = parts[0].length == 0 || parts[0].length > 0 && parts[0] =~ /^#{regexp_path_separator}/
         # Remove leading and trailing slashes from each part so that the join will work (and the slash at the end will go away)
-        parts = parts.map { |part| part.gsub(/^#{regexp_path_separator}+|#{regexp_path_separator}+$/, '') }
+        parts = parts.map { |part| part.gsub(/^#{regexp_path_separator}+|#{regexp_path_separator}+$/, "") }
         # Don't join empty bits
-        result = parts.select { |part| part != '' }.join('/')
+        result = parts.select { |part| part != "" }.join("/")
         # Put the / back on
         absolute ? "/#{result}" : result
       end
@@ -57,13 +57,14 @@ class Chef
       end
 
       def self.regexp_path_separator
-        Chef::ChefFS::windows? ? '[\/\\\\]' : '/'
+        Chef::ChefFS::windows? ? '[\/\\\\]' : "/"
       end
 
       # Given a server path, determines if it is absolute.
       def self.is_absolute?(path)
         !!(path =~ /^#{regexp_path_separator}/)
       end
+
       # Given a path which may only be partly real (i.e. /x/y/z when only /x exists,
       # or /x/y/*/blah when /x/y/z/blah exists), call File.realpath on the biggest
       # part that actually exists.  The paths operated on here are not Chef-FS paths.
@@ -113,9 +114,9 @@ class Chef
         candidate_fragment = path[0, ancestor.length]
         return nil unless PathUtils.os_path_eq?(candidate_fragment, ancestor)
         if ancestor.length == path.length
-          ''
-        elsif path[ancestor.length,1] =~ /#{PathUtils.regexp_path_separator}/
-          path[ancestor.length+1..-1]
+          ""
+        elsif path[ancestor.length, 1] =~ /#{PathUtils.regexp_path_separator}/
+          path[ancestor.length + 1..-1]
         else
           nil
         end

data/lib/chef/client.rb

@@ -1,9 +1,9 @@
 #
-# Author:: Adam Jacob (<adam@opscode.com>)
-# Author:: Christopher Walters (<cw@opscode.com>)
-# Author:: Christopher Brown (<cb@opscode.com>)
-# Author:: Tim Hinderliter (<tim@opscode.com>)
-# Copyright:: Copyright (c) 2008-2015 Chef Software, Inc.
+# Author:: Adam Jacob (<adam@chef.io>)
+# Author:: Christopher Walters (<cw@chef.io>)
+# Author:: Christopher Brown (<cb@chef.io>)
+# Author:: Tim Hinderliter (<tim@chef.io>)
+# Copyright:: Copyright 2008-2016, Chef Software, Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -18,41 +18,41 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require 'chef/config'
-require 'chef/mixin/params_validate'
-require 'chef/mixin/path_sanity'
-require 'chef/log'
-require 'chef/rest'
-require 'chef/api_client'
-require 'chef/api_client/registration'
-require 'chef/audit/runner'
-require 'chef/node'
-require 'chef/role'
-require 'chef/file_cache'
-require 'chef/run_context'
-require 'chef/runner'
-require 'chef/run_status'
-require 'chef/cookbook/cookbook_collection'
-require 'chef/cookbook/file_vendor'
-require 'chef/cookbook/file_system_file_vendor'
-require 'chef/cookbook/remote_file_vendor'
-require 'chef/event_dispatch/dispatcher'
-require 'chef/event_loggers/base'
-require 'chef/event_loggers/windows_eventlog'
-require 'chef/exceptions'
-require 'chef/formatters/base'
-require 'chef/formatters/doc'
-require 'chef/formatters/minimal'
-require 'chef/version'
-require 'chef/resource_reporter'
-require 'chef/audit/audit_reporter'
-require 'chef/run_lock'
-require 'chef/policy_builder'
-require 'chef/request_id'
-require 'chef/platform/rebooter'
-require 'chef/mixin/deprecation'
-require 'ohai'
-require 'rbconfig'
+require "chef/config"
+require "chef/mixin/params_validate"
+require "chef/mixin/path_sanity"
+require "chef/log"
+require "chef/server_api"
+require "chef/api_client"
+require "chef/api_client/registration"
+require "chef/audit/runner"
+require "chef/node"
+require "chef/role"
+require "chef/file_cache"
+require "chef/run_context"
+require "chef/runner"
+require "chef/run_status"
+require "chef/cookbook/cookbook_collection"
+require "chef/cookbook/file_vendor"
+require "chef/cookbook/file_system_file_vendor"
+require "chef/cookbook/remote_file_vendor"
+require "chef/event_dispatch/dispatcher"
+require "chef/event_loggers/base"
+require "chef/event_loggers/windows_eventlog"
+require "chef/exceptions"
+require "chef/formatters/base"
+require "chef/formatters/doc"
+require "chef/formatters/minimal"
+require "chef/version"
+require "chef/resource_reporter"
+require "chef/audit/audit_reporter"
+require "chef/run_lock"
+require "chef/policy_builder"
+require "chef/request_id"
+require "chef/platform/rebooter"
+require "chef/mixin/deprecation"
+require "ohai"
+require "rbconfig"
 
 class Chef
   # == Chef::Client
@@ -78,6 +78,7 @@ class Chef
     def node
       run_status.node
     end
+
     def node=(value)
       run_status.node = value
     end
@@ -92,10 +93,18 @@ class Chef
     #
     # The rest object used to communicate with the Chef server.
     #
-    # @return [Chef::REST]
+    # @return [Chef::ServerAPI]
     #
     attr_reader :rest
 
+    #
+    # A rest object with validate_utf8 set to false.  This will not throw exceptions
+    # on non-UTF8 strings in JSON but will sanitize them so that e.g. POSTs will
+    # never fail.  Cannot be configured on a request-by-request basis, so we carry
+    # around another rest object for it.
+    #
+    attr_reader :rest_clean
+
     #
     # The runner used to converge.
     #
@@ -143,7 +152,7 @@ class Chef
     # @option args [Array<String>] :specific_recipes A list of recipe file paths
     #   to load after the run list has been loaded.
     #
-    def initialize(json_attribs=nil, args={})
+    def initialize(json_attribs = nil, args = {})
       @json_attribs = json_attribs || {}
       @ohai = Ohai::System.new
 
@@ -317,10 +326,10 @@ class Chef
                   run_error || converge_error
                 else
                   e = if run_error == converge_error
-                    Chef::Exceptions::RunFailedWrappingError.new(converge_error, audit_error)
-                  else
-                    Chef::Exceptions::RunFailedWrappingError.new(run_error, converge_error, audit_error)
-                  end
+                        Chef::Exceptions::RunFailedWrappingError.new(converge_error, audit_error)
+                      else
+                        Chef::Exceptions::RunFailedWrappingError.new(run_error, converge_error, audit_error)
+                      end
                   e.fill_backtrace
                   e
                 end
@@ -385,13 +394,23 @@ class Chef
       end
     end
 
+    # Rest client for use by API reporters.  This rest client will not fail with an exception if
+    # it is fed non-UTF8 data.
+    #
+    # @api private
+    def rest_clean(client_name = node_name, config = Chef::Config)
+      @rest_clean ||=
+        Chef::ServerAPI.new(config[:chef_server_url], client_name: client_name,
+                                                      signing_key_filename: config[:client_key], validate_utf8: false)
+    end
+
     # Resource reporters send event information back to the chef server for
     # processing.  Can only be called after we have a @rest object
     # @api private
     def register_reporters
       [
-        Chef::ResourceReporter.new(rest),
-        Chef::Audit::AuditReporter.new(rest)
+        Chef::ResourceReporter.new(rest_clean),
+        Chef::Audit::AuditReporter.new(rest_clean),
       ].each do |r|
         events.register(r)
       end
@@ -536,7 +555,7 @@ class Chef
     # @api private
     #
     def run_ohai
-      filter = Chef::Config[:minimal_ohai] ? %w[fqdn machinename hostname platform platform_version os os_version] : nil
+      filter = Chef::Config[:minimal_ohai] ? %w{fqdn machinename hostname platform platform_version os os_version} : nil
       ohai.all_plugins(filter)
       events.ohai_completed(node)
     end
@@ -550,14 +569,10 @@ class Chef
     # - ohai[:machinename]
     # - ohai[:hostname]
     #
-    # If we are running against a server with authentication protocol < 1.0, we
-    # *require* authentication protocol version 1.1.
-    #
     # @raise [Chef::Exceptions::CannotDetermineNodeName] If the node name is not
     #   set and cannot be determined via ohai.
     #
     # @see Chef::Config#node_name
-    # @see Chef::Config#authentication_protocol_version
     #
     # @api private
     #
@@ -567,14 +582,6 @@ class Chef
 
       raise Chef::Exceptions::CannotDetermineNodeName unless name
 
-      # node names > 90 bytes only work with authentication protocol >= 1.1
-      # see discussion in config.rb.
-      # TODO use a computed default in Chef::Config to determine this instead of
-      # setting it.
-      if name.bytesize > 90
-        Chef::Config[:authentication_protocol_version] = "1.1"
-      end
-
       name
     end
 
@@ -587,7 +594,7 @@ class Chef
     # If Chef::Config.client_key does not exist, we register the client with the
     # Chef server and fire the registration_start and registration_completed events.
     #
-    # @return [Chef::REST] The server connection object.
+    # @return [Chef::ServerAPI] The server connection object.
     #
     # @see Chef::Config#chef_server_url
     # @see Chef::Config#client_key
@@ -599,7 +606,7 @@ class Chef
     #
     # @api private
     #
-    def register(client_name=node_name, config=Chef::Config)
+    def register(client_name = node_name, config = Chef::Config)
       if !config[:client_key]
         events.skipping_registration(client_name, config)
         Chef::Log.debug("Client key is unspecified - skipping registration")
@@ -613,7 +620,10 @@ class Chef
         events.registration_completed
       end
       # We now have the client key, and should use it from now on.
-      @rest = Chef::REST.new(config[:chef_server_url], client_name, config[:client_key])
+      @rest = Chef::ServerAPI.new(config[:chef_server_url], client_name: client_name,
+                                                            signing_key_filename: config[:client_key])
+      # force initialization of the rest_clean API object
+      rest_clean(client_name, config)
       register_reporters
     rescue Exception => e
       # TODO this should probably only ever fire if we *started* registration.
@@ -897,7 +907,7 @@ class Chef
     attr_reader :specific_recipes
 
     def profiling_prereqs!
-      require 'ruby-prof'
+      require "ruby-prof"
     rescue LoadError
       raise "You must have the ruby-prof gem installed in order to use --profile-ruby"
     end
@@ -933,7 +943,7 @@ class Chef
         # if it's an array, go through it and check each one, raise error at the last one if no files are found
         cookbook_paths = Array(Chef::Config[:cookbook_path])
         Chef::Log.debug "Loading from cookbook_path: #{cookbook_paths.map { |path| File.expand_path(path) }.join(', ')}"
-        if cookbook_paths.all? {|path| empty_directory?(path) }
+        if cookbook_paths.all? { |path| empty_directory?(path) }
           msg = "None of the cookbook paths set in Chef::Config[:cookbook_path], #{cookbook_paths.inspect}, contain any cookbooks"
           Chef::Log.fatal(msg)
           raise Chef::Exceptions::CookbookNotFound, msg
@@ -941,11 +951,10 @@ class Chef
       else
         Chef::Log.warn("Node #{node_name} has an empty run list.") if run_context.node.run_list.empty?
       end
-
     end
 
     def has_admin_privileges?
-      require 'chef/win32/security'
+      require "chef/win32/security"
 
       Chef::ReservedNames::Win32::Security.has_admin_privileges?
     end
@@ -953,6 +962,6 @@ class Chef
 end
 
 # HACK cannot load this first, but it must be loaded.
-require 'chef/cookbook_loader'
-require 'chef/cookbook_version'
-require 'chef/cookbook/synchronizer'
+require "chef/cookbook_loader"
+require "chef/cookbook_version"
+require "chef/cookbook/synchronizer"