chef 16.0.257 → 16.2.44

data/lib/chef/resource/file.rb

@@ -32,7 +32,7 @@ class Chef
 
       provides :file
 
-      description "Use the file resource to manage files directly on a node."
+      description "Use the **file** resource to manage files directly on a node."
 
       if ChefUtils.windows?
         # Use Windows rights instead of standard *nix permissions
@@ -56,27 +56,30 @@ class Chef
       allowed_actions :create, :delete, :touch, :create_if_missing
 
       property :path, String, name_property: true,
-               description: "The full path to the file, including the file name and its extension. For example: /files/file.txt. Default value: the name of the resource block. Microsoft Windows: A path that begins with a forward slash (/) will point to the root of the current working directory of the #{Chef::Dist::CLIENT} process. This path can vary from system to system. Therefore, using a path that begins with a forward slash (/) is not recommended."
+        description: "The full path to the file, including the file name and its extension. For example: /files/file.txt. Default value: the name of the resource block. Microsoft Windows: A path that begins with a forward slash (/) will point to the root of the current working directory of the #{Chef::Dist::CLIENT} process. This path can vary from system to system. Therefore, using a path that begins with a forward slash (/) is not recommended."
 
       property :atomic_update, [ TrueClass, FalseClass ], desired_state: false, default: lazy { docker? && special_docker_files?(path) ? false : Chef::Config[:file_atomic_update] },
-               description: "Perform atomic file updates on a per-resource basis. Set to true for atomic file updates. Set to false for non-atomic file updates. This setting overrides file_atomic_update, which is a global setting found in the client.rb file."
+        default_description: "False if modifying /etc/hosts, /etc/hostname, or /etc/resolv.conf within Docker containers. Otherwise default to the client.rb 'file_atomic_update' config value.",
+        description: "Perform atomic file updates on a per-resource basis. Set to true for atomic file updates. Set to false for non-atomic file updates. This setting overrides `file_atomic_update`, which is a global setting found in the `client.rb` file."
 
       property :backup, [ Integer, FalseClass ], desired_state: false, default: 5,
-               description: "The number of backups to be kept in /var/chef/backup (for UNIX- and Linux-based platforms) or C:/chef/backup (for the Microsoft Windows platform). Set to false to prevent backups from being kept."
+        description: "The number of backups to be kept in `/var/chef/backup` (for UNIX- and Linux-based platforms) or `C:/chef/backup` (for the Microsoft Windows platform). Set to `false` to prevent backups from being kept."
 
-      property :checksum, [ /^[a-zA-Z0-9]{64}$/, nil ],
+      property :checksum, [ String, nil ],
+        regex: /^\h{64}$/,
+        coerce: lambda { |s| s.is_a?(String) ? s.downcase : s },
         description: "The SHA-256 checksum of the file. Use to ensure that a specific file is used. If the checksum does not match, the file is not used."
 
       property :content, [ String, nil ], desired_state: false,
-               description: "A string that is written to the file. The contents of this property replace any previous content when this property has something other than the default value. The default behavior will not modify content."
+        description: "A string that is written to the file. The contents of this property replace any previous content when this property has something other than the default value. The default behavior will not modify content."
 
       property :diff, [ String, nil ], desired_state: false, skip_docs: true
 
       property :force_unlink, [ TrueClass, FalseClass ], desired_state: false, default: false,
-               description: "How the #{Chef::Dist::CLIENT} handles certain situations when the target file turns out not to be a file. For example, when a target file is actually a symlink. Set to true for the #{Chef::Dist::CLIENT} delete the non-file target and replace it with the specified file. Set to false for the #{Chef::Dist::CLIENT} to raise an error."
+        description: "How #{Chef::Dist::PRODUCT} handles certain situations when the target file turns out not to be a file. For example, when a target file is actually a symlink. Set to `true` for #{Chef::Dist::PRODUCT} to delete the non-file target and replace it with the specified file. Set to `false` for #{Chef::Dist::PRODUCT} to raise an error."
 
       property :manage_symlink_source, [ TrueClass, FalseClass ], desired_state: false,
