chef 16.2.44 → 16.4.35

data/lib/chef/node/attribute.rb

@@ -563,11 +563,10 @@ class Chef
       # @param path [Array] Array of args to method chain to descend into the node object
       # @return [attr] Deep Merged values (may be VividMash, Hash, Array, etc) from the node object
       def merge_defaults(path)
-        ret = DEFAULT_COMPONENTS.inject(NIL) do |merged, component_ivar|
+        DEFAULT_COMPONENTS.inject(NIL) do |merged, component_ivar|
           component_value = apply_path(instance_variable_get(component_ivar), path)
           deep_merge!(merged, component_value)
         end
-        ret
       end
 
       # Deep merge the override attribute levels with array merging.
@@ -577,11 +576,10 @@ class Chef
       # @param path [Array] Array of args to method chain to descend into the node object
       # @return [attr] Deep Merged values (may be VividMash, Hash, Array, etc) from the node object
       def merge_overrides(path)
-        ret = OVERRIDE_COMPONENTS.inject(NIL) do |merged, component_ivar|
+        OVERRIDE_COMPONENTS.inject(NIL) do |merged, component_ivar|
           component_value = apply_path(instance_variable_get(component_ivar), path)
           deep_merge!(merged, component_value)
         end
-        ret
       end
 
       # needed for __path__

data/lib/chef/node_map.rb

@@ -35,10 +35,13 @@
 #
 # XXX: confusingly, in the *_priority_map the :klass may be an array of Strings of class names
 #
+
+require_relative "dist"
+
 class Chef
   class NodeMap
     COLLISION_WARNING = <<~EOH.gsub(/\s+/, " ").strip
-      %{type_caps} %{key} from the client is overriding the %{type} from a cookbook.  Please upgrade your cookbook
+      %{type_caps} %{key} built into %{client_name} is being overridden by the %{type} from a cookbook. Please upgrade your cookbook
         or remove the cookbook from your run_list.
     EOH
 
@@ -83,7 +86,7 @@ class Chef
                         else
                           klass.superclass.to_s
                         end
-        Chef::Log.warn( COLLISION_WARNING % { type: type_of_thing, key: key, type_caps: type_of_thing.capitalize } )
+        Chef::Log.warn( COLLISION_WARNING % { type: type_of_thing, key: key, type_caps: type_of_thing.capitalize, client_name: Chef::Dist::PRODUCT } )
       end
 
       # The map is sorted in order of preference already; we just need to find
@@ -209,7 +212,7 @@ class Chef
     # - no negative matches (!value)
     # - at least one positive match (value or :all), or no positive filters
     #
-    def matches_black_white_list?(node, filters, attribute)
+    def matches_block_allow_list?(node, filters, attribute)
       # It's super common for the filter to be nil.  Catch that so we don't
       # spend any time here.
       return true unless filters[attribute]
@@ -217,21 +220,21 @@ class Chef
       filter_values = Array(filters[attribute])
       value = node[attribute]
 
-      # Split the blacklist and whitelist
-      blacklist, whitelist = filter_values.partition { |v| v.is_a?(String) && v.start_with?("!") }
+      # Split the blocklist and allowlist
+      blocklist, allowlist = filter_values.partition { |v| v.is_a?(String) && v.start_with?("!") }
 
       if attribute == :platform_family
-        # If any blacklist value matches, we don't match
-        return false if blacklist.any? { |v| v[1..-1] == value || platform_family_query_helper?(node, v[1..-1]) }
+        # If any blocklist value matches, we don't match
+        return false if blocklist.any? { |v| v[1..-1] == value || platform_family_query_helper?(node, v[1..-1]) }
 
-        # If the whitelist is empty, or anything matches, we match.
-        whitelist.empty? || whitelist.any? { |v| v == :all || v == value || platform_family_query_helper?(node, v) }
+        # If the allowlist is empty, or anything matches, we match.
+        allowlist.empty? || allowlist.any? { |v| v == :all || v == value || platform_family_query_helper?(node, v) }
       else
