chef 17.1.35 → 17.2.29

data/lib/chef/node.rb

@@ -687,6 +687,25 @@ class Chef
       name <=> other.name
     end
 
+    # Returns hash of node data with attributes based on whitelist/blacklist rules.
+    def data_for_save
+      data = for_json
+      %w{automatic default normal override}.each do |level|
+        allowlist = allowlist_or_whitelist_config(level)
+        unless allowlist.nil? # nil => save everything
+          logger.info("Allowing #{level} node attributes for save.")
+          data[level] = Chef::AttributeAllowlist.filter(data[level], allowlist)
+        end
+
+        blocklist = blocklist_or_blacklist_config(level)
+        unless blocklist.nil? # nil => remove nothing
+          logger.info("Blocking #{level} node attributes for save")
+          data[level] = Chef::AttributeBlocklist.filter(data[level], blocklist)
+        end
+      end
+      data
+    end
+
     private
 
     def save_without_policyfile_attrs
@@ -712,7 +731,7 @@ class Chef
     # @param [String] level the attribute level
     def allowlist_or_whitelist_config(level)
       if Chef::Config["#{level}_attribute_whitelist".to_sym]
-        Chef.deprecated(:attribute_blacklist_configuration, "Attribute whitelist configurations have been deprecated. Use the allowed_LEVEL_attribute configs instead")
+        Chef.deprecated(:attribute_whitelist_configuration, "Attribute whitelist configurations have been deprecated. Use the allowed_LEVEL_attribute configs instead")
         Chef::Config["#{level}_attribute_whitelist".to_sym]
       else
         Chef::Config["allowed_#{level}_attributes".to_sym]
@@ -732,24 +751,6 @@ class Chef
       end
     end
 
-    def data_for_save
-      data = for_json
-      %w{automatic default normal override}.each do |level|
-        allowlist = allowlist_or_whitelist_config(level)
-        unless allowlist.nil? # nil => save everything
-          logger.info("Allowing #{level} node attributes for save.")
-          data[level] = Chef::AttributeAllowlist.filter(data[level], allowlist)
-        end
-
-        blocklist = blocklist_or_blacklist_config(level)
-        unless blocklist.nil? # nil => remove nothing
-          logger.info("Blocking #{level} node attributes for save")
-          data[level] = Chef::AttributeBlocklist.filter(data[level], blocklist)
-        end
-      end
-      data
-    end
-
     # Returns a UUID that uniquely identifies this node for reporting reasons.
     #
     # The node is read in from disk if it exists, or it's generated if it does

data/lib/chef/provider/support/zypper_repo.erb

@@ -1,15 +1,17 @@
-# This file was generated by Chef
+# This file was generated by Chef Infra
 # Do NOT modify this file by hand.
 
 [<%= @config.repo_name %>]
 <% %w{ type enabled autorefresh gpgcheck gpgkey baseurl mirrorlist path priority keeppackages mode refresh_cache }.each do |prop| -%>
-<%  next if @config.send(prop.to_sym).nil? -%>
+<%  next if @config.send(prop.to_sym).nil? || (@config.send(prop.to_sym).is_a?(Array) && @config.send(prop.to_sym).empty?) -%>
 <%= prop %>=<%=
        case @config.send(prop.to_sym)
        when TrueClass
          '1'
        when FalseClass
          '0'
+       when Array
+         @config.send(prop.to_sym).join("\n       ")
        else
          @config.send(prop.to_sym)
        end %>

data/lib/chef/provider/zypper_repository.rb

@@ -31,12 +31,12 @@ class Chef
 
       action :create do
         if new_resource.gpgautoimportkeys
-          install_gpg_key(new_resource.gpgkey)
+          install_gpg_keys(new_resource.gpgkey)
         else
           logger.debug("'gpgautoimportkeys' property is set to false. Skipping key import.")
         end
 
-        declare_resource(:template, "/etc/zypp/repos.d/#{escaped_repo_name}.repo") do
+        template "/etc/zypp/repos.d/#{escaped_repo_name}.repo" do
           if template_available?(new_resource.source)
             source new_resource.source
           else
@@ -51,13 +51,13 @@ class Chef
       end
 
       action :delete do
-        declare_resource(:execute, "zypper --quiet --non-interactive removerepo #{escaped_repo_name}") do
+        execute "zypper --quiet --non-interactive removerepo #{escaped_repo_name}" do
           only_if "zypper --quiet lr #{escaped_repo_name}"
         end
       end
 
       action :refresh do
-        declare_resource(:execute, "zypper --quiet --non-interactive refresh --force #{escaped_repo_name}") do
+        execute "zypper --quiet --non-interactive refresh --force #{escaped_repo_name}" do
           only_if "zypper --quiet lr #{escaped_repo_name}"
         end
       end
@@ -68,15 +68,7 @@ class Chef
       # zypper repos are allowed to have spaces in the names
       # @return [String] escaped repo string
       def escaped_repo_name
