chef 12.10.24 → 12.11.18

data/lib/chef/knife/cookbook_site_install.rb

@@ -141,10 +141,15 @@ class Chef
 
       def extract_cookbook(upstream_file, version)
         ui.info("Uncompressing #{@cookbook_name} version #{version}.")
-        # FIXME: Detect if we have the bad tar from git on Windows: https://github.com/opscode/chef/issues/1753
         extract_command = "tar zxvf \"#{convert_path upstream_file}\""
         if Chef::Platform.windows?
-          extract_command << " --force-local"
+          tar_version = shell_out("tar --version").stdout.tr("\n", " ")
+          if tar_version =~ /GNU tar/
+            Chef::Log.debug("GNU tar detected, adding --force-local")
+            extract_command << " --force-local"
+          else
+            Chef::Log.debug("non-GNU tar detected, not adding --force-local")
+          end
         end
         shell_out!(extract_command, :cwd => @install_path)
       end

data/lib/chef/knife/help_topics.rb

@@ -1,4 +1,4 @@
-# Do not edit this file by hand
-# This file is autogenerated by the docs:list rake task from the available manpages
-
-HELP_TOPICS = ["chef-shell", "knife-bootstrap", "knife-client", "knife-configure", "knife-cookbook-site", "knife-cookbook", "knife-data-bag", "knife-delete", "knife-deps", "knife-diff", "knife-download", "knife-edit", "knife-environment", "knife-exec", "knife-index-rebuild", "knife-list", "knife-node", "knife-raw", "knife-recipe-list", "knife-role", "knife-search", "knife-show", "knife-ssh", "knife-status", "knife-tag", "knife-upload", "knife-user", "knife-xargs", "knife"]
+# Do not edit this file by hand
+# This file is autogenerated by the docs:list rake task from the available manpages
+
+HELP_TOPICS = ["chef-shell", "knife-bootstrap", "knife-client", "knife-configure", "knife-cookbook-site", "knife-cookbook", "knife-data-bag", "knife-delete", "knife-deps", "knife-diff", "knife-download", "knife-edit", "knife-environment", "knife-exec", "knife-index-rebuild", "knife-list", "knife-node", "knife-raw", "knife-recipe-list", "knife-role", "knife-search", "knife-show", "knife-ssh", "knife-status", "knife-tag", "knife-upload", "knife-user", "knife-xargs", "knife"]

data/lib/chef/knife/list.rb

@@ -44,7 +44,6 @@ class Chef
         patterns = name_args.length == 0 ? [""] : name_args
 
         # Get the top-level matches
-        args = pattern_args_from(patterns)
         all_results = parallelize(pattern_args_from(patterns)) do |pattern|
           pattern_results = Chef::ChefFS::FileSystem.list(config[:local] ? local_fs : chef_fs, pattern).to_a
 
@@ -95,7 +94,7 @@ class Chef
             printed_something = true
           end
           output "#{format_path(result)}:"
-          print_results(children.map { |result| maybe_add_slash(result.name, result.dir?) }.sort, "")
+          print_results(children.map { |result| maybe_add_slash(result.display_name, result.dir?) }.sort, "")
         end
 
         exit self.exit_code if self.exit_code

data/lib/chef/knife/ssl_check.rb

@@ -257,7 +257,8 @@ ADVICE
 
       def trusted_certificates
         if configuration.trusted_certs_dir && Dir.exist?(configuration.trusted_certs_dir)
-          Dir.glob(File.join(configuration.trusted_certs_dir, "*.{crt,pem}"))
+          glob_dir = ChefConfig::PathHelper.escape_glob_dir(configuration.trusted_certs_dir)
+          Dir.glob(File.join(glob_dir, "*.{crt,pem}"))
         else
           []
         end

data/lib/chef/monkey_patches/win32/registry.rb

@@ -22,6 +22,17 @@ require "win32/registry"
 module Win32
   class Registry
 