-        # If any blacklist value matches, we don't match
-        return false if blacklist.any? { |v| v[1..-1] == value }
+        # If any blocklist value matches, we don't match
+        return false if blocklist.any? { |v| v[1..-1] == value }
 
-        # If the whitelist is empty, or anything matches, we match.
-        whitelist.empty? || whitelist.any? { |v| v == :all || v == value }
+        # If the allowlist is empty, or anything matches, we match.
+        allowlist.empty? || allowlist.any? { |v| v == :all || v == value }
       end
     end
 
@@ -260,9 +263,9 @@ class Chef
     end
 
     def filters_match?(node, filters)
-      matches_black_white_list?(node, filters, :os) &&
-        matches_black_white_list?(node, filters, :platform_family) &&
-        matches_black_white_list?(node, filters, :platform) &&
+      matches_block_allow_list?(node, filters, :os) &&
+        matches_block_allow_list?(node, filters, :platform_family) &&
+        matches_block_allow_list?(node, filters, :platform) &&
         matches_version_list?(node, filters, :platform_version) &&
         matches_target_mode?(filters)
     end
@@ -311,8 +314,8 @@ class Chef
       return -1 if !b && a
       return 0 if !a && !b
 
-      # Check for blacklists ('!windows'). Those always come *after* positive
-      # whitelists.
+      # Check for blocklists ('!windows'). Those always come *after* positive
+      # allowlists.
       a_negated = Array(a).any? { |f| f.is_a?(String) && f.start_with?("!") }
       b_negated = Array(b).any? { |f| f.is_a?(String) && f.start_with?("!") }
       return 1 if a_negated && !b_negated

data/lib/chef/platform/service_helpers.rb

@@ -17,38 +17,41 @@
 #
 
 require_relative "../chef_class"
-require "chef-utils" if defined?(ChefUtils::CANARY)
+require "chef-utils" unless defined?(ChefUtils::CANARY)
+require_relative "../mixin/chef_utils_wiring" unless defined?(Chef::Mixin::ChefUtilsWiring)
 
 class Chef
   class Platform
-    # @deprecated, use ChefUtils::DSL::Service instead (via the ChefUtils Universal DSL)
-    class ServiceHelpers
-      class << self
-        def service_resource_providers
-          providers = []
-
-          providers << :debian if ChefUtils::DSL::Service.debianrcd?
-          providers << :invokercd if ChefUtils::DSL::Service.invokercd?
-          providers << :upstart if ChefUtils::DSL::Service.upstart?
-          providers << :insserv if ChefUtils::DSL::Service.insserv?
-          providers << :systemd if ChefUtils.systemd?
-          providers << :redhat if ChefUtils::DSL::Service.redhatrcd?
-
-          providers
-        end
-
-        def config_for_service(service_name)
-          configs = []
-
-          configs << :initd if ChefUtils::DSL::Service.service_script_exist?(:initd, service_name)
-          configs << :upstart if ChefUtils::DSL::Service.service_script_exist?(:upstart, service_name)
-          configs << :xinetd if ChefUtils::DSL::Service.service_script_exist?(:xinetd, service_name)
-          configs << :systemd if ChefUtils::DSL::Service.service_script_exist?(:systemd, service_name)
-          configs << :etc_rcd if ChefUtils::DSL::Service.service_script_exist?(:etc_rcd, service_name)
-
-          configs
-        end
+    module ServiceHelpers
+      include ChefUtils::DSL::Service
+      include Chef::Mixin::ChefUtilsWiring
+
+      def service_resource_providers
+        providers = []
+
+        providers << :debian if debianrcd?
+        providers << :invokercd if invokercd?
+        providers << :upstart if upstart?
+        providers << :insserv if insserv?
+        providers << :systemd if systemd?
+        providers << :redhat if redhatrcd?
+
+        providers
+      end
+
+      def config_for_service(service_name)
+        configs = []
+
+        configs << :initd if service_script_exist?(:initd, service_name)
+        configs << :upstart if service_script_exist?(:upstart, service_name)
+        configs << :xinetd if service_script_exist?(:xinetd, service_name)
+        configs << :systemd if service_script_exist?(:systemd, service_name)
+        configs << :etc_rcd if service_script_exist?(:etc_rcd, service_name)
+
+        configs
       end
