mixlib-shellout 3.3.9 → 3.4.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0a9ab082811bde7ebba65cb6d326ff71d9f55e6a9a8d966a9294a173c56cf35b
-  data.tar.gz: 8eb25e4d17a30d1d1fc1e8a3f9e6fa0434dc6c692f4e461980d7cd670cbceb2e
+  metadata.gz: fcac251ffc6584464c8df6cc4d1583eb3d8c0d520ac987139f733baffcde3f24
+  data.tar.gz: 53076e837afe3d68a5c23c92186df8c44243a1432615866edf4cd527924d0918
 SHA512:
-  metadata.gz: d0ae915100dd53a40c78f3c6dc7439d99de2684b9a057cdbbc724cf8c41997c5a279912af76f4e3b00b9b732c207f98ca9d2e3f5225b30e5aea3941c21c65646
-  data.tar.gz: 9a4d490d87c8f9d2297c84ef7e81e844769d581b59b1bca36c8ed2a50a8a41e7909d5c788e36207b8f224002ecc7a1ad263d09b272598fce6ae16a45fe47d52f
+  metadata.gz: '019e84c71357cc9d3e79ce34d45f31d18d1fda1dc1f4e54a3172a26822481f873d25a1aea1f70f71cc39a84a687b4cbc4fc49b08eb7581ecac0a0c184ca7c952'
+  data.tar.gz: bafd1b3456b24b846346d8dc1acf1b88791fec0fc9912e84befe4554898019ae4eafbd413bf3f5b34d31fe8a946dee874b21cf73cab012c975ab8fd1a09a744c

data/lib/mixlib/shellout/unix.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Author:: Daniel DeLeo (<dan@chef.io>)
 # Copyright:: Copyright (c) Chef Software Inc.

data/lib/mixlib/shellout/version.rb

@@ -1,5 +1,5 @@
 module Mixlib
   class ShellOut
-    VERSION = "3.3.9".freeze
+    VERSION = "3.4.10".freeze
   end
 end

data/lib/mixlib/shellout/windows/core_ext.rb

@@ -447,7 +447,6 @@ module Process
 
     def create_process_as_user(token, app, cmd, process_security,
       thread_security, inherit, creation_flags, env, cwd, startinfo, procinfo)