-        Shellwords.escape(new_resource.repo_name)
-      end
-
-      # return the specified cookbook name or the cookbook containing the
-      # resource.
-      #
-      # @return [String] name of the cookbook
-      def cookbook_name
-        new_resource.cookbook || new_resource.cookbook_name
+        @escaped_repo_name ||= Shellwords.escape(new_resource.repo_name)
       end
 
       # determine if a template file is available in the current run
@@ -84,7 +76,7 @@ class Chef
       #
       # @return [Boolean] template file exists or doesn't
       def template_available?(path)
-        !path.nil? && run_context.has_template_in_cookbook?(cookbook_name, path)
+        !path.nil? && run_context.has_template_in_cookbook?(new_resource.cookbook, path)
       end
 
       # determine if a cookbook file is available in the run
@@ -92,7 +84,7 @@ class Chef
       #
       # @return [Boolean] cookbook file exists or doesn't
       def has_cookbook_file?(fn)
-        run_context.has_cookbook_file_in_cookbook?(cookbook_name, fn)
+        run_context.has_cookbook_file_in_cookbook?(new_resource.cookbook, fn)
       end
 
       # Given the provided key URI determine what kind of chef resource we need
@@ -158,27 +150,31 @@ class Chef
         short_key_id
       end
 
-      # install the provided gpg key
-      # @param [String] uri the uri of the local or remote gpg key
-      def install_gpg_key(uri)
-        unless uri
-          logger.debug("'gpgkey' property not provided or set to nil. Skipping key import.")
+      # install the provided gpg keys
+      # @param [String] uris the uri of the local or remote gpg key
+      def install_gpg_keys(uris)
+        if uris.empty?
+          logger.debug("'gpgkey' property not provided or set. Skipping gpg key import.")
           return
         end
 
-        cached_keyfile = ::File.join(Chef::Config[:file_cache_path], uri.split("/")[-1])
+        # fetch each key to the cache dir either from the cookbook or by downloading it
+        # and then import the key
+        uris.each do |uri|
+          cached_keyfile = ::File.join(Chef::Config[:file_cache_path], uri.split("/")[-1])
 
-        declare_resource(key_type(new_resource.gpgkey), cached_keyfile) do
-          source uri
-          mode "0644"
-          sensitive new_resource.sensitive
-          action :create
-        end
+          declare_resource(key_type(uri), cached_keyfile) do
+            source uri
+            mode "0644"
+            sensitive new_resource.sensitive
+            action :create
+          end
 
-        declare_resource(:execute, "import gpg key from #{new_resource.gpgkey}") do
-          command "/bin/rpm --import #{cached_keyfile}"
-          not_if { key_installed?(cached_keyfile) }
-          action :run
+          execute "import gpg key from #{uri}" do
+            command "/bin/rpm --import #{cached_keyfile}"
+            not_if { key_installed?(cached_keyfile) }
+            action :run
+          end
         end
       end
     end

data/lib/chef/resource/alternatives.rb

@@ -122,7 +122,7 @@ class Chef
         end
       end
 
-      action :install, description: "Install an alternative on the system including symlinks" 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, description: "Set the symlink for an alternative" 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, description: "Remove an alternative and all associated links" 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, description: "Set an alternative up in automatic mode with the highest priority automatically selected" 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, description: "Refresh alternatives" 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_preference.rb

@@ -91,7 +91,7 @@ class Chef
         end
       end
 
-      action :add, description: "Creates a preferences file under `/etc/apt/preferences.d`" 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, description: "Removes the preferences file, thus unpinning the package" 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

@@ -409,7 +409,7 @@ class Chef
         end
       end
 
-      action :add, description: "Creates a repository file at `/etc/apt/sources.list.d/` and builds the repository listing" 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, description: "Removes the repository listing" do
+      action :remove, description: "Removes the repository listing." do
         return unless debian?
 
         cleanup_legacy_file!

data/lib/chef/resource/apt_update.rb

@@ -33,8 +33,8 @@ class Chef
 
         ```ruby
         apt_update 'all platforms' do
-        frequency 86400
-        action :periodic
+          frequency 86400
+          action :periodic
         end
         ```
 
@@ -86,7 +86,7 @@ class Chef
         end
       end
 
-      action :periodic, description: "Update the Apt repository at the interval specified by the `frequency` property" 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?
@@ -96,7 +96,7 @@ class Chef
         end
       end
 
-      action :update, description: "Update the Apt repository at the start of a #{ChefUtils::Dist::Infra::PRODUCT} run" 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/build_essential.rb

@@ -57,7 +57,7 @@ class Chef
         introduced: "15.5",
         default: false, desired_state: false # FIXME: make this default to true
 
-      action :install, description: "Install build essential packages" do
+      action :install, description: "Install build essential packages." do
         case
         when debian?
           package %w{ autoconf binutils-doc bison build-essential flex gettext ncurses-dev }

data/lib/chef/resource/chef_client_config.rb

