mixlib-shellout 3.2.6 → 3.3.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ecadd2e4dc88a253a01b40a4791a2fa7940e2528569849aa3ed3127203c36a61
-  data.tar.gz: 42ad87d950f91197a4ee90adb05a31eeb17d298b3c5cf997b6d90f1f8a431f1c
+  metadata.gz: 0a9ab082811bde7ebba65cb6d326ff71d9f55e6a9a8d966a9294a173c56cf35b
+  data.tar.gz: 8eb25e4d17a30d1d1fc1e8a3f9e6fa0434dc6c692f4e461980d7cd670cbceb2e
 SHA512:
-  metadata.gz: c3afd05d78583036b4fa39420a305222dacbb9dcf2b32f3c4121c91677cde7cbfdbbc429cc02e3862c1140456c51c9d263321b279286def56cb9f6a8b74d8d19
-  data.tar.gz: ce2ca5cd28c792552dbf8f312a9061da532995e9470ef6e21095e39a1eee5dba59acb0b80758cd7d3d66dbcf32c60ea0f5540a5d98a418e443871eca641db08f
+  metadata.gz: d0ae915100dd53a40c78f3c6dc7439d99de2684b9a057cdbbc724cf8c41997c5a279912af76f4e3b00b9b732c207f98ca9d2e3f5225b30e5aea3941c21c65646
+  data.tar.gz: 9a4d490d87c8f9d2297c84ef7e81e844769d581b59b1bca36c8ed2a50a8a41e7909d5c788e36207b8f224002ecc7a1ad263d09b272598fce6ae16a45fe47d52f

data/lib/mixlib/shellout/helper.rb

@@ -141,9 +141,43 @@ module Mixlib
         args.flatten.compact.map(&:to_s)
       end
 
+      # Join arguments into a string.
+      #
+      # Strips leading/trailing spaces from each argument. If an argument contains
+      # a space, it is quoted. Join into a single string with spaces between each argument.
+      #
+      # @param args [String] variable number of string arguments
+      # @return [String] merged string
+      #
+      def __join_whitespace(*args, quote: false)
+        args.map do |arg|
+          if arg.is_a?(Array)
+            __join_whitespace(*arg, quote: arg.count > 1)
+          else
+            arg = arg.include?(" ") ? sprintf('"%s"', arg) : arg if quote
+            arg.strip
+          end
+        end.join(" ")
+      end
+
       def __shell_out_command(*args, **options)
         if __transport_connection
-          FakeShellOut.new(args, options, __transport_connection.run_command(args.join(" "))) # FIXME: train should accept run_command(*args)
+          command = __join_whitespace(args)
+          unless ChefUtils.windows?
+            if options[:cwd]
+              # as `timeout` is used, commands need to be executed in a subshell
+              command = "sh -c 'cd #{options[:cwd]}; #{command}'"
+            end
+
+            if options[:input]
+              command.concat "<<'COMMANDINPUT'\n"
+              command.concat __join_whitespace(options[:input])
+              command.concat "\nCOMMANDINPUT\n"
+            end
+          end
+
+          # FIXME: train should accept run_command(*args)
+          FakeShellOut.new(args, options, __transport_connection.run_command(command, options))
         else
           cmd = if options.empty?
                   Mixlib::ShellOut.new(*args)
@@ -181,15 +215,16 @@ module Mixlib
           @stdout = result.stdout
           @stderr = result.stderr
           @exitstatus = result.exit_status
-          @status = OpenStruct.new(success?: ( exitstatus == 0 ))
+          @valid_exit_codes = Array(options[:returns] || 0)
+          @status = OpenStruct.new(success?: (@valid_exit_codes.include? exitstatus))
         end
 
         def error?
-          exitstatus != 0
+          @valid_exit_codes.none?(exitstatus)
         end
 
         def error!
-          raise Mixlib::ShellOut::ShellCommandFailed, "Unexpected exit status of #{exitstatus} running #{@args}" if error?
+          raise Mixlib::ShellOut::ShellCommandFailed, "Unexpected exit status of #{exitstatus} running #{@args}: #{stderr}" if error?
         end
       end
     end

data/lib/mixlib/shellout/unix.rb

@@ -16,15 +16,12 @@
 # limitations under the License.
 #
 
+require "fileutils" unless defined?(FileUtils)
+
 module Mixlib
   class ShellOut
     module Unix
 
-      # "1.8.7" as a frozen string. We use this with a hack that disables GC to
-      # avoid segfaults on Ruby 1.8.7, so we need to allocate the fewest
-      # objects we possibly can.
-      ONE_DOT_EIGHT_DOT_SEVEN = "1.8.7".freeze
-
       # Option validation that is unix specific
       def validate_options(opts)
         if opts[:elevated]
@@ -99,12 +96,6 @@ module Mixlib
 
         configure_parent_process_file_descriptors
 
-        # Ruby 1.8.7 and 1.8.6 from mid 2009 try to allocate objects during GC
-        # when calling IO.select and IO#read. Disabling GC works around the
-        # segfault, but obviously it's a bad workaround. We no longer support
-        # 1.8.6 so we only need this hack for 1.8.7.
-        GC.disable if RUBY_VERSION == ONE_DOT_EIGHT_DOT_SEVEN
-
         # CHEF-3390: Marshall.load on Ruby < 1.8.7p369 also has a GC bug related
         # to Marshall.load, so try disabling GC first.
         propagate_pre_exec_failure