+    # ::Win32::Registry#export_string is used when enumerating child
+    # keys and values and re encodes a UTF-16LE to the local codepage.
+    # This can result in encoding incompatibilities if the native codepage
+    # does not support the characters in the registry. There is an open bug
+    # in ruby at https://bugs.ruby-lang.org/issues/11410. Rather than converting
+    # the UTF-16LE originally returned by the win32 api, we encode to UTF-8
+    # which will likely not result in any conversion error.
+    def export_string(str, enc = Encoding.default_internal || "utf-8")
+      str.encode(enc)
+    end
+
     module API
 
       extend Chef::ReservedNames::Win32::API::Registry

data/lib/chef/nil_argument.rb

@@ -1,3 +1,3 @@
-class Chef
-  NIL_ARGUMENT = Object.new
-end
+class Chef
+  NIL_ARGUMENT = Object.new
+end

data/lib/chef/node.rb

@@ -25,7 +25,7 @@ require "chef/mixin/params_validate"
 require "chef/mixin/from_file"
 require "chef/mixin/deep_merge"
 require "chef/dsl/include_attribute"
-require "chef/dsl/platform_introspection"
+require "chef/dsl/universal"
 require "chef/environment"
 require "chef/server_api"
 require "chef/run_list"
@@ -58,7 +58,7 @@ class Chef
 
     include Chef::Mixin::FromFile
     include Chef::DSL::IncludeAttribute
-    include Chef::DSL::PlatformIntrospection
+    include Chef::DSL::Universal
 
     include Chef::Mixin::ParamsValidate
 

data/lib/chef/platform/rebooter.rb

@@ -19,6 +19,7 @@
 require "chef/dsl/reboot_pending"
 require "chef/log"
 require "chef/platform"
+require "chef/application/exit_code"
 
 class Chef
   class Platform
@@ -27,6 +28,8 @@ class Chef
 
       class << self
 
+        include Chef::DSL::RebootPending
+
         def reboot!(node)
           reboot_info = node.run_context.reboot_info
 
@@ -38,8 +41,16 @@ class Chef
                   "shutdown -r +#{reboot_info[:delay_mins]} \"#{reboot_info[:reason]}\""
                 end
 
-          Chef::Log.warn "Rebooting server at a recipe's request. Details: #{reboot_info.inspect}"
-          shell_out!(cmd)
+          msg = "Rebooting server at a recipe's request. Details: #{reboot_info.inspect}"
+          begin
+            Chef::Log.warn msg
+            shell_out!(cmd)
+          rescue Mixlib::ShellOut::ShellCommandFailed => e
+            raise Chef::Exceptions::RebootFailed.new(e.message)
+          end
+
+          raise Chef::Exceptions::Reboot.new(msg) if Chef::Application::ExitCode.enforce_rfc_062_exit_codes?
+          Chef::Application::ExitCode.notify_reboot_exit_code_deprecation
         end
 
         # this is a wrapper function so Chef::Client only needs a single line of code.

data/lib/chef/policy_builder/dynamic.rb

@@ -66,7 +66,7 @@ class Chef
         Chef::Log.debug("Building node object for #{node_name}")
 
         @node =
-          if Chef::Config[:solo]
+          if Chef::Config[:solo_legacy_mode]
             Chef::Node.build(node_name)
           else
             Chef::Node.find_or_create(node_name)

data/lib/chef/policy_builder/expand_node_object.rb

@@ -69,7 +69,7 @@ class Chef
       end
 
       def setup_run_context(specific_recipes = nil)
-        if Chef::Config[:solo]
+        if Chef::Config[:solo_legacy_mode]
           Chef::Cookbook::FileVendor.fetch_from_disk(Chef::Config[:cookbook_path])
           cl = Chef::CookbookLoader.new(Chef::Config[:cookbook_path])
           cl.load_cookbooks
@@ -118,7 +118,7 @@ class Chef
         Chef::Log.debug("Building node object for #{node_name}")
 
         @node =
-          if Chef::Config[:solo]
+          if Chef::Config[:solo_legacy_mode]
             Chef::Node.build(node_name)
           else
             Chef::Node.find_or_create(node_name)
@@ -167,7 +167,7 @@ class Chef
 
       # Expands the node's run list. Stores the run_list_expansion object for later use.
       def expand_run_list
