chef 15.17.4 → 16.0.257

data/lib/chef/resource/dsc_resource.rb

@@ -21,7 +21,8 @@ require_relative "../dist"
 class Chef
   class Resource
     class DscResource < Chef::Resource
-      resource_name :dsc_resource
+      unified_mode true
+
       provides :dsc_resource
 
       description "The dsc_resource resource allows any DSC resource to be used in a 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."
@@ -100,12 +101,13 @@ class Chef
       # is necessary, reboot_action provides the mechanism for a reboot to
       # be requested.
       property :reboot_action, Symbol, default: :nothing, equal_to: %i{nothing reboot_now request_reboot},
-                introduced: "12.6",
-                description: "Use to request an immediate reboot or to queue a reboot using the :reboot_now (immediate reboot) or :request_reboot (queued reboot) actions built into the reboot resource."
+        introduced: "12.6",
+        description: "Use to request an immediate reboot or to queue a reboot using the :reboot_now (immediate reboot) or :request_reboot (queued reboot) actions built into the reboot resource."
 
       property :timeout, Integer,
         introduced: "12.6",
-        description: "The amount of time (in seconds) a command is to wait before timing out."
+        description: "The amount of time (in seconds) a command is to wait before timing out.",
+        desired_state: false
 
       private
 

data/lib/chef/resource/dsc_script.rb

@@ -26,7 +26,7 @@ class Chef
     class DscScript < Chef::Resource
       include Chef::DSL::Powershell
 
-      resource_name :dsc_script
+      unified_mode true
       provides :dsc_script
 
       description "Many DSC resources are comparable to built-in #{Chef::Dist::PRODUCT} resources. For example, both DSC and #{Chef::Dist::PRODUCT} have file, package, and service resources. The dsc_script resource is most useful for those DSC resources that do not have a direct comparison to a resource in #{Chef::Dist::PRODUCT}, such as the Archive resource, a custom DSC resource, an existing DSC script that performs an important task, and so on. Use the dsc_script resource to embed the code that defines a DSC configuration directly within a #{Chef::Dist::PRODUCT} recipe."
@@ -124,7 +124,8 @@ class Chef
         description: "A Hash of environment variables in the form of ({'ENV_VARIABLE' => 'VALUE'}). (These variables must exist for a command to be run successfully)."
 
       property :timeout, Integer,
-        description: "The amount of time (in seconds) a command is to wait before timing out."
+        description: "The amount of time (in seconds) a command is to wait before timing out.",
+        desired_state: false
     end
   end
 end

data/lib/chef/resource/execute.rb

@@ -25,7 +25,6 @@ class Chef
     class Execute < Chef::Resource
       unified_mode true
 
-      resource_name :execute
       provides :execute, target_mode: true
 
       description "Use the execute resource to execute a single command. Commands that"\
@@ -50,7 +49,7 @@ class Chef
       end
 
       property :command, [ String, Array ],
-        name_property: true, identity: true,
+        name_property: true,
         description: "An optional property to set the command to be executed if it differs from the resource block's name."
 
       property :umask, [ String, Integer ],
@@ -69,18 +68,20 @@ class Chef
         description: "The group name or group ID that must be changed before running a command."
 
       property :live_stream, [ TrueClass, FalseClass ], default: false,
-               description: "Send the output of the command run by this execute resource block to the #{Chef::Dist::CLIENT} event stream."
+        description: "Send the output of the command run by this execute resource block to the #{Chef::Dist::CLIENT} event stream."
 
       # default_env defaults to `false` so that the command execution more exactly matches what the user gets on the command line without magic
       property :default_env, [ TrueClass, FalseClass ], desired_state: false, default: false,
-               introduced: "14.2",
-               description: "When true this enables ENV magic to add path_sanity to the PATH and force the locale to English+UTF-8 for parsing output"
+        introduced: "14.2",
+        description: "When true this enables ENV magic to add path_sanity to the PATH and force the locale to English+UTF-8 for parsing output"
 
       property :returns, [ Integer, Array ], default: 0,
