chef 13.12.14 → 14.0.190

data/lib/chef/chef_fs/file_system/chef_server/cookbook_dir.rb

@@ -1,6 +1,6 @@
 #
 # Author:: John Keiser (<jkeiser@chef.io>)
-# Copyright:: Copyright 2012-2016, Chef Software Inc.
+# Copyright:: Copyright 2012-2018, Chef Software Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -76,7 +76,7 @@ class Chef
             if @children.nil?
               @children = []
               manifest = chef_object.cookbook_manifest
-              manifest.by_parent_directory.each do |segment, files|
+              manifest.by_parent_directory.each_value do |files|
                 files.each do |file|
                   parts = file[:path].split("/")
                   # Get or create the path to the file

data/lib/chef/chef_fs/file_system/chef_server/policies_dir.rb

@@ -1,6 +1,6 @@
 #
 # Author:: John Keiser (<jkeiser@chef.io>)
-# Copyright:: Copyright 2012-2016, Chef Software Inc.
+# Copyright:: Copyright 2012-2018, Chef Software Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -71,7 +71,7 @@ class Chef
               result = []
               data = root.get_json(api_path)
               data.keys.sort.each do |policy_name|
-                data[policy_name]["revisions"].keys.each do |policy_revision|
+                data[policy_name]["revisions"].each_key do |policy_revision|
                   filename = "#{policy_name}-#{policy_revision}.json"
                   result << make_child_entry(filename, true)
                 end

data/lib/chef/chef_fs/file_system/multiplexed_dir.rb

@@ -39,7 +39,7 @@ class Chef
             child_entry = dir.child(name)
             if child_entry.exists?
               if result
-                Chef::Log.debug("Child with name '#{child_entry.name}' found in multiple directories: #{result.parent.path_for_printing} and #{child_entry.parent.path_for_printing}")
+                Chef::Log.trace("Child with name '#{child_entry.name}' found in multiple directories: #{result.parent.path_for_printing} and #{child_entry.parent.path_for_printing}")
               else
                 result = child_entry
               end

data/lib/chef/chef_fs/file_system/repository/base_file.rb

@@ -43,12 +43,12 @@ class Chef
 
             file_path = "#{parent.file_path}/#{name}"
 
-            Chef::Log.debug "BaseFile: Detecting file extension for #{name}"
+            Chef::Log.trace "BaseFile: Detecting file extension for #{name}"
             ext = File.exist?(file_path + ".rb") ? ".rb" : ".json"
             name += ext
             file_path += ext
 
-            Chef::Log.debug "BaseFile: got a file path of #{file_path} for #{name}"
+            Chef::Log.trace "BaseFile: got a file path of #{file_path} for #{name}"
             @name = name
             @path = Chef::ChefFS::PathUtils.join(parent.path, name)
             @file_path = file_path

data/lib/chef/chef_fs/file_system_cache.rb

@@ -51,7 +51,7 @@ class Chef
 
       def delete!(path)
         parent = _get_parent(path)
-        Chef::Log.debug("Deleting parent #{parent} and #{path} from FileSystemCache")
+        Chef::Log.trace("Deleting parent #{parent} and #{path} from FileSystemCache")
         if @cache.key?(path)
           @cache.delete(path)
         end

data/lib/chef/chef_fs/path_utils.rb

@@ -1,6 +1,6 @@
 #
 # Author:: John Keiser (<jkeiser@chef.io>)
-# Copyright:: Copyright 2012-2016, Chef Software Inc.
+# Copyright:: Copyright 2012-2018, Chef Software Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -90,7 +90,7 @@ class Chef
           begin
             path = File.realpath(path)
             break
-          rescue Errno::ENOENT
+          rescue Errno::ENOENT, Errno::EINVAL
             suffix << File.basename(path)
             path = parent_path
             parent_path = File.dirname(path)

data/lib/chef/client.rb

@@ -3,7 +3,7 @@
 # Author:: Christopher Walters (<cw@chef.io>)
 # Author:: Christopher Brown (<cb@chef.io>)
 # Author:: Tim Hinderliter (<tim@chef.io>)
-# Copyright:: Copyright 2008-2017, Chef Software Inc.
+# Copyright:: Copyright 2008-2018, Chef Software Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -99,14 +99,6 @@ class Chef
     #
     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,6 +135,7 @@ class Chef
     #
     attr_reader :events
 
+    attr_reader :logger
     #
     # Creates a new Chef::Client.
     #
@@ -156,13 +149,15 @@ class Chef
     #
     def initialize(json_attribs = nil, args = {})
       @json_attribs = json_attribs || {}
-      @ohai = Ohai::System.new
+      @logger = args.delete(:logger) || Chef::Log.with_child
+
+      @ohai = Ohai::System.new(logger: logger)
 
       event_handlers = configure_formatters + configure_event_loggers
       event_handlers += Array(Chef::Config[:event_handlers])
 
       @events = EventDispatch::Dispatcher.new(*event_handlers)
