chef 16.18.30 → 17.0.242

data/lib/chef/resource/archive_file.rb

@@ -20,12 +20,6 @@
 
 require_relative "../resource"
 require "fileutils" unless defined?(FileUtils)
-begin
-  # ffi-libarchive must be eager loaded see: https://github.com/chef/chef/issues/12228
-  require "ffi-libarchive" unless defined?(Archive::Reader)
-rescue LoadError
-  STDERR.puts "ffi-libarchive could not be loaded, libarchive is probably not installed on system, archive_file will not be available"
-end
 
 class Chef
   class Resource
@@ -73,7 +67,7 @@ class Chef
 
       property :mode, [String, Integer],
         description: "The mode of the extracted files. Integer values are deprecated as octal values (ex. 0755) would not be interpreted correctly.",
-        default: "755"
+        default: "755", default_description: "'755'"
 
       property :destination, String,
         description: "The file path to extract the archive file to.",
@@ -91,8 +85,9 @@ class Chef
       alias_method :extract_options, :options
       alias_method :extract_to, :destination
 
-      action :extract do
-        description "Extract and archive file."
+      action :extract, description: "Extract and archive file." do
+
+        require_libarchive
 
         unless ::File.exist?(new_resource.path)
           raise Errno::ENOENT, "No archive found at #{new_resource.path}! Cannot continue."
@@ -131,6 +126,10 @@ class Chef
       end
 
       action_class do
+        def require_libarchive
+          require "ffi-libarchive"
+        end
+
         def define_resource_requirements
           if new_resource.mode.is_a?(Integer)
             Chef.deprecated(:archive_file_integer_file_mode, "The mode property should be passed to archive_file resources as a String and not an Integer to ensure the value is properly interpreted.")

data/lib/chef/resource/breakpoint.rb

@@ -92,7 +92,7 @@ class Chef
         super(caller.first, *args)
       end
 
-      action :break do
+      action :break, description: "Add a breakpoint for use with #{ChefUtils::Dist::Infra::SHELL}" do
         if defined?(Shell) && Shell.running?
           with_run_context :parent do
             run_context.resource_collection.iterator.pause

data/lib/chef/resource/build_essential.rb

@@ -57,10 +57,7 @@ class Chef
         introduced: "15.5",
         default: false, desired_state: false # FIXME: make this default to true
 
-      action :install do
-
-        description "Install build essential packages"
-
+      action :install, description: "Install build essential packages" do
         case
         when debian?
           package %w{ autoconf binutils-doc bison build-essential flex gettext ncurses-dev }
@@ -122,8 +119,7 @@ class Chef
         end
       end
 
-      action :upgrade do
-        description "Upgrade build essential (Xcode Command Line) tools on macOS"
+      action :upgrade, description: "Upgrade the Xcode CLI Tools on macOS hosts. **New in Chef Infra Client 16**" do
 
         if macos?
           pkg_label = xcode_cli_package_label

data/lib/chef/resource/chef_client_config.rb

@@ -227,7 +227,7 @@ class Chef
       property :additional_config, String,
         description: "Additional text to add at the bottom of the client.rb config. This can be used to run custom Ruby or to add less common config options"
 
-      action :create do
+      action :create, description: "Create a client.rb config file" do
         unless ::Dir.exist?(new_resource.config_directory)
           directory new_resource.config_directory do
             user new_resource.user unless new_resource.user.nil?
@@ -284,7 +284,7 @@ class Chef
         end
       end
 
-      action :remove do
+      action :remove, description: "Remove a client.rb config file" do
         file ::File.join(new_resource.config_directory, "client.rb") do
           action :delete
         end

data/lib/chef/resource/chef_client_cron.rb

@@ -131,11 +131,11 @@ class Chef
         description: "The path to the #{ChefUtils::Dist::Infra::CLIENT} binary."
 
       property :daemon_options, Array,
-        default: lazy { [] },
+        default: [],
         description: "An array of options to pass to the #{ChefUtils::Dist::Infra::CLIENT} command."
 
       property :environment, Hash,
-        default: lazy { {} },
+        default: {},
         description: "A Hash containing additional arbitrary environment variables under which the cron job will be run in the form of `({'ENV_VARIABLE' => 'VALUE'})`."
 
       property :nice, [Integer, String],