-        @run_list_expansion = if Chef::Config[:solo]
+        @run_list_expansion = if Chef::Config[:solo_legacy_mode]
                                 node.expand!("disk")
                               else
                                 node.expand!("server")

data/lib/chef/policy_builder/policyfile.rb

@@ -68,7 +68,7 @@ class Chef
 
         @node = nil
 
-        if Chef::Config[:solo]
+        if Chef::Config[:solo_legacy_mode]
           raise UnsupportedFeature, "Policyfile does not support chef-solo. Use chef-client local mode instead."
         end
 

data/lib/chef/provider/git.rb

@@ -25,8 +25,11 @@ class Chef
   class Provider
     class Git < Chef::Provider
 
+      extend Forwardable
       provides :git
 
+      def_delegator :@new_resource, :destination, :cwd
+
       def whyrun_supported?
         true
       end
@@ -42,11 +45,11 @@ class Chef
       def define_resource_requirements
         # Parent directory of the target must exist.
         requirements.assert(:checkout, :sync) do |a|
-          dirname = ::File.dirname(@new_resource.destination)
+          dirname = ::File.dirname(cwd)
           a.assertion { ::File.directory?(dirname) }
           a.whyrun("Directory #{dirname} does not exist, this run will fail unless it has been previously created. Assuming it would have been created.")
           a.failure_message(Chef::Exceptions::MissingParentDirectory,
-            "Cannot clone #{@new_resource} to #{@new_resource.destination}, the enclosing directory #{dirname} does not exist")
+            "Cannot clone #{@new_resource} to #{cwd}, the enclosing directory #{dirname} does not exist")
         end
 
         requirements.assert(:all_actions) do |a|
@@ -79,14 +82,14 @@ class Chef
           enable_submodules
           add_remotes
         else
-          Chef::Log.debug "#{@new_resource} checkout destination #{@new_resource.destination} already exists or is a non-empty directory"
+          Chef::Log.debug "#{@new_resource} checkout destination #{cwd} already exists or is a non-empty directory"
         end
       end
 
       def action_export
         action_checkout
-        converge_by("complete the export by removing #{@new_resource.destination}.git after checkout") do
-          FileUtils.rm_rf(::File.join(@new_resource.destination, ".git"))
+        converge_by("complete the export by removing #{cwd}.git after checkout") do
+          FileUtils.rm_rf(::File.join(cwd, ".git"))
         end
       end
 
@@ -105,22 +108,22 @@ class Chef
       end
 
       def git_minor_version
-        @git_minor_version ||= Gem::Version.new(shell_out!("git --version", run_options).stdout.split.last)
+        @git_minor_version ||= Gem::Version.new( git("--version").stdout.split.last )
       end
 
       def existing_git_clone?
-        ::File.exist?(::File.join(@new_resource.destination, ".git"))
+        ::File.exist?(::File.join(cwd, ".git"))
       end
 
       def target_dir_non_existent_or_empty?
-        !::File.exist?(@new_resource.destination) || Dir.entries(@new_resource.destination).sort == [".", ".."]
+        !::File.exist?(cwd) || Dir.entries(cwd).sort == [".", ".."]
       end
 
       def find_current_revision
         Chef::Log.debug("#{@new_resource} finding current git revision")
         if ::File.exist?(::File.join(cwd, ".git"))
           # 128 is returned when we're not in a git repo. this is fine
-          result = shell_out!("git rev-parse HEAD", :cwd => cwd, :returns => [0, 128]).stdout.strip
+          result = git("rev-parse", "HEAD", cwd: cwd, returns: [0, 128]).stdout.strip
         end
         sha_hash?(result) ? result : nil
       end
@@ -137,18 +140,18 @@ class Chef
       end
 
       def clone
-        converge_by("clone from #{@new_resource.repository} into #{@new_resource.destination}") do
+        converge_by("clone from #{@new_resource.repository} into #{cwd}") do
           remote = @new_resource.remote
 
