chef 13.12.14 → 14.0.190

data/lib/chef/provider/windows_task.rb

@@ -1,6 +1,6 @@
 #
 # Author:: Nimisha Sharad (<nimisha.sharad@msystechnologies.com>)
-# Copyright:: Copyright 2008-2016, 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");
@@ -27,7 +27,7 @@ class Chef
       include Chef::Mixin::ShellOut
       include Chef::Mixin::PowershellOut
 
-      provides :windows_task, os: "windows"
+      provides :windows_task
 
       def load_current_resource
         self.current_resource = Chef::Resource::WindowsTask.new(new_resource.name)
@@ -75,9 +75,9 @@ class Chef
 
       def action_create
         if current_resource.exists
-          Chef::Log.debug "#{new_resource} task exists."
+          logger.trace "#{new_resource} task exists"
           if !(task_need_update? || new_resource.force)
-            Chef::Log.info "#{new_resource} task doesn't need updating and force not specified - nothing to do"
+            logger.info "#{new_resource} task does not need updating and force is not specified - nothing to do"
             return
           end
           # Setting the attributes of new_resource as current_resource.
@@ -128,74 +128,74 @@ class Chef
 
       def action_run
         if current_resource.exists
-          Chef::Log.debug "#{new_resource} task exists."
+          logger.trace "#{new_resource} task exists"
           if current_resource.status == :running
-            Chef::Log.info "#{new_resource} task is currently running, skipping run."
+            logger.info "#{new_resource} task is currently running, skipping run"
           else
             converge_by("run scheduled task #{new_resource}") do
               run_schtasks "RUN"
             end
           end
         else
-          Chef::Log.warn "#{new_resource} task doesn't exists - nothing to do"
+          logger.warn "#{new_resource} task does not exist - nothing to do"
         end
       end
 
       def action_delete
         if current_resource.exists
-          Chef::Log.debug "#{new_resource} task exists."
+          logger.trace "#{new_resource} task exists"
           converge_by("delete scheduled task #{new_resource}") do
             # always need to force deletion
             run_schtasks "DELETE", "F" => ""
           end
         else
-          Chef::Log.warn "#{new_resource} task doesn't exists - nothing to do"
+          logger.warn "#{new_resource} task does not exist - nothing to do"
         end
       end
 
       def action_end
         if current_resource.exists
-          Chef::Log.debug "#{new_resource} task exists."
+          logger.trace "#{new_resource} task exists"
           if current_resource.status != :running
-            Chef::Log.debug "#{new_resource} is not running - nothing to do"
+            logger.trace "#{new_resource} is not running - nothing to do"
           else
             converge_by("#{new_resource} task ended") do
               run_schtasks "END"
             end
           end
         else
-          Chef::Log.warn "#{new_resource} task doesn't exist - nothing to do"
+          logger.warn "#{new_resource} task does not exist - nothing to do"
         end
       end
 
       def action_enable
         if current_resource.exists
-          Chef::Log.debug "#{new_resource} task exists."
+          logger.trace "#{new_resource} task exists"
           if current_resource.enabled
-            Chef::Log.debug "#{new_resource} already enabled - nothing to do"
+            logger.trace "#{new_resource} already enabled - nothing to do"
           else
             converge_by("#{new_resource} task enabled") do
               run_schtasks "CHANGE", "ENABLE" => ""
             end
           end
         else
-          Chef::Log.fatal "#{new_resource} task doesn't exist - nothing to do"
+          logger.fatal "#{new_resource} task does not exist - nothing to do"
           raise Errno::ENOENT, "#{new_resource}: task does not exist, cannot enable"
         end
       end
 
       def action_disable
         if current_resource.exists
-          Chef::Log.info "#{new_resource} task exists."
+          logger.info "#{new_resource} task exists"
           if current_resource.enabled
             converge_by("#{new_resource} task disabled") do
               run_schtasks "CHANGE", "DISABLE" => ""
             end
           else