@@ -144,7 +144,7 @@ class Chef
         coerce: proc { |x| Integer(x) },
         callbacks: { "should be an Integer between -20 and 19" => proc { |v| v >= -20 && v <= 19 } }
 
-      action :add do
+      action :add, description: "Add a cron job to run #{ChefUtils::Dist::Infra::PRODUCT}" do
         # TODO: Replace this with a :create_if_missing action on directory when that exists
         unless ::Dir.exist?(new_resource.log_directory)
           directory new_resource.log_directory do
@@ -168,7 +168,7 @@ class Chef
         end
       end
 
-      action :remove do
+      action :remove, description: "Remove a cron job for #{ChefUtils::Dist::Infra::PRODUCT}" do
         declare_resource(cron_resource_type, new_resource.job_name) do
           action :delete
         end

data/lib/chef/resource/chef_client_launchd.rb

@@ -23,7 +23,7 @@ class Chef
 
       provides :chef_client_launchd
 
-      description "Use the **chef_client_launchd** resource to configure the #{ChefUtils::Dist::Infra::PRODUCT} to run on a schedule."
+      description "Use the **chef_client_launchd** resource to configure the #{ChefUtils::Dist::Infra::PRODUCT} to run on a schedule on macOS systems."
       introduced "16.5"
       examples <<~DOC
         **Set the #{ChefUtils::Dist::Infra::PRODUCT} to run on a schedule**:
@@ -86,11 +86,11 @@ class Chef
 
       property :daemon_options, Array,
         description: "An array of options to pass to the #{ChefUtils::Dist::Infra::CLIENT} command.",
-        default: lazy { [] }
+        default: []
 
       property :environment, Hash,
         description: "A Hash containing additional arbitrary environment variables under which the launchd daemon will be run in the form of `({'ENV_VARIABLE' => 'VALUE'})`.",
-        default: lazy { {} }
+        default: {}
 
       property :nice, [Integer, String],
         description: "The process priority to run the #{ChefUtils::Dist::Infra::CLIENT} process at. A value of -20 is the highest priority and 19 is the lowest priority.",

data/lib/chef/resource/chef_client_scheduled_task.rb

@@ -127,7 +127,7 @@ class Chef
 
       property :daemon_options, Array,
         description: "An array of options to pass to the #{ChefUtils::Dist::Infra::CLIENT} command.",
-        default: lazy { [] }
+        default: []
 
       action :add do
         # TODO: Replace this with a :create_if_missing action on directory when that exists

data/lib/chef/resource/chef_client_systemd_timer.rb

@@ -92,11 +92,11 @@ class Chef
 
       property :daemon_options, Array,
         description: "An array of options to pass to the #{ChefUtils::Dist::Infra::CLIENT} command.",
-        default: lazy { [] }
+        default: []
 
       property :environment, Hash,
         description: "A Hash containing additional arbitrary environment variables under which the systemd timer will be run in the form of `({'ENV_VARIABLE' => 'VALUE'})`.",
-        default: lazy { {} }
+        default: {}
 
       property :cpu_quota, [Integer, String],
         description: "The systemd CPUQuota to run the #{ChefUtils::Dist::Infra::CLIENT} process with. This is a percentage value of the total CPU time available on the system. If the system has more than 1 core this may be a value greater than 100.",

data/lib/chef/resource/chef_client_trusted_certificate.rb

@@ -75,7 +75,6 @@ class Chef
         file cert_path do
           content new_resource.certificate
           mode "0640"
-          sensitive new_resource.sensitive
         end
       end
 

data/lib/chef/resource/chef_handler.rb

@@ -182,7 +182,7 @@ class Chef
 
       property :arguments, [Array, Hash],
         description: "Arguments to pass the handler's class initializer.",
-        default: lazy { [] }
+        default: []
 
       property :type, Hash,
         description: "The type of handler to register as, i.e. :report, :exception or both.",
@@ -194,9 +194,7 @@ class Chef
 
       # This action needs to find an rb file that presumably contains the indicated class in it and the
       # load that file. It then instantiates that class by name and registers it as a handler.