-               description: "Change the behavior of the file resource if it is pointed at a symlink. When this value is set to true, #{Chef::Dist::PRODUCT} will manage the symlink's permissions or will replace the symlink with a normal file if the resource has content. When this value is set to false, #{Chef::Dist::PRODUCT} will follow the symlink and will manage the permissions and content of symlink's target file. The default behavior is true but emits a warning that the default value will be changed to false in a future version; setting this explicitly to true or false suppresses this warning."
+        description: "Change the behavior of the file resource if it is pointed at a symlink. When this value is set to true, #{Chef::Dist::PRODUCT} will manage the symlink's permissions or will replace the symlink with a normal file if the resource has content. When this value is set to false, #{Chef::Dist::PRODUCT} will follow the symlink and will manage the permissions and content of symlink's target file. The default behavior is true but emits a warning that the default value will be changed to false in a future version; setting this explicitly to true or false suppresses this warning."
 
       property :verifications, Array, default: lazy { [] }
 

data/lib/chef/resource/freebsd_package.rb

@@ -29,7 +29,7 @@ class Chef
       provides :freebsd_package
       provides :package, platform: "freebsd"
 
-      description "Use the freebsd_package resource to manage packages for the FreeBSD platform."
+      description "Use the **freebsd_package** resource to manage packages for the FreeBSD platform."
 
       # make sure we assign the appropriate underlying providers based on what
       # package managers exist on this FreeBSD system or the source of the package
@@ -42,7 +42,7 @@ class Chef
       private
 
       def assign_provider
-        @provider = if source.to_s =~ /^ports$/i
+        @provider = if /^ports$/i.match?(source.to_s)
                       Chef::Provider::Package::Freebsd::Port
                     else
                       Chef::Provider::Package::Freebsd::Pkgng

data/lib/chef/resource/gem_package.rb

@@ -25,7 +25,7 @@ class Chef
       unified_mode true
       provides :gem_package
 
-      description "Use the gem_package resource to manage gem packages that are only included in recipes. 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 **gem_package** resource to manage gem packages that are only included in recipes. 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 :package_name, String,
         description: "An optional property to set the package name if it differs from the resource block's name.",
@@ -46,21 +46,21 @@ class Chef
       # FIXME? the array form of installing paths most likely does not work?
       #
       property :source, [ String, Array ],
-        description: "Optional. The URL, or list of URLs, at which the gem package is located. This list is added to the source configured in Chef::Config[:rubygems_url] (see also include_default_source) to construct the complete list of rubygems sources. Users in an 'airgapped' environment should set Chef::Config[:rubygems_url] to their local RubyGems mirror."
+        description: "Optional. The URL, or list of URLs, at which the gem package is located. This list is added to the source configured in `Chef::Config[:rubygems_url]` (see also include_default_source) to construct the complete list of rubygems sources. Users in an 'airgapped' environment should set Chef::Config[:rubygems_url] to their local RubyGems mirror."
 
       property :clear_sources, [ TrueClass, FalseClass, nil ],
-        description: "Set to 'true' to download a gem from the path specified by the source property (and not from RubyGems).",
+        description: "Set to `true` to download a gem from the path specified by the `source` property (and not from RubyGems).",
         default: lazy { Chef::Config[:clear_gem_sources] }, desired_state: false
 
       property :gem_binary, String, desired_state: false,
-        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::Dist::CLIENT} will be installed."
+        description: "The path of a gem binary to use for the installation. By default, the same version of Ruby that is used by #{Chef::Dist::PRODUCT} will be installed."
 
       property :include_default_source, [ TrueClass, FalseClass, nil ],
-        description: "Set to 'false' to not include 'Chef::Config[:rubygems_url]'' in the sources.",
+        description: "Set to `false` to not include `Chef::Config[:rubygems_url]` in the sources.",
         default: nil, introduced: "13.0"
 
       property :options, [ String, Hash, Array, nil ],
-        description: "Options for the gem install, either a Hash or a String. When a hash is given, the options are passed to Gem::DependencyInstaller.new, and the gem will be installed via the gems API. When a String is given, the gem will be installed by shelling out to the gem command. Using a Hash of options with an explicit gem_binary will result in undefined behavior.",
+        description: "Options for the gem install, either a Hash or a String. When a hash is given, the options are passed to `Gem::DependencyInstaller.new`, and the gem will be installed via the gems API. When a String is given, the gem will be installed by shelling out to the gem command. Using a Hash of options with an explicit gem_binary will result in undefined behavior.",
         desired_state: false
     end
   end

data/lib/chef/resource/group.rb

@@ -23,7 +23,7 @@ class Chef
       unified_mode true
       state_attrs :members
 