-          args = []
-          args << "-o #{remote}" unless remote == "origin"
-          args << "--depth #{@new_resource.depth}" if @new_resource.depth
-          args << "--no-single-branch" if @new_resource.depth && git_minor_version >= Gem::Version.new("1.7.10")
-
-          Chef::Log.info "#{@new_resource} cloning repo #{@new_resource.repository} to #{@new_resource.destination}"
+          clone_cmd = ["clone"]
+          clone_cmd << "-o #{remote}" unless remote == "origin"
+          clone_cmd << "--depth #{@new_resource.depth}" if @new_resource.depth
+          clone_cmd << "--no-single-branch" if @new_resource.depth && git_minor_version >= Gem::Version.new("1.7.10")
+          clone_cmd << "\"#{@new_resource.repository}\""
+          clone_cmd << "\"#{cwd}\""
 
-          clone_cmd = "git clone #{args.join(' ')} \"#{@new_resource.repository}\" \"#{@new_resource.destination}\""
-          shell_out!(clone_cmd, run_options)
+          Chef::Log.info "#{@new_resource} cloning repo #{@new_resource.repository} to #{cwd}"
+          git clone_cmd
         end
       end
 
@@ -157,8 +160,8 @@ class Chef
 
         converge_by("checkout ref #{sha_ref} branch #{@new_resource.revision}") do
           # checkout into a local branch rather than a detached HEAD
-          shell_out!("git branch -f #{@new_resource.checkout_branch} #{sha_ref}", run_options(:cwd => @new_resource.destination))
-          shell_out!("git checkout #{@new_resource.checkout_branch}", run_options(:cwd => @new_resource.destination))
+          git("branch", "-f", @new_resource.checkout_branch, sha_ref, cwd: cwd)
+          git("checkout", @new_resource.checkout_branch, cwd: cwd)
           Chef::Log.info "#{@new_resource} checked out branch: #{@new_resource.revision} onto: #{@new_resource.checkout_branch} reference: #{sha_ref}"
         end
       end
@@ -167,12 +170,10 @@ class Chef
         if @new_resource.enable_submodules
           converge_by("enable git submodules for #{@new_resource}") do
             Chef::Log.info "#{@new_resource} synchronizing git submodules"
-            command = "git submodule sync"
-            shell_out!(command, run_options(:cwd => @new_resource.destination))
+            git("submodule", "sync", cwd: cwd)
             Chef::Log.info "#{@new_resource} enabling git submodules"
             # the --recursive flag means we require git 1.6.5+ now, see CHEF-1827
-            command = "git submodule update --init --recursive"
-            shell_out!(command, run_options(:cwd => @new_resource.destination))
+            git("submodule", "update", "--init", "--recursive", cwd: cwd)
           end
         end
       end
@@ -181,17 +182,18 @@ class Chef
         setup_remote_tracking_branches(@new_resource.remote, @new_resource.repository)
         converge_by("fetch updates for #{@new_resource.remote}") do
           # since we're in a local branch already, just reset to specified revision rather than merge
-          fetch_command = "git fetch #{@new_resource.remote} && git fetch #{@new_resource.remote} --tags && git reset --hard #{target_revision}"
           Chef::Log.debug "Fetching updates from #{new_resource.remote} and resetting to revision #{target_revision}"
-          shell_out!(fetch_command, run_options(:cwd => @new_resource.destination))
+          git("fetch", @new_resource.remote, cwd: cwd)
+          git("fetch", @new_resource.remote, "--tags", cwd: cwd)
+          git("reset", "--hard", target_revision, cwd: cwd)
         end
       end
 
       def setup_remote_tracking_branches(remote_name, remote_url)
         converge_by("set up remote tracking branches for #{remote_url} at #{remote_name}") do
           Chef::Log.debug "#{@new_resource} configuring remote tracking branches for repository #{remote_url} " + "at remote #{remote_name}"
-          check_remote_command = "git config --get remote.#{remote_name}.url"
-          remote_status = shell_out!(check_remote_command, run_options(:cwd => @new_resource.destination, :returns => [0, 1, 2]))
+          check_remote_command = ["config", "--get", "remote.#{remote_name}.url"]
+          remote_status = git(check_remote_command, cwd: cwd, returns: [0, 1, 2])
           case remote_status.exitstatus
           when 0, 2
             # * Status 0 means that we already have a remote with this name, so we should update the url
