chef 16.18.30-universal-mingw32 → 17.0.242-universal-mingw32

data/lib/chef/provider/user/mac.rb

@@ -29,13 +29,12 @@ class Chef
     class User
       # A macOS user provider that is compatible with default TCC restrictions
       # in macOS 10.14. See resource/user/mac_user.rb for complete description
-      # of the mac_user resource and how it differs from the dscl resource used
-      # on previous platforms.
+      # of the mac_user resource
       class MacUser < Chef::Provider::User
         include Chef::Mixin::Which
 
         provides :mac_user
-        provides :user, os: "darwin", platform_version: ">= 10.14"
+        provides :user, os: "darwin"
 
         attr_reader :user_plist, :admin_group_plist
 
@@ -394,23 +393,21 @@ class Chef
         # associated group resource. If a group exists we'll modify it, otherwise
         # create it.
         def user_group_info
-          @user_group_info ||= begin
-            if new_resource.gid.is_a?(String)
-              begin
-                g = Etc.getgrnam(new_resource.gid)
-                [g.name, g.gid.to_s, :modify]
-              rescue
-                [new_resource.gid, nil, :create]
-              end
-            else
-              begin
-                g = Etc.getgrgid(new_resource.gid)
-                [g.name, g.gid.to_s, :modify]
-              rescue
-                [g.username, nil, :create]
-              end
-            end
-          end
+          @user_group_info ||= if new_resource.gid.is_a?(String)
+                                 begin
+                                   g = Etc.getgrnam(new_resource.gid)
+                                   [g.name, g.gid.to_s, :modify]
+                                 rescue
+                                   [new_resource.gid, nil, :create]
+                                 end
+                               else
+                                 begin
+                                   g = Etc.getgrgid(new_resource.gid)
+                                   [g.name, g.gid.to_s, :modify]
+                                 rescue
+                                   [g.username, nil, :create]
+                                 end
+                               end
         end
 
         def secure_token_enabled?

data/lib/chef/provider/user/pw.rb

@@ -97,7 +97,7 @@ class Chef
             command = "pw usermod #{new_resource.username} -H 0"
             shell_out!(command, input: new_resource.password.to_s)
           else
-            logger.trace("#{new_resource} no change needed to password")
+            logger.debug("#{new_resource} no change needed to password")
           end
         end
       end

data/lib/chef/provider/user/windows.rb

@@ -62,7 +62,7 @@ class Chef
         # <false>:: If the users are identical
         def compare_user
           @change_desc = []
-          unless @net_user.validate_credentials(new_resource.password)
+          if new_resource.password && !@net_user.validate_credentials(new_resource.password)
             @change_desc << "update password"
           end
 

data/lib/chef/provider/user.rb

@@ -172,7 +172,7 @@ class Chef
             logger.info("#{new_resource} locked")
           end
         else
-          logger.trace("#{new_resource} already locked - nothing to do")
+          logger.debug("#{new_resource} already locked - nothing to do")
         end
       end
 
@@ -183,7 +183,7 @@ class Chef
             logger.info("#{new_resource} unlocked")
           end
         else
-          logger.trace("#{new_resource} already unlocked - nothing to do")
+          logger.debug("#{new_resource} already unlocked - nothing to do")
         end
       end
 

data/lib/chef/provider/zypper_repository.rb

@@ -33,7 +33,7 @@ class Chef
         if new_resource.gpgautoimportkeys
           install_gpg_key(new_resource.gpgkey)
         else
-          logger.trace("'gpgautoimportkeys' property is set to false. Skipping key import.")
+          logger.debug("'gpgautoimportkeys' property is set to false. Skipping key import.")
         end
 
         declare_resource(:template, "/etc/zypp/repos.d/#{escaped_repo_name}.repo") do
@@ -162,7 +162,7 @@ class Chef
       # @param [String] uri the uri of the local or remote gpg key
       def install_gpg_key(uri)
         unless uri
-          logger.trace("'gpgkey' property not provided or set to nil. Skipping key import.")
+          logger.debug("'gpgkey' property not provided or set to nil. Skipping key import.")
           return
         end
 

data/lib/chef/provider.rb

@@ -435,7 +435,7 @@ class Chef
       # this block cannot interact with resources outside, e.g.,
       # manipulating notifies.
 
-      converge_by ("evaluate block and run any associated actions") do
+      converge_by("evaluate block and run any associated actions") do
         saved_run_context = run_context
         begin
           @run_context = run_context.create_child

data/lib/chef/providers.rb

@@ -94,7 +94,6 @@ require_relative "provider/service/aixinit"
 require_relative "provider/service/aix"
 
 require_relative "provider/user/aix"
-require_relative "provider/user/dscl"
 require_relative "provider/user/linux"
 require_relative "provider/user/mac"
 require_relative "provider/user/pw"

data/lib/chef/resource/alternatives.rb

@@ -26,7 +26,7 @@ class Chef
 
       provides(:alternatives) { true }
 
-      description "The alternatives resource allows for configuration of command alternatives in Linux using the alternatives or update-alternatives packages."
+      description "Use the **alternatives** resource to configure command alternatives in Linux using the alternatives or update-alternatives packages."
       introduced "16.0"
       examples <<~DOC
       **Install an alternative**:
@@ -122,7 +122,7 @@ class Chef
         end
       end
 
-      action :install do
+      action :install, description: "Install an alternative on the system including symlinks" do
         if path_priority != new_resource.priority
           converge_by("adding alternative #{new_resource.link} #{new_resource.link_name} #{new_resource.path} #{new_resource.priority}") do
             output = shell_out(alternatives_cmd, "--install", new_resource.link, new_resource.link_name, new_resource.path, new_resource.priority)
@@ -133,7 +133,7 @@ class Chef
         end
       end
 
-      action :set do
+      action :set, description: "Set the symlink for an alternative" do
         if current_path != new_resource.path
           converge_by("setting alternative #{new_resource.link_name} #{new_resource.path}") do
             output = shell_out(alternatives_cmd, "--set", new_resource.link_name, new_resource.path)
@@ -144,7 +144,7 @@ class Chef
         end
       end
 
-      action :remove do
+      action :remove, description: "Remove an alternative and all associated links" do
         if path_exists?
           converge_by("removing alternative #{new_resource.link_name} #{new_resource.path}") do
             shell_out(alternatives_cmd, "--remove", new_resource.link_name, new_resource.path)
@@ -152,13 +152,13 @@ class Chef
         end
       end
 
-      action :auto do
+      action :auto, description: "Set an alternative up in automatic mode with the highest priority automatically selected" do
         converge_by("setting auto alternative #{new_resource.link_name}") do
           shell_out(alternatives_cmd, "--auto", new_resource.link_name)
         end
       end
 
-      action :refresh do
+      action :refresh, description: "Refresh alternatives" do
         converge_by("refreshing alternative #{new_resource.link_name}") do
           shell_out(alternatives_cmd, "--refresh", new_resource.link_name)
         end

data/lib/chef/resource/apt_package.rb

@@ -72,7 +72,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

data/lib/chef/resource/apt_preference.rb

@@ -91,7 +91,7 @@ class Chef
         end
       end
 
-      action :add do
+      action :add, description: "Creates a preferences file under `/etc/apt/preferences.d`" do
         return unless debian?
 
         preference = build_pref(
@@ -130,7 +130,7 @@ class Chef
         end
       end
 
-      action :remove do
+      action :remove, description: "Removes the preferences file, thus unpinning the package" do
         return unless debian?
 
         sanitized_prefname = safe_name(new_resource.package_name)

data/lib/chef/resource/apt_repository.rb

@@ -36,7 +36,7 @@ class Chef
       examples <<~DOC
         **Add repository with basic settings**:
 
-         ```ruby
+        ```ruby
         apt_repository 'nginx' do
           uri        'http://nginx.org/packages/ubuntu/'
           components ['nginx']
@@ -128,7 +128,7 @@ class Chef
 
       property :components, Array,
         description: "Package groupings, such as 'main' and 'stable'.",
-        default: lazy { [] }, default_description: "`main` if using a PPA repository."
+        default: [], default_description: "`main` if using a PPA repository."
 
       property :arch, [String, nil, FalseClass],
         description: "Constrain packages to a particular CPU architecture such as `i386` or `amd64`."
@@ -147,7 +147,7 @@ class Chef
 
       property :key, [String, Array, nil, FalseClass],
         description: "If a keyserver is provided, this is assumed to be the fingerprint; otherwise it can be either the URI of GPG key for the repo, or a cookbook_file.",
-        default: lazy { [] }, coerce: proc { |x| x ? Array(x) : x }
+        default: [], coerce: proc { |x| x ? Array(x) : x }
 
       property :key_proxy, [String, nil, FalseClass],
         description: "If set, a specified proxy is passed to GPG via `http-proxy=`."
@@ -409,7 +409,7 @@ class Chef
         end
       end
 
-      action :add do
+      action :add, description: "Creates a repository file at `/etc/apt/sources.list.d/` and builds the repository listing" do
         return unless debian?
 
         execute "apt-cache gencaches" do
@@ -459,7 +459,7 @@ class Chef
         end
       end
 
-      action :remove do
+      action :remove, description: "Removes the repository listing" do
         return unless debian?
 
         cleanup_legacy_file!
@@ -477,7 +477,7 @@ class Chef
             end
           end
         else
-          logger.trace("/etc/apt/sources.list.d/#{new_resource.repo_name}.list does not exist. Nothing to do")
+          logger.debug("/etc/apt/sources.list.d/#{new_resource.repo_name}.list does not exist. Nothing to do")
         end
       end
 

data/lib/chef/resource/apt_update.rb

@@ -17,6 +17,7 @@
 #
 
 require_relative "../resource"
+require "chef-utils/dist" unless defined?(ChefUtils::Dist)
 
 class Chef
   class Resource
@@ -85,7 +86,7 @@ class Chef
         end
       end
 
-      action :periodic do
+      action :periodic, description: "Update the Apt repository at the interval specified by the `frequency` property" do
         return unless debian?
 
         unless apt_up_to_date?
@@ -95,7 +96,7 @@ class Chef
         end
       end
 
-      action :update do
+      action :update, description: "Update the Apt repository at the start of a #{ChefUtils::Dist::Infra::PRODUCT} run" do
         return unless debian?
 
         converge_by "force update new lists of packages" do

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)