-      description "Use the group resource to manage a local group."
+      description "Use the **group** resource to manage a local group."
 
       provides :group
 

data/lib/chef/resource/helpers/cron_validations.rb

@@ -35,7 +35,7 @@ class Chef
         # Lists of individual values, ranges, and step values all share the validity range for type
         spec.split(%r{\/|-|,}).each do |x|
           next if x == "*"
-          return false unless x =~ /^\d+$/
+          return false unless /^\d+$/.match?(x)
 
           x = x.to_i
           return false unless x >= min && x <= max
@@ -62,13 +62,16 @@ class Chef
         end
       end
 
-      # validate the provided day of the week is sun-sat, 0-7, or *
+      # validate the provided day of the week is sun-sat, sunday-saturday, 0-7, or *
+      # Added crontab param to check cron resource
       # @param spec the value to validate
       # @return [Boolean] valid or not?
       def validate_dow(spec)
+        spec = spec.to_s
         spec == "*" ||
           validate_numeric(spec, 0, 7) ||
-          %w{sun mon tue wed thu fri sat}.include?(String(spec).downcase)
+          %w{sun mon tue wed thu fri sat}.include?(spec.downcase) ||
+          %w{sunday monday tuesday wednesday thursday friday saturday}.include?(spec.downcase)
       end
 
       # validate the day of the month is 1-31

data/lib/chef/resource/homebrew_cask.rb

@@ -27,7 +27,7 @@ class Chef
 
       provides(:homebrew_cask) { true }
 
-      description "Use the homebrew_cask resource to install binaries distributed via the Homebrew package manager."
+      description "Use the **homebrew_cask** resource to install binaries distributed via the Homebrew package manager."
       introduced "14.0"
 
       include Chef::Mixin::HomebrewUser

data/lib/chef/resource/homebrew_package.rb

@@ -29,8 +29,37 @@ class Chef
       provides :homebrew_package
       provides :package, os: "darwin"
 
-      description "Use the homebrew_package resource to manage packages for the macOS platform."
+      description "Use the **homebrew_package** resource to manage packages for the macOS platform. Note: Starting with #{Chef::Dist::PRODUCT} 16 the homebrew resource now accepts an array of packages for installing multiple packages at once."
       introduced "12.0"
+      examples <<~DOC
+      **Install a package**:
+
+      ```ruby
+      homebrew_package 'git'
+      ```
+
+      **Install multiple packages at once**:
+
+      ```ruby
+      homebrew_package %w(git fish ruby)
+      ```
+
+      **Specify the Homebrew user with a UUID**
+
+      ```ruby
+      homebrew_package 'git' do
+        homebrew_user 1001
+      end
+      ```
+
+      **Specify the Homebrew user with a string**:
+
+      ```ruby
+      homebrew_package 'vim' do
+        homebrew_user 'user1'
+      end
+      ```
+      DOC
 
       property :homebrew_user, [ String, Integer ],
         description: "The name or uid of the Homebrew owner to be used by #{Chef::Dist::PRODUCT} when executing a command."

data/lib/chef/resource/homebrew_tap.rb

@@ -27,7 +27,7 @@ class Chef
 
       provides(:homebrew_tap) { true }
 
-      description "Use the homebrew_tap resource to add additional formula repositories to the Homebrew package manager."
+      description "Use the **homebrew_tap** resource to add additional formula repositories to the Homebrew package manager."
       introduced "14.0"
 
       include Chef::Mixin::HomebrewUser

data/lib/chef/resource/homebrew_update.rb