+
+      extend self
     end
   end
 end

data/lib/chef/property.rb

@@ -706,7 +706,7 @@ class Chef
       # As of this writing, `name` is the only Chef::Resource property created with the
       # `property` definition, but this will allow for future properties to be extended
       # as needed.
-      !Chef::Resource.properties.keys.include?(name)
+      !Chef::Resource.properties.key?(name)
     end
 
     def exec_in_resource(resource, proc, *args)

data/lib/chef/provider/cron/unix.rb

@@ -26,8 +26,6 @@ class Chef
   class Provider
     class Cron
       class Unix < Chef::Provider::Cron
-        include Chef::Mixin::ShellOut
-
         provides :cron, os: "solaris2"
 
         private

data/lib/chef/provider/git.rb

@@ -44,11 +44,11 @@ class Chef
         unless new_resource.user.nil?
           requirements.assert(:all_actions) do |a|
             a.assertion do
-              begin
-                get_homedir(new_resource.user)
-              rescue ArgumentError
-                false
-              end
+
+              get_homedir(new_resource.user)
+            rescue ArgumentError
+              false
+
             end
             a.whyrun("User #{new_resource.user} does not exist, this run will fail unless it has been previously created. Assuming it would have been created.")
             a.failure_message(Chef::Exceptions::User, "#{new_resource.user} required by resource #{new_resource.name} does not exist")
@@ -154,6 +154,11 @@ class Chef
         sha_hash?(result) ? result : nil
       end
 
+      def already_on_target_branch?
+        current_branch = git("rev-parse", "--abbrev-ref", "HEAD", cwd: cwd, returns: [0, 128]).stdout.strip
+        current_branch == (new_resource.checkout_branch || new_resource.revision)
+      end
+
       def add_remotes
         if new_resource.additional_remotes.length > 0
           new_resource.additional_remotes.each_pair do |remote_name, remote_url|
@@ -193,6 +198,9 @@ class Chef
             # detached head
             git("checkout", target_revision, cwd: cwd)
             logger.info "#{new_resource} checked out reference: #{target_revision}"
+          elsif already_on_target_branch?
+            # we are already on the proper branch
+            git("reset", "--hard", target_revision, cwd: cwd)
           else
             # need a branch with a tracking branch
             git("branch", "-f", new_resource.revision, target_revision, cwd: cwd)
@@ -222,13 +230,13 @@ class Chef
           logger.trace "Fetching updates from #{new_resource.remote} and resetting to revision #{target_revision}"
           git("fetch", "--prune", new_resource.remote, cwd: cwd)
           git("fetch", new_resource.remote, "--tags", cwd: cwd)
-          if new_resource.checkout_branch
+          if sha_hash?(new_resource.revision) || is_tag? || already_on_target_branch?
+            # detached head or if we are already on the proper branch
+            git("reset", "--hard", target_revision, cwd: cwd)
+          elsif new_resource.checkout_branch
             # check out to a local branch
             git("branch", "-f", new_resource.checkout_branch, target_revision, cwd: cwd)
             git("checkout", new_resource.checkout_branch, cwd: cwd)
-          elsif sha_hash?(new_resource.revision) || is_tag?
-            # detached head
-            git("reset", "--hard", target_revision, cwd: cwd)
           else
             # need a branch with a tracking branch
             git("branch", "-f", new_resource.revision, target_revision, cwd: cwd)

