chef 13.12.14 → 14.0.190

data/lib/chef/provider/batch.rb

@@ -22,7 +22,7 @@ class Chef
   class Provider
     class Batch < Chef::Provider::WindowsScript
 
-      provides :batch, os: "windows"
+      provides :batch
 
       def initialize(new_resource, run_context)
         super(new_resource, run_context, ".bat")

data/lib/chef/provider/cookbook_file/content.rb

@@ -34,7 +34,7 @@ class Chef
           else
             tempfile = Chef::FileContentManagement::Tempfile.new(@new_resource).tempfile
             tempfile.close
-            Chef::Log.debug("#{@new_resource} staging #{file_cache_location} to #{tempfile.path}")
+            logger.trace("#{@new_resource} staging #{file_cache_location} to #{tempfile.path}")
             FileUtils.cp(file_cache_location, tempfile.path)
             tempfile
           end

data/lib/chef/provider/cron.rb

@@ -50,7 +50,7 @@ class Chef
           crontab.each_line do |line|
             case line.chomp
             when "# Chef Name: #{new_resource.name}"
-              Chef::Log.debug("Found cron '#{new_resource.name}'")
+              logger.trace("Found cron '#{new_resource.name}'")
               cron_found = true
               @cron_exists = true
               next
@@ -79,9 +79,9 @@ class Chef
               next
             end
           end
-          Chef::Log.debug("Cron '#{new_resource.name}' not found") unless @cron_exists
+          logger.trace("Cron '#{new_resource.name}' not found") unless @cron_exists
         else
-          Chef::Log.debug("Cron empty for '#{new_resource.user}'")
+          logger.trace("Cron empty for '#{new_resource.user}'")
           @cron_empty = true
         end
 
@@ -95,15 +95,15 @@ class Chef
       end
 
       def action_create
-        crontab = String.new
-        newcron = String.new
+        crontab = ""
+        newcron = ""
         cron_found = false
 
         newcron = get_crontab_entry
 
         if @cron_exists
           unless cron_different?
-            Chef::Log.debug("Skipping existing cron entry '#{new_resource.name}'")
+            logger.trace("Skipping existing cron entry '#{new_resource.name}'")
             return
           end
           read_crontab.each_line do |line|
@@ -140,7 +140,7 @@ class Chef
 
           converge_by("update crontab entry for #{new_resource}") do
             write_crontab crontab
-            Chef::Log.info("#{new_resource} updated crontab entry")
+            logger.info("#{new_resource} updated crontab entry")
           end
 
         else
@@ -149,14 +149,14 @@ class Chef
 
           converge_by("add crontab entry for #{new_resource}") do
             write_crontab crontab
-            Chef::Log.info("#{new_resource} added crontab entry")
+            logger.info("#{new_resource} added crontab entry")
           end
         end
       end
 
       def action_delete
         if @cron_exists
-          crontab = String.new
+          crontab = ""
           cron_found = false
           read_crontab.each_line do |line|
             case line.chomp
@@ -184,7 +184,7 @@ class Chef
           description = cron_found ? "remove #{new_resource.name} from crontab" : "save unmodified crontab"
           converge_by(description) do
             write_crontab crontab
-            Chef::Log.info("#{new_resource} deleted crontab entry")
+            logger.info("#{new_resource} deleted crontab entry")
           end
         end
       end

data/lib/chef/provider/cron/unix.rb

@@ -36,7 +36,7 @@ class Chef
           crontab = shell_out("/usr/bin/crontab -l", :user => @new_resource.user)
           status = crontab.status.exitstatus
 
-          Chef::Log.debug crontab.format_for_exception if status > 0
+          logger.trace crontab.format_for_exception if status > 0
 
           if status > 1
             raise Chef::Exceptions::Cron, "Error determining state of #{@new_resource.name}, exit: #{status}"
@@ -62,12 +62,12 @@ class Chef
               exit_status = 1
             end
           rescue Chef::Exceptions::Exec => e
-            Chef::Log.debug(e.message)
+            logger.trace(e.message)
             exit_status = 1
             error_message = e.message
           rescue ArgumentError => e
             # usually raised on invalid user.
-            Chef::Log.debug(e.message)
+            logger.trace(e.message)
             exit_status = 1
             error_message = e.message
           end

data/lib/chef/provider/directory.rb