-      action :enable do
-        description "Enables the handler for the current #{ChefUtils::Dist::Infra::PRODUCT} run on the current node"
-
+      action :enable, description: "Enables the handler for the current #{ChefUtils::Dist::Infra::PRODUCT} run on the current node" do
         class_name = new_resource.class_name
         new_resource.type.each do |type, enable|
           next unless enable
@@ -218,9 +216,7 @@ class Chef
         end
       end
 
-      action :disable do
-        description "Disables the handler for the current #{ChefUtils::Dist::Infra::PRODUCT} run on the current node"
-
+      action :disable, description: "Disables the handler for the current #{ChefUtils::Dist::Infra::PRODUCT} run on the current node" do
         new_resource.type.each_key do |type|
           unregister_handler(type, new_resource.class_name)
         end

data/lib/chef/resource/chef_sleep.rb

@@ -62,7 +62,7 @@ class Chef
         coerce: proc { |s| Integer(s) },
         name_property: true
 
-      action :sleep do
+      action :sleep, description: "Pause the #{ChefUtils::Dist::Infra::PRODUCT} run for a specified number of seconds" do
         converge_by("sleep #{new_resource.seconds} seconds") do
           sleep(new_resource.seconds)
         end

data/lib/chef/resource/chef_vault_secret.rb

@@ -88,8 +88,7 @@ class Chef
 
       end
 
-      action :create do
-        description "Creates the item, or updates it if it already exists."
+      action :create, description: "Creates the item, or updates it if it already exists." do
 
         converge_if_changed do
           item = ChefVault::Item.new(new_resource.data_bag, new_resource.id)
@@ -111,15 +110,11 @@ class Chef
         end
       end
 
-      action :create_if_missing do
-        description "Calls the create action unless it exists."
-
+      action :create_if_missing, description: "Calls the create action unless it exists." do
         action_create if current_resource.nil?
       end
 
-      action :delete do
-        description "Deletes the item and the item's keys ('id'_keys)."
-
+      action :delete, description: "Deletes the item and the item's keys ('id'_keys)." do
         chef_data_bag_item new_resource.id do
           data_bag new_resource.data_bag
           action :delete

data/lib/chef/resource/chocolatey_config.rb

@@ -68,9 +68,7 @@ class Chef
         data ? data.attribute("value").to_s : nil # REXML just returns nil if it can't find anything so avoid an undefined method error
       end
 
-      action :set do
-        description "Sets a Chocolatey config value."
-
+      action :set, description: "Sets a Chocolatey config value." do
         raise "#{new_resource}: When adding a Chocolatey config you must pass the 'value' property!" unless new_resource.value
 
         converge_if_changed do
@@ -78,9 +76,7 @@ class Chef
         end
       end
 
-      action :unset do
-        description "Unsets a Chocolatey config value."
-
+      action :unset, description: "Unsets a Chocolatey config value." do
         if current_resource
           converge_by("unset Chocolatey config '#{new_resource.config_key}'") do
             shell_out!(choco_cmd("unset"))

data/lib/chef/resource/chocolatey_feature.rb

@@ -65,9 +65,7 @@ class Chef
         data ? data.attribute("enabled").to_s : nil # REXML just returns nil if it can't find anything so avoid an undefined method error
       end
 
-      action :enable do
-        description "Enables a named Chocolatey feature."
-
+      action :enable, description: "Enables a named Chocolatey feature" do
         if current_resource.feature_state != true
           converge_by("enable Chocolatey feature '#{new_resource.feature_name}'") do
             shell_out!(choco_cmd("enable"))
@@ -75,9 +73,7 @@ class Chef
         end
       end
 
-      action :disable do
-        description "Disables a named Chocolatey feature."
-
+      action :disable, description: "Disables a named Chocolatey feature" do
         if current_resource.feature_state == true
           converge_by("disable Chocolatey feature '#{new_resource.feature_name}'") do
             shell_out!(choco_cmd("disable"))

data/lib/chef/resource/chocolatey_source.rb

@@ -89,8 +89,7 @@ class Chef
         data ? data.attributes : nil # REXML just returns nil if it can't find anything so avoid an undefined method error
       end
 
-      action :add do
-        description "Adds a Chocolatey source."
+      action :add, description: "Adds a Chocolatey source" do
 
         raise "#{new_resource}: When adding a Chocolatey source you must pass the 'source' property!" unless new_resource.source
 