-            Chef::Log.warn "#{new_resource} already disabled - nothing to do"
+            logger.warn "#{new_resource} already disabled - nothing to do"
           end
         else
-          Chef::Log.warn "#{new_resource} task doesn't exist - nothing to do"
+          logger.warn "#{new_resource} task does not exist - nothing to do"
         end
       end
 
@@ -204,7 +204,7 @@ class Chef
       # rubocop:disable Style/StringLiteralsInInterpolation
       def run_schtasks(task_action, options = {})
         cmd = "schtasks /#{task_action} /TN \"#{new_resource.task_name}\" "
-        options.keys.each do |option|
+        options.each_key do |option|
           unless option == "TR"
             cmd += "/#{option} "
             cmd += "\"#{options[option].to_s.gsub('"', "\\\"")}\" " unless options[option] == ""
@@ -214,8 +214,8 @@ class Chef
         if options["TR"]
           cmd += "/TR \"#{options["TR"]} \" " unless task_action == "DELETE"
         end
-        Chef::Log.debug("running: ")
-        Chef::Log.debug("    #{cmd}")
+        logger.trace("running: ")
+        logger.trace("    #{cmd}")
         shell_out!(cmd, returns: [0])
       end
       # rubocop:enable Style/StringLiteralsInInterpolation
@@ -236,7 +236,7 @@ class Chef
           return true if new_resource.day.to_s.casecmp(current_resource.day.to_s) != 0 ||
               new_resource.months.to_s.casecmp(current_resource.months.to_s) != 0
         rescue
-          Chef::Log.debug "caught a raise in task_needs_update?"
+          logger.trace "caught a raise in task_needs_update?"
         end
 
         false
@@ -314,7 +314,7 @@ class Chef
 
       def get_system_short_date_format
         return @system_short_date_format if @system_short_date_format
-        Chef::Log.debug "Finding system date format"
+        logger.trace "Finding system date format"
         task_script = <<-EOH
           [Console]::OutputEncoding = [Text.UTF8Encoding]::UTF8
           [Globalization.Cultureinfo]::CurrentCulture.DateTimeFormat.ShortDatePattern
@@ -349,7 +349,7 @@ class Chef
           "execution_time_limit" => "Settings/ExecutionTimeLimit",
         }
 
-        Chef::Log.debug "looking for existing tasks"
+        logger.trace "looking for existing tasks"
 
         task_script = <<-EOH
             [Console]::OutputEncoding = [Text.UTF8Encoding]::UTF8
@@ -368,12 +368,12 @@ class Chef
         end
 
         options.each do |option|
-          Chef::Log.debug "Removing former #{option} if any"
+          logger.trace "Removing former #{option} if any"
           doc.root.elements.delete(xml_element_mapping[option])
           option_value = new_resource.send("#{option}")
 
           if option_value
-            Chef::Log.debug "Setting #{option} as #{option_value}"
+            logger.trace "Setting #{option} as #{option_value}"
             split_xml_path = xml_element_mapping[option].split("/") # eg. if xml_element_mapping[option] = "Actions/Exec/WorkingDirectory"
             element_name = split_xml_path.last # element_name = "WorkingDirectory"
             cwd_element = REXML::Element.new(element_name)
@@ -403,7 +403,7 @@ class Chef
       end
 
       def load_task_hash(task_name)
-        Chef::Log.debug "Looking for existing tasks"
+        logger.trace "Looking for existing tasks"
 
         task_script = <<-EOH
           [Console]::OutputEncoding = [Text.UTF8Encoding]::UTF8

data/lib/chef/provider/zypper_repository.rb

@@ -34,7 +34,7 @@ class Chef
         if new_resource.gpgautoimportkeys
           install_gpg_key(new_resource.gpgkey)
         else
-          Chef::Log.debug("'gpgautoimportkeys' property is set to false. Skipping key import.")
+          logger.trace("'gpgautoimportkeys' property is set to false. Skipping key import.")
         end
 
         declare_resource(:template, "/etc/zypp/repos.d/#{escaped_repo_name}.repo") do