-               description: "The return value for a command. This may be an array of accepted values. An exception is raised when the return value(s) do not match."
+        description: "The return value for a command. This may be an array of accepted values. An exception is raised when the return value(s) do not match."
 
-      property :timeout, [ Integer, Float ],
-        description: "The amount of time (in seconds) a command is to wait before timing out."
+      property :timeout, [ Integer, String, Float ],
+        default: 3600,
+        description: "The amount of time (in seconds) a command is to wait before timing out.",
+        desired_state: false
 
       property :user, [ String, Integer ],
         description: "The user name of the user identity with which to launch the new process. The user name may optionally be specifed with a domain, i.e. domainuser or user@my.dns.domain.com via Universal Principal Name (UPN)format. It can also be specified without a domain simply as user if the domain is instead specified using the domain property. On Windows only, if this property is specified, the password property must be specified."
@@ -90,8 +91,8 @@ class Chef
         description: "Windows only: The domain of the user user specified by the user property. If not specified, the user name and password specified by the user and password properties will be used to resolve that user against the domain in which the system running #{Chef::Dist::PRODUCT} is joined, or if that system is not joined to a domain it will resolve the user as a local account on that system. An alternative way to specify the domain is to leave this property unspecified and specify the domain as part of the user property."
 
       property :password, String, sensitive: true,
-               introduced: "12.21",
-               description: "Windows only: The password of the user specified by the user property. This property is mandatory if user is specified on Windows and may only be specified if user is specified. The sensitive property for this resource will automatically be set to true if password is specified."
+        introduced: "12.21",
+        description: "Windows only: The password of the user specified by the user property. This property is mandatory if user is specified on Windows and may only be specified if user is specified. The sensitive property for this resource will automatically be set to true if password is specified."
 
       # lazy used to set default value of sensitive to true if password is set
       property :sensitive, [ TrueClass, FalseClass ],
@@ -99,8 +100,8 @@ class Chef
         default: lazy { password ? true : false }, default_description: "True if the password property is set. False otherwise."
 
       property :elevated, [ TrueClass, FalseClass ], default: false,
-               description: "Determines whether the script will run with elevated permissions to circumvent User Access Control (UAC) interactively blocking the process.\nThis will cause the process to be run under a batch login instead of an interactive login. The user running #{Chef::Dist::CLIENT} needs the “Replace a process level token” and “Adjust Memory Quotas for a process” permissions. The user that is running the command needs the “Log on as a batch job” permission.\nBecause this requires a login, the user and password properties are required.",
-               introduced: "13.3"
+        description: "Determines whether the script will run with elevated permissions to circumvent User Access Control (UAC) interactively blocking the process.\nThis will cause the process to be run under a batch login instead of an interactive login. The user running #{Chef::Dist::CLIENT} needs the “Replace a process level token” and “Adjust Memory Quotas for a process” permissions. The user that is running the command needs the “Log on as a batch job” permission.\nBecause this requires a login, the user and password properties are required.",
+        introduced: "13.3"
 
       alias :env :environment
 

data/lib/chef/resource/file.rb

@@ -30,6 +30,8 @@ class Chef
       include Chef::Mixin::Securable
       unified_mode true
 
+      provides :file
+
       description "Use the file resource to manage files directly on a node."
 
       if ChefUtils.windows?
@@ -53,7 +55,7 @@ class Chef
       default_action :create
       allowed_actions :create, :delete, :touch, :create_if_missing
 
-      property :path, String, name_property: true, identity: true,
+      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."
 
       property :atomic_update, [ TrueClass, FalseClass ], desired_state: false, default: lazy { docker? && special_docker_files?(path) ? false : Chef::Config[:file_atomic_update] },

data/lib/chef/resource/freebsd_package.rb

@@ -25,7 +25,8 @@ require_relative "../provider/package/freebsd/pkgng"
 class Chef
   class Resource
     class FreebsdPackage < Chef::Resource::Package
-      resource_name :freebsd_package
+      unified_mode true
+      provides :freebsd_package
       provides :package, platform: "freebsd"
 
       description "Use the freebsd_package resource to manage packages for the FreeBSD platform."

