chef 16.18.30 → 17.10.163

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

@@ -0,0 +1,168 @@
+#
+# Copyright:: Chef Software Inc.
+#
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+require_relative "../../http/simple"
+require_relative "../../json_compat"
+require_relative "../../exceptions"
+require_relative "../package"
+# Bring in needed shared methods
+
+class Chef
+  class Provider
+    class Package
+      class Habitat < Chef::Provider::Package
+        use_multipackage_api
+        use "../../resource/habitat/habitat_shared"
+        provides :habitat_package
+
+        def load_current_resource
+          @current_resource = Chef::Resource::HabitatPackage.new(new_resource.name)
+          current_resource.package_name(strip_version(new_resource.package_name))
+
+          @candidate_version = candidate_versions
+          current_resource.version(current_versions)
+
+          current_resource
+        end
+
+        def install_package(names, versions)
+          names.zip(versions).map do |n, v|
+            opts = ["pkg", "install", "--channel", new_resource.channel, "--url", new_resource.bldr_url]
+            opts += ["--auth", new_resource.auth_token] if new_resource.auth_token
+            opts += ["#{strip_version(n)}/#{v}", new_resource.options]
+            opts += ["--binlink"] if new_resource.binlink
+            opts += ["--force"] if new_resource.binlink.eql? :force
+            hab(opts)
+          end
+        end
+
+        alias_method :upgrade_package, :install_package
+
+        def remove_package(names, versions)
+          # raise 'It is too dangerous to :remove packages with the habitat_package resource right now. This functionality should be deferred to the hab cli.'
+          names.zip(versions).map do |n, v|
+            opts = %w{pkg uninstall}
+            opts += ["--keep-latest", new_resource.keep_latest ] if new_resource.keep_latest
+            opts += ["#{strip_version(n).chomp("/")}#{v}", new_resource.options]
+            opts += ["--exclude"] if new_resource.exclude
+            opts += ["--no-deps"] if new_resource.no_deps
+            hab(opts)
+            # action :remove
+          end
+        end
+
+        alias_method :purge_package, :remove_package
+
+        private
+
+        def validate_name!(name)
+          raise ArgumentError, "package name must be specified as 'origin/name', use the 'version' property to specify a version" unless name.squeeze("/").count("/") < 2
+        end
+
+        def strip_version(name)
+          validate_name!(name)
+          n = name.squeeze("/").chomp("/").sub(%r{^\/}, "")
+          n = n[0..(n.rindex("/") - 1)] while n.count("/") >= 2
+          n
+        end
+
+        def platform_target
+          if windows?
+            "target=x86_64-windows"
+          elsif node["kernel"]["release"].to_i < 3
+            "target=x86_64-linux-kernel2"
+          else
+            ""
+          end
+        end
+
+        def depot_package(name, version = nil)
+          @depot_package ||= {}
+          @depot_package[name] ||=
+            begin
+              origin, pkg_name = name.split("/")
+              name_version = [pkg_name, version].compact.join("/").squeeze("/").chomp("/").sub(%r{^\/}, "")
+              url = if new_resource.bldr_url.include?("/v1/")
+                      "#{new_resource.bldr_url.chomp("/")}/depot/channels/#{origin}/#{new_resource.channel}/pkgs/#{name_version}"
+                    else
+                      "#{new_resource.bldr_url.chomp("/")}/v1/depot/channels/#{origin}/#{new_resource.channel}/pkgs/#{name_version}"
+                    end
+              url << "/latest" unless name_version.count("/") >= 2
+              url << "?#{platform_target}" unless platform_target.empty?
+
+              headers = {}
+              headers["Authorization"] = "Bearer #{new_resource.auth_token}" if new_resource.auth_token
+
+              Chef::JSONCompat.parse(http.get(url, headers))
+            rescue Net::HTTPClientException
+              nil
+            end
+        end
+
+        def package_version(name, version = nil)
+          p = depot_package(name, version)
+          "#{p["ident"]["version"]}/#{p["ident"]["release"]}" unless p.nil?
+        end
+
+        def http
+          # FIXME: use SimpleJSON when the depot mime-type is fixed
+          @http ||= Chef::HTTP::Simple.new(new_resource.bldr_url.to_s)
+        end
+
+        def candidate_versions
+          package_name_array.zip(new_version_array).map do |n, v|
+            package_version(n, v)
+          end
+        end
+
+        def current_versions
+          package_name_array.map do |n|
+            installed_version(n)
+          end
+        end
+
+        def installed_version(ident)
+          hab("pkg", "path", ident).stdout.chomp.split(windows? ? "\\" : "/")[-2..-1].join("/")
+        rescue Mixlib::ShellOut::ShellCommandFailed
+          nil
+        end
+
+        # This is used by the superclass Chef::Provider::Package
+        def version_requirement_satisfied?(current_version, new_version)
+          return false if new_version.nil? || current_version.nil?
+
+          nv_parts = new_version.squeeze("/").split("/")
+
+          if nv_parts.count < 2
+            current_version.squeeze("/").split("/")[0] == new_version.squeeze("/")
+          else
+            current_version.squeeze("/") == new_resource.version.squeeze("/")
+          end
+        end
+
+        # This is used by the superclass Chef::Provider::Package
+        def version_compare(v1, v2)
+          require "mixlib/versioning" unless defined?(Mixlib::Versioning)
+          # Convert the package version (X.Y.Z/DATE) into a version that Mixlib::Versioning understands (X.Y.Z+DATE)
+          hab_v1 = Mixlib::Versioning.parse(v1.tr("/", "+"))
+          hab_v2 = Mixlib::Versioning.parse(v2.tr("/", "+"))
+          hab_v1 <=> hab_v2
+        end
+      end
+    end
+  end
+end

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