@@ -139,7 +139,7 @@ class Chef
         DESC
 
       property :formatters, Array,
-        description: "",
+        description: "Client logging formatters to load.",
         default: []
 
       property :event_loggers, Array,
@@ -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, description: "Create a client.rb config file" do
+      action :create, description: "Create a client.rb config file for configuring #{ChefUtils::Dist::Infra::PRODUCT}." 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, description: "Remove a client.rb config file" do
+      action :remove, description: "Remove a client.rb config file for configuring #{ChefUtils::Dist::Infra::PRODUCT}." do
         file ::File.join(new_resource.config_directory, "client.rb") do
           action :delete
         end

data/lib/chef/resource/chef_client_cron.rb

@@ -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, description: "Add a cron job to run #{ChefUtils::Dist::Infra::PRODUCT}" 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, description: "Remove a cron job for #{ChefUtils::Dist::Infra::PRODUCT}" 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

@@ -101,7 +101,7 @@ class Chef
         description: "Run the #{ChefUtils::Dist::Infra::CLIENT} process with low priority disk IO",
         default: true
 
-      action :enable do
+      action :enable, description: "Enable running #{ChefUtils::Dist::Infra::PRODUCT} on a schedule using launchd." do
         unless ::Dir.exist?(new_resource.log_directory)
           directory new_resource.log_directory do
             owner new_resource.user
@@ -148,7 +148,7 @@ class Chef
         end
       end
 
-      action :disable do
+      action :disable, description: "Disable running #{ChefUtils::Dist::Infra::PRODUCT} on a schedule using launchd" do
         service ChefUtils::Dist::Infra::PRODUCT do
           service_name "com.#{ChefUtils::Dist::Infra::SHORT}.#{ChefUtils::Dist::Infra::CLIENT}"
           action :disable

data/lib/chef/resource/chef_client_scheduled_task.rb

@@ -30,33 +30,33 @@ class Chef
       **Setup #{ChefUtils::Dist::Infra::PRODUCT} to run using the default 30 minute cadence**:
 
       ```ruby
-        chef_client_scheduled_task 'Run #{ChefUtils::Dist::Infra::PRODUCT} as a scheduled task'
+      chef_client_scheduled_task 'Run #{ChefUtils::Dist::Infra::PRODUCT} as a scheduled task'
       ```
 
       **Run #{ChefUtils::Dist::Infra::PRODUCT} on system start**:
 
       ```ruby
-        chef_client_scheduled_task '#{ChefUtils::Dist::Infra::PRODUCT} on start' do
-          frequency 'onstart'
-        end
+      chef_client_scheduled_task '#{ChefUtils::Dist::Infra::PRODUCT} on start' do
+        frequency 'onstart'
+      end
       ```
 
       **Run #{ChefUtils::Dist::Infra::PRODUCT} with extra options passed to the client**:
 
       ```ruby
-        chef_client_scheduled_task 'Run an override recipe' do
-          daemon_options ['--override-runlist mycorp_base::default']
-        end
+      chef_client_scheduled_task 'Run an override recipe' do
+        daemon_options ['--override-runlist mycorp_base::default']
+      end
       ```
 
       **Run #{ChefUtils::Dist::Infra::PRODUCT} daily at 01:00 am, specifying a named run-list**:
 
       ```ruby
-        chef_client_scheduled_task 'Run chef-client named run-list daily' do
-          frequency 'daily'
-          start_time '01:00'
-          daemon_options ['-n audit_only']
-        end
+      chef_client_scheduled_task 'Run chef-client named run-list daily' do
+        frequency 'daily'
+        start_time '01:00'
+        daemon_options ['-n audit_only']
+      end
       ```
       DOC
 
@@ -129,7 +129,7 @@ class Chef
         description: "An array of options to pass to the #{ChefUtils::Dist::Infra::CLIENT} command.",
         default: []
 
-      action :add do
+      action :add, description: "Add a Windows Scheduled Task that runs #{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
@@ -157,7 +157,7 @@ class Chef
         end
       end
 
-      action :remove do
+      action :remove, description: "Remove a Windows Scheduled Task that runs #{ChefUtils::Dist::Infra::PRODUCT}." do
         windows_task new_resource.task_name do
           action :delete
         end

data/lib/chef/resource/chef_client_systemd_timer.rb

@@ -104,7 +104,7 @@ class Chef
         coerce: proc { |x| Integer(x) },
         callbacks: { "should be a positive Integer" => proc { |v| v > 0 } }
 
-      action :add do
+      action :add, description: "Add a systemd timer that runs #{ChefUtils::Dist::Infra::PRODUCT}." do
         systemd_unit "#{new_resource.job_name}.service" do
           content service_content
           action :create
@@ -116,7 +116,7 @@ class Chef
         end
       end
 
-      action :remove do
+      action :remove, description: "Remove a systemd timer that runs #{ChefUtils::Dist::Infra::PRODUCT}." do
         systemd_unit "#{new_resource.job_name}.service" do
           action :delete
         end