chef 15.4.45 → 15.5.9

data/lib/chef/provider/windows_path.rb

@@ -1,6 +1,6 @@
 #
 # Author:: Nimisha Sharad (<nimisha.sharad@msystechnologies.com>)
-# Copyright:: Copyright 2008-2017, Chef Software Inc.
+# Copyright:: Copyright 2008-2019, Chef Software Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -16,14 +16,14 @@
 # limitations under the License.
 #
 
-require_relative "../mixin/windows_env_helper" if Chef::Platform.windows?
+require_relative "../mixin/windows_env_helper" if ChefUtils.windows?
 require_relative "../mixin/wide_string"
 require_relative "../exceptions"
 
 class Chef
   class Provider
     class WindowsPath < Chef::Provider
-      include Chef::Mixin::WindowsEnvHelper if Chef::Platform.windows?
+      include Chef::Mixin::WindowsEnvHelper if ChefUtils.windows?
 
       provides :windows_path
 

data/lib/chef/provider/windows_task.rb

@@ -1,6 +1,6 @@
 #
 # Author:: Nimisha Sharad (<nimisha.sharad@msystechnologies.com>)
-# Copyright:: Copyright 2008-2018, Chef Software Inc.
+# Copyright:: Copyright 2008-2019, Chef Software Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -18,11 +18,11 @@
 
 require_relative "../mixin/shell_out"
 require "rexml/document" unless defined?(REXML::Document)
-require "iso8601" if Chef::Platform.windows?
+require "iso8601" if ChefUtils.windows?
 require_relative "../mixin/powershell_out"
 require_relative "../provider"
 require_relative "../util/path_helper"
-require "win32/taskscheduler" if Chef::Platform.windows?
+require "win32/taskscheduler" if ChefUtils.windows?
 
 class Chef
   class Provider
@@ -30,7 +30,7 @@ class Chef
       include Chef::Mixin::ShellOut
       include Chef::Mixin::PowershellOut
 
-      if Chef::Platform.windows?
+      if ChefUtils.windows?
         include Win32
 
         provides :windows_task

data/lib/chef/resource.rb

@@ -59,6 +59,7 @@ class Chef
     extend Chef::Mixin::Provides
 
     include Chef::DSL::Universal
+    extend Chef::DSL::Universal
 
     # Bring in `property` and `property_type`
     include Chef::Mixin::Properties

data/lib/chef/resource/bash.rb

@@ -22,6 +22,8 @@ require_relative "../provider/script"
 class Chef
   class Resource
     class Bash < Chef::Resource::Script
+      unified_mode true
+
       description "Use the bash resource to execute scripts using the Bash interpreter. This resource may also use any of the actions and properties that are available to the execute resource. Commands that are executed with this resource are (by their nature) not idempotent, as they are typically unique to the environment in which they are run. Use not_if and only_if to guard this resource for idempotence."
 
       def initialize(name, run_context = nil)

data/lib/chef/resource/batch.rb

@@ -21,6 +21,8 @@ require_relative "windows_script"
 class Chef
   class Resource
     class Batch < Chef::Resource::WindowsScript
+      unified_mode true
+
       provides :batch
 
       description "Use the batch resource to execute a batch script using the cmd.exe interpreter on Windows. The batch resource creates and executes a temporary file (similar to how the script resource behaves), rather than running the command inline. Commands that are executed with this resource are (by their nature) not idempotent, as they are typically unique to the environment in which they are run. Use not_if and only_if to guard this resource for idempotence."

data/lib/chef/resource/breakpoint.rb

@@ -22,10 +22,12 @@ require_relative "../dist"
 class Chef
   class Resource
     class Breakpoint < Chef::Resource
+      unified_mode true
+
       provides :breakpoint, target_mode: true
       resource_name :breakpoint
 
-      description "Use the breakpoint resource to add breakpoints to recipes. Run the #{Chef::Dist::SHELL} in #{Chef::Dist::CLIENT} mode, and then use those breakpoints to debug recipes. Breakpoints are ignored by the #{Chef::Dist::CLIENT} during an actual #{Chef::Dist::CLIENT} run. That said, breakpoints are typically used to debug recipes only when running them in a non-production environment, after which they are removed from those recipes before the parent cookbook is uploaded to the Chef server."
+      description "Use the breakpoint resource to add breakpoints to recipes. Run the #{Chef::Dist::SHELL} in #{Chef::Dist::PRODUCT} mode, and then use those breakpoints to debug recipes. Breakpoints are ignored by the #{Chef::Dist::CLIENT} during an actual #{Chef::Dist::CLIENT} run. That said, breakpoints are typically used to debug recipes only when running them in a non-production environment, after which they are removed from those recipes before the parent cookbook is uploaded to the Chef server."
       introduced "12.0"
 
       default_action :break