@@ -99,8 +98,7 @@ class Chef
         end
       end
 
-      action :remove do
-        description "Removes a Chocolatey source."
+      action :remove, description: "Removes a Chocolatey source" do
 
         if current_resource
           converge_by("remove Chocolatey source '#{new_resource.source_name}'") do
@@ -109,9 +107,7 @@ class Chef
         end
       end
 
-      action :disable do
-        description "Disables a Chocolatey source."
-
+      action :disable, description: "Disables a Chocolatey source. **New in Chef Infra Client 15.1.**" do
         if current_resource.disabled != true
           converge_by("disable Chocolatey source '#{new_resource.source_name}'") do
             shell_out!(choco_cmd("disable"))
@@ -119,9 +115,7 @@ class Chef
         end
       end
 
-      action :enable do
-        description "Enables a Chocolatey source."
-
+      action :enable, description: "Enables a Chocolatey source. **New in Chef Infra Client 15.1.**" do
         if current_resource.disabled == true
           converge_by("enable Chocolatey source '#{new_resource.source_name}'") do
             shell_out!(choco_cmd("enable"))

data/lib/chef/resource/cron/_cron_shared.rb

@@ -61,7 +61,7 @@ property :user, String,
 
 property :environment, Hash,
   description: "A Hash containing additional arbitrary environment variables under which the cron job will be run in the form of `({'ENV_VARIABLE' => 'VALUE'})`. **Note**: These variables must exist for a command to be run successfully.",
-  default: lazy { {} }
+  default: {}
 
 property :time_out, Hash,
   description: "A Hash of timeouts in the form of `({'OPTION' => 'VALUE'})`. Accepted valid options are:
@@ -69,7 +69,7 @@ property :time_out, Hash,
   - `foreground` (BOOL, default: 'false'),
   - `kill-after` (in seconds),
   - `signal` (a name like 'HUP' or a number)",
-  default: lazy { {} },
+  default: {},
   introduced: "15.7",
   coerce: proc { |h|
     if h.is_a?(Hash)

data/lib/chef/resource/cron_access.rb

@@ -64,8 +64,7 @@ class Chef
           "default" => "/etc",
       }.freeze
 
-      action :allow do
-        description "Add the user to the cron.allow file."
+      action :allow, description: "Add the user to the cron.allow file" do
         allow_path = ::File.join(value_for_platform_family(CRON_PATHS), "cron.allow")
 
         with_run_context :root do
@@ -81,8 +80,7 @@ class Chef
         end
       end
 
-      action :deny do
-        description "Add the user to the cron.deny file."
+      action :deny, description: "Add the user to the cron.deny file." do
         deny_path = ::File.join(value_for_platform_family(CRON_PATHS), "cron.deny")
 
         with_run_context :root do

data/lib/chef/resource/dmg_package.rb

@@ -121,9 +121,7 @@ class Chef
         end
       end
 
-      action :install do
-        description "Installs the application."
-
+      action :install, description: "Installs the application" do
         if current_resource.nil?
           if new_resource.source
             remote_file dmg_file do
@@ -171,13 +169,11 @@ class Chef
       action_class do
         # @return [String] the path to the dmg file
         def dmg_file
-          @dmg_file ||= begin
-            if new_resource.file.nil?
-              "#{Chef::Config[:file_cache_path]}/#{new_resource.dmg_name}.dmg"
-            else
-              new_resource.file
-            end
-          end
+          @dmg_file ||= if new_resource.file.nil?
+                          "#{Chef::Config[:file_cache_path]}/#{new_resource.dmg_name}.dmg"
+                        else
+                          new_resource.file
+                        end
         end
 
         # @return [String] the hdiutil flag for handling DMGs with a password

data/lib/chef/resource/dpkg_package.rb

@@ -36,7 +36,7 @@ class Chef
 
       property :response_file_variables, Hash,
         description: "A Hash of response file variables in the form of {'VARIABLE' => 'VALUE'}.",
-        default: lazy { {} }, desired_state: false
+        default: {}, desired_state: false
     end
   end
 end

data/lib/chef/resource/execute.rb

@@ -572,6 +572,10 @@ class Chef
         introduced: "16.2",
         description: "An optional property to set the input sent to the command as STDIN."
 
