chef 18.9.4 → 18.11.11

data/lib/chef/monkey_patches/reline-windows.rb

@@ -0,0 +1,116 @@
+# Author:: Chef Software Inc.
+# Copyright:: Copyright (c) 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.
+#
+# == Background
+#
+# On Windows, Reline's process_key_event emits an ESC byte (0x1B) before every
+# character when the :ALT control key flag is set.  This is correct for true
+# Alt key combos (Meta sequences), but AltGr on European keyboards – most
+# notably German layouts – is reported by Windows as Ctrl+Alt (RIGHT_CTRL +
+# RIGHT_ALT pressed simultaneously).  Characters that require AltGr, such as
+# { } [ ] @ ~ | \, therefore receive both :CTRL and :ALT flags, causing Reline to
+# emit an ESC prefix.  In a terminal the result looks like ^[{ instead of {.
+#
+# The corrupt input leaves IRB's parser in an open-string/block state which
+# re-draws continuation prompts endlessly when multi-line blocks are pasted,
+# making chef-shell unusable for German (and many other European) keyboard users.
+#
+# == Fix
+#
+# Only emit the ESC Meta prefix when :ALT is set WITHOUT :CTRL.  When both
+# flags are present the keypress is AltGr-originated and the raw character
+# bytes are sufficient and correct.
+#
+# == Affected versions
+#
+# Verified against Reline <= 0.3.x (shipped with Ruby 3.1.x in chef-foundation).
+# The issue was resolved upstream in Reline 0.3.2 / irb 1.6.2 (Ruby 3.2+),
+# so the patch is guarded to apply only when the installed Reline version is
+# affected.
+#
+# == References
+#
+# * Upstream report:  https://github.com/ruby/reline/issues/475
+# * Chef PR #9267   (Ruby 2.7 IRB fixes, introduced multiline/singleline wiring)
+# * Chef PR #14919  (Prompt consistency fix for left-arrow on Ruby 3.1/3.2)
+# * Chef PR #15336  (IRB @ALIASES removal compat)
+
+if Gem.win_platform? && defined?(Reline::Windows)
+
+  # Only patch versions where the bug is present.  Reline 0.3.2 fixed it
+  # upstream.  Gem::Version comparison is safe even when reline is a stdlib
+  # default gem without a Gemspec entry in loaded_specs.
+  reline_version = begin
+    Gem::Version.new(Reline::VERSION)
+                   rescue StandardError
+                     Gem::Version.new("0")
+  end
+
+  if reline_version < Gem::Version.new("0.3.2")
+    Chef::Log.debug("chef-shell: applying Reline::Windows AltGr monkey patch (reline #{Reline::VERSION})")
+
+    class Reline::Windows
+      class << self
+        # Reopen process_key_event and change only the ESC-emission guard.
+        # All other behavior – surrogate pair handling, KEY_MAP matching, bare
+        # control-key suppression – is preserved verbatim from the original.
+        def process_key_event(repeat_count, virtual_key_code, virtual_scan_code, char_code, control_key_state)
+          # ---- surrogate pair handling (unchanged) --------------------------------
+          if char_code.between?(0xD800, 0xDBFF)
+            @@hsg = char_code
+            return
+          end
+
+          if char_code.between?(0xDC00, 0xDFFF)
+            if @@hsg
+              char_code = 0x10000 + (@@hsg - 0xD800) * 0x400 + char_code - 0xDC00
+              @@hsg = nil
+            else
+              return # low-surrogate without preceding high-surrogate – ignore
+            end
+          else
+            @@hsg = nil # discard stale high-surrogate
+          end
+          # -------------------------------------------------------------------------
+
+          key = KeyEventRecord.new(virtual_key_code, char_code, control_key_state)
+
+          # KEY_MAP takes priority (arrow keys, Delete, Home, End, Tab, etc.)
+          match = KEY_MAP.find { |args,| key.matches?(**args) }
+          unless match.nil?
+            @@output_buf.concat(match.last)
+            return
+          end
+
+          # Suppress bare modifier-only keypresses (no printable character)
+          return if key.char_code == 0 && key.control_keys.any?
+
+          # ---- THE FIX -----------------------------------------------------------
+          # Original:  @@output_buf.push("\e".ord) if key.control_keys.include?(:ALT)
+          #
+          # AltGr on European keyboards reports as Ctrl+Alt (both :CTRL and :ALT
+          # present).  Only emit the ESC Meta prefix when Alt is pressed WITHOUT
+          # Ctrl – i.e. a genuine Meta/Alt sequence, not an AltGr character.
+          alt_without_ctrl = key.control_keys.include?(:ALT) && !key.control_keys.include?(:CTRL)
+          @@output_buf.push("\e".ord) if alt_without_ctrl
+          # -------------------------------------------------------------------------
+
+          @@output_buf.concat(key.char.bytes)
+        end
+      end
+    end
+  end
+end