data/lib/chef/resource/build_essential.rb

@@ -1,5 +1,5 @@
 #
-# Copyright:: 2008-2019, Chef Software, Inc.
+# Copyright:: 2008-2019, Chef Software Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -22,7 +22,7 @@ class Chef
       resource_name :build_essential
       provides(:build_essential) { true }
 
-      description "Use the build_essential resource to install packages required for compiling C software from source."
+      description "Use the build_essential resource to install the packages required for compiling C software from source."
       introduced "14.0"
       examples <<~DOC
         Install compilation packages
@@ -52,7 +52,7 @@ class Chef
         case node["platform_family"]
         when "debian"
           package %w{ autoconf binutils-doc bison build-essential flex gettext ncurses-dev }
-        when "amazon", "fedora", "rhel"
+        when fedora_derived?
           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

data/lib/chef/resource/chef_sleep.rb

@@ -0,0 +1,70 @@
+#
+# Copyright:: 2019, Chef Software Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require_relative "../resource"
+require_relative "../dist"
+
+class Chef
+  class Resource
+    class ChefSleep < Chef::Resource
+      resource_name :chef_sleep
+      provides :chef_sleep
+
+      unified_mode true
+
+      description "Use the chef_sleep resource to set the number of seconds to sleep during a #{Chef::Dist::PRODUCT} run. Only use this resource when a command or service exits successfully but is not ready for the next step of the recipe."
+      introduced "15.5"
+      examples <<~DOC
+        Sleep for 10 seconds
+        ```ruby
+        chef_sleep '10'
+        ```
+
+        Sleep for 10 seconds with a descriptive resource name for logging
+        ```ruby
+        chef_sleep 'wait for the service to start' do
+          seconds 10
+        end
+        ````
+
+        Use a notification from another resource to sleep only when necessary
+        ```ruby
+        service 'Service that is slow to start and reports as started' do
+          service_name 'my_database'
+          action :start
+          notifies :sleep, chef_sleep['wait for service start']
+        end
+
+        chef_sleep 'wait for service start' do
+          seconds 30
+          action :nothing
+        end
+        ```
+      DOC
+
+      property :seconds, [String, Integer],
+        description: "The number of seconds to sleep.",
+        coerce: proc { |s| Integer(s) },
+        name_property: true
+
+      action :sleep do
+        converge_by("sleep #{new_resource.seconds} seconds") do
+          sleep(new_resource.seconds)
+        end
+      end
+    end
+  end
+end

data/lib/chef/resource/cookbook_file.rb

@@ -27,10 +27,11 @@ class Chef
   class Resource
     class CookbookFile < Chef::Resource::File
       include Chef::Mixin::Securable
+      unified_mode true
 
       resource_name :cookbook_file
 
-      description "Use the cookbook_file resource to transfer files from a sub-directory of COOKBOOK_NAME/files/ to a specified path located on a host that is running the #{Chef::Dist::CLIENT}. The file is selected according to file specificity, which allows different source files to be used based on the hostname, host platform (operating system, distro, or as appropriate), or platform version. Files that are located in the COOKBOOK_NAME/files/default sub-directory may be used on any platform.\n\nDuring a #{Chef::Dist::CLIENT} run, the checksum for each local file is calculated and then compared against the checksum for the same file as it currently exists in the cookbook on the #{Chef::Dist::SERVER_PRODUCT}. A file is not transferred when the checksums match. Only files that require an update are transferred from the #{Chef::Dist::SERVER_PRODUCT} to a node."
+      description "Use the cookbook_file resource to transfer files from a sub-directory of COOKBOOK_NAME/files/ to a specified path located on a host that is running the #{Chef::Dist::PRODUCT}. The file is selected according to file specificity, which allows different source files to be used based on the hostname, host platform (operating system, distro, or as appropriate), or platform version. Files that are located in the COOKBOOK_NAME/files/default sub-directory may be used on any platform.\n\nDuring a #{Chef::Dist::PRODUCT} run, the checksum for each local file is calculated and then compared against the checksum for the same file as it currently exists in the cookbook on the #{Chef::Dist::SERVER_PRODUCT}. A file is not transferred when the checksums match. Only files that require an update are transferred from the #{Chef::Dist::SERVER_PRODUCT} to a node."
 
       property :source, [ String, Array ],
         description: "The name of the file in COOKBOOK_NAME/files/default or the path to a file located in COOKBOOK_NAME/files. The path must include the file name and its extension. This can be used to distribute specific files depending upon the platform used.",

data/lib/chef/resource/csh.rb

@@ -22,6 +22,8 @@ require_relative "../provider/script"
 class Chef
   class Resource
     class Csh < Chef::Resource::Script
+      unified_mode true
+
       description "Use the csh resource to execute scripts using the csh interpreter."\
                   " This resource may also use any of the actions and properties that are"\
                   " available to the execute resource. Commands that are executed with this"\

data/lib/chef/resource/directory.rb

@@ -24,6 +24,8 @@ require_relative "../mixin/securable"
 class Chef
   class Resource
     class Directory < Chef::Resource
+      unified_mode true
+
       resource_name :directory
 
       description "Use the directory resource to manage a directory, which is a hierarchy"\

data/lib/chef/resource/dmg_package.rb

@@ -23,7 +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 package from a .dmg file. 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"
       examples <<~DOC
         Install Google Chrome via the DMG package

data/lib/chef/resource/dnf_package.rb

@@ -41,7 +41,7 @@ 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 and RHEL 8+. 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

data/lib/chef/resource/execute.rb

@@ -23,6 +23,8 @@ require_relative "../dist"
 class Chef
   class Resource
     class Execute < Chef::Resource
+      unified_mode true
+
       resource_name :execute
       provides :execute, target_mode: true
 

data/lib/chef/resource/file.rb

@@ -28,10 +28,11 @@ class Chef
   class Resource
     class File < Chef::Resource
       include Chef::Mixin::Securable
+      unified_mode true
 
       description "Use the file resource to manage files directly on a node."
 
-      if Platform.windows?
+      if ChefUtils.windows?
         # Use Windows rights instead of standard *nix permissions
         state_attrs :checksum, :rights, :deny_rights
       else

data/lib/chef/resource/git.rb

@@ -21,6 +21,8 @@ require_relative "scm"
 class Chef
   class Resource
     class Git < Chef::Resource::Scm
+      unified_mode true
+
       description "Use the git resource to manage source control resources that exist in a git repository. git version 1.6.5 (or higher) is required to use all of the functionality in the git resource."
 
       property :additional_remotes, Hash,

data/lib/chef/resource/group.rb

@@ -1,7 +1,7 @@
 #
 # Author:: Adam Jacob (<adam@chef.io>)
 # Author:: Tyler Cloke (<tyler@chef.io>)
-# Copyright:: Copyright 2008-2018, Chef Software Inc.
+# Copyright:: Copyright 2008-2019, Chef Software Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

data/lib/chef/resource/homebrew_package.rb

@@ -32,7 +32,7 @@ class Chef
       introduced "12.0"
 
       property :homebrew_user, [ String, Integer ],
-        description: "The name of the Homebrew owner to be used by the #{Chef::Dist::CLIENT} when executing a command."
+        description: "The name of the Homebrew owner to be used by #{Chef::Dist::PRODUCT} when executing a command."
 
     end
   end

data/lib/chef/resource/http_request.rb

@@ -22,6 +22,8 @@ require_relative "../resource"
 class Chef
   class Resource
     class HttpRequest < Chef::Resource
+      unified_mode true
+
       resource_name :http_request
       provides :http_request
 

data/lib/chef/resource/ifconfig.rb

@@ -26,6 +26,8 @@ class Chef
     #     device 'eth1'
     #   end
     class Ifconfig < Chef::Resource
+      unified_mode true
+
       resource_name :ifconfig
 
       description "Use the ifconfig resource to manage interfaces on Unix and Linux systems."
@@ -47,7 +49,7 @@ class Chef
 
       property :family, String, default: "inet",
                introduced: "14.0",
-               description: "Networking family option for Debian-based systems. For example: inet or inet6."
+               description: "Networking family option for Debian-based systems; for example: inet or inet6."
 
       property :inet_addr, String,
         description: "The Internet host address for the network interface."

data/lib/chef/resource/ksh.rb

@@ -21,6 +21,8 @@ require_relative "script"
 class Chef
   class Resource
     class Ksh < Chef::Resource::Script
+      unified_mode true
+
       description "Use the ksh resource to execute scripts using the Korn shell (ksh)"\
                   " interpreter. This resource may also use any of the actions and properties"\
                   " that are available to the execute resource. Commands that are executed"\

data/lib/chef/resource/link.rb

@@ -1,7 +1,7 @@
 #
 # Author:: Adam Jacob (<adam@chef.io>)
 # Author:: Tyler Cloke (<tyler@chef.io>)
-# Copyright:: Copyright 2008-2018, Chef Software Inc.
+# Copyright:: Copyright 2008-2019, Chef Software Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -24,6 +24,8 @@ class Chef
   class Resource
     class Link < Chef::Resource
       include Chef::Mixin::Securable
+      unified_mode true
+
       resource_name :link
       provides :link
 
@@ -77,7 +79,7 @@ class Chef
       # On certain versions of windows links are not supported. Make
       # sure we are not on such a platform.
       def verify_links_supported!
-        if Chef::Platform.windows?
+        if ChefUtils.windows?
           require_relative "../win32/file"
           begin
             Chef::ReservedNames::Win32::File.verify_links_supported!

data/lib/chef/resource/locale.rb

@@ -11,7 +11,7 @@
 # Unless required by applicable law or agreed to in writing, software
 # distributed under the License is distributed on an "AS IS" BASIS,
 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific slanguage governing permissions and
+# See the License for the specific language governing permissions and
 # limitations under the License.
 #
 

data/lib/chef/resource/log.rb

@@ -29,6 +29,8 @@ class Chef
     #     level :debug
     #   end
     class Log < Chef::Resource
+      unified_mode true
+
       resource_name :log
       provides :log, target_mode: true
 

data/lib/chef/resource/ohai.rb

@@ -23,6 +23,8 @@ require_relative "../dist"
 class Chef
   class Resource
     class Ohai < Chef::Resource
+      unified_mode true
+
       resource_name :ohai
       provides :ohai
 

data/lib/chef/resource/perl.rb

@@ -22,6 +22,8 @@ require_relative "../provider/script"
 class Chef
   class Resource
     class Perl < Chef::Resource::Script
+      unified_mode true
+
       def initialize(name, run_context = nil)
         super
         @interpreter = "perl"

data/lib/chef/resource/python.rb

@@ -21,6 +21,8 @@ require_relative "../provider/script"
 class Chef
   class Resource
     class Python < Chef::Resource::Script
+      unified_mode true
+
       def initialize(name, run_context = nil)
         super
         @interpreter = "python"

data/lib/chef/resource/reboot.rb

@@ -22,6 +22,8 @@ require_relative "../dist"
 class Chef
   class Resource
     class Reboot < Chef::Resource
+      unified_mode true
+
       resource_name :reboot
 
       description "Use the reboot resource to reboot a node, a necessary step with some"\

data/lib/chef/resource/registry_key.rb

@@ -22,6 +22,8 @@ require_relative "../digester"
 class Chef
   class Resource
     class RegistryKey < Chef::Resource
+      unified_mode true
+
       resource_name :registry_key
       provides(:registry_key) { true }
 

data/lib/chef/resource/remote_directory.rb

@@ -1,7 +1,7 @@
 #
 # Author:: Adam Jacob (<adam@chef.io>)
 # Author:: Tyler Cloke (<tyler@chef.io>)
-# Copyright:: Copyright 2008-2018, Chef Software Inc.
+# Copyright:: Copyright 2008-2019, Chef Software Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -25,6 +25,7 @@ class Chef
   class Resource
     class RemoteDirectory < Chef::Resource::Directory
       include Chef::Mixin::Securable
+      unified_mode true
 
       description "Use the remote_directory resource to incrementally transfer a directory from a cookbook to a node. The director that is copied from the cookbook should be located under COOKBOOK_NAME/files/default/REMOTE_DIRECTORY. The remote_directory resource will obey file specificity."
 
@@ -36,7 +37,7 @@ class Chef
         @delete = false
       end
 
-      if Chef::Platform.windows?
+      if ChefUtils.windows?
         # create a second instance of the 'rights' attribute (property)
         rights_attribute(:files_rights)
       end