data/lib/chef/resource/gem_package.rb

@@ -22,14 +22,22 @@ require_relative "../dist"
 class Chef
   class Resource
     class GemPackage < Chef::Resource::Package
-      resource_name :gem_package
+      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."
 
+      property :package_name, String,
+        description: "An optional property to set the package name if it differs from the resource block's name.",
+        identity: true
+
+      property :version, String,
+        description: "The version of a package to be installed or upgraded."
+
       # the source can either be a path to a package source like:
       #   source /var/tmp/mygem-1.2.3.4.gem
       # or it can be a url rubygems source like:
-      #   https://www.rubygems.org
+      #   https://rubygems.org
       # the default has to be nil in order for the magical wiring up of the name property to
       # the source pathname to work correctly.
       #
@@ -40,16 +48,16 @@ class Chef
       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."
 
-      property :clear_sources, [ TrueClass, FalseClass ],
+      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).",
         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 the #{Chef::Dist::CLIENT} will be installed."
 
-      property :include_default_source, [ TrueClass, FalseClass ],
+      property :include_default_source, [ TrueClass, FalseClass, nil ],
         description: "Set to 'false' to not include 'Chef::Config[:rubygems_url]'' in the sources.",
-        default: true, introduced: "13.0"
+        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.",

data/lib/chef/resource/group.rb

@@ -20,15 +20,18 @@
 class Chef
   class Resource
     class Group < Chef::Resource
+      unified_mode true
       state_attrs :members
 
       description "Use the group resource to manage a local group."
 
+      provides :group
+
       allowed_actions :create, :remove, :modify, :manage
       default_action :create
 
       property :group_name, String,
-        name_property: true, identity: true,
+        name_property: true,
         description: "The name of the group."
 
       property :gid, [ String, Integer ],

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

@@ -0,0 +1,98 @@
+#
+# 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
+#
+#     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.
+#
+
+class Chef
+  module ResourceHelpers
+    # a collection of methods for validating cron times. Used in the various cron-like resources
+    module CronValidations
+      # validate a provided value is between two other provided values
+      # we also allow * as a valid input
+      # @param spec the value to validate
+      # @param min the lowest value allowed
+      # @param max the highest value allowed
+      # @return [Boolean] valid or not?
+      def validate_numeric(spec, min, max)
+        return true if spec == "*"
+
+        if spec.respond_to? :to_int
+          return spec >= min && spec <= max
+        end
+
+        # 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+$/
+
+          x = x.to_i
+          return false unless x >= min && x <= max
+        end
+        true
+      end
+
+      # validate the provided month value to be jan - dec, 1 - 12, or *
+      # @param spec the value to validate
+      # @return [Boolean] valid or not?
+      def validate_month(spec)
+        return true if spec == "*"
+
+        if spec.respond_to? :to_int
+          validate_numeric(spec, 1, 12)
+        elsif spec.respond_to? :to_str
+          # Named abbreviations are permitted but not as part of a range or with stepping
+          return true if %w{jan feb mar apr may jun jul aug sep oct nov dec}.include? spec.downcase
+
+          # 1-12 are legal for months
+          validate_numeric(spec, 1, 12)
+        else
+          false
+        end
+      end
+
+      # validate the provided day of the week is sun-sat, 0-7, or *
+      # @param spec the value to validate
+      # @return [Boolean] valid or not?
+      def validate_dow(spec)
+        spec == "*" ||
+          validate_numeric(spec, 0, 7) ||
+          %w{sun mon tue wed thu fri sat}.include?(String(spec).downcase)
+      end
+
+      # validate the day of the month is 1-31
+      # @param spec the value to validate
+      # @return [Boolean] valid or not?
+      def validate_day(spec)
+        validate_numeric(spec, 1, 31)
+      end
+
+      # validate the hour is 0-23
+      # @param spec the value to validate
+      # @return [Boolean] valid or not?
+      def validate_hour(spec)
+        validate_numeric(spec, 0, 23)
+      end
+
+      # validate the minute is 0-59
+      # @param spec the value to validate
+      # @return [Boolean] valid or not?
+      def validate_minute(spec)
+        validate_numeric(spec, 0, 59)
+      end
+
+      extend self
+    end
+  end
+end