@@ -129,7 +129,7 @@ class Chef
             else
               ::Dir.mkdir(new_resource.path)
             end
-            Chef::Log.info("#{new_resource} created directory #{new_resource.path}")
+            logger.info("#{new_resource} created directory #{new_resource.path}")
           end
         end
         do_acl_changes
@@ -144,10 +144,10 @@ class Chef
               # we don't use rm_rf here because it masks all errors, including
               # IO errors or permission errors that would prvent the deletion
               FileUtils.rm_r(new_resource.path)
-              Chef::Log.info("#{new_resource} deleted #{new_resource.path} recursively")
+              logger.info("#{new_resource} deleted #{new_resource.path} recursively")
             else
               ::Dir.delete(new_resource.path)
-              Chef::Log.info("#{new_resource} deleted #{new_resource.path}")
+              logger.info("#{new_resource} deleted #{new_resource.path}")
             end
           end
         end

data/lib/chef/provider/dsc_resource.rb

@@ -24,7 +24,7 @@ class Chef
   class Provider
     class DscResource < Chef::Provider
       include Chef::Mixin::PowershellTypeCoercions
-      provides :dsc_resource, os: "windows"
+      provides :dsc_resource
       def initialize(new_resource, run_context)
         super
         @new_resource = new_resource
@@ -196,10 +196,10 @@ class Chef
         unless @reboot_resource.nil?
           case reboot_action
           when :nothing
-            Chef::Log.debug("A reboot was requested by the DSC resource, but reboot_action is :nothing.")
-            Chef::Log.debug("This dsc_resource will not reboot the node.")
+            logger.trace("A reboot was requested by the DSC resource, but reboot_action is :nothing.")
+            logger.trace("This dsc_resource will not reboot the node.")
           else
-            Chef::Log.debug("Requesting node reboot with #{reboot_action}.")
+            logger.trace("Requesting node reboot with #{reboot_action}.")
             @reboot_resource.run_action(reboot_action)
           end
         end

data/lib/chef/provider/dsc_script.rb

@@ -25,7 +25,7 @@ class Chef
   class Provider
     class DscScript < Chef::Provider
 
-      provides :dsc_script, os: "windows"
+      provides :dsc_script
 
       def initialize(dsc_resource, run_context)
         super(dsc_resource, run_context)
@@ -44,7 +44,7 @@ class Chef
         if ! @resource_converged
           converge_by(generate_description) do
             run_configuration(:set)
-            Chef::Log.info("DSC resource configuration completed successfully")
+            logger.info("DSC resource configuration completed successfully")
           end
         end
       end
@@ -95,7 +95,7 @@ class Chef
           configuration_document = generate_configuration_document(config_directory, configuration_flags)
           @operations[operation].call(config_manager, configuration_document, shellout_flags)
         rescue Exception => e
-          Chef::Log.error("DSC operation failed: #{e.message}")
+          logger.error("DSC operation failed: #{e.message}")
           raise e
         ensure
           ::FileUtils.rm_rf(config_directory)
@@ -124,7 +124,7 @@ class Chef
           generator.configuration_document_from_script_path(@dsc_resource.command, configuration_name, configuration_flags, shellout_flags)
         else
           # If code is also not provided, we mimic what the other script resources do (execute nothing)
-          Chef::Log.warn("Neither code or command were provided for dsc_resource[#{@dsc_resource.name}].") unless @dsc_resource.code
+          logger.warn("Neither code or command were provided for dsc_resource[#{@dsc_resource.name}].") unless @dsc_resource.code
           generator.configuration_document_from_script_code(@dsc_resource.code || "", configuration_flags, @dsc_resource.imports, shellout_flags)
         end
       end

data/lib/chef/provider/execute.rb

@@ -49,7 +49,7 @@ class Chef
 
       def action_run
         if creates && sentinel_file.exist?
-          Chef::Log.debug("#{new_resource} sentinel file #{sentinel_file} exists - nothing to do")
+          logger.debug("#{new_resource} sentinel file #{sentinel_file} exists - nothing to do")
           return false
         end
 
@@ -58,13 +58,17 @@ class Chef
             shell_out_with_systems_locale!(command, opts)
           rescue Mixlib::ShellOut::ShellCommandFailed
             if sensitive?