@@ -89,7 +89,7 @@ class Chef
       end
 
       # determine if a cookbook file is available in the run
-      # @param [String] path the path to the template file
+      # @param [String] fn the path to the template file
       #
       # @return [Boolean] cookbook file exists or doesn't
       def has_cookbook_file?(fn)
@@ -105,10 +105,10 @@ class Chef
       # @return [Symbol] :remote_file or :cookbook_file
       def key_type(uri)
         if uri.start_with?("http")
-          Chef::Log.debug("Will use :remote_file resource to cache the gpg key locally")
+          logger.trace("Will use :remote_file resource to cache the gpg key locally")
           :remote_file
         elsif has_cookbook_file?(uri)
-          Chef::Log.debug("Will use :cookbook_file resource to cache the gpg key locally")
+          logger.trace("Will use :cookbook_file resource to cache the gpg key locally")
           :cookbook_file
         else
           raise Chef::Exceptions::FileNotFound, "Cannot determine location of gpgkey. Must start with 'http' or be a file managed by Chef."
@@ -123,7 +123,7 @@ class Chef
         so = shell_out("rpm -qa gpg-pubkey*")
         # expected output & match: http://rubular.com/r/RdF7EcXEtb
         status = /gpg-pubkey-#{key_fingerprint(key_path)}/.match(so.stdout)
-        Chef::Log.debug("GPG key at #{key_path} is known by rpm? #{status ? "true" : "false"}")
+        logger.trace("GPG key at #{key_path} is known by rpm? #{status ? "true" : "false"}")
         status
       end
 
@@ -135,7 +135,7 @@ class Chef
         so = shell_out!("gpg --with-fingerprint #{key_path}")
         # expected output and match: http://rubular.com/r/BpfMjxySQM
         fingerprint = /pub\s*\S*\/(\S*)/.match(so.stdout)[1].downcase
-        Chef::Log.debug("GPG fingerprint of key at #{key_path} is #{fingerprint}")
+        logger.trace("GPG fingerprint of key at #{key_path} is #{fingerprint}")
         fingerprint
       end
 
@@ -143,7 +143,7 @@ class Chef
       # @param [String] uri the uri of the local or remote gpg key
       def install_gpg_key(uri)
         unless uri
-          Chef::Log.debug("'gpgkey' property not provided or set to nil. Skipping key import.")
+          logger.trace("'gpgkey' property not provided or set to nil. Skipping key import.")
           return
         end
 

data/lib/chef/provider_resolver.rb

@@ -95,7 +95,7 @@ class Chef
           # a provider to say "assuming /etc/init.d/whatever would have been installed" and in the non-why-run case we
           # need to make a best guess at "cannot find /etc/init.d/whatever".  We are essentially defining a "default" provider
           # for the platform, which is the best we can do, but which might give misleading errors, but we cannot read minds.
-          Chef::Log.debug "No providers responded true to `supports?` for action #{action} on resource #{resource}, falling back to enabled handlers so we can return something anyway."
+          Chef::Log.trace "No providers responded true to `supports?` for action #{action} on resource #{resource}, falling back to enabled handlers so we can return something anyway."
           supported_handlers = enabled_handlers
         end
 
@@ -118,14 +118,14 @@ class Chef
 
     # try dynamically finding a provider based on querying the providers to see what they support
     def maybe_dynamic_provider_resolution(resource, action)
-      Chef::Log.debug "Providers for generic #{resource.resource_name} resource enabled on node include: #{enabled_handlers}"
+      Chef::Log.trace "Providers for generic #{resource.resource_name} resource enabled on node include: #{enabled_handlers}"
 
       handler = prioritized_handlers.first
 
       if handler
-        Chef::Log.debug "Provider for action #{action} on resource #{resource} is #{handler}"
+        Chef::Log.trace "Provider for action #{action} on resource #{resource} is #{handler}"
       else