-      # @todo it seems like a bad idea to be deletin' other peoples' hashes.
+      # TODO it seems like a bad idea to be deletin' other peoples' hashes.
       @override_runlist = args.delete(:override_runlist)
       @specific_recipes = args.delete(:specific_recipes)
       @run_status = Chef::RunStatus.new(nil, events)
@@ -257,13 +252,15 @@ class Chef
         request_id = Chef::RequestID.instance.request_id
         run_context = nil
         events.run_start(Chef::VERSION)
-        Chef::Log.info("*** Chef #{Chef::VERSION} ***")
-        Chef::Log.info("Platform: #{RUBY_PLATFORM}")
-        Chef::Log.info "Chef-client pid: #{Process.pid}"
-        Chef::Log.debug("Chef-client request_id: #{request_id}")
+        logger.info("*** Chef #{Chef::VERSION} ***")
+        logger.info("Platform: #{RUBY_PLATFORM}")
+        logger.info "Chef-client pid: #{Process.pid}"
+        logger.debug("Chef-client request_id: #{request_id}")
         enforce_path_sanity
         run_ohai
 
+        generate_guid
+
         register unless Chef::Config[:solo_legacy_mode]
         register_data_collector_reporter
 
@@ -273,7 +270,7 @@ class Chef
 
         run_status.run_id = request_id
         run_status.start_clock
-        Chef::Log.info("Starting Chef Run for #{node.name}")
+        logger.info("Starting Chef Run for #{node.name}")
         run_started
 
         do_windows_admin_check
@@ -288,7 +285,7 @@ class Chef
 
         if Chef::Config[:why_run] == true
           # why_run should probably be renamed to why_converge
-          Chef::Log.debug("Not running controls in 'why-run' mode - this mode is used to see potential converge changes")
+          logger.debug("Not running controls in 'why-run' mode - this mode is used to see potential converge changes")
         elsif Chef::Config[:audit_mode] != :disabled
           audit_error = run_audits(run_context)
         end
@@ -297,7 +294,7 @@ class Chef
         raise converge_error if converge_error
 
         run_status.stop_clock
-        Chef::Log.info("Chef Run complete in #{run_status.elapsed_time} seconds")
+        logger.info("Chef Run complete in #{run_status.elapsed_time} seconds")
         run_completed_successfully
         events.run_completed(node, run_status)
 
@@ -308,7 +305,7 @@ class Chef
         Chef::Platform::Rebooter.reboot_if_needed!(node)
       rescue Exception => run_error
         # CHEF-3336: Send the error first in case something goes wrong below and we don't know why
-        Chef::Log.debug("Re-raising exception: #{run_error.class} - #{run_error.message}\n#{run_error.backtrace.join("\n  ")}")
+        logger.trace("Re-raising exception: #{run_error.class} - #{run_error.message}\n#{run_error.backtrace.join("\n  ")}")
         # If we failed really early, we may not have a run_status yet. Too early for these to be of much use.
         if run_status
           run_status.stop_clock
@@ -398,8 +395,10 @@ 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.
+    # 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.
     #
     # @api private
     def rest_clean(client_name = node_name, config = Chef::Config)
@@ -532,7 +531,7 @@ class Chef
     #
     def load_required_recipe(rest, run_context)
       required_recipe_contents = rest.get("required_recipe")
-      Chef::Log.info("Required Recipe found, loading it")
+      logger.info("Required Recipe found, loading it")
       Chef::FileCache.store("required_recipe", required_recipe_contents)
       required_recipe_file = Chef::FileCache.load("required_recipe", false)
 
@@ -553,7 +552,7 @@ class Chef
     rescue Net::HTTPServerException => e
       case e.response
       when Net::HTTPNotFound
-        Chef::Log.debug("Required Recipe not configured on the server, skipping it")
+        logger.trace("Required Recipe not configured on the server, skipping it")
       else
         raise
       end
@@ -584,9 +583,9 @@ class Chef
       if Chef::Config[:solo_legacy_mode]
         # nothing to do
       elsif policy_builder.temporary_policy?
-        Chef::Log.warn("Skipping final node save because override_runlist was given")
+        logger.warn("Skipping final node save because override_runlist was given")
       else
-        Chef::Log.debug("Saving the current state of node #{node_name}")
+        logger.debug("Saving the current state of node #{node_name}")
         node.save
       end
     end
@@ -606,7 +605,7 @@ class Chef
       ohai.all_plugins(filter)
       events.ohai_completed(node)
     rescue Ohai::Exceptions::CriticalPluginFailure => e
-      Chef::Log.error("Critical Ohai plugins failed: #{e.message}")
+      logger.error("Critical Ohai plugins failed: #{e.message}")
       exit(false)
     end
 