-              raise Mixlib::ShellOut::ShellCommandFailed,
-                "Command execution failed. STDOUT/STDERR suppressed for sensitive resource"
+              ex = Mixlib::ShellOut::ShellCommandFailed.new("Command execution failed. STDOUT/STDERR suppressed for sensitive resource")
+              # Forcibly hide the exception cause chain here so we don't log the unredacted version
+              def ex.cause
+                nil
+              end
+              raise ex
             else
               raise
             end
           end
-          Chef::Log.info("#{new_resource} ran successfully")
+          logger.info("#{new_resource} ran successfully")
         end
       end
 
@@ -95,7 +99,7 @@ class Chef
         opts[:umask]       = umask if umask
         opts[:log_level]   = :info
         opts[:log_tag]     = new_resource.to_s
-        if (Chef::Log.info? || live_stream?) && !sensitive?
+        if (logger.info? || live_stream?) && !sensitive?
           if run_context.events.formatter?
             opts[:live_stream] = Chef::EventDispatch::EventsOutputStream.new(run_context.events, :name => :execute)
           elsif stream_to_stdout?

data/lib/chef/provider/file.rb

@@ -92,7 +92,7 @@ class Chef
         if !needs_creating?
           # we are updating an existing file
           if managing_content?
-            Chef::Log.debug("#{new_resource} checksumming file at #{new_resource.path}.")
+            logger.trace("#{new_resource} checksumming file at #{new_resource.path}.")
             current_resource.checksum(checksum(current_resource.path))
           else
             # if the file does not exist or is not a file, then the checksum is invalid/pointless
@@ -151,7 +151,7 @@ class Chef
         unless ::File.exist?(new_resource.path)
           action_create
         else
-          Chef::Log.debug("#{new_resource} exists at #{new_resource.path} taking no action.")
+          logger.trace("#{new_resource} exists at #{new_resource.path} taking no action.")
         end
       end
 
@@ -160,7 +160,7 @@ class Chef
           converge_by("delete file #{new_resource.path}") do
             do_backup unless file_class.symlink?(new_resource.path)
             ::File.delete(new_resource.path)
-            Chef::Log.info("#{new_resource} deleted file at #{new_resource.path}")
+            logger.info("#{new_resource} deleted file at #{new_resource.path}")
           end
         end
       end
@@ -170,7 +170,7 @@ class Chef
         converge_by("update utime on file #{new_resource.path}") do
           time = Time.now
           ::File.utime(time, time, new_resource.path)
-          Chef::Log.info("#{new_resource} updated atime and mtime to #{time}")
+          logger.info("#{new_resource} updated atime and mtime to #{time}")
         end
       end
 
@@ -227,9 +227,9 @@ class Chef
         elsif file_class.symlink?(path) && new_resource.manage_symlink_source
           verify_symlink_sanity(path)
         elsif file_class.symlink?(new_resource.path) && new_resource.manage_symlink_source.nil?
-          Chef::Log.warn("File #{path} managed by #{new_resource} is really a symlink. Managing the source file instead.")
-          Chef::Log.warn("Disable this warning by setting `manage_symlink_source true` on the resource")
-          Chef::Log.warn("In a future Chef release, 'manage_symlink_source' will not be enabled by default")
+          logger.warn("File #{path} managed by #{new_resource} is really a symlink. Managing the source file instead.")
+          logger.warn("Disable this warning by setting `manage_symlink_source true` on the resource")
+          logger.warn("In a future Chef release, 'manage_symlink_source' will not be enabled by default")
           verify_symlink_sanity(path)
         elsif new_resource.force_unlink
           [nil, nil, nil]
@@ -273,7 +273,7 @@ class Chef
       def content
         @content ||= begin
           load_current_resource if current_resource.nil?
-          @content_class.new(new_resource, current_resource, @run_context)
+          @content_class.new(new_resource, current_resource, @run_context, logger)
         end
       end
 
@@ -361,7 +361,7 @@ class Chef
         if needs_creating?
           converge_by("create new file #{new_resource.path}") do
             deployment_strategy.create(new_resource.path)
-            Chef::Log.info("#{new_resource} created file #{new_resource.path}")
+            logger.info("#{new_resource} created file #{new_resource.path}")
           end
         end
       end
@@ -377,7 +377,7 @@ class Chef
       def update_file_contents
         do_backup unless needs_creating?
         deployment_strategy.deploy(tempfile.path, ::File.realpath(new_resource.path))