-        Chef::Log.debug "Dynamic provider resolver FAILED to resolve a provider for action #{action} on resource #{resource}"
+        Chef::Log.trace "Dynamic provider resolver FAILED to resolve a provider for action #{action} on resource #{resource}"
       end
 
       handler

data/lib/chef/providers.rb

@@ -24,12 +24,9 @@ require "chef/provider/cookbook_file"
 require "chef/provider/cron"
 require "chef/provider/cron/solaris"
 require "chef/provider/cron/aix"
-require "chef/provider/deploy"
 require "chef/provider/directory"
 require "chef/provider/dsc_script"
 require "chef/provider/dsc_resource"
-require "chef/provider/env"
-require "chef/provider/erl_call"
 require "chef/provider/execute"
 require "chef/provider/file"
 require "chef/provider/git"
@@ -58,13 +55,12 @@ require "chef/provider/systemd_unit"
 require "chef/provider/template"
 require "chef/provider/user"
 require "chef/provider/whyrun_safe_ruby_block"
+require "chef/provider/windows_env"
 require "chef/provider/yum_repository"
 require "chef/provider/windows_task"
 require "chef/provider/zypper_repository"
 require "chef/provider/windows_path"
 
-require "chef/provider/env/windows"
-
 require "chef/provider/package/apt"
 require "chef/provider/package/chocolatey"
 require "chef/provider/package/dpkg"
@@ -85,7 +81,7 @@ require "chef/provider/package/yum"
 require "chef/provider/package/zypper"
 require "chef/provider/package/solaris"
 require "chef/provider/package/smartos"
-require "chef/provider/package/aix"
+require "chef/provider/package/bff"
 require "chef/provider/package/cab"
 require "chef/provider/package/powershell"
 require "chef/provider/package/msu"
@@ -131,9 +127,6 @@ require "chef/provider/mount/aix"
 require "chef/provider/mount/solaris"
 require "chef/provider/mount/windows"
 
-require "chef/provider/deploy/revision"
-require "chef/provider/deploy/timestamped"
-
 require "chef/provider/remote_file/ftp"
 require "chef/provider/remote_file/sftp"
 require "chef/provider/remote_file/http"

data/lib/chef/resource.rb

@@ -131,6 +131,13 @@ class Chef
     def initialize(name, run_context = nil)
       name(name) unless name.nil?
       @run_context = run_context
+
+      @logger = if run_context
+                  run_context.logger.with_child({ name: name, resource: resource_name })
+                else
+                  Chef::Log.with_child({ name: name, resource: resource_name })
+                end
+
       @before = nil
       @params = Hash.new
       @provider = nil
@@ -536,11 +543,6 @@ class Chef
     #
     property :ignore_failure, [ TrueClass, FalseClass ], default: false, desired_state: false
 
-    #
-    # Equivalent to #ignore_failure.
-    #
-    alias :epic_fail :ignore_failure
-
     #
     # Make this resource into an exact (shallow) copy of the other resource.
     #
@@ -573,9 +575,9 @@ class Chef
       resolve_notification_references
       validate_action(action)
 
-      if Chef::Config[:verbose_logging] || Chef::Log.level == :debug
+      if Chef::Config[:verbose_logging] || logger.level == :debug
         # This can be noisy
-        Chef::Log.info("Processing #{self} action #{action} (#{defined_at})")
+        logger.info("Processing #{self} action #{action} (#{defined_at})")
       end
 
       # ensure that we don't leave @updated_by_last_action set to true
@@ -592,12 +594,12 @@ class Chef
         provider_for_action(action).run_action
       rescue StandardError => e
         if ignore_failure
-          Chef::Log.error("#{custom_exception_message(e)}; ignore_failure is set, continuing")
+          logger.error("#{custom_exception_message(e)}; ignore_failure is set, continuing")
           events.resource_failed(self, action, e)
         elsif remaining_retries > 0
           events.resource_failed_retriable(self, action, remaining_retries, e)
           remaining_retries -= 1