@@ -28,13 +28,13 @@ class Chef
         provides :package, platform: "gentoo"
         provides :portage_package
 
-        PACKAGE_NAME_PATTERN = %r{(?:([^/]+)/)?([^/]+)}.freeze
+        PACKAGE_NAME_PATTERN = %r{^(?:([^/]+)/)?([^/]+)$}.freeze
 
         def load_current_resource
           @current_resource = Chef::Resource::PortagePackage.new(new_resource.name)
           current_resource.package_name(new_resource.package_name)
 
-          category, pkg = /^#{PACKAGE_NAME_PATTERN}$/.match(new_resource.package_name)[1, 2]
+          category, pkg = PACKAGE_NAME_PATTERN.match(new_resource.package_name)[1, 2]
 
           globsafe_category = category ? Chef::Util::PathHelper.escape_glob_dir(category) : nil
           globsafe_pkg = Chef::Util::PathHelper.escape_glob_dir(pkg)

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

@@ -17,13 +17,13 @@
 
 require_relative "../package"
 require_relative "../../resource/powershell_package"
-require_relative "../../mixin/powershell_out"
+require_relative "../../mixin/powershell_exec"
 
 class Chef
   class Provider
     class Package
       class Powershell < Chef::Provider::Package
-        include Chef::Mixin::PowershellOut
+        include Chef::Mixin::PowershellExec
 
         provides :powershell_package
 
@@ -54,9 +54,9 @@ class Chef
         # Installs the package specified with the version passed else latest version will be installed
         def install_package(names, versions)
           names.each_with_index do |name, index|
-            cmd = powershell_out(build_powershell_package_command("Install-Package '#{name}'", versions[index]), timeout: new_resource.timeout)
+            cmd = powershell_exec(build_powershell_package_command("Install-Package '#{name}'", versions[index]), timeout: new_resource.timeout)
             next if cmd.nil?
-            raise Chef::Exceptions::PowershellCmdletException, "Failed to install package due to catalog signing error, use skip_publisher_check to force install" if /SkipPublisherCheck/.match?(cmd.stderr)
+            raise Chef::Exceptions::PowershellCmdletException, "Failed to install package due to catalog signing error, use skip_publisher_check to force install" if /SkipPublisherCheck/.match?(cmd.error!)
           end
         end
 
