chef 14.7.17 → 14.8.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 72ed54db28d5229e29a1d6c6611636d777a5a291bd49cdc7909105fe8018208d
-  data.tar.gz: e52fd041a354f764f5aa4fa8ff52b0f65b524f7614c87fda5888de50d3745656
+  metadata.gz: c08486082bafcd0e272f4a8fbdcf7677de1260168607f2f1a8a1017d41654ba5
+  data.tar.gz: 63d92a1beb97fef7ef40d566d02e2d6304848c51a0a59251dba9545bdbcdafcc
 SHA512:
-  metadata.gz: 1b6ddeb455f54fbd683dc4456f3c4aeb7e6e35179781c57c7a5cccc96dfa6eba03129746a333fd03522c771916b8ef4c99c172c2e6201cb57f72873ccecb3b51
-  data.tar.gz: 3fe50c3a56e2900692a15e0134453af0395790b1f020d91c7e14477a8c3e9293feef1987ee6f4bc0dff40bb1d891b0596aea5d8ec15de1b9ff79b4d503006118
+  metadata.gz: 123ec76435079d744bf4cd759b33932ea74f3381680b668a34e765f71817c69df7c2d012bbee5039363a26932b1cbda799d8a2abb85725fdbadceb4515f57f2b
+  data.tar.gz: f8265387cc5daaf80506352219cf787a847d4250c121bde4162fb88b62606f04f9120100025bc1fdf7dd98673eae922068f80a81cf1b056fb09c745fb4acd232

data/lib/chef/mixin/which.rb

@@ -1,6 +1,6 @@
 #--
 # Author:: Lamont Granquist <lamont@chef.io>
-# Copyright:: Copyright 2010-2017, Chef Software Inc.
+# Copyright:: Copyright 2010-2018, Chef Software Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -18,6 +18,8 @@
 class Chef
   module Mixin
     module Which
+      require "chef/chef_class"
+
       def which(*cmds, extra_path: nil, &block)
         where(*cmds, extra_path: extra_path, &block).first || false
       end

data/lib/chef/provider/apt_repository.rb

@@ -225,7 +225,7 @@ class Chef
       #
       # @return [String] the full apt-key command to run
       def keyserver_install_cmd(key, keyserver)
-        cmd = "apt-key adv --recv"
+        cmd = "apt-key adv --no-tty --recv"
         cmd << " --keyserver-options http-proxy=#{new_resource.key_proxy}" if new_resource.key_proxy
         cmd << " --keyserver "
         cmd << if keyserver.start_with?("hkp://")

data/lib/chef/provider/execute.rb

@@ -37,7 +37,7 @@ class Chef
       def define_resource_requirements
         if creates && creates_relative? && !cwd
           # FIXME? move this onto the resource?
-          raise Chef::Exceptions::Execute, "Please either specify a full path for the creates attribute, or specify a cwd property to the #{new_resource} resource"
+          raise Chef::Exceptions::Execute, "Please either specify a full path for the creates property, or specify a cwd property to the #{new_resource} resource"
         end
       end
 

data/lib/chef/provider/osx_profile.rb

@@ -68,7 +68,7 @@ class Chef
                 !@new_profile_identifier.end_with?(".mobileconfig") &&
                 /^\w+(?:(\.| )\w+)+$/.match(@new_profile_identifier)
             end
-            a.failure_message RuntimeError, "when removing using the identifier attribute, it must match the profile identifier"
+            a.failure_message RuntimeError, "when removing using the identifier property, it must match the profile identifier"
           else
             new_profile_name = new_resource.profile_name
             a.assertion do

data/lib/chef/provider/package/apt.rb

@@ -1,6 +1,6 @@
 #
 # Author:: Adam Jacob (<adam@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");
@@ -44,7 +44,7 @@ class Chef
 
           requirements.assert(:all_actions) do |a|
             a.assertion { !new_resource.source }
-            a.failure_message(Chef::Exceptions::Package, "apt package provider cannot handle source attribute. Use dpkg provider instead")
+            a.failure_message(Chef::Exceptions::Package, "apt package provider cannot handle source property. Use dpkg provider instead")
           end
         end
 
@@ -92,7 +92,8 @@ class Chef
           package_name = name.zip(version).map do |n, v|
             package_data[n][:virtual] ? n : "#{n}=#{v}"
           end