data/lib/chef/provider/group.rb

@@ -17,13 +17,11 @@
 #
 
 require_relative "../provider"
-require_relative "../mixin/shell_out"
 require "etc" unless defined?(Etc)
 
 class Chef
   class Provider
     class Group < Chef::Provider
-      include Chef::Mixin::ShellOut
       attr_accessor :group_exists
       attr_accessor :change_desc
 

data/lib/chef/provider/group/suse.rb

@@ -39,11 +39,11 @@ class Chef
 
           requirements.assert(:create, :manage, :modify) do |a|
             a.assertion do
-              begin
-                to_add(new_resource.members).all? { |member| Etc.getpwnam(member) }
-              rescue
-                false
-              end
+
+              to_add(new_resource.members).all? { |member| Etc.getpwnam(member) }
+            rescue
+              false
+
             end
             a.failure_message Chef::Exceptions::Group, "Could not add users #{to_add(new_resource.members).join(", ")} to #{new_resource.group_name}: one of these users does not exist"
             a.whyrun "Could not find one of these users: #{to_add(new_resource.members).join(", ")}. Assuming it will be created by a prior step"

data/lib/chef/provider/ifconfig.rb

@@ -17,11 +17,10 @@
 #
 
 require_relative "../log"
-require_relative "../mixin/shell_out"
 require_relative "../provider"
 require_relative "../resource/file"
 require_relative "../exceptions"
-require "erb"
+require "erb" unless defined?(Erb)
 
 class Chef
   class Provider
@@ -34,8 +33,6 @@ class Chef
     class Ifconfig < Chef::Provider
       provides :ifconfig
 
-      include Chef::Mixin::ShellOut
-
       attr_accessor :config_template
       attr_accessor :config_path
 

data/lib/chef/provider/mount.rb

@@ -18,13 +18,11 @@
 #
 
 require_relative "../log"
-require_relative "../mixin/shell_out"
 require_relative "../provider"
 
 class Chef
   class Provider
     class Mount < Chef::Provider
-      include Chef::Mixin::ShellOut
 
       attr_accessor :unmount_retries
 

data/lib/chef/provider/mount/solaris.rb

@@ -1,4 +1,3 @@
-# Encoding: utf-8
 # Author:: Hugo Fichter
 # Author:: Lamont Granquist (<lamont@chef.io>)
 # Author:: Joshua Timberman (<joshua@chef.io>)

data/lib/chef/provider/package.rb

@@ -16,7 +16,6 @@
 # limitations under the License.
 #
 
-require_relative "../mixin/shell_out"
 require_relative "../mixin/subclass_directive"
 require_relative "../log"
 require_relative "../file_cache"
@@ -27,7 +26,6 @@ require "shellwords" unless defined?(Shellwords)
 class Chef
   class Provider
     class Package < Chef::Provider
-      include Chef::Mixin::ShellOut
       extend Chef::Mixin::SubclassDirective
 
       # subclasses declare this if they want all their arguments as arrays of packages and names

data/lib/chef/provider/package/rubygems.rb

@@ -188,7 +188,7 @@ class Chef
                 # Use the API that 'gem install' calls which does not pull down the rubygems universe
                 begin
                   rs = dependency_installer.resolve_dependencies gem_dependency.name, gem_dependency.requirement
-                  rs.specs.select { |s| s.name == gem_dependency.name }.first
+                  rs.specs.find { |s| s.name == gem_dependency.name }
                 rescue Gem::UnsatisfiableDependencyError
                   nil
                 end

data/lib/chef/provider/package/snap.rb

@@ -20,7 +20,7 @@ require_relative "../package"
 require_relative "../../resource/snap_package"
 require_relative "../../mixin/shell_out"
 require "socket" unless defined?(Socket)
-require "json"
+require "json" unless defined?(JSON)
 
 class Chef
   class Provider