+      property :login, [ TrueClass, FalseClass ], default: false,
+        introduced: "17.0",
+        description: "Use a login shell to run the commands instead of inheriting the existing execution environment."
+
       alias :env :environment
 
       def self.set_guard_inherited_attributes(*inherited_attributes)
@@ -666,7 +670,8 @@ class Chef
         :group,
         :password,
         :user,
-        :umask
+        :umask,
+        :login
       )
 
     end

data/lib/chef/resource/file.rb

@@ -81,7 +81,7 @@ class Chef
       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, #{ChefUtils::Dist::Infra::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, #{ChefUtils::Dist::Infra::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 { [] }
+      property :verifications, Array, default: lazy { [] }, desired_state: false, skip_docs: true
 
       def verify(command = nil, opts = {}, &block)
         unless command.nil? || [String, Symbol].include?(command.class)

data/lib/chef/resource/group.rb

@@ -37,11 +37,11 @@ class Chef
       property :gid, [ String, Integer ],
         description: "The identifier for the group."
 
-      property :members, [String, Array], default: lazy { [] },
+      property :members, [String, Array], default: [],
                coerce: proc { |arg| arg.is_a?(String) ? arg.split(/\s*,\s*/) : arg },
                description: "Which users should be set or appended to a group. When more than one group member is identified, the list of members should be an array: members ['user1', 'user2']."
 
-      property :excluded_members, [String, Array], default: lazy { [] },
+      property :excluded_members, [String, Array], default: [],
                coerce: proc { |arg| arg.is_a?(String) ? arg.split(/\s*,\s*/) : arg },
                description: "Remove users from a group. May only be used when append is set to true."
 

data/lib/chef/resource/homebrew_cask.rb

@@ -34,7 +34,7 @@ class Chef
 
       property :cask_name, String,
         description: "An optional property to set the cask name if it differs from the resource block's name.",
-        regex: %r{^[\w/\-@]+$},
+        regex: %r{^[\w/-]+$},
         validation_message: "The provided Homebrew cask name is not valid. Cask names can contain alphanumeric characters, _, -, or / only!",
         name_property: true
 
@@ -53,13 +53,8 @@ class Chef
         description: "The owner of the Homebrew installation.",
         default: lazy { find_homebrew_username }
 
-      action :install do
-        if new_resource.install_cask
-          homebrew_tap "homebrew/cask" do
-            homebrew_path new_resource.homebrew_path
-            owner new_resource.owner
-          end
-        end
+      action :install, description: "Install an application packaged as a Homebrew cask" do
+        homebrew_tap "homebrew/cask" if new_resource.install_cask
 
         unless casked?
           converge_by("install cask #{new_resource.cask_name} #{new_resource.options}") do
@@ -71,13 +66,8 @@ class Chef
         end
       end
 
-      action :remove do
-        if new_resource.install_cask
-          homebrew_tap "homebrew/cask" do
-            homebrew_path new_resource.homebrew_path
-            owner new_resource.owner
-          end
-        end
+      action :remove, description: "Remove an application packaged as a Homebrew cask" do
+        homebrew_tap "homebrew/cask" if new_resource.install_cask
 
         if casked?
           converge_by("uninstall cask #{new_resource.cask_name}") do

data/lib/chef/resource/homebrew_tap.rb

@@ -53,9 +53,7 @@ class Chef
         description: "The owner of the Homebrew installation.",
         default: lazy { find_homebrew_username }
 
-      action :tap do
-        description "Add a Homebrew tap."
-
+      action :tap, description: "Add a Homebrew tap" do
         unless tapped?(new_resource.tap_name)
           converge_by("tap #{new_resource.tap_name}") do
             shell_out!("#{new_resource.homebrew_path} tap #{new_resource.full ? "--full" : ""} #{new_resource.tap_name} #{new_resource.url || ""}",
@@ -66,9 +64,7 @@ class Chef
         end
       end
 
-      action :untap do
-        description "Remove a Homebrew tap."
-
+      action :untap, description: "Remove a Homebrew tap" do
         if tapped?(new_resource.tap_name)
           converge_by("untap #{new_resource.tap_name}") do
             shell_out!("#{new_resource.homebrew_path} untap #{new_resource.tap_name}",