-          run_noninteractive("apt-get", "-q", "-y", config_file_options, default_release_options, options, "install", package_name)
+          dgrade = "--allow-downgrades" if supports_allow_downgrade? && allow_downgrade
+          run_noninteractive("apt-get", "-q", "-y", dgrade, config_file_options, default_release_options, options, "install", package_name)
         end
 
         def upgrade_package(name, version)
@@ -133,6 +134,17 @@ class Chef
 
         private
 
+        # @return [String] version of apt-get which is installed
+        def apt_version
+          @apt_version ||= shell_out("apt-get --version").stdout.match(/^apt (\S+)/)[1]
+        end
+
+        # @return [Boolean] if apt-get supports --allow-downgrades
+        def supports_allow_downgrade?
+          return @supports_allow_downgrade unless @supports_allow_downgrade.nil?
+          @supports_allow_downgrade = ( version_compare(apt_version, "1.1.0") >= 0 )
+        end
+
         # compare 2 versions to each other to see which is newer.
         # this differs from the standard package method because we
         # need to be able to parse debian version strings which contain

data/lib/chef/provider/package/cab.rb

@@ -74,9 +74,13 @@ class Chef
         end
 
         def dism_command(command)
-          shellout = Mixlib::ShellOut.new("dism.exe /Online /English #{command} /NoRestart", timeout: new_resource.timeout)
           with_os_architecture(nil) do
-            shellout.run_command
+            result = shell_out("dism.exe /Online /English #{command} /NoRestart", { timeout: new_resource.timeout })
+            if result.exitstatus == -2146498530
+              raise Chef::Exceptions::Package, "The specified package is not applicable to this image." if result.stdout.include?("0x800f081e")
+              result.error!
+            end
+            result
           end
         end
 

data/lib/chef/provider/package/chocolatey.rb

@@ -54,7 +54,7 @@ EOS
 
           # The check that Chocolatey is installed is in #choco_exe.
 
-          # Chocolatey source attribute points to an alternate feed
+          # Chocolatey source property points to an alternate feed
           # and not a package specific alternate source like other providers
           # so we want to assert candidates exist for the alternate source
           requirements.assert(:upgrade, :install) do |a|

data/lib/chef/provider/package/dnf/python_helper.rb

@@ -37,7 +37,8 @@ class Chef
           DNF_HELPER = ::File.expand_path(::File.join(::File.dirname(__FILE__), "dnf_helper.py")).freeze
 
           def dnf_command
-            @dnf_command ||= which("python", "python3", "python2", "python2.7") do |f|
+            # platform-python is used for system tools on RHEL 8 and is installed under /usr/libexec
+            @dnf_command ||= which("platform-python", "python", "python3", "python2", "python2.7", extra_path: "/usr/libexec") do |f|
               shell_out("#{f} -c 'import dnf'").exitstatus == 0
             end + " #{DNF_HELPER}"
           end

data/lib/chef/provider/package/openbsd.rb

@@ -53,7 +53,7 @@ class Chef
           # Below are incomplete/missing features for this package provider
           requirements.assert(:all_actions) do |a|
             a.assertion { !new_resource.source }
-            a.failure_message(Chef::Exceptions::Package, "The openbsd package provider does not support the source attribute")
+            a.failure_message(Chef::Exceptions::Package, "The openbsd package provider does not support the source property")
           end
           requirements.assert(:all_actions) do |a|
             a.assertion do

data/lib/chef/provider/package/rubygems.rb

@@ -1,7 +1,7 @@
 #
 # Author:: Adam Jacob (<adam@chef.io>)
 # Author:: Daniel DeLeo (<dan@chef.io>)
-# Copyright:: Copyright 2008-2016, 2010-2017, Chef Software Inc.
+# Copyright:: Copyright 2008-2016, 2010-2018, Chef Software Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -49,42 +49,44 @@ class Chef
 
           DEFAULT_UNINSTALLER_OPTS = { ignore: true, executables: true }.freeze
 
-          ##
           # The paths where rubygems should search for installed gems.
           # Implemented by subclasses.
           def gem_paths
             raise NotImplementedError
           end
 
-          ##
           # A rubygems source index containing the list of gemspecs for all
           # available gems in the gem installation.
           # Implemented by subclasses