@@ -0,0 +1,107 @@
+#
+# Author:: Joshua Timberman (<jtimberman@chef.io>)
+# Author:: Dan Webb (<dan@webb-agile-solutions.ltd>)
+#
+# Copyright:: Copyright (c) Chef Software Inc.
+# Copyright:: Copyright (c) Webb Agile Solutions Ltd.
+#
+# 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 HomebrewUpdate < Chef::Resource
+      unified_mode true
+
+      provides(:homebrew_update) { true }
+
+      description "Use the **homebrew_update** resource to manage Homebrew repository updates on macOS."
+      introduced "16.2"
+      examples <<~DOC
+        **Update the homebrew repository data at a specified interval**:
+        ```ruby
+        homebrew_update 'all platforms' do
+          frequency 86400
+          action :periodic
+        end
+        ```
+        **Update the Homebrew repository at the start of a #{Chef::Dist::PRODUCT} run**:
+        ```ruby
+        homebrew_update 'update'
+        ```
+      DOC
+
+      # allow bare homebrew_update with no name
+      property :name, String, default: ""
+
+      property :frequency, Integer,
+        description: "Determines how frequently (in seconds) Homebrew updates are made. Use this property when the `:periodic` action is specified.",
+        default: 86_400
+
+      default_action :periodic
+      allowed_actions :update, :periodic
+
+      action_class do
+        BREW_STAMP_DIR = "/var/lib/homebrew/periodic".freeze
+        BREW_STAMP = "#{BREW_STAMP_DIR}/update-success-stamp".freeze
+
+        # Determines whether we need to run `homebrew update`
+        #
+        # @return [Boolean]
+        def brew_up_to_date?
+          ::File.exist?("#{BREW_STAMP}") &&
+            ::File.mtime("#{BREW_STAMP}") > Time.now - new_resource.frequency
+        end
+
+        def do_update
+          directory BREW_STAMP_DIR do
+            recursive true
+          end
+
+          file "#{BREW_STAMP}" do
+            content "BREW::Update::Post-Invoke-Success\n"
+            action :create_if_missing
+          end
+
+          execute "brew update" do
+            command %w{brew update}
+            default_env true
+            user Homebrew.owner
+            notifies :touch, "file[#{BREW_STAMP}]", :immediately
+          end
+        end
+      end
+
+      action :periodic do
+        return unless mac_os_x?
+
+        unless brew_up_to_date?
+          converge_by "update new lists of packages" do
+            do_update
+          end
+        end
+      end
+
+      action :update do
+        return unless mac_os_x?
+
+        converge_by "force update new lists of packages" do
+          do_update
+        end
+      end
+    end
+  end
+end

data/lib/chef/resource/hostname.rb

@@ -1,4 +1,7 @@
 #
+# Copyright:: Copyright (c) Chef Software Inc.
+# License:: Apache License, Version 2.0
+#
 # 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
@@ -13,6 +16,7 @@
 #
 
 require_relative "../resource"
+require_relative "../dist"
 
 class Chef
   class Resource
@@ -23,16 +27,16 @@ class Chef
 
       provides :hostname
 
-      description "Use the hostname resource to set the system's hostname, configure hostname and hosts config file, and re-run the Ohai hostname plugin so the hostname will be available in subsequent cookbooks."
+      description "Use the **hostname** resource to set the system's hostname, configure hostname and hosts config file, and re-run the Ohai hostname plugin so the hostname will be available in subsequent cookbooks."
       introduced "14.0"
       examples <<~DOC
-        Set the hostname using the IP address, as detected by Ohai
+        **Set the hostname using the IP address, as detected by Ohai**:
 
         ```ruby
         hostname 'example'
         ```
 