@@ -200,12 +202,10 @@ class Chef
             #   which we can fix by replacing them all with our target url (hence the --replace-all option)
 
             if multiple_remotes?(remote_status) || !remote_matches?(remote_url, remote_status)
-              update_remote_url_command = "git config --replace-all remote.#{remote_name}.url #{remote_url}"
-              shell_out!(update_remote_url_command, run_options(:cwd => @new_resource.destination))
+              git("config", "--replace-all", "remote.#{remote_name}.url", remote_url, cwd: cwd)
             end
           when 1
-            add_remote_command = "git remote add #{remote_name} #{remote_url}"
-            shell_out!(add_remote_command, run_options(:cwd => @new_resource.destination))
+            git("remote", "add", remote_name, remote_url, cwd: cwd)
           end
         end
       end
@@ -282,8 +282,7 @@ class Chef
       end
 
       def git_ls_remote(rev_pattern)
-        command = git(%Q{ls-remote "#{@new_resource.repository}" "#{rev_pattern}"})
-        shell_out!(command, run_options).stdout
+        git("ls-remote", "\"#{@new_resource.repository}\"", "\"#{rev_pattern}\"").stdout
       end
 
       def refs_search(refs, pattern)
@@ -301,7 +300,12 @@ class Chef
           # user who is executing `git` not the user running Chef.
           env["HOME"] = begin
             require "etc"
-            Etc.getpwnam(@new_resource.user).dir
+            case @new_resource.user
+            when Integer
+              Etc.getpwuid(@new_resource.user).dir
+            else
+              Etc.getpwnam(@new_resource.user.to_s).dir
+            end
           rescue ArgumentError # user not found
             raise Chef::Exceptions::User, "Could not determine HOME for specified user '#{@new_resource.user}' for resource '#{@new_resource.name}'"
           end
@@ -315,12 +319,10 @@ class Chef
         run_opts
       end
 
-      def cwd
-        @new_resource.destination
-      end
-
-      def git(*args)
-        ["git", *args].compact.join(" ")
+      def git(*args, **run_opts)
+        git_command = ["git", args].compact.join(" ")
+        Chef::Log.debug "running #{git_command}"
+        shell_out!(git_command, run_options(run_opts))
       end
 
       def sha_hash?(string)

data/lib/chef/provider/lwrp_base.rb

@@ -34,7 +34,6 @@ class Chef
       # These were previously provided by Chef::Mixin::RecipeDefinitionDSLCore.
       # They are not included by its replacement, Chef::DSL::Recipe, but
       # they may be used in existing LWRPs.
-      include Chef::DSL::PlatformIntrospection
       include Chef::DSL::DataQuery
 
       # Allow include_recipe from within LWRP provider code

data/lib/chef/provider/osx_profile.rb

@@ -54,9 +54,8 @@ class Chef
             @new_resource.profile_name
         end
 
-        if all_profiles.empty?
-          current_profile = nil
-        else
+        current_profile = nil
+        if all_profiles && !all_profiles.empty?
           current_profile = all_profiles["_computerlevel"].find do |item|
             item["ProfileIdentifier"] == @new_profile_identifier
           end

data/lib/chef/provider/package.rb

@@ -22,6 +22,7 @@ require "chef/mixin/subclass_directive"
 require "chef/log"
 require "chef/file_cache"
 require "chef/platform"
+require "chef/decorator/lazy_array"
 
 class Chef
   class Provider
@@ -256,9 +257,41 @@ class Chef
         options ? " #{options}" : ""
       end
 