@@ -64,11 +64,12 @@ class Chef
         def remove_package(names, versions)
           names.each_with_index do |name, index|
             if versions && !versions[index].nil?
-              powershell_out(build_powershell_package_command("Uninstall-Package '#{name}'", versions[index]), timeout: new_resource.timeout)
+              powershell_exec(build_powershell_package_command("Uninstall-Package '#{name}'", versions[index]), timeout: new_resource.timeout)
             else
               version = "0"
               until version.empty?
-                version = powershell_out(build_powershell_package_command("Uninstall-Package '#{name}'"), timeout: new_resource.timeout).stdout.strip
+                version = powershell_exec(build_powershell_package_command("Uninstall-Package '#{name}'"), timeout: new_resource.timeout).result
+                version = version.strip if version.respond_to?(:strip)
                 unless version.empty?
                   logger.info("Removed package '#{name}' with version #{version}")
                 end
@@ -82,13 +83,14 @@ class Chef
           versions = []
           new_resource.package_name.each_with_index do |name, index|
             version = if new_resource.version && !new_resource.version[index].nil?
-                        powershell_out(build_powershell_package_command("Find-Package '#{name}'", new_resource.version[index]), timeout: new_resource.timeout).stdout.strip
+                        powershell_exec(build_powershell_package_command("Find-Package '#{name}'", new_resource.version[index]), timeout: new_resource.timeout).result
                       else
-                        powershell_out(build_powershell_package_command("Find-Package '#{name}'"), timeout: new_resource.timeout).stdout.strip
+                        powershell_exec(build_powershell_package_command("Find-Package '#{name}'"), timeout: new_resource.timeout).result
                       end
             if version.empty?
               version = nil
             end
+            version = version.strip if version.respond_to?(:strip)
             versions.push(version)
           end
           versions
@@ -99,13 +101,14 @@ class Chef
           version_list = []
           new_resource.package_name.each_with_index do |name, index|
             version = if new_resource.version && !new_resource.version[index].nil?
-                        powershell_out(build_powershell_package_command("Get-Package '#{name}'", new_resource.version[index]), timeout: new_resource.timeout).stdout.strip
+                        powershell_exec(build_powershell_package_command("Get-Package '#{name}'", new_resource.version[index]), timeout: new_resource.timeout).result
                       else
-                        powershell_out(build_powershell_package_command("Get-Package '#{name}'"), timeout: new_resource.timeout).stdout.strip
+                        powershell_exec(build_powershell_package_command("Get-Package '#{name}'"), timeout: new_resource.timeout).result
                       end
             if version.empty?
               version = nil
             end
+            version = version.strip if version.respond_to?(:strip)
             version_list.push(version)
           end
           version_list

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

@@ -72,7 +72,6 @@ class Chef
           # A rubygems specification object containing the list of gemspecs for all
           # available gems in the gem installation.
           # Implemented by subclasses
-          # For rubygems >= 1.8.0
           #
           # @return [Gem::Specification]
           #
@@ -107,10 +106,8 @@ class Chef
               # This isn't sorting before returning because the only code that
               # uses this method calls `max_by` so it doesn't need to be sorted.
               stubs
-            elsif rubygems_version >= Gem::Version.new("1.8.0")
+            else # >= rubygems 1.8 behavior
               gem_specification.find_all_by_name(gem_dep.name, gem_dep.requirement)
-            else
-              gem_source_index.search(gem_dep)
             end
           end
 
@@ -192,7 +189,8 @@ class Chef
                 begin
                   rs = dependency_installer.resolve_dependencies gem_dependency.name, gem_dependency.requirement
                   rs.specs.find { |s| s.name == gem_dependency.name }