-        Chef::Log.info("#{new_resource} updated file contents #{new_resource.path}")
+        logger.info("#{new_resource} updated file contents #{new_resource.path}")
         if managing_content?
           # save final checksum for reporting.
           new_resource.final_checksum = checksum(new_resource.path)
@@ -428,7 +428,7 @@ class Chef
               restore_security_context(::File.realpath(new_resource.path), recursive)
             end
           else
-            Chef::Log.debug "selinux utilities can not be found. Skipping selinux permission fixup."
+            logger.trace "selinux utilities can not be found. Skipping selinux permission fixup."
           end
         end
       end
@@ -442,7 +442,7 @@ class Chef
       end
 
       def contents_changed?
-        Chef::Log.debug "calculating checksum of #{tempfile.path} to compare with #{current_resource.checksum}"
+        logger.trace "calculating checksum of #{tempfile.path} to compare with #{current_resource.checksum}"
         tempfile_checksum != current_resource.checksum
       end
 

data/lib/chef/provider/git.rb

@@ -80,7 +80,7 @@ class Chef
           enable_submodules
           add_remotes
         else
-          Chef::Log.debug "#{new_resource} checkout destination #{cwd} already exists or is a non-empty directory"
+          logger.trace "#{new_resource} checkout destination #{cwd} already exists or is a non-empty directory"
         end
       end
 
@@ -93,11 +93,11 @@ class Chef
 
       def action_sync
         if existing_git_clone?
-          Chef::Log.debug "#{new_resource} current revision: #{current_resource.revision} target revision: #{target_revision}"
+          logger.trace "#{new_resource} current revision: #{current_resource.revision} target revision: #{target_revision}"
           unless current_revision_matches_target_revision?
             fetch_updates
             enable_submodules
-            Chef::Log.info "#{new_resource} updated to revision #{target_revision}"
+            logger.info "#{new_resource} updated to revision #{target_revision}"
           end
           add_remotes
         else
@@ -116,7 +116,7 @@ class Chef
         if match
           @git_gem_version = Gem::Version.new(match[1])
         else
-          Chef::Log.warn "Unable to parse git version from '#{output}'"
+          logger.warn "Unable to parse git version from '#{output}'"
           @git_gem_version = nil
         end
         @git_gem_version
@@ -131,7 +131,7 @@ class Chef
       end
 
       def find_current_revision
-        Chef::Log.debug("#{new_resource} finding current git revision")
+        logger.trace("#{new_resource} finding current git revision")
         if ::File.exist?(::File.join(cwd, ".git"))
           # 128 is returned when we're not in a git repo. this is fine
           result = git("rev-parse", "HEAD", cwd: cwd, returns: [0, 128]).stdout.strip
@@ -143,7 +143,7 @@ class Chef
         if new_resource.additional_remotes.length > 0
           new_resource.additional_remotes.each_pair do |remote_name, remote_url|
             converge_by("add remote #{remote_name} from #{remote_url}") do
-              Chef::Log.info "#{new_resource} adding git remote #{remote_name} = #{remote_url}"
+              logger.info "#{new_resource} adding git remote #{remote_name} = #{remote_url}"
               setup_remote_tracking_branches(remote_name, remote_url)
             end
           end
@@ -161,7 +161,7 @@ class Chef
           clone_cmd << "\"#{new_resource.repository}\""
           clone_cmd << "\"#{cwd}\""
 
-          Chef::Log.info "#{new_resource} cloning repo #{new_resource.repository} to #{cwd}"
+          logger.info "#{new_resource} cloning repo #{new_resource.repository} to #{cwd}"
           git clone_cmd
         end
       end
@@ -173,16 +173,16 @@ class Chef
           # checkout into a local branch rather than a detached HEAD
           git("branch", "-f", new_resource.checkout_branch, sha_ref, cwd: cwd)
           git("checkout", new_resource.checkout_branch, cwd: cwd)
-          Chef::Log.info "#{new_resource} checked out branch: #{new_resource.revision} onto: #{new_resource.checkout_branch} reference: #{sha_ref}"
+          logger.info "#{new_resource} checked out branch: #{new_resource.revision} onto: #{new_resource.checkout_branch} reference: #{sha_ref}"
         end
       end
 
       def enable_submodules
         if new_resource.enable_submodules
           converge_by("enable git submodules for #{new_resource}") do