data/lib/chef/resource/homebrew_cask.rb

@@ -23,7 +23,8 @@ require_relative "../mixin/homebrew_user"
 class Chef
   class Resource
     class HomebrewCask < Chef::Resource
-      resource_name :homebrew_cask
+      unified_mode true
+
       provides(:homebrew_cask) { true }
 
       description "Use the homebrew_cask resource to install binaries distributed via the Homebrew package manager."
@@ -59,7 +60,7 @@ class Chef
 
         unless casked?
           converge_by("install cask #{new_resource.cask_name} #{new_resource.options}") do
-            shell_out!("#{new_resource.homebrew_path} install --cask #{new_resource.cask_name} #{new_resource.options}",
+            shell_out!("#{new_resource.homebrew_path} cask install #{new_resource.cask_name} #{new_resource.options}",
               user: new_resource.owner,
               env:  { "HOME" => ::Dir.home(new_resource.owner), "USER" => new_resource.owner },
               cwd: ::Dir.home(new_resource.owner))
@@ -74,7 +75,7 @@ class Chef
 
         if casked?
           converge_by("uninstall cask #{new_resource.cask_name}") do
-            shell_out!("#{new_resource.homebrew_path} uninstall --cask #{new_resource.cask_name}",
+            shell_out!("#{new_resource.homebrew_path} cask uninstall #{new_resource.cask_name}",
               user: new_resource.owner,
               env:  { "HOME" => ::Dir.home(new_resource.owner), "USER" => new_resource.owner },
               cwd: ::Dir.home(new_resource.owner))
@@ -92,7 +93,7 @@ class Chef
         # @return [Boolean]
         def casked?
           unscoped_name = new_resource.cask_name.split("/").last
-          shell_out!("#{new_resource.homebrew_path} list --cask 2>/dev/null",
+          shell_out!("#{new_resource.homebrew_path} cask list 2>/dev/null",
             user: new_resource.owner,
             env:  { "HOME" => ::Dir.home(new_resource.owner), "USER" => new_resource.owner },
             cwd: ::Dir.home(new_resource.owner)).stdout.split.include?(unscoped_name)

data/lib/chef/resource/homebrew_package.rb

@@ -24,14 +24,16 @@ require_relative "../dist"
 class Chef
   class Resource
     class HomebrewPackage < Chef::Resource::Package
-      resource_name :homebrew_package
+      unified_mode true
+
+      provides :homebrew_package
       provides :package, os: "darwin"
 
       description "Use the homebrew_package resource to manage packages for the macOS platform."
       introduced "12.0"
 
       property :homebrew_user, [ String, Integer ],
-        description: "The name of the Homebrew owner to be used by #{Chef::Dist::PRODUCT} when executing a command."
+        description: "The name or uid of the Homebrew owner to be used by #{Chef::Dist::PRODUCT} when executing a command."
 
     end
   end

data/lib/chef/resource/homebrew_tap.rb

@@ -23,7 +23,8 @@ require_relative "../mixin/homebrew_user"
 class Chef
   class Resource
     class HomebrewTap < Chef::Resource
-      resource_name :homebrew_tap
+      unified_mode true
+
       provides(:homebrew_tap) { true }
 
       description "Use the homebrew_tap resource to add additional formula repositories to the Homebrew package manager."

data/lib/chef/resource/hostname.rb

@@ -13,28 +13,39 @@
 #
 
 require_relative "../resource"
-require_relative "../dist"
 
 class Chef
   class Resource
     # Sets the hostname and updates /etc/hosts on *nix systems
     # @since 14.0.0
     class Hostname < Chef::Resource
-      resource_name :hostname
+      unified_mode true
+
       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
+
+        ```ruby
+        hostname 'example'
+        ```
+
+        Manually specify the hostname and IP address
+
+        ```ruby
+        hostname 'statically_configured_host' do
+          hostname 'example'
+          ipaddress '198.51.100.2'
+        end
+        ```
+      DOC
 
       property :hostname, String,
         description: "An optional property to set the hostname if it differs from the resource block's name.",
         name_property: true
 
-      property :compile_time, [ TrueClass, FalseClass ],
-        description: "Determines whether or not the resource should be run at compile time.",
-        default: true, desired_state: false
-
       property :ipaddress, String,
         description: "The IP address to use when configuring the hosts file.",
         default: lazy { node["ipaddress"] }, default_description: "The node's IP address as determined by Ohai."
@@ -43,6 +54,11 @@ class Chef
         description: "An array of hostname aliases to use when configuring the hosts file.",
         default: nil
 
+      # override compile_time property to be true by default
+      property :compile_time, [ TrueClass, FalseClass ],
+        description: "Determines whether or not the resource should be run at compile time.",
+        default: true, desired_state: false
+
       property :windows_reboot, [ TrueClass, FalseClass ],
         description: "Determines whether or not Windows should be reboot after changing the hostname, as this is required for the change to take effect.",
         default: true
@@ -67,7 +83,8 @@ class Chef
         def updated_ec2_config_xml
           begin
             require "rexml/document" unless defined?(REXML::Document)
-            config = REXML::Document.new(::File.read(WINDOWS_EC2_CONFIG))
+            config_file = 'C:\Program Files\Amazon\Ec2ConfigService\Settings\config.xml'
+            config = REXML::Document.new(::File.read(config_file))
             # find an element named State with a sibling element whose value is Ec2SetComputerName
             REXML::XPath.each(config, "//Plugin/State[../Name/text() = 'Ec2SetComputerName']") do |element|
               element.text = "Disabled"
@@ -219,47 +236,35 @@ class Chef
           end
 
         else # windows
-          WINDOWS_EC2_CONFIG = 'C:\Program Files\Amazon\Ec2ConfigService\Settings\config.xml'.freeze
-
           raise "Windows hostnames cannot contain a period." if new_resource.hostname.match?(/\./)
 
           # suppress EC2 config service from setting our hostname
-          if ::File.exist?(WINDOWS_EC2_CONFIG)
+          if ::File.exist?('C:\Program Files\Amazon\Ec2ConfigService\Settings\config.xml')
             xml_contents = updated_ec2_config_xml
             if xml_contents.empty?
               Chef::Log.warn('Unable to properly parse and update C:\Program Files\Amazon\Ec2ConfigService\Settings\config.xml contents. Skipping file update.')
             else
-              file WINDOWS_EC2_CONFIG do
+              declare_resource(:file, 'C:\Program Files\Amazon\Ec2ConfigService\Settings\config.xml') do
                 content xml_contents
               end
             end
           end
 
-          unless Socket.gethostbyname(Socket.gethostname).first == new_resource.hostname
-            converge_by "set hostname to #{new_resource.hostname}" do
-              powershell_out! <<~EOH
-                $sysInfo = Get-WmiObject -Class Win32_ComputerSystem
-                $sysInfo.Rename("#{new_resource.hostname}")
-              EOH
-            end
-
-            # reboot because $windows
-            reboot "setting hostname" do
-              reason "#{Chef::Dist::PRODUCT} updated system hostname"
-              only_if { new_resource.windows_reboot }
-              action :request_reboot
-            end
+          # update via netdom
+          declare_resource(:powershell_script, "set hostname") do
+            code <<-EOH
+              $sysInfo = Get-WmiObject -Class Win32_ComputerSystem
+              $sysInfo.Rename("#{new_resource.hostname}")
+            EOH
+            notifies :request_reboot, "reboot[setting hostname]"
+            not_if { Socket.gethostbyname(Socket.gethostname).first == new_resource.hostname }
           end
-        end
-      end
 
-      # this resource forces itself to run at compile_time
-      #
-      # @return [void]
-      def after_created
-        if compile_time
-          Array(action).each do |action|
-            run_action(action)
+          # reboot because $windows
+          declare_resource(:reboot, "setting hostname") do
+            reason "chef setting hostname"
+            action :nothing
+            only_if { new_resource.windows_reboot }
           end
         end
       end