-          # === Returns
-          # Gem::SourceIndex
+          #
+          # @return [Gem::SourceIndex]
+          #
           def gem_source_index
             raise NotImplementedError
           end
 
-          ##
           # A rubygems specification object containing the list of gemspecs for all
           # available gems in the gem installation.
           # Implemented by subclasses
           # For rubygems >= 1.8.0
-          # === Returns
-          # Gem::Specification
+          #
+          # @return [Gem::Specification]
+          #
           def gem_specification
             raise NotImplementedError
           end
 
-          ##
+          def rubygems_version
+            raise NotImplementedError
+          end
+
           # Lists the installed versions of +gem_name+, constrained by the
           # version spec in +gem_dep+
-          # === Arguments
-          # Gem::Dependency   +gem_dep+ is a Gem::Dependency object, its version
-          #                   specification constrains which gems are returned.
-          # === Returns
-          # [Gem::Specification]  an array of Gem::Specification objects
+          #
+          # @param gem_dep [Gem::Dependency] the version specification that constrains
+          #   which gems are used.
+          # @return [Array<Gem::Specification>]  an array of Gem::Specification objects
+          #
           def installed_versions(gem_dep)
             rubygems_version = Gem::Version.new(Gem::VERSION)
             if rubygems_version >= Gem::Version.new("2.7")
@@ -266,6 +268,10 @@ class Chef
             Gem::Specification
           end
 
+          def rubygems_version
+            Gem::VERSION
+          end
+
           def candidate_version_from_remote(gem_dependency, *sources)
             with_gem_sources(*sources) do
               find_newest_remote_version(gem_dependency, *sources)
@@ -293,6 +299,10 @@ class Chef
             @gem_binary_location = gem_binary_location
           end
 
+          def rubygems_version
+            @rubygems_version ||= shell_out!("#{@gem_binary_location} --version").stdout.chomp
+          end
+
           def gem_paths
             if self.class.gempath_cache.key?(@gem_binary_location)
               self.class.gempath_cache[@gem_binary_location]
@@ -547,9 +557,9 @@ class Chef
           end
           src_str = src.empty? ? "" : " #{src.join(" ")}"
           if !version.nil? && !version.empty?
-            shell_out!("#{gem_binary_path} install #{name} -q --no-rdoc --no-ri -v \"#{version}\"#{src_str}#{opts}", env: nil)
+            shell_out!("#{gem_binary_path} install #{name} -q #{rdoc_string} -v \"#{version}\"#{src_str}#{opts}", env: nil)
           else
-            shell_out!("#{gem_binary_path} install \"#{name}\" -q --no-rdoc --no-ri #{src_str}#{opts}", env: nil)
+            shell_out!("#{gem_binary_path} install \"#{name}\" -q #{rdoc_string} #{src_str}#{opts}", env: nil)
           end
         end
 
@@ -585,6 +595,18 @@ class Chef
 
         private
 
+        def rdoc_string
+          if needs_nodocument?
+            "--no-document"
+          else
+            "--no-rdoc --no-ri"
+          end
+        end
+
+        def needs_nodocument?
+          Gem::Requirement.new(">= 3.0.0.beta1").satisfied_by?(Gem::Version.new(gem_env.rubygems_version))
+        end
+
         def opts
           expand_options(new_resource.options)
         end

data/lib/chef/resource/apt_package.rb

@@ -32,7 +32,7 @@ class Chef
 
       property :overwrite_config_files, [TrueClass, FalseClass],
                introduced: "14.0",
-               description: "Overwrite existing config files with those in the package if prompted by apt.",
+               description: "Overwrite existing configuration files with those supplied by the package, if prompted by APT.",
                default: false
 
     end

data/lib/chef/resource/apt_preference.rb

@@ -30,7 +30,7 @@ class Chef
 
       property :package_name, String,
                name_property: true,
-               description: "The name of the package.",
+               description: "An optional property to set the package name if it differs from the resource block's name.",
                regex: [/^([a-z]|[A-Z]|[0-9]|_|-|\.|\*|\+)+$/],
                validation_message: "The provided package name is not valid. Package names can only contain alphanumeric characters as well as _, -, +, or *!"
 

data/lib/chef/resource/apt_repository.rb

@@ -34,7 +34,7 @@ class Chef
       # to allow that so don't refactor this however tempting it is
       property :repo_name, String,
                regex: [/^[^\/]+$/],
