chef 14.4.56 → 14.5.27

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 920d213233499ebaf1139781822c11ee3cfecb6a1009cc32bf48f4e2982c6558
-  data.tar.gz: 1e4ef57ed7418c1eb0f4962432ecdb6367f7bbacdad02aeba12bb1c107328c4a
+  metadata.gz: 8b63f0b14b7cff605ffc2cc9ff2a84a53452638e2e246dccce90a71bd09d3624
+  data.tar.gz: 0c5e0154e8f3120ea4dcba4072decb4c45c1c850c88084c525d4f4cf809ce762
 SHA512:
-  metadata.gz: cbf9dab5941de391fb2b9ecb614473e46998ac3c029daca776fe52e1fa68244087437393a9bc0237052f34b625af4e3f16a687660f2efca7c241c47c1b279b9d
-  data.tar.gz: 42d09d8dbea598cac992be0afcc5ed6381c0aaff22f78b181a76255890cdbfe763c8c1afeb076f3fc16c3ebb47cae5fddfc2991486ffc770698e3341f0d454c4
+  metadata.gz: fbe8e68a50a797bac5cedb67ea5df61fb372019e6c0e111252e3d47ea36b456c85124fa866246f3017062bb1250d7f4178b11121036fe587a329ad30fdffb2fd
+  data.tar.gz: ff0ed7f917660b9a156b3e112138e825e89a3d57badead4e48c70e69273cc83d349bc2320db6b4e0ec359f1132639e0961812b23fdbf75168e02675d8ab2930d

data/Rakefile

@@ -19,7 +19,6 @@
 
 require_relative "tasks/rspec"
 require_relative "tasks/maintainers"
-require_relative "tasks/cbgb"
 require_relative "tasks/dependencies"
 require_relative "tasks/announce"
 

data/VERSION

@@ -1 +1 @@
-14.4.56
+14.5.27

data/lib/chef/client.rb

@@ -157,7 +157,7 @@ class Chef
       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)

data/lib/chef/cookbook_version.rb

@@ -296,9 +296,9 @@ class Chef
         # we're just going to make cookbook_files out of these and make the
         # cookbook find them by filespecificity again. but it's the shortest
         # path to "success" for now.