@@ -659,13 +658,13 @@ class Chef
     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")
+        logger.trace("Client key is unspecified - skipping registration")
       elsif File.exists?(config[:client_key])
         events.skipping_registration(client_name, config)
-        Chef::Log.debug("Client key #{config[:client_key]} is present - skipping registration")
+        logger.trace("Client key #{config[:client_key]} is present - skipping registration")
       else
         events.registration_start(node_name, config)
-        Chef::Log.info("Client key #{config[:client_key]} is not present - registering")
+        logger.info("Client key #{config[:client_key]} is not present - registering")
         Chef::ApiClient::Registration.new(node_name, config[:client_key]).run
         events.registration_completed
       end
@@ -713,7 +712,7 @@ class Chef
       catch(:end_client_run_early) do
         begin
           events.converge_start(run_context)
-          Chef::Log.debug("Converging node #{node_name}")
+          logger.debug("Converging node #{node_name}")
           @runner = Chef::Runner.new(run_context)
           @runner.converge
           events.converge_complete
@@ -781,7 +780,7 @@ class Chef
     def run_audits(run_context)
       begin
         events.audit_phase_start(run_status)
-        Chef::Log.info("Starting audit phase")
+        logger.info("Starting audit phase")
         auditor = Chef::Audit::Runner.new(run_context)
         auditor.run
         if auditor.failed?
@@ -791,7 +790,7 @@ class Chef
           @events.audit_phase_complete(Chef::Audit::Logger.read_buffer)
         end
       rescue Exception => e
-        Chef::Log.error("Audit phase failed with error message: #{e.message}")
+        logger.error("Audit phase failed with error message: #{e.message}")
         @events.audit_phase_failed(e, Chef::Audit::Logger.read_buffer)
         audit_exception = e
       end
@@ -824,19 +823,19 @@ class Chef
     #
     def do_windows_admin_check
       if Chef::Platform.windows?
-        Chef::Log.debug("Checking for administrator privileges....")
+        logger.trace("Checking for administrator privileges....")
 
         if !has_admin_privileges?
           message = "chef-client doesn't have administrator privileges on node #{node_name}."
           if Chef::Config[:fatal_windows_admin_check]
-            Chef::Log.fatal(message)
-            Chef::Log.fatal("fatal_windows_admin_check is set to TRUE.")
+            logger.fatal(message)
+            logger.fatal("fatal_windows_admin_check is set to TRUE.")
             raise Chef::Exceptions::WindowsNotAdmin, message
           else
-            Chef::Log.warn("#{message} This might cause unexpected resource failures.")
+            logger.warn("#{message} This might cause unexpected resource failures.")
           end
         else
-          Chef::Log.debug("chef-client has administrator privileges on node #{node_name}.")
+          logger.trace("chef-client has administrator privileges on node #{node_name}.")
         end
       end
     end
@@ -966,7 +965,7 @@ class Chef
       File.open(path, "w+") do |file|
         RubyProf::GraphPrinter.new(RubyProf.stop).print(file, {})
       end
-      Chef::Log.warn("Ruby execution profile dumped to #{path}")
+      logger.warn("Ruby execution profile dumped to #{path}")
     end
 
     def empty_directory?(path)
@@ -983,14 +982,14 @@ class Chef
         # Chef::Config[:cookbook_path] can be a string or an array
         # 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(', ')}"
+        logger.trace "Loading from cookbook_path: #{cookbook_paths.map { |path| File.expand_path(path) }.join(', ')}"
         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)
+          logger.fatal(msg)
           raise Chef::Exceptions::CookbookNotFound, msg
         end
       else
-        Chef::Log.warn("Node #{node_name} has an empty run list.") if run_context.node.run_list.empty?
+        logger.warn("Node #{node_name} has an empty run list.") if run_context.node.run_list.empty?
       end
     end
 
@@ -1000,6 +999,27 @@ class Chef
       Chef::ReservedNames::Win32::Security.has_admin_privileges?
     end
 
+    # Ensure that we have a GUID for this node
+    # If we've got the proper configuration, we'll simply set that.
+    # If we're registed with the data collector, we'll migrate that UUID into our configuration and use that
+    # Otherwise, we'll create a new GUID and save it
+    def generate_guid
+      Chef::Config[:chef_guid] ||=
+        if File.exists?(Chef::Config[:chef_guid_path])
+          File.read(Chef::Config[:chef_guid_path])
+        else
+          uuid = UUIDFetcher.node_uuid
+          File.open(Chef::Config[:chef_guid_path], "w+") do |fh|
+            fh.write(uuid)
+          end
+          uuid
+        end
+    end
+
+    class UUIDFetcher
+      extend Chef::DataCollector::Messages::Helpers
+    end
+
     # Register the data collector reporter to send event information to the
     # data collector server
     def register_data_collector_reporter