-                rescue Gem::UnsatisfiableDependencyError
+                  # ruby-3.0.0 versions of rubygems-3.x throws NoMethodError when the dep is not found
+                rescue Gem::UnsatisfiableDependencyError, NoMethodError
                   nil
                 end
               end
@@ -216,7 +214,7 @@ class Chef
           def install(gem_dependency, options = {})
             with_gem_sources(*options.delete(:sources)) do
               with_correct_verbosity do
-                dependency_installer(options).install(gem_dependency)
+                dependency_installer(**options).install(gem_dependency)
               end
             end
           end
@@ -230,7 +228,7 @@ class Chef
           def uninstall(gem_name, gem_version = nil, opts = {})
             gem_version ? opts[:version] = gem_version : opts[:all] = true
             with_correct_verbosity do
-              uninstaller(gem_name, opts).uninstall
+              uninstaller(gem_name, **opts).uninstall
             end
           end
 
@@ -242,12 +240,12 @@ class Chef
             yield
           end
 
-          def dependency_installer(opts = {})
-            Gem::DependencyInstaller.new(opts)
+          def dependency_installer(**opts)
+            Gem::DependencyInstaller.new(**opts)
           end
 
-          def uninstaller(gem_name, opts = {})
-            Gem::Uninstaller.new(gem_name, DEFAULT_UNINSTALLER_OPTS.merge(opts))
+          def uninstaller(gem_name, **opts)
+            Gem::Uninstaller.new(gem_name, **DEFAULT_UNINSTALLER_OPTS.merge(opts))
           end
 
           private
@@ -481,9 +479,7 @@ class Chef
         end
 
         def all_installed_versions
-          @all_installed_versions ||= begin
-                                        @gem_env.installed_versions(Gem::Dependency.new(gem_dependency.name, ">= 0"))
-                                      end
+          @all_installed_versions ||= @gem_env.installed_versions(Gem::Dependency.new(gem_dependency.name, ">= 0"))
         end
 
         ##
@@ -523,13 +519,11 @@ class Chef
         end
 
         def candidate_version
-          @candidate_version ||= begin
-                                  if source_is_remote?
-                                    @gem_env.candidate_version_from_remote(gem_dependency, *gem_sources).to_s
-                                  else
-                                    @gem_env.candidate_version_from_file(gem_dependency, new_resource.source).to_s
-                                  end
-                                end
+          @candidate_version ||= if source_is_remote?
+                                   @gem_env.candidate_version_from_remote(gem_dependency, *gem_sources).to_s
+                                 else
+                                   @gem_env.candidate_version_from_file(gem_dependency, new_resource.source).to_s
+                                 end
         end
 
         def version_requirement_satisfied?(current_version, new_version)

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

@@ -70,8 +70,7 @@ class Chef
         end
 
         def package_provider
-          @package_provider ||= begin
-            case installer_type
+          @package_provider ||= case installer_type
             when :msi
               logger.trace("#{new_resource} is MSI")
               require_relative "windows/msi"
@@ -80,8 +79,7 @@ class Chef
               logger.trace("#{new_resource} is EXE with type '#{installer_type}'")
               require_relative "windows/exe"
               Chef::Provider::Package::Windows::Exe.new(resource_for_provider, installer_type, uninstall_registry_entries)
-            end
-          end
+                                end
         end
 
         def installer_type

data/lib/chef/provider/package/yum/python_helper.rb

@@ -51,7 +51,6 @@ class Chef
           end
 
           def start
-            ENV["PYTHONUNBUFFERED"] = "1"
             @inpipe, inpipe_write = IO.pipe
             outpipe_read, @outpipe = IO.pipe
             @stdin, @stdout, @stderr, @wait_thr = Open3.popen3("#{yum_command} #{outpipe_read.fileno} #{inpipe_write.fileno}", outpipe_read.fileno => outpipe_read, inpipe_write.fileno => inpipe_write, close_others: false)
@@ -74,6 +73,7 @@ class Chef
               stderr.close unless stderr.nil?
               inpipe.close unless inpipe.nil?
               outpipe.close unless outpipe.nil?