@@ -137,7 +137,7 @@ class Chef
 
           # while it is expected to allow clients to connect using https over
           # a tcp socket, at this point only a unix socket is supported. the
-          # socket is /run/snapd.socket note - unix socket is not defined on
+          # socket is /run/snapd.socket note - UNIXSocket is not defined on
           # windows systems
           if defined?(::UNIXSocket)
             UNIXSocket.open("/run/snapd.socket") do |socket|
@@ -304,7 +304,7 @@ class Chef
             SNAP_OPTION
           end
 
-          multipart_form_data = <<~SNAP_S
+          <<~SNAP_S
             Host:
             Content-Type: multipart/form-data; boundary=#{snap_name}
             Content-Length: #{content_length}
@@ -320,7 +320,6 @@ class Chef
             <#{content_length} bytes of snap file data>
             --#{snap_name}
           SNAP_S
-          multipart_form_data
         end
 
         # Constructs json to post for snap changes

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

@@ -242,22 +242,27 @@ class Chef
         end
 
         def download_source_file
+          source_resource.run_action(:create)
+          logger.trace("#{new_resource} fetched source file to #{default_download_cache_path}")
+        end
+
+        def source_resource
           # It seems correct that this is a build_resource rather than declare_resource/DSL use since updating should not trigger a notification
           # unless the downloaded file is actually installed.  The case where the remote_file downloads the package but the package is already
           # installed on the target should not trigger a notification since the running state did not change.
-          build_resource(:remote_file, default_download_cache_path) do
+          @source_resource ||= build_resource(:remote_file, default_download_cache_path) do
             source(new_resource.source)
             cookbook_name = new_resource.cookbook_name
             checksum(new_resource.checksum)
             backup(false)
 
+            # since the source_resource can mutate here, we save off the @source_resource so we can inspect the actual state later
             if new_resource.remote_file_attributes
               new_resource.remote_file_attributes.each do |(k, v)|
                 send(k.to_sym, v)
               end
             end
-          end.run_action(:create)
-          logger.trace("#{new_resource} fetched source file to #{default_download_cache_path}")
+          end
         end
 
         def default_download_cache_path
@@ -271,7 +276,7 @@ class Chef
           if new_resource.source.nil?
             nil
           elsif uri_scheme?(new_resource.source)
-            default_download_cache_path
+            source_resource.path
           else
             new_source = Chef::Util::PathHelper.cleanpath(new_resource.source)
             ::File.exist?(new_source) ? new_source : nil

data/lib/chef/provider/package/windows/registry_uninstall_entry.rb

@@ -37,16 +37,16 @@ class Chef
               begin
                 ::Win32::Registry.open(hkey[0], UNINSTALL_SUBKEY, desired) do |reg|
                   reg.each_key do |key, _wtime|
-                    begin
-                      entry = reg.open(key, desired)
-                      display_name = read_registry_property(entry, "DisplayName")
-                      if display_name.to_s.rstrip == package_name
-                        quiet_uninstall_string = RegistryUninstallEntry.read_registry_property(entry, "QuietUninstallString")
-                        entries.push(quiet_uninstall_string_key?(quiet_uninstall_string, hkey, key, entry))
-                      end
-                    rescue ::Win32::Registry::Error => ex
-                      logger.trace("Registry error opening key '#{key}' on node #{desired}: #{ex}")
+
+                    entry = reg.open(key, desired)
+                    display_name = read_registry_property(entry, "DisplayName")
+                    if display_name.to_s.rstrip == package_name
+                      quiet_uninstall_string = RegistryUninstallEntry.read_registry_property(entry, "QuietUninstallString")
+                      entries.push(quiet_uninstall_string_key?(quiet_uninstall_string, hkey, key, entry))
                     end
+                  rescue ::Win32::Registry::Error => ex
+                    logger.trace("Registry error opening key '#{key}' on node #{desired}: #{ex}")
+
                   end
                 end
               rescue ::Win32::Registry::Error => ex