data/lib/chef/property.rb

@@ -698,7 +698,7 @@ class Chef
       # Weeding out class methods avoids unnecessary deprecations such Chef::Resource
       # defining a `name` property when there's an already-existing `name` method
       # for a Module.
-      return false unless declared_in.instance_methods.include?(name)
+      return false unless declared_in.method_defined?(name)
 
       # Only emit deprecations for some well-known classes. This will still
       # allow more advanced users to subclass their own custom resources and

data/lib/chef/provider/cron.rb

@@ -27,7 +27,7 @@ class Chef
       SPECIAL_TIME_VALUES = %i{reboot yearly annually monthly weekly daily midnight hourly}.freeze
       CRON_ATTRIBUTES = %i{minute hour day month weekday time command mailto path shell home environment}.freeze
       CRON_PATTERN = %r{\A([-0-9*,/]+)\s([-0-9*,/]+)\s([-0-9*,/]+)\s([-0-9*,/]+|[a-zA-Z]{3})\s([-0-9*,/]+|[a-zA-Z]{3})\s(.*)}.freeze
-      SPECIAL_PATTERN = /\A(@(#{SPECIAL_TIME_VALUES.join('|')}))\s(.*)/.freeze
+      SPECIAL_PATTERN = /\A(@(#{SPECIAL_TIME_VALUES.join("|")}))\s(.*)/.freeze
       ENV_PATTERN = /\A(\S+)=(\S*)/.freeze
       ENVIRONMENT_PROPERTIES = %w{MAILTO PATH SHELL HOME}.freeze
 

data/lib/chef/provider/directory.rb

@@ -65,6 +65,17 @@ class Chef
           a.whyrun("Assuming directory #{parent_directory} would have been created")
         end
 
+        requirements.assert(:create) do |a|
+          a.assertion do
+            if ::File.exist?(new_resource.path)
+              ::File.directory?(new_resource.path)
+            else
+              true
+            end
+          end
+          a.failure_message(Chef::Exceptions::FileTypeMismatch, "Cannot create #{new_resource} at #{new_resource.path} because a file already exists at that path")
+        end
+
         requirements.assert(:create) do |a|
           parent_directory = ::File.dirname(new_resource.path)
           a.assertion do

data/lib/chef/provider/dsc_resource.rb

@@ -114,7 +114,7 @@ class Chef
           r = case found.length
               when 0
                 raise Chef::Exceptions::ResourceNotFound,
-                  "Could not find #{dsc_resource_name}. Check to make "\
+                  "Could not find #{dsc_resource_name}. Check to make " \
                   "sure that it shows up when running Get-DscResource"
               when 1
                 if found[0]["Module"].nil?
@@ -162,7 +162,7 @@ class Chef
 
       def invoke_resource(method)
         properties = translate_type(new_resource.properties)
-        switches = "-Method #{method} -Name #{new_resource.resource}"\
+        switches = "-Method #{method} -Name #{new_resource.resource}" \
                    " -Property #{properties} -Module #{module_info_object} -Verbose"
         Timeout.timeout(new_resource.timeout) {
           powershell_exec!("Invoke-DscResource #{switches}")

data/lib/chef/provider/file/content.rb

@@ -24,9 +24,10 @@ class Chef
     class File
       class Content < Chef::FileContentManagement::ContentBase
         def file_for_provider
-          if @new_resource.content
+          content = @new_resource.content
+          if content
             tempfile = Chef::FileContentManagement::Tempfile.new(@new_resource).tempfile
-            tempfile.write(@new_resource.content)
+            tempfile.write(content)
             tempfile.close
             tempfile
           else

data/lib/chef/provider/file.rb

@@ -192,7 +192,7 @@ class Chef
       # be overridden in subclasses.
       def managing_content?
         return true if new_resource.checksum
-        return true if !new_resource.content.nil? && @action != :create_if_missing
+        return true if new_resource.property_is_set?(:content) && @action != :create_if_missing
 
         false
       end

data/lib/chef/provider/git.rb

@@ -61,7 +61,7 @@ class Chef
           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 #{cwd}, 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|

data/lib/chef/provider/ifconfig/debian.rb

@@ -87,7 +87,7 @@ iface <%= new_resource.device %> <%= new_resource.family %> static
           directory INTERFACES_DOT_D_DIR
 
           # roll our own file_edit resource, this will not get reported until we have a file_edit resource
-          interfaces_dot_d_for_regexp = INTERFACES_DOT_D_DIR.gsub(/\./, "\\.") # escape dots for the regexp
+          interfaces_dot_d_for_regexp = INTERFACES_DOT_D_DIR.gsub(".", "\\.") # escape dots for the regexp
           regexp = %r{^\s*source\s+#{interfaces_dot_d_for_regexp}/\*\s*$}
 
           return if ::File.exist?(INTERFACES_FILE) && regexp.match(IO.read(INTERFACES_FILE))

data/lib/chef/provider/ifconfig/redhat.rb

@@ -22,7 +22,7 @@ class Chef
   class Provider
     class Ifconfig
       class Redhat < Chef::Provider::Ifconfig
-        provides :ifconfig, platform_family: "fedora_derived"
+        provides :ifconfig, platform_family: %w{fedora rhel amazon}
 
         def initialize(new_resource, run_context)
           super(new_resource, run_context)

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

@@ -83,4 +83,4 @@ class Chef
       end
     end
   end
-end
+end

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

@@ -30,7 +30,7 @@ class Chef
         provides :mount, os: "windows"
 
         def is_volume(name)
-          /^\\\\\?\\Volume\{[\w-]+\}\\$/.match?(name) ? true : false
+          /^\\\\\?\\Volume\{[\w-]+\}\\$/.match?(name) || false
         end
 
         def initialize(new_resource, run_context)
@@ -62,9 +62,9 @@ class Chef
         def mount_fs
           unless @current_resource.mounted
             @mount.add(remote: @new_resource.device,
-                       username: @new_resource.username,
-                       domainname: @new_resource.domain,
-                       password: @new_resource.password)
+              username: @new_resource.username,
+              domainname: @new_resource.domain,
+              password: @new_resource.password)
             logger.trace("#{@new_resource} is mounted at #{@new_resource.mount_point}")
           else
             logger.debug("#{@new_resource} is already mounted at #{@new_resource.mount_point}")

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

@@ -257,7 +257,8 @@ class Chef
           @choco_install_path ||= begin
             result = powershell_exec!(PATHFINDING_POWERSHELL_COMMAND).result
             result = "" if result.empty?
-            result
+            # Ensure consistent Windows path separators
+            result.empty? ? result : result.tr("/", "\\")
           end
         end
 
@@ -459,8 +460,10 @@ class Chef
         def get_local_pkg_dirs(base_dir)
           return [] unless Dir.exist?(base_dir)
 
-          Dir.entries(base_dir).select do |dir|
-            ::File.directory?(::File.join(base_dir, dir)) && !dir.start_with?(".")
+          with_file_lock_retry("reading chocolatey package directories") do
+            Dir.entries(base_dir).select do |dir|
+              ::File.directory?(::File.join(base_dir, dir)) && !dir.start_with?(".")
+            end
           end
         end
 
@@ -496,6 +499,60 @@ class Chef
           args
         end
 
+        # Wait for chocolatey to release file locks after package operations
+        # @param names [Array<String>] package names that were just installed/upgraded
+        def wait_for_chocolatey_lock_release(names)
+          return if names.empty?
+
+          Chef::Log.debug("Waiting for chocolatey to release file locks for packages: #{names.join(", ")}")
+
+          # Check for .chocolateyPending files and wait for them to be released
+          names.each do |name|
+            pending_file = ::File.join(choco_lib_path, name.downcase, ".chocolateyPending")
+            if ::File.exist?(pending_file)
+              with_file_lock_retry("waiting for .chocolateyPending file release: #{pending_file}") do
+                # Try to open the file exclusively - this will fail if it's locked
+                ::File.open(pending_file, "r") do |f|
+                  f.flock(::File::LOCK_EX | ::File::LOCK_NB) or raise Errno::EAGAIN
+                end
+              end
+            end
+          end
+        end
+
+        # Retry file operations that might encounter chocolatey process file locks
+        # @param operation_desc [String] description of the operation for logging
+        # @param max_retries [Integer] maximum number of retry attempts
+        # @param base_delay [Float] base delay between retries in seconds
+        def with_file_lock_retry(operation_desc, max_retries: 5, base_delay: 0.5)
+          retries = 0
+          begin
+            yield
+          rescue Errno::EACCES, Errno::EBUSY, Errno::EAGAIN, Errno::ENOENT => e
+            if retries < max_retries && file_lock_error?(e)
+              retries += 1
+              delay = base_delay * (2**(retries - 1)) # exponential backoff
+              Chef::Log.debug("Chocolatey file lock detected during #{operation_desc}, retrying in #{delay}s (attempt #{retries}/#{max_retries}): #{e.message}")
+              sleep(delay)
+              retry
+            else
+              Chef::Log.warn("Failed #{operation_desc} after #{retries} retries: #{e.message}")
+              raise e
+            end
+          end
+        end
+
+        # Check if the error is related to file locking by chocolatey processes
+        # @param error [Exception] the exception to check
+        # @return [Boolean] true if it's a chocolatey file lock related error
+        def file_lock_error?(error)
+          error.message&.include?("being used by another process") ||
+            error.message&.include?("chocolateyPending") ||
+            error.is_a?(Errno::EACCES) ||
+            error.is_a?(Errno::EBUSY) ||
+            error.is_a?(Errno::EAGAIN)
+        end
+
         # Fetch the local package versions from chocolatey
         def fetch_package_versions(base_dir, target_dirs, targets)
           pkg_versions = {}
@@ -511,25 +568,27 @@ class Chef
         # Grab the locally installed packages from the nupkg list
         # rather than shelling out to chocolatey
         def get_pkg_data(path)
-          t = ::File.join(path, "*.nupkg").gsub("\\", "/")
-          targets = Dir.glob(t)
-
-          # Extract package version from the first nuspec file in this nupkg
-          targets.each do |target|
-            Zip::File.open(target) do |zip_file|
-              zip_file.each do |entry|
-                next unless entry.name.end_with?(".nuspec")
-
-                f = entry.get_input_stream
-                doc = REXML::Document.new(f.read.to_s)
-                f.close
-                id = doc.elements["package/metadata/id"]
-                version = doc.elements["package/metadata/version"]
-                return { id.text.to_s.downcase => version.text } if id && version
+          with_file_lock_retry("get package data for #{path}") do
+            t = ::File.join(path, "*.nupkg")
+            targets = Dir.glob(t)
+
+            # Extract package version from the first nuspec file in this nupkg
+            targets.each do |target|
+              Zip::File.open(target) do |zip_file|
+                zip_file.each do |entry|
+                  next unless entry.name.end_with?(".nuspec")
+
+                  f = entry.get_input_stream
+                  doc = REXML::Document.new(f.read.to_s)
+                  f.close
+                  id = doc.elements["package/metadata/id"]
+                  version = doc.elements["package/metadata/version"]
+                  return { id.text.to_s.downcase => version.text } if id && version
+                end
               end
             end
+            {}
           end
-          {}
         rescue StandardError => e
           Chef::Log.warn("Failed to get package info for #{path}: #{e}")
           {}