-      # this is public and overridden by subclasses (rubygems package implements '>=' and '~>' operators)
-      def target_version_already_installed?(current_version, new_version)
-        new_version == current_version
+      # Check the current_version against either the candidate_version or the new_version
+      #
+      # For some reason the windows provider subclasses this (to implement passing Arrays to
+      # versions for some reason other than multipackage stuff, which is mildly terrifying).
+      #
+      # This MUST have 'equality' semantics -- the exact thing matches the exact thing.
+      #
+      # The current_version should probably be dropped out of the method signature, it should
+      # always be the first argument.
+      #
+      # The name is not just bad, but i find it completely misleading, consider:
+      #
+      #    target_version_already_installed?(current_version, new_version)
+      #    target_version_already_installed?(current_version, candidate_version)
+      #
+      # which of those is the 'target_version'?  i'd say the new_version and i'm confused when
+      # i see it called with the candidate_version.
+      #
+      # `current_version_equals?(version)` would be a better name
+      def target_version_already_installed?(current_version, target_version)
+        return false unless current_version && target_version
+        current_version == target_version
+      end
+
+      # Check the current_version against the new_resource.version, possibly using fuzzy
+      # matching criteria.
+      #
+      # Subclasses MAY override this to provide fuzzy matching on the resource ('>=' and '~>' stuff)
+      #
+      # This should only ever be offered the same arguments (so they should most likely be
+      # removed from the method signature).
+      #
+      # `new_version_satisfied?()` might be a better name
+      def version_requirement_satisfied?(current_version, new_version)
+        target_version_already_installed?(current_version, new_version)
       end
 
       # @todo: extract apt/dpkg specific preseeding to a helper class
@@ -354,12 +387,15 @@ class Chef
             each_package do |package_name, new_version, current_version, candidate_version|
               case action
               when :upgrade
-
-                if !candidate_version
-                  Chef::Log.debug("#{new_resource} #{package_name} has no candidate_version to upgrade to")
+                if target_version_already_installed?(current_version, new_version)
+                  # this is an odd use case
+                  Chef::Log.debug("#{new_resource} #{package_name} #{new_version} is already installed -- you are equality pinning with an :upgrade action, this may be deprecated in the future")
                   target_version_array.push(nil)
-                elsif current_version == candidate_version
-                  Chef::Log.debug("#{new_resource} #{package_name} the #{candidate_version} is already installed")
+                elsif target_version_already_installed?(current_version, candidate_version)
+                  Chef::Log.debug("#{new_resource} #{package_name} #{candidate_version} is already installed")
+                  target_version_array.push(nil)
+                elsif candidate_version.nil?
+                  Chef::Log.debug("#{new_resource} #{package_name} has no candidate_version to upgrade to")
                   target_version_array.push(nil)
                 else
                   Chef::Log.debug("#{new_resource} #{package_name} is out of date, will upgrade to #{candidate_version}")
@@ -369,7 +405,7 @@ class Chef
               when :install
 
                 if new_version
-                  if target_version_already_installed?(current_version, new_version)
+                  if version_requirement_satisfied?(current_version, new_version)
                     Chef::Log.debug("#{new_resource} #{package_name} #{current_version} satisifies #{new_version} requirement")
                     target_version_array.push(nil)
                   else
@@ -411,7 +447,7 @@ class Chef
           begin
             missing = []
             each_package do |package_name, new_version, current_version, candidate_version|
-              missing.push(package_name) if candidate_version.nil? && current_version.nil?
+              missing.push(package_name) if current_version.nil? && candidate_version.nil?
             end
             missing
           end
@@ -436,7 +472,7 @@ class Chef
             missing = []
             each_package do |package_name, new_version, current_version, candidate_version|
               next if new_version.nil? || current_version.nil?
-              if candidate_version.nil? && !target_version_already_installed?(current_version, new_version)
+              if !version_requirement_satisfied?(current_version, new_version) && candidate_version.nil?
                 missing.push(package_name)
               end
             end
@@ -468,7 +504,9 @@ class Chef
 
       # @return [Array] candidate_version(s) as an array
       def candidate_version_array
-        [ candidate_version ].flatten
+        # NOTE: even with use_multipackage_api candidate_version may be a bare nil and need wrapping
+        # ( looking at you, dpkg provider... )
+        Chef::Decorator::LazyArray.new { [ candidate_version ].flatten }
       end
 
       # @return [Array] current_version(s) as an array
@@ -558,7 +596,7 @@ class Chef
       # @param args [String] variable number of string arguments
       # @return [String] nicely concatenated string or empty string
       def a_to_s(*args)
-        args.reject { |i| i.nil? || i == "" }.join(" ")
+        args.flatten.reject { |i| i.nil? || i == "" }.join(" ")
       end
     end
   end