+              @stdin = @stdout = @stderr = @inpipe = @outpipe = @wait_thr = nil
             end
           end
 
@@ -81,6 +81,10 @@ class Chef
             start if stdin.nil?
           end
 
+          def close_rpmdb
+            query("close_rpmdb", {})
+          end
+
           def compare_versions(version1, version2)
             query("versioncompare", { "versions" => [version1, version2] }).to_i
           end
@@ -111,18 +115,111 @@ class Chef
             end
           end
 
+          def is_arch?(arch)
+            # cspell:disable-next
+            arches = %w{aarch64 alpha alphaev4 alphaev45 alphaev5 alphaev56 alphaev6 alphaev67 alphaev68 alphaev7 alphapca56 armv5tejl armv5tel armv5tl armv6l armv7l armv8l armv6hl armv7hl armv7hnl armv8hl i386 athlon geode i386 i486 i586 i686 ia64 mips mipsel mips64 mips64el noarch ppc ppc64 ppc64iseries ppc64p7 ppc64pseries ppc64le riscv32 riscv64 riscv128 s390 s390x sh3 sh4 sh4a sparc sparc64 sparc64v sparcv8 sparcv9 sparcv9v x86_64 amd64 ia32e}
+            arches.include?(arch)
+          end
+
+          # We have a provides line with an epoch in it and yum cannot parse that, so we
+          # need to deconstruct the args.  This doesn't support splats which is why we
+          # only do it for this particularly narrow use case.
+          #
+          # name-epoch:version
+          # name-epoch:version.arch
+          # name-epoch:version-release
+          # name-epoch:version-release.arch
+          #
+          # @api private
+          def deconstruct_args(provides)
+            raise "provides must have an epoch in the version to deconstruct" unless provides =~ /^(\S+)-(\d+):(\S+)/
+
+            name = $1
+            epoch = $2
+            other = $3
+            ret = { "provides" => name, "epoch" => epoch }
+            maybe_arch = other.rpartition(".").last
+            arch = if is_arch?(maybe_arch)
+                     other.delete_suffix!(".#{maybe_arch}")
+                     maybe_arch
+                   end
+            ret.merge!({ "arch" => arch }) if arch
+            (version, _, release) = other.rpartition("-")
+            if version.empty?
+              ret.merge!({ "version" => release }) # yeah, rpartition is just weird
+            else
+              ret.merge!({ "version" => version, "release" => release })
+            end
+          end
+
+          # In the default case for the yum provider we now do terrible things with ruby
+          # to concatenate all the properties together to form a single string to feed to
+          # the python which favors using returnPackages/searchProvides over the
+          # searchNevra API.  That means that these two different ways of constructing the
+          # resource are now perfectly identical:
+          #
+          # yum_package "zabbix-agent-4.0.15-1.fc31.x86_64"
+          #
+          # yum_package "zabbix-agent" do
+          #   version "4.0.15-1.fc31"
+          #   arch "x86_64"
+          # end
+          #
+          # This function handles turning the second form into the first form.
+          #
+          # In the case where the epoch is given in the version and we do not have any glob
+          # patterns that is handled by going the other way and calling deconstruct_args due
+          # to the yum libraries not supporting that calling pattern other than by searchNevra.
+          #
+          # NOTE: This is an ugly hack and should NOT be considered an endorsement of this approach
+          # towards any kind of features or bugfixes in the DNF provider.  I'm doing this
+          # because YUM is sunsetting at this point and its very difficult to fight with the
+          # libraries on the python side of things.
+          #
+          # @api private
+          def combine_args(provides, version, arch)
+            provides = provides.to_s.strip
+            version = if !version.nil? && !version.empty?
+                        version.to_s.strip
+                      end
+            arch = if !arch.nil? && !arch.empty?
+                     arch.to_s.strip
+                   end
+            if version =~ /^[><=]/
+              if arch
+                return { "provides" => "#{provides}.#{arch} #{version}" }
+              else
+                return { "provides" => "#{provides} #{version}" }
+              end
+            end
+            maybe_arch = provides.rpartition(".").last
+            if is_arch?(maybe_arch)
+              arch = maybe_arch
+              provides.delete_suffix!(".#{arch}")
+            end
+            provides = "#{provides}-#{version}" if version
+            provides = "#{provides}.#{arch}" if arch
+            # yum (on rhel7) can't handle an epoch in provides, but
+            # deconstructing the args can't handle dealing with globs
+            if provides =~ /-\d+:/ && provides !~ /[\*\?]/
+              deconstruct_args(provides)
+            else
+              { "provides" => provides }
+            end
+          end
+
           # @return Array<Version>
           # NB: "options" here is the yum_package options hash and is deliberately not **opts
           def package_query(action, provides, version: nil, arch: nil, options: {})