-               description: "The name of the repository to configure, if it differs from the name of the resource block. The value of this setting must not contain spaces.",
+               description: "An optional property to set the repository name if it differs from the resource block's name. The value of this setting must not contain spaces.",
                validation_message: "repo_name property cannot contain a forward slash '/'",
                introduced: "14.1", name_property: true
 

data/lib/chef/resource/chocolatey_config.rb

@@ -24,7 +24,7 @@ class Chef
       introduced "14.3"
 
       property :config_key, String, name_property: true,
-               description: "The name of the config. The resource's name will be used if this isn't provided."
+               description: "An optional property to set the config key name if it differs from the resource block's name."
 
       property :value, String,
                description: "The value to set."

data/lib/chef/resource/chocolatey_source.rb

@@ -24,7 +24,7 @@ class Chef
       introduced "14.3"
 
       property :source_name, String, name_property: true,
-               description: "The name of the source to add. The resource's name will be used if this isn't provided."
+               description: "An optional property to set the source name if it differs from the resource block's name."
 
       property :source, String,
                description: "The source URL."

data/lib/chef/resource/cron.rb

@@ -134,14 +134,33 @@ class Chef
         )
       end
 
-      property :time, Symbol, equal_to: Chef::Provider::Cron::SPECIAL_TIME_VALUES
-      property :mailto, String
-      property :path, String
-      property :home, String
-      property :shell, String
-      property :command, String, identity: true
-      property :user, String, default: "root"
-      property :environment, Hash, default: lazy { Hash.new }
+      property :time, Symbol,
+               description: "A time interval. Possible values: :annually, :daily, :hourly, :midnight, :monthly, :reboot, :weekly, or :yearly.",
+               equal_to: Chef::Provider::Cron::SPECIAL_TIME_VALUES
+
+      property :mailto, String,
+               description: "Set the MAILTO environment variable."
+
+      property :path, String,
+               description: "Set the PATH environment variable."
+
+      property :home, String,
+               description: "Set the HOME environment variable."
+
+      property :shell, String,
+               description: "Set the SHELL environment variable."
+
+      property :command, String,
+               description: "The command to be run, or the path to a file that contains the command to be run.",
+               identity: true
+
+      property :user, String,
+               description: "The name of the user that runs the command. If the user property is changed, the original user for the crontab program continues to run until that crontab program is deleted. This property is not applicable on the AIX platform.",
+               default: "root"
+
+      property :environment, Hash,
+               description: "A Hash of environment variables in the form of ({'ENV_VARIABLE' => 'VALUE'}).",
+               default: lazy { Hash.new }
 
       private
 

data/lib/chef/resource/cron_access.rb

@@ -31,7 +31,7 @@ class Chef
       description "Use the cron_access resource to manage the /etc/cron.allow and /etc/cron.deny files."
 
       property :user, String,
-               description: "The user to allow or deny. If not provided we'll use the resource name.",
+               description: "An optional property to set the user name if it differs from the resource block's name.",
                name_property: true
 
       action :allow do

data/lib/chef/resource/cron_d.rb

@@ -88,7 +88,7 @@ class Chef
       end
 
       property :cron_name, String,
-               description: "Set the name of the cron job. If this isn't specified we'll use the resource name.",
+               description: "An optional property to set the cron name if it differs from the resource block's name.",
                name_property: true
 
       property :cookbook, String, desired_state: false
@@ -98,31 +98,31 @@ class Chef
                equal_to: %w{ @reboot @yearly @annually @monthly @weekly @daily @midnight @hourly }
 
       property :minute, [Integer, String],
-               description: "The minute to schedule the cron job to run at. Valid values: 0-59.",
+               description: "The minute at which the cron entry should run (0 - 59).",
                default: "*", callbacks: {
                  "should be a valid minute spec" => ->(spec) { validate_numeric(spec, 0, 59) },
                }
 
       property :hour, [Integer, String],
-               description: "The hour to schedule the cron job to run at. Valid values: 0-23.",
+               description: "The hour at which the cron entry should run (0 - 23).",
                default: "*", callbacks: {
                  "should be a valid hour spec" => ->(spec) { validate_numeric(spec, 0, 23) },
                }
 
       property :day, [Integer, String],