-        if manifest_record_path =~ /(#{Regexp.escape(segment.to_s)}\/[^\/]+\/#{Regexp.escape(dirname)})\/.+$/
+        if manifest_record_path =~ /(#{Regexp.escape(segment.to_s)}\/[^\/]*\/?#{Regexp.escape(dirname)})\/.+$/
           specificity_dirname = $1
-          non_specific_path = manifest_record_path[/#{Regexp.escape(segment.to_s)}\/[^\/]+\/#{Regexp.escape(dirname)}\/(.+)$/, 1]
+          non_specific_path = manifest_record_path[/#{Regexp.escape(segment.to_s)}\/[^\/]*\/?#{Regexp.escape(dirname)}\/(.+)$/, 1]
           # Record the specificity_dirname only if it's in the list of
           # valid preferences
           if filenames_by_pref[specificity_dirname]

data/lib/chef/mixin/powershell_out.rb

@@ -86,7 +86,7 @@ class Chef
           # always set the ExecutionPolicy flag
           # see http://technet.microsoft.com/en-us/library/ee176961.aspx
           "-ExecutionPolicy Unrestricted",
-          # Powershell will hang if STDIN is redirected
+          # PowerShell will hang if STDIN is redirected
           # http://connect.microsoft.com/PowerShell/feedback/details/572313/powershell-exe-can-hang-if-stdin-is-redirected
           "-InputFormat None",
         ]

data/lib/chef/node_map.rb

@@ -38,19 +38,13 @@
 class Chef
   class NodeMap
     COLLISION_WARNING_14 = <<~EOH.gsub(/\s+/, " ").strip
-      %{type_caps} %{key} has been loaded from a cookbook. The %{type} %{key} is now
-      included in Chef and will take precedence over the existing cookbook %{type} in the
-      next major release of Chef (15.0, April 2019). You may be able to remove this cookbook dependency from
-      your runlist if you do not use other recipes/resources/libraries from the cookbook.
-      Alternatively there may be a newer version of this cookbook without the %{key} %{type}.
+      %{type_caps} %{key} from a cookbook is overriding the %{type} from the client.  Please upgrade your cookbook
+        or remove the cookbook from your run_list before the next major release of Chef.
 EOH
 
     COLLISION_WARNING_15 = <<~EOH.gsub(/\s+/, " ").strip
-      %{type_caps} %{key} attempted to load from a cookbook. The %{type} %{key} is now
-      included in Chef and takes precedence over the existing cookbook %{type}
-      which will be ignored. You may be able to remove this cookbook dependency from
-      your runlist if you do not use other recipes/resources/libraries from the cookbook.
-      Alternatively there may be a newer version of this cookbook without the %{key} %{type}.
+      %{type_caps} %{key} from the client is overriding the %{type} from a cookbook.  Please upgrade your cookbook
+        or remove the cookbook from your run_list.
 EOH
 
     #

data/lib/chef/provider/dsc_resource.rb

@@ -48,10 +48,10 @@ class Chef
       def define_resource_requirements
         requirements.assert(:run) do |a|
           a.assertion { supports_dsc_invoke_resource? }
-          err = ["You must have Powershell version >= 5.0.10018.0 to use dsc_resource."]
+          err = ["You must have PowerShell version >= 5.0.10018.0 to use dsc_resource."]
           a.failure_message Chef::Exceptions::ProviderNotFound,
             err
-          a.whyrun err + ["Assuming a previous resource installs Powershell 5.0.10018.0 or higher."]
+          a.whyrun err + ["Assuming a previous resource installs PowerShell 5.0.10018.0 or higher."]
           a.block_action!
         end
         requirements.assert(:run) do |a|

data/lib/chef/provider/dsc_script.rb

@@ -63,11 +63,11 @@ class Chef
           err = [
             "Could not find PowerShell DSC support on the system",
             powershell_info_str,
-            "Powershell 4.0 or higher was not detected on your system and is required to use the dsc_script resource.",
+            "PowerShell 4.0 or higher was not detected on your system and is required to use the dsc_script resource.",
           ]
           a.assertion { supports_dsc? }
           a.failure_message Chef::Exceptions::ProviderNotFound, err.join(" ")
-          a.whyrun err + ["Assuming a previous resource installs Powershell 4.0 or higher."]
+          a.whyrun err + ["Assuming a previous resource installs PowerShell 4.0 or higher."]
           a.block_action!
         end
       end
@@ -175,9 +175,9 @@ class Chef
 
       def powershell_info_str
         if run_context && run_context.node[:languages] && run_context.node[:languages][:powershell]
-          install_info = "Powershell #{run_context.node[:languages][:powershell][:version]} was found on the system."
+          install_info = "PowerShell #{run_context.node[:languages][:powershell][:version]} was found on the system."
         else
-          install_info = "Powershell was not found."
+          install_info = "PowerShell was not found."
         end
       end
     end

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

@@ -37,7 +37,7 @@ class Chef
         def define_resource_requirements
           super
           if powershell_out("$PSVersionTable.PSVersion.Major").stdout.strip.to_i < 5
-            raise "Minimum installed Powershell Version required is 5"
+            raise "Minimum installed PowerShell Version required is 5"
           end
           requirements.assert(:install) do |a|
             a.assertion { candidates_exist_for_all_uninstalled? }

data/lib/chef/provider/powershell_script.rb

@@ -129,7 +129,7 @@ EOH
           "-NonInteractive",
           "-NoProfile",
           "-ExecutionPolicy #{execution_policy}",
-          # Powershell will hang if STDIN is redirected
+          # PowerShell will hang if STDIN is redirected
           # http://connect.microsoft.com/PowerShell/feedback/details/572313/powershell-exe-can-hang-if-stdin-is-redirected
           "-InputFormat None",
         ]
@@ -137,10 +137,10 @@ EOH
 
       # A wrapper script is used to launch user-supplied script while
       # still obtaining useful process exit codes. Unless you
-      # explicitly call exit in Powershell, the powershell.exe
+      # explicitly call exit in PowerShell, the powershell.exe
       # interpreter returns only 0 for success or 1 for failure. Since
       # we'd like to get specific exit codes from executable tools run
-      # with Powershell, we do some work using the automatic variables
+      # with PowerShell, we do some work using the automatic variables
       # $? and $LASTEXITCODE to return the process exit code of the
       # last process run in the script if it is the last command
       # executed, otherwise 0 or 1 based on whether $? is set to true

data/lib/chef/provider/script.rb

@@ -49,9 +49,9 @@ class Chef
 
       def load_current_resource
         super
-        # @todo Chef-13: change this to an exception
+        # @todo Chef-15: change this to an exception
         if code.nil?
-          logger.warn "#{new_resource}: No code attribute was given, resource does nothing, this behavior is deprecated and will be removed in Chef-13"
+          logger.warn "#{new_resource}: No code attribute was given, resource does nothing, this behavior is deprecated and will be removed in Chef 15 (April 2019)"
         end
       end
 

data/lib/chef/resource/apt_package.rb

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

data/lib/chef/resource/apt_repository.rb

@@ -36,7 +36,7 @@ class Chef
                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.",
                validation_message: "repo_name property cannot contain a forward slash '/'",
-               name_property: true
+               introduced: "14.1", name_property: true
 
       property :uri, String,
                description: "The base of the Debian distribution."

data/lib/chef/resource/build_essential.rb

@@ -29,7 +29,7 @@ class Chef
       property :name, String, default: ""
 
       property :compile_time, [TrueClass, FalseClass],
-               description: "Install build essential packages at compile time.",
+               description: "Install the build essential packages at compile time.",
                default: false
 
       action :install do
@@ -38,22 +38,22 @@ class Chef
 
         case node["platform_family"]
         when "debian"
-          declare_resource(:package,  %w{ autoconf binutils-doc bison build-essential flex gettext ncurses-dev })
+          package %w{ autoconf binutils-doc bison build-essential flex gettext ncurses-dev }
         when "amazon", "fedora", "rhel"
-          declare_resource(:package,  %w{ autoconf bison flex gcc gcc-c++ gettext kernel-devel make m4 ncurses-devel patch })
+          package %w{ autoconf bison flex gcc gcc-c++ gettext kernel-devel make m4 ncurses-devel patch }
 
           # Ensure GCC 4 is available on older pre-6 EL
-          declare_resource(:package,  %w{ gcc44 gcc44-c++ }) if platform_family?("rhel") && node["platform_version"].to_i < 6
+          package %w{ gcc44 gcc44-c++ } if platform_family?("rhel") && node["platform_version"].to_i < 6
         when "freebsd"
-          declare_resource(:package,  "devel/gmake")
-          declare_resource(:package,  "devel/autoconf")
-          declare_resource(:package,  "devel/m4")
-          declare_resource(:package,  "devel/gettext")
+          package "devel/gmake"
+          package "devel/autoconf"
+          package "devel/m4"
+          package "devel/gettext"
         when "mac_os_x"
           unless xcode_cli_installed?
             # This script was graciously borrowed and modified from Tim Sutton's
             # osx-vm-templates at https://github.com/timsutton/osx-vm-templates/blob/b001475df54a9808d3d56d06e71b8fa3001fff42/scripts/xcode-cli-tools.sh
-            declare_resource(:execute, "install XCode Command Line tools") do
+            execute "install XCode Command Line tools" do
               command <<-EOH.gsub(/^ {14}/, "")
                 # create the placeholder file that's checked by CLI updates' .dist code
                 # in Apple's SUS catalog
@@ -68,46 +68,46 @@ class Chef
             end
           end
         when "omnios"
-          declare_resource(:package,  "developer/gcc48")
-          declare_resource(:package,  "developer/object-file")
-          declare_resource(:package,  "developer/linker")
-          declare_resource(:package,  "developer/library/lint")
-          declare_resource(:package,  "developer/build/gnu-make")
-          declare_resource(:package,  "system/header")
-          declare_resource(:package,  "system/library/math/header-math")
+          package "developer/gcc48"
+          package "developer/object-file"
+          package "developer/linker"
+          package "developer/library/lint"
+          package "developer/build/gnu-make"
+          package "system/header"
+          package "system/library/math/header-math"
 
           # Per OmniOS documentation, the gcc bin dir isn't in the default
           # $PATH, so add it to the running process environment
           # http://omnios.omniti.com/wiki.php/DevEnv
           ENV["PATH"] = "#{ENV['PATH']}:/opt/gcc-4.7.2/bin"
         when "solaris2"
-          declare_resource(:package,  "autoconf")
-          declare_resource(:package,  "automake")
-          declare_resource(:package,  "bison")
-          declare_resource(:package,  "gnu-coreutils")
-          declare_resource(:package,  "flex")
-          declare_resource(:package,  "gcc") do
+          package "autoconf"
+          package "automake"
+          package "bison"
+          package "gnu-coreutils"
+          package "flex"
+          package "gcc" do
             # lock because we don't use 5 yet
             version "4.8.2"
           end
-          declare_resource(:package,  "gcc-3")
-          declare_resource(:package,  "gnu-grep")
-          declare_resource(:package,  "gnu-make")
-          declare_resource(:package,  "gnu-patch")
-          declare_resource(:package,  "gnu-tar")
-          declare_resource(:package,  "make")
-          declare_resource(:package,  "pkg-config")
-          declare_resource(:package,  "ucb")
+          package "gcc-3"
+          package "gnu-grep"
+          package "gnu-make"
+          package "gnu-patch"
+          package "gnu-tar"
+          package "make"
+          package "pkg-config"
+          package "ucb"
         when "smartos"
-          declare_resource(:package,  "autoconf")
-          declare_resource(:package,  "binutils")
-          declare_resource(:package,  "build-essential")
-          declare_resource(:package,  "gcc47")
-          declare_resource(:package,  "gmake")
-          declare_resource(:package,  "pkg-config")
+          package "autoconf"
+          package "binutils"
+          package "build-essential"
+          package "gcc47"
+          package "gmake"
+          package "pkg-config"
         when "suse"
-          declare_resource(:package,  %w{ autoconf bison flex gcc gcc-c++ kernel-default-devel make m4 })
-          declare_resource(:package,  %w{ gcc48 gcc48-c++ }) if node["platform_version"].to_i < 12
+          package %w{ autoconf bison flex gcc gcc-c++ kernel-default-devel make m4 }
+          package %w{ gcc48 gcc48-c++ } if node["platform_version"].to_i < 12
         else
           Chef::Log.warn <<-EOH
         The build_essential resource does not currently support the '#{node['platform_family']}'

data/lib/chef/resource/chef_gem.rb

@@ -37,10 +37,13 @@ class Chef
       resource_name :chef_gem
 
       property :gem_binary, default: "#{RbConfig::CONFIG['bindir']}/gem",
+                            description: "The path of a gem binary to use for the installation. By default, the same version of Ruby that is used by the chef-client will be installed.",
                             callbacks: {
                  "The chef_gem resource is restricted to the current gem environment, use gem_package to install to other environments." => proc { |v| v == "#{RbConfig::CONFIG['bindir']}/gem" },
                }
-      property :compile_time, [TrueClass, FalseClass], default: false, desired_state: false
+      property :compile_time, [TrueClass, FalseClass],
+               description: "Controls the phase during which a gem is installed on a node. Set to 'true' to install a gem while the resource collection is being built (the 'compile phase'). Set to 'false' to install a gem while the chef-client is configuring the node (the 'converge phase').",
+               default: false, desired_state: false
 
       # force the resource to compile time if the compile time property has been set
       def after_created

data/lib/chef/resource/chocolatey_package.rb

@@ -43,7 +43,8 @@ class Chef
 
       property :returns, [Integer, Array],
                 description: "The exit code(s) returned a chocolatey package that indicate success.",
-                default: [ 0 ], desired_state: false
+                default: [ 0 ], desired_state: false,
+                introduced: "12.18"
     end
   end
 end

data/lib/chef/resource/directory.rb

@@ -40,8 +40,12 @@ class Chef
       default_action :create
       allowed_actions :create, :delete
 
-      property :path, String, name_property: true, identity: true
-      property :recursive, [ TrueClass, FalseClass ], default: false
+      property :path, String, name_property: true, identity: true,
+               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.",
+               default: false
     end
   end
 end

data/lib/chef/resource/dmg_package.rb

@@ -23,10 +23,7 @@ class Chef
       resource_name :dmg_package
       provides(:dmg_package) { true }
 
-      description "Use the dmg_package resource to install a dmg 'package'. The resource will retrieve the"\
-                  " dmg file from a remote URL, mount it using OS X's hdidutil, copy the application (.app directory)"\
-                  " to the specified destination (/Applications), and detach the image using hdiutil. The dmg file"\
-                  " will be stored in the Chef::Config[:file_cache_path]."
+      description "Use the dmg_package resource to install a dmg 'package'. The resource will retrieve the dmg file from a remote URL, mount it using OS X's hdidutil, copy the application (.app directory) to the specified destination (/Applications), and detach the image using hdiutil. The dmg file will be stored in the Chef::Config[:file_cache_path]."
       introduced "14.0"
 
       property :app, String,

data/lib/chef/resource/dnf_package.rb

@@ -40,36 +40,33 @@ class Chef
 
       provides :dnf_package
 
-      description "Use the dnf_package resource to install, upgrade, and remove packages"\
-                  " with DNF for Fedora platforms. The dnf_package resource is able to"\
-                  " resolve provides data for packages much like DNF can do when it is"\
-                  " run from the command line. This allows a variety of options for"\
-                  " installing packages, like minimum versions, virtual provides,"\
-                  " and library names."
+      description "Use the dnf_package resource to install, upgrade, and remove packages with DNF for Fedora platforms. The dnf_package resource is able to resolve provides data for packages much like DNF can do when it is run from the command line. This allows a variety of options for installing packages, like minimum versions, virtual provides and library names."
       introduced "12.18"
 
       allowed_actions :install, :upgrade, :remove, :purge, :reconfig, :lock, :unlock, :flush_cache
 
       # Install a specific arch
-      property :arch, [String, Array], coerce: proc { |x| [x].flatten }
+      property :arch, [String, Array],
+               description: "The architecture of the package to be installed or upgraded. This value can also be passed as part of the package name.",
+               coerce: proc { |x| [x].flatten }
 
       # Flush the in-memory available/installed cache, this does not flush the dnf caches on disk
-      property :flush_cache,
-        Hash,
-        default: { before: false, after: false },
-        coerce: proc { |v|
-          if v.is_a?(Hash)
-            v
-          elsif v.is_a?(Array)
-            v.each_with_object({}) { |arg, obj| obj[arg] = true }
-          elsif v.is_a?(TrueClass) || v.is_a?(FalseClass)
-            { before: v, after: v }
-          elsif v == :before
-            { before: true, after: false }
-          elsif v == :after
-            { after: true, before: false }
-          end
-        }
+      property :flush_cache, Hash,
+               description: "Flush the in-memory cache before or after a DNF operation that installs, upgrades, or removes a package. DNF automatically synchronizes remote metadata to a local cache. The chef-client creates a copy of the local cache, and then stores it in-memory during the chef-client run. The in-memory cache allows packages to be installed during the chef-client run without the need to continue synchronizing the remote metadata to the local cache while the chef-client run is in-progress.",
+               default: { before: false, after: false },
+               coerce: proc { |v|
+                         if v.is_a?(Hash)
+                           v
+                         elsif v.is_a?(Array)
+                           v.each_with_object({}) { |arg, obj| obj[arg] = true }
+                         elsif v.is_a?(TrueClass) || v.is_a?(FalseClass)
+                           { before: v, after: v }
+                         elsif v == :before
+                           { before: true, after: false }
+                         elsif v == :after
+                           { after: true, before: false }
+                         end
+                       }
 
       def allow_downgrade(arg = nil)
         if !arg.nil?

data/lib/chef/resource/dpkg_package.rb

@@ -24,9 +24,7 @@ class Chef
       resource_name :dpkg_package
       provides :dpkg_package
 
-      description "Use the dpkg_package resource to manage packages for the dpkg platform."\
-                  " When a package is installed from a local file, it must be added to the"\
-                  " node using the remote_file or cookbook_file resources."
+      description "Use the dpkg_package resource to manage packages for the dpkg platform. When a package is installed from a local file, it must be added to the node using the remote_file or cookbook_file resources."
 
       property :source, [ String, Array, nil ],
                description: "The path to a package in the local file system."

data/lib/chef/resource/dsc_resource.rb

@@ -23,10 +23,7 @@ class Chef
       resource_name :dsc_resource
       provides :dsc_resource
 
-      description "The dsc_resource resource allows any DSC resource to be used in a"\
-                  " Chef recipe, as well as any custom resources that have been added"\
-                  " to your Windows PowerShell environment. Microsoft frequently adds"\
-                  " new resources to the DSC resource collection."
+      description "The dsc_resource resource allows any DSC resource to be used in a Chef recipe, as well as any custom resources that have been added to your Windows PowerShell environment. Microsoft frequently adds new resources to the DSC resource collection."
       introduced "12.2"
 
       # This class will check if the object responds to
@@ -76,7 +73,7 @@ class Chef
 
       property :module_version, String,
                introduced: "12.21",
-               description: "The version number of the module to use. Powershell 5.0.10018.0 (or higher) supports having multiple versions of a module installed. This should be specified along with the module_name."
+               description: "The version number of the module to use. PowerShell 5.0.10018.0 (or higher) supports having multiple versions of a module installed. This should be specified along with the module_name."
 
       def property(property_name, value = nil)
         if not property_name.is_a?(Symbol)