-
       bool = CreateProcessAsUserW(
         token,            # User token handle
         app,              # App name
@@ -479,7 +478,6 @@ module Process
 
     def create_process_with_logon(logon, domain, passwd, logon_flags, app, cmd,
       creation_flags, env, cwd, startinfo, procinfo)
-
       bool = CreateProcessWithLogonW(
         logon,           # User
         domain,          # Domain
@@ -501,7 +499,6 @@ module Process
 
     def create_process(app, cmd, process_security, thread_security, inherit,
       creation_flags, env, cwd, startinfo, procinfo)
-
       bool = CreateProcessW(
         app,               # App name
         cmd,               # Command line

data/lib/mixlib/shellout/windows.rb

@@ -1,4 +1,6 @@
 #
+# frozen_string_literal: true
+
 # Author:: Daniel DeLeo (<dan@chef.io>)
 # Author:: John Keiser (<jkeiser@chef.io>)
 # Author:: Ho-Sheng Hsiao (<hosh@chef.io>)
@@ -24,7 +26,6 @@ require_relative "windows/core_ext"
 module Mixlib
   class ShellOut
     module Windows
-
       include Process::Functions
       include Process::Constants
 
@@ -44,9 +45,9 @@ module Mixlib
           raise InvalidCommandOption, "`elevated` option should be passed only with `username` and `password`."
         end
 
-        if opts[:elevated] && opts[:elevated] != true && opts[:elevated] != false
-          raise InvalidCommandOption, "Invalid value passed for `elevated`. Please provide true/false."
-        end
+        return unless opts[:elevated] && opts[:elevated] != true && opts[:elevated] != false
+
+        raise InvalidCommandOption, "Invalid value passed for `elevated`. Please provide true/false."
       end
 
       #--
@@ -59,18 +60,17 @@ module Mixlib
         stdout_read, stdout_write = IO.pipe
         stderr_read, stderr_write = IO.pipe
         stdin_read, stdin_write = IO.pipe
-        open_streams = [ stdout_read, stderr_read ]
+        open_streams = [stdout_read, stderr_read]
         @execution_time = 0
 
         begin
-
           #
           # Set cwd, environment, appname, etc.
           #
           app_name, command_line = command_to_run(combine_args(*command))
           create_process_args = {
-            app_name: app_name,
-            command_line: command_line,
+            app_name:,
+            command_line:,
             startup_info: {
               stdout: stdout_write,
               stderr: stderr_write,
@@ -110,12 +110,10 @@ module Mixlib
                 @execution_time = Time.now - start_wait
                 # Get process exit code
                 exit_code = [0].pack("l")
-                unless GetExitCodeProcess(process.process_handle, exit_code)
-                  raise get_last_error
-                end
+                raise get_last_error unless GetExitCodeProcess(process.process_handle, exit_code)
 
                 @status = ThingThatLooksSortOfLikeAProcessStatus.new
-                @status.exitstatus = exit_code.unpack("l").first
+                @status.exitstatus = exit_code.unpack1("l")
 
                 return self
               when WAIT_TIMEOUT
@@ -144,16 +142,13 @@ module Mixlib
               else
                 raise "Unknown response from WaitForSingleObject(#{process.process_handle}, #{timeout * 1000}): #{wait_status}"
               end
-
             end
-
           ensure
             CloseHandle(process.thread_handle) if process.thread_handle
             CloseHandle(process.process_handle) if process.process_handle
             Process.unload_user_profile(token, profile) if profile
             CloseHandle(token) if token
           end
-
         ensure
           #
           # Consume all remaining data from the pipes until they are closed
@@ -168,6 +163,7 @@ module Mixlib
 
       class ThingThatLooksSortOfLikeAProcessStatus
         attr_accessor :exitstatus
+
         def success?
           exitstatus == 0
         end
@@ -183,7 +179,11 @@ module Mixlib
 
         if ready.first.include?(stdout_read)
           begin
-            next_chunk = stdout_read.readpartial(READ_SIZE)
+            # The unary plus operator (+) creates a mutable copy of the string returned by readpartial.
+            # This is necessary because readpartial may return a frozen string, and we need to be able
+            # to modify the string (append to buffers, manipulate encoding, etc.) in subsequent operations.
+            # Without the +, attempting to modify a frozen string would raise a FrozenError.
+            next_chunk = +stdout_read.readpartial(READ_SIZE)
             @stdout << next_chunk
             @live_stdout << next_chunk if @live_stdout
           rescue EOFError
@@ -194,7 +194,7 @@ module Mixlib
 
         if ready.first.include?(stderr_read)
           begin
-            next_chunk = stderr_read.readpartial(READ_SIZE)
+            next_chunk = +stderr_read.readpartial(READ_SIZE)
             @stderr << next_chunk
             @live_stderr << next_chunk if @live_stderr
           rescue EOFError
@@ -261,7 +261,7 @@ module Mixlib
         if exe_needs_cmd?(exe)
           run_under_cmd(command)
         else
-          [ exe, command ]
+          [exe, command]
         end
       end
 
@@ -275,14 +275,14 @@ module Mixlib
       # https://github.com/chef/mixlib-shellout/pull/2#issuecomment-4837859
       # http://ss64.com/nt/syntax-esc.html
       def run_under_cmd(command)
-        [ ENV["COMSPEC"], "cmd /c \"#{command}\"" ]
+        [ENV["COMSPEC"], "cmd /c \"#{command}\""]
       end
 
       # FIXME: this extracts ARGV[0] but is it correct?
       def candidate_executable_for_command(command)
         if command =~ /^\s*"(.*?)"/ || command =~ /^\s*([^\s]+)/
           # If we have quotes, do an exact match, else pick the first word ignoring the leading spaces
-          $1
+          ::Regexp.last_match(1)
         else
           ""
         end
@@ -405,15 +405,15 @@ module Mixlib
       def kill_process(instance, logger)
         child_pid = instance.wmi_ole_object.processid
         logger&.debug([
-            "killing child process #{child_pid}::",
-            "#{instance.wmi_ole_object.Name} of parent #{pid}",
-          ].join)
+          "killing child process #{child_pid}::",
+          "#{instance.wmi_ole_object.Name} of parent #{pid}",
+        ].join)
         Process.kill(:KILL, instance.wmi_ole_object.processid)
       rescue SystemCallError
         logger&.debug([
-            "Failed to kill child process #{child_pid}::",
-            "#{instance.wmi_ole_object.Name} of parent #{pid}",
-          ].join)
+          "Failed to kill child process #{child_pid}::",
+          "#{instance.wmi_ole_object.Name} of parent #{pid}",
+        ].join)
       end
 
       def format_process(process, app_name, command_line, timeout)

data/lib/mixlib/shellout.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #--
 # Author:: Daniel DeLeo (<dan@chef.io>)
 # Copyright:: Copyright (c) Chef Software Inc.
@@ -170,7 +171,8 @@ module Mixlib
     #   cmd = Mixlib::ShellOut.new("apachectl", "start", :user => 'www', :env => nil, :cwd => '/tmp')
     #   cmd.run_command # etc.
     def initialize(*command_args)
-      @stdout, @stderr, @process_status = "", "", ""
+      # Since ruby 4.0 will freeze string literals by default, we are assigning mutable strings here.
+      @stdout, @stderr, @process_status = String.new(""), String.new(""), String.new("")
       @live_stdout = @live_stderr = nil
       @input = nil
       @log_level = :debug
@@ -238,7 +240,7 @@ module Mixlib
     def format_for_exception
       return "Command execution failed. STDOUT/STDERR suppressed for sensitive resource" if sensitive
 
-      msg = ""
+      msg = String.new
       msg << "#{@terminate_reason}\n" if @terminate_reason
       msg << "---- Begin output of #{command} ----\n"
       msg << "STDOUT: #{stdout.strip}\n"
@@ -268,7 +270,9 @@ module Mixlib
     #   within +timeout+ seconds (default: 600s)
     def run_command
       if logger
-        log_message = (log_tag.nil? ? "" : "#{@log_tag} ") << "sh(#{@command})"
+        prefix = log_tag.nil? ? "" : "#{@log_tag} "
+        log_message = prefix + "sh(#{@command})"
+        # log_message = (log_tag.nil? ? "" : "#{@log_tag} ") << "sh(#{@command})"
         logger.send(log_level, log_message)
       end
       super
@@ -334,11 +338,11 @@ module Mixlib
         when "returns"
           self.valid_exit_codes = Array(setting)
         when "live_stream"
-          self.live_stdout = self.live_stderr = setting
+          self.live_stdout = self.live_stderr = setting.is_a?(String) ? String.new(setting) : setting
         when "live_stdout"
-          self.live_stdout = setting
+          self.live_stdout = setting.is_a?(String) ? String.new(setting) : setting
         when "live_stderr"
-          self.live_stderr = setting
+          self.live_stderr = setting.is_a?(String) ? String.new(setting) : setting
         when "input"
           self.input = setting
         when "logger"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mixlib-shellout
 version: !ruby/object:Gem::Version
-  version: 3.3.9
+  version: 3.4.10
 platform: ruby
 authors:
 - Chef Software Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2025-04-04 00:00:00.000000000 Z
+date: 2025-12-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: chef-utils
@@ -50,14 +50,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.0'
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.3.27
 signing_key: 
 specification_version: 4
 summary: Run external commands on Unix or Windows