-        Manually specify the hostname and IP address
+        **Manually specify the hostname and IP address**:
 
         ```ruby
         hostname 'statically_configured_host' do
@@ -149,7 +153,7 @@ class Chef
               # this must come before other methods like /etc/hostname and /etc/sysconfig/network
               declare_resource(:execute, "hostnamectl set-hostname #{new_resource.hostname}") do
                 notifies :reload, "ohai[reload hostname]"
-                not_if { shell_out!("hostnamectl status", { returns: [0, 1] }).stdout =~ /Static hostname:\s*#{new_resource.hostname}\s*$/ }
+                not_if { shell_out!("hostnamectl status", returns: [0, 1]).stdout =~ /Static hostname:\s*#{new_resource.hostname}\s*$/ }
               end
             when ::File.exist?("/etc/hostname")
               # debian family uses /etc/hostname
@@ -168,7 +172,7 @@ class Chef
               # older non-systemd RHEL/Fedora derived
               append_replacing_matching_lines("/etc/sysconfig/network", /^HOSTNAME\s*=/, "HOSTNAME=#{new_resource.hostname}")
             when ::File.exist?("/etc/HOSTNAME")
-              # SuSE/OpenSUSE uses /etc/HOSTNAME
+              # SuSE/openSUSE uses /etc/HOSTNAME
               declare_resource(:file, "/etc/HOSTNAME") do
                 content "#{new_resource.hostname}\n"
                 owner "root"
@@ -199,24 +203,7 @@ class Chef
               group node["root_group"]
               mode "0644"
             end
-          when ::File.exist?("/etc/nodename")
-            # Solaris <= 5.10 systems prior to svccfg taking over this functionality (must come before svccfg handling)
-            declare_resource(:file, "/etc/nodename") do
-              content "#{new_resource.hostname}\n"
-              owner "root"
-              group node["root_group"]
-              mode "0644"
-            end
-            # Solaris also has /etc/inet/hosts (copypasta alert)
-            unless new_resource.ipaddress.nil?
-              newline = "#{new_resource.ipaddress} #{new_resource.hostname}"
-              newline << " #{new_resource.aliases.join(" ")}" if new_resource.aliases && !new_resource.aliases.empty?
-              newline << " #{new_resource.hostname[/[^\.]*/]}"
-              r = append_replacing_matching_lines("/etc/inet/hosts", /^#{new_resource.ipaddress}\s+|\s+#{new_resource.hostname}\s+/, newline)
-              r.notifies :reload, "ohai[reload hostname]"
-            end
-          when ::File.exist?("/usr/sbin/svccfg")
-            # Solaris >= 5.11 systems using svccfg (must come after /etc/nodename handling)
+          when ::File.exist?("/usr/sbin/svccfg") # solaris 5.11
             declare_resource(:execute, "svccfg -s system/identity:node setprop config/nodename=\'#{new_resource.hostname}\'") do
               notifies :run, "execute[svcadm refresh]", :immediately
               notifies :run, "execute[svcadm restart]", :immediately
@@ -262,7 +249,7 @@ class Chef
 
           # reboot because $windows
           declare_resource(:reboot, "setting hostname") do
-            reason "chef setting hostname"
+            reason "#{Chef::Dist::PRODUCT} updated system hostname"
             action :nothing
             only_if { new_resource.windows_reboot }
           end

data/lib/chef/resource/http_request.rb

@@ -26,7 +26,7 @@ class Chef
 
       provides :http_request
 
-      description "Use the http_request resource to send an HTTP request (GET, PUT, POST, DELETE, HEAD, or OPTIONS) with an arbitrary message. This resource is often useful when custom callbacks are necessary."
+      description "Use the **http_request** resource to send an HTTP request (GET, PUT, POST, DELETE, HEAD, or OPTIONS) with an arbitrary message. This resource is often useful when custom callbacks are necessary."
 
       default_action :get
       allowed_actions :get, :patch, :put, :post, :delete, :head, :options

data/lib/chef/resource/ifconfig.rb

@@ -30,7 +30,7 @@ class Chef
 
       provides :ifconfig
 
-      description "Use the ifconfig resource to manage interfaces on Unix and Linux systems."
+      description "Use the **ifconfig** resource to manage interfaces on Unix and Linux systems."
 
       state_attrs :inet_addr, :mask
 
@@ -45,11 +45,11 @@ class Chef
         description: "The hardware address for the network interface."
 
       property :mask, String,
-        description: "The decimal representation of the network mask. For example: 255.255.255.0."
+        description: "The decimal representation of the network mask. For example: `255.255.255.0`."
 
       property :family, String, default: "inet",
-               introduced: "14.0",
-               description: "Networking family option for Debian-based systems; for example: inet or inet6."
+        introduced: "14.0",
+        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."
@@ -81,11 +81,11 @@ class Chef
 
       property :ethtool_opts, String,
         introduced: "13.4",
-        description: "Options to be passed to ethtool(8). For example: -A eth0 autoneg off rx off tx off."
+        description: "Options to be passed to ethtool(8). For example: `-A eth0 autoneg off rx off tx off`."
 
       property :bonding_opts, String,
         introduced: "13.4",
-        description: "Bonding options to pass via BONDING_OPTS on RHEL and CentOS. For example: mode=active-backup miimon=100."
+        description: "Bonding options to pass via `BONDING_OPTS` on RHEL and CentOS. For example: `mode=active-backup miimon=100`."
 
       property :master, String,
         introduced: "13.4",
@@ -93,7 +93,7 @@ class Chef
 
       property :slave, String,
         introduced: "13.4",
-        description: "When set to yes, this device is controlled by the channel bonding interface that is specified via the master property."
+        description: "When set to `yes`, this device is controlled by the channel bonding interface that is specified via the `master` property."
 
       property :vlan, String,
         introduced: "14.4",