-            Chef::Log.info "#{new_resource} synchronizing git submodules"
+            logger.info "#{new_resource} synchronizing git submodules"
             git("submodule", "sync", cwd: cwd)
-            Chef::Log.info "#{new_resource} enabling git submodules"
+            logger.info "#{new_resource} enabling git submodules"
             # the --recursive flag means we require git 1.6.5+ now, see CHEF-1827
             git("submodule", "update", "--init", "--recursive", cwd: cwd)
           end
@@ -193,7 +193,7 @@ class Chef
         setup_remote_tracking_branches(new_resource.remote, new_resource.repository)
         converge_by("fetch updates for #{new_resource.remote}") do
           # since we're in a local branch already, just reset to specified revision rather than merge
-          Chef::Log.debug "Fetching updates from #{new_resource.remote} and resetting to revision #{target_revision}"
+          logger.trace "Fetching updates from #{new_resource.remote} and resetting to revision #{target_revision}"
           git("fetch", new_resource.remote, cwd: cwd)
           git("fetch", new_resource.remote, "--tags", cwd: cwd)
           git("reset", "--hard", target_revision, cwd: cwd)
@@ -202,7 +202,7 @@ class Chef
 
       def setup_remote_tracking_branches(remote_name, remote_url)
         converge_by("set up remote tracking branches for #{remote_url} at #{remote_name}") do
-          Chef::Log.debug "#{new_resource} configuring remote tracking branches for repository #{remote_url} " + "at remote #{remote_name}"
+          logger.trace "#{new_resource} configuring remote tracking branches for repository #{remote_url} " + "at remote #{remote_name}"
           check_remote_command = ["config", "--get", "remote.#{remote_name}.url"]
           remote_status = git(check_remote_command, cwd: cwd, returns: [0, 1, 2])
           case remote_status.exitstatus
@@ -246,7 +246,7 @@ class Chef
       alias :revision_slug :target_revision
 
       def remote_resolve_reference
-        Chef::Log.debug("#{new_resource} resolving remote reference")
+        logger.trace("#{new_resource} resolving remote reference")
         # The sha pointed to by an annotated tag is identified by the
         # '^{}' suffix appended to the tag. In order to resolve
         # annotated tags, we have to search for "revision*" and
@@ -334,7 +334,7 @@ class Chef
 
       def git(*args, **run_opts)
         git_command = ["git", args].compact.join(" ")
-        Chef::Log.debug "running #{git_command}"
+        logger.trace "running #{git_command}"
         shell_out!(git_command, run_options(run_opts))
       end
 

data/lib/chef/provider/group.rb

@@ -41,7 +41,7 @@ class Chef
           group_info = Etc.getgrnam(new_resource.group_name)
         rescue ArgumentError
           @group_exists = false
-          Chef::Log.debug("#{new_resource} group does not exist")
+          logger.trace("#{new_resource} group does not exist")
         end
 
         if group_info
@@ -126,13 +126,13 @@ class Chef
         when false
           converge_by("create group #{new_resource.group_name}") do
             create_group
-            Chef::Log.info("#{new_resource} created")
+            logger.info("#{new_resource} created")
           end
         else
           if compare_group
             converge_by(["alter group #{new_resource.group_name}"] + change_desc) do
               manage_group
-              Chef::Log.info("#{new_resource} altered")
+              logger.info("#{new_resource} altered")
             end
           end
         end
@@ -142,7 +142,7 @@ class Chef
         return unless @group_exists
         converge_by("remove group #{new_resource.group_name}") do
           remove_group
-          Chef::Log.info("#{new_resource} removed")
+          logger.info("#{new_resource} removed")
         end
       end
 
@@ -150,7 +150,7 @@ class Chef
         return unless @group_exists && compare_group
         converge_by(["manage group #{new_resource.group_name}"] + change_desc) do
           manage_group
-          Chef::Log.info("#{new_resource} managed")
+          logger.info("#{new_resource} managed")
         end
       end
 
@@ -158,7 +158,7 @@ class Chef
         return unless compare_group
         converge_by(["modify group #{new_resource.group_name}"] + change_desc) do
           manage_group
-          Chef::Log.info("#{new_resource} modified")
+          logger.info("#{new_resource} modified")
         end
       end