-               description: "The day to schedule the cron job to run at. Valid values: 1-31.",
+               description: "The day of month at which the cron entry should run (1 - 31).",
                default: "*", callbacks: {
                  "should be a valid day spec" => ->(spec) { validate_numeric(spec, 1, 31) },
                }
 
       property :month, [Integer, String],
-               description: "The month to schedule the cron job to run at. Valid values: 1-12, jan-dec, or *.",
+               description: "The month in the year on which a cron entry is to run (1 - 12, jan-dec, or *).",
                default: "*", callbacks: {
                  "should be a valid month spec" => ->(spec) { validate_month(spec) },
                }
 
       property :weekday, [Integer, String],
-               description: "The day to schedule the cron job to run at. Valid values: 0-7, mon-sun, or *.",
+               description: "The day of the week on which this entry is to run (0-7, mon-sun, or *), where Sunday is both 0 and 7.",
                default: "*", callbacks: {
                  "should be a valid weekday spec" => ->(spec) { validate_dow(spec) },
                }
@@ -132,7 +132,7 @@ class Chef
                required: true
 
       property :user, String,
-               description: "The user to run the cron job as.",
+               description: "The name of the user that runs the command.",
                default: "root"
 
       property :mailto, String,
@@ -151,7 +151,7 @@ class Chef
                description: "A comment to place in the cron.d file."
 
       property :environment, Hash,
-               description: "A Hash containing additional arbitrary environment variables under which the cron job will be run.",
+               description: "A Hash containing additional arbitrary environment variables under which the cron job will be run in the form of ``({'ENV_VARIABLE' => 'VALUE'})``.",
                default: lazy { Hash.new }
 
       property :mode, [String, Integer],

data/lib/chef/resource/directory.rb

@@ -44,7 +44,7 @@ class Chef
                description: "The path to the directory. Using a fully qualified path is recommended, but is not always required."
 
       property :recursive, [ TrueClass, FalseClass ],
-               description: "Create or delete parent directories recursively. For the owner, group, and mode properties, the value of this attribute applies only to the leaf directory.",
+               description: "Create or delete parent directories recursively. For the owner, group, and mode properties, the value of this property applies only to the leaf directory.",
                default: false
     end
   end

data/lib/chef/resource/dmg_package.rb

@@ -27,31 +27,31 @@ class Chef
       introduced "14.0"
 
       property :app, String,
-               description: "The name of the application used by default for the /Volumes directory and the .app directory copied to /Applications.",
+               description: "The name of the application as it appears in the /Volumes directory, if it differs from the resource block's name.",
                name_property: true
 
       property :source, String,
-               description: "The remote URL for the dmg to download if specified."
+               description: "The remote URL that is used to download the .dmg file, if specified."
 
       property :file, String,
-               description: "The local dmg full file path."
+               description: "The full path to the .dmg file on the local system."
 
       property :owner, String,
-               description: "The owner that should own the package installation."
+               description: "The user that should own the package installation."
 
       property :destination, String,
                description: "The directory to copy the .app into.",
                default: "/Applications"
 
       property :checksum, String,
-               description: "The sha256 checksum of the dmg to download."
+               description: "The sha256 checksum of the .dmg file to download."
 
       property :volumes_dir, String,
-               description: "The Directory under /Volumes where the dmg is mounted as not all dmgs are mounted into a /Volumes location matching the name of the dmg.",
+               description: "The directory under /Volumes where the dmg is mounted, if it differs from the name of the .dmg file.",
                default: lazy { |r| r.app }, default_description: "The value passed for the application name."
 
       property :dmg_name, String,
-               description: "The name of the dmg if it is not the same as app, or if the name has spaces.",
+               description: "The name of the .dmg file if it differs from that of the app, or if the name has spaces.",
                desired_state: false,
                default: lazy { |r| r.app }, default_description: "The value passed for the application name."
 
@@ -61,10 +61,10 @@ class Chef
                default: "app", desired_state: false
 
       property :package_id, String,
-               description: "The package id registered with pkgutil when a pkg or mpkg is installed."
+               description: "The package ID that is registered with pkgutil when a pkg or mpkg is installed."
 
       property :dmg_passphrase, String,
-               description: "Specify a passphrase to use to unencrypt the dmg while mounting.",
+               description: "Specify a passphrase to be used to decrypt the .dmg file during the mount process.",
                desired_state: false
 
       property :accept_eula, [TrueClass, FalseClass],