-            parameters = { "provides" => provides, "version" => version, "arch" => arch }
+            parameters = combine_args(provides, version, arch)
             repo_opts = options_params(options || {})
             parameters.merge!(repo_opts)
-            # XXX: for now we restart before and after every query with an enablerepo/disablerepo to clean the helpers internal state
-            restart unless repo_opts.empty?
+            # XXX: for now we close the rpmdb before and after every query with an enablerepo/disablerepo to clean the helpers internal state
+            close_rpmdb unless repo_opts.empty?
             query_output = query(action, parameters)
             version = parse_response(query_output.lines.last)
             Chef::Log.trace "parsed #{version} from python helper"
-            restart unless repo_opts.empty?
+            close_rpmdb unless repo_opts.empty?
             version
           end
 
@@ -133,33 +230,15 @@ class Chef
 
           private
 
-          # i couldn't figure out how to decompose an evr on the python side, it seems reasonably
-          # painless to do it in ruby (generally massaging nevras in the ruby side is HIGHLY
-          # discouraged -- this is an "every rule has an exception" exception -- any additional
-          # functionality should probably trigger moving this regexp logic into python)
-          def add_version(hash, version)
-            epoch = nil
-            if version =~ /(\S+):(\S+)/
-              epoch = $1
-              version = $2
-            end
-            if version =~ /(\S+)-(\S+)/
-              version = $1
-              release = $2
-            end
-            hash["epoch"] = epoch unless epoch.nil?
-            hash["release"] = release unless release.nil?
-            hash["version"] = version
-          end
-
           def query(action, parameters)
             with_helper do
               json = build_query(action, parameters)
               Chef::Log.trace "sending '#{json}' to python helper"
-              outpipe.syswrite json + "\n"
-              output = inpipe.sysread(4096).chomp
+              outpipe.puts json
+              outpipe.flush
+              output = inpipe.readline.chomp
               Chef::Log.trace "got '#{output}' from python helper"
-              return output
+              output
             end
           end
 
@@ -169,11 +248,6 @@ class Chef
               hash[param_name] = param_value unless param_value.nil?
             end
 
-            # Special handling for certain action / param combos
-            if %i{whatinstalled whatavailable}.include?(action)
-              add_version(hash, parameters["version"]) unless parameters["version"].nil?
-            end
-
             FFI_Yajl::Encoder.encode(hash)
           end
 
@@ -207,13 +281,13 @@ class Chef
               Chef::Log.trace "discarding output on stderr/stdout from python helper: #{output}"
             end
             ret
-          rescue EOFError, Errno::EPIPE, Timeout::Error, Errno::ESRCH => e
+          rescue => e
             output = drain_fds
-            if ( max_retries -= 1 ) > 0
+            restart
+            if ( max_retries -= 1 ) > 0 && !ENV["YUM_HELPER_NO_RETRIES"]
               unless output.empty?
                 Chef::Log.trace "discarding output on stderr/stdout from python helper: #{output}"
               end
-              restart
               retry
             else
               raise e if output.empty?