-          Chef::Log.info("Retrying execution of #{self}, #{remaining_retries} attempt(s) left")
+          logger.info("Retrying execution of #{self}, #{remaining_retries} attempt#{"s" if remaining_retries > 1} left")
           sleep retry_delay
           retry
         else
@@ -862,7 +864,7 @@ class Chef
     # @return [Array<Symbol>] The list of actions this Resource is allowed to
     #   have.
     #
-    attr_accessor :allowed_actions
+    attr_writer :allowed_actions
     def allowed_actions(value = NOT_PASSED)
       if value != NOT_PASSED
         self.allowed_actions = value
@@ -1180,8 +1182,8 @@ class Chef
     # Internal Resource Interface (for Chef)
     #
 
-    FORBIDDEN_IVARS = [:@run_context, :@not_if, :@only_if, :@enclosing_provider, :@description, :@introduced, :@examples, :@validation_message, :@deprecated]
-    HIDDEN_IVARS = [:@allowed_actions, :@resource_name, :@source_line, :@run_context, :@name, :@not_if, :@only_if, :@elapsed_time, :@enclosing_provider, :@description, :@introduced, :@examples, :@validation_message, :@deprecated]
+    FORBIDDEN_IVARS = [:@run_context, :@logger, :@not_if, :@only_if, :@enclosing_provider, :@description, :@introduced, :@examples, :@validation_message, :@deprecated]
+    HIDDEN_IVARS = [:@allowed_actions, :@resource_name, :@source_line, :@run_context, :@logger, :@name, :@not_if, :@only_if, :@elapsed_time, :@enclosing_provider, :@description, :@introduced, :@examples, :@validation_message, :@deprecated]
 
     include Chef::Mixin::ConvertToClassName
     extend Chef::Mixin::ConvertToClassName
@@ -1195,6 +1197,10 @@ class Chef
     # and the resource collection.
     attr_accessor :run_context
 
+    # @return [Mixlib::Log::Child] The logger for this resources. This is a child
+    # of the run context's logger, if one exists.
+    attr_reader :logger
+
     # @return [String] The cookbook this resource was declared in.
     attr_accessor :cookbook_name
 
@@ -1470,7 +1476,7 @@ class Chef
           false
         else
           events.resource_skipped(self, action, conditional)
-          Chef::Log.debug("Skipping #{self} due to #{conditional.description}")
+          logger.debug("Skipping #{self} due to #{conditional.description}")
           true
         end
       end

data/lib/chef/resource/action_class.rb

@@ -1,6 +1,6 @@
 #
 # Author:: John Keiser (<jkeiser@chef.io)
-# Copyright:: Copyright 2015-2017, Chef Software Inc.
+# Copyright:: Copyright 2015-2018, Chef Software Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -40,7 +40,7 @@ class Chef
           # We clear desired state in the copy, because it is supposed to be actual state.
           # We keep identity properties and non-desired-state, which are assumed to be
           # "control" values like `recurse: true`
-          current_resource.class.properties.each do |name, property|
+          current_resource.class.properties.each_value do |property|
             if property.desired_state? && !property.identity? && !property.name_property?
               property.reset(current_resource)
             end

data/lib/chef/resource/apt_package.rb

@@ -17,16 +17,22 @@
 #
 
 require "chef/resource/package"
-require "chef/provider/package/apt"
 
 class Chef
   class Resource
-    # Use the apt_package resource to manage packages on Debian and Ubuntu platforms.
     class AptPackage < Chef::Resource::Package
       resource_name :apt_package
-      provides :package, os: "linux", platform_family: "debian"
+      provides :package, platform_family: "debian"
 
-      property :default_release, String, desired_state: false
+      description "Use the apt_package resource to manage packages on Debian and Ubuntu platforms."
+
+      property :default_release, String,
+               description: "The default release. For example: stable.",
+               desired_state: false
+
+      property :overwrite_config_files, [TrueClass, FalseClass],
+               description: "Overwrite existing config files with those in the package if prompted by apt.",
+               default: false
 
     end
   end