@@ -142,7 +133,7 @@ module Mixlib
         reap_errant_child if should_reap?
         # make one more pass to get the last of the output after the
         # child process dies
-        attempt_buffer_read
+        attempt_buffer_read(0)
         # no matter what happens, turn the GC back on, and hope whatever busted
         # version of ruby we're on doesn't allocate some objects during the next
         # GC run.
@@ -187,6 +178,16 @@ module Mixlib
         Dir.chdir(cwd) if cwd
       end
 
+      def set_cgroup
+        new_cgroup_path = "/sys/fs/cgroup/#{cgroup}"
+        # Create cgroup if missing
+        unless Dir.exist?(new_cgroup_path)
+          FileUtils.mkdir_p new_cgroup_path
+        end
+        # Migrate current process to newly cgroup, any subprocesses will run inside new cgroup
+        File.write("#{new_cgroup_path}/cgroup.procs", Process.pid.to_s)
+      end
+
       # Since we call setsid the child_pgid will be the child_pid, set to negative here
       # so it can be directly used in arguments to kill, wait, etc.
       def child_pgid
@@ -276,8 +277,8 @@ module Mixlib
         child_stdin.close # Kick things off
       end
 
-      def attempt_buffer_read
-        ready = IO.select(open_pipes, nil, nil, READ_WAIT_TIME)
+      def attempt_buffer_read(timeout = READ_WAIT_TIME)
+        ready = IO.select(open_pipes, nil, nil, timeout)
         if ready
           read_stdout_to_buffer if ready.first.include?(child_stdout)
           read_stderr_to_buffer if ready.first.include?(child_stderr)
@@ -315,6 +316,10 @@ module Mixlib
         open_pipes.delete(child_process_status)
       end
 
+      def cgroupv2_available?
+        File.read("/proc/mounts").match?(%r{^cgroup2 /sys/fs/cgroup})
+      end
+
       def fork_subprocess
         initialize_ipc
 
@@ -332,6 +337,10 @@ module Mixlib
 
           configure_subprocess_file_descriptors
 
+          if cgroup && cgroupv2_available?
+            set_cgroup
+          end
+
           set_secondarygroups
           set_group
           set_user

data/lib/mixlib/shellout/version.rb

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

data/lib/mixlib/shellout/windows.rb

@@ -60,6 +60,7 @@ module Mixlib
         stderr_read, stderr_write = IO.pipe
         stdin_read, stdin_write = IO.pipe
         open_streams = [ stdout_read, stderr_read ]
+        @execution_time = 0
 
         begin
 
@@ -105,6 +106,8 @@ module Mixlib
               wait_status = WaitForSingleObject(process.process_handle, 0)
               case wait_status
               when WAIT_OBJECT_0
+                # Save the execution time
+                @execution_time = Time.now - start_wait
                 # Get process exit code
                 exit_code = [0].pack("l")
                 unless GetExitCodeProcess(process.process_handle, exit_code)
@@ -127,6 +130,9 @@ module Mixlib
                     logger&.warn("Failed to kill timed out process #{process.process_id}")
                   end
 
+                  # Save the execution time
+                  @execution_time = Time.now - start_wait
+
                   raise Mixlib::ShellOut::CommandTimeout, [
                     "command timed out:",
                     format_for_exception,

data/lib/mixlib/shellout.rb

@@ -114,6 +114,9 @@ module Mixlib
 
     attr_accessor :sensitive
 
+    # Path to cgroupv2 that the process should run on
+    attr_accessor :cgroup
+
     # === Arguments:
     # Takes a single command, or a list of command fragments. These are used
     # as arguments to Kernel.exec. See the Kernel.exec documentation for more
@@ -179,6 +182,7 @@ module Mixlib
       @timeout = nil
       @elevated = false
       @sensitive = false
+      @cgroup = nil
 
       if command_args.last.is_a?(Hash)
         parse_options(command_args.pop)
@@ -303,7 +307,8 @@ module Mixlib
     def inspect
       "<#{self.class.name}##{object_id}: command: '#{@command}' process_status: #{@status.inspect} " +
         "stdout: '#{stdout.strip}' stderr: '#{stderr.strip}' child_pid: #{@child_pid.inspect} " +
-        "environment: #{@environment.inspect} timeout: #{timeout} user: #{@user} group: #{@group} working_dir: #{@cwd} >"
+        "environment: #{@environment.inspect} timeout: #{timeout} user: #{@user} group: #{@group} working_dir: #{@cwd} " +
+        "cgroup: #{@cgroup} >"
     end
 
     private
@@ -354,6 +359,8 @@ module Mixlib
           self.elevated = setting
         when "sensitive"
           self.sensitive = setting
+        when "cgroup"
+          self.cgroup = setting
         else
           raise InvalidCommandOption, "option '#{option.inspect}' is not a valid option for #{self.class.name}"
         end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mixlib-shellout
 version: !ruby/object:Gem::Version
-  version: 3.2.6
+  version: 3.3.9
 platform: ruby
 authors:
 - Chef Software Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-03-29 00:00:00.000000000 Z
+date: 2025-04-04 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: '2.4'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.2.3
 signing_key: 
 specification_version: 4
 summary: Run external commands on Unix or Windows