mixlib-shellout 1.2.0 → 1.3.0.rc.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    Y2I1ZDQ4Zjk4OThmNzU0M2ZjYWQ3ODQyNThiOTg2YTkxNGViYTg5Nw==
+  data.tar.gz: !binary |-
+    YmU5Y2E4NDgyMDQxZjIzMzRkMmNhNDFiZTVhNmI1MzIwZTM1OTQxMQ==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    ZGQ0MmIwNjZmNWM2NjJiZmZmZDU0YWY4NWFiZDI2YTU0ZDA5MGY1NmZkYjBj
+    MDRmYzhkNGNiZjg1MjU5ZjQ4NzI4MTgzYWE3M2QyNDFlYzI4YzEzNjcyMjFh
+    ZmEyZjc0YmU0ZWY2MzA1OGVlNjVjNDIxMTc2MDRlNzcwZGY0Yzc=
+  data.tar.gz: !binary |-
+    ZWVkYTc1M2E1YjM5NWVlOTgzMDQyM2Y5YmY0NGMwMWM2MDFhNGNkNjY2YjU0
+    NzQ0MTRjNTViOTA4OGZhZGViMjhmNDhjNTI0ODQyMDkxOTNmNDRkODE4MjA3
+    ZDRkOWY5NmMwNDI0ODQwZjUyZWIzNzE5YWIzMDJhNDdkODcyYjQ=

data/lib/mixlib/shellout.rb

@@ -154,6 +154,7 @@ module Mixlib
       @environment = DEFAULT_ENVIRONMENT
       @cwd = nil
       @valid_exit_codes = [0]
+      @terminate_reason = nil
 
       if command_args.last.is_a?(Hash)
         parse_options(command_args.pop)
@@ -191,6 +192,7 @@ module Mixlib
     # results when the command exited with an unexpected status.
     def format_for_exception
       msg = ""
+      msg << "#{@terminate_reason}\n" if @terminate_reason
       msg << "---- Begin output of #{command} ----\n"
       msg << "STDOUT: #{stdout.strip}\n"
       msg << "STDERR: #{stderr.strip}\n"

data/lib/mixlib/shellout/unix.rb

@@ -38,6 +38,7 @@ module Mixlib
       #   within +timeout+ seconds (default: 600s)
       def run_command
         @child_pid = fork_subprocess
+        @reaped = false
 
         configure_parent_process_file_descriptors
 
@@ -57,36 +58,33 @@ module Mixlib
         write_to_child_stdin
 
         until @status
-          ready = IO.select(open_pipes, nil, nil, READ_WAIT_TIME)
-          unless ready
+          ready_buffers = attempt_buffer_read
+          unless ready_buffers
             @execution_time += READ_WAIT_TIME
             if @execution_time >= timeout && !@result
-              raise CommandTimeout, "command timed out:\n#{format_for_exception}"
+              # kill the bad proccess
+              reap_errant_child
+              # read anything it wrote when we killed it
+              attempt_buffer_read
+              # raise
+              raise CommandTimeout, "Command timed out after #{@execution_time.to_i}s:\n#{format_for_exception}"
             end
           end
 
-          if ready && ready.first.include?(child_stdout)
-            read_stdout_to_buffer
-          end
-          if ready && ready.first.include?(child_stderr)
-            read_stderr_to_buffer
-          end
-
-          unless @status
-            # make one more pass to get the last of the output after the
-            # child process dies
-            if results = Process.waitpid2(@child_pid, Process::WNOHANG)
-              @status = results.last
-              redo
-            end
-          end
+          attempt_reap
         end
+
         self
-      rescue Exception
-        # do our best to kill zombies
-        Process.waitpid2(@child_pid, Process::WNOHANG) rescue nil
+      rescue Errno::ENOENT
+        # When ENOENT happens, we can be reasonably sure that the child process
+        # is going to exit quickly, so we use the blocking variant of waitpid2
+        reap
         raise
       ensure
+        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
         # 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.
@@ -231,6 +229,17 @@ module Mixlib
         child_stdin.close # Kick things off
       end
 
+      def attempt_buffer_read
+        ready = IO.select(open_pipes, nil, nil, READ_WAIT_TIME)
+        if ready && ready.first.include?(child_stdout)
+          read_stdout_to_buffer
+        end
+        if ready && ready.first.include?(child_stderr)
+          read_stderr_to_buffer
+        end
+        ready
+      end
+
       def read_stdout_to_buffer
         while chunk = child_stdout.read_nonblock(READ_SIZE)
           @stdout << chunk
@@ -291,6 +300,44 @@ module Mixlib
         end
       end
 
+      def reap_errant_child
+        return if attempt_reap
+        @terminate_reason = "Command execeded allowed execution time, killed by TERM signal."
+        logger.error("Command execeded allowed execution time, sending TERM") if logger
+        Process.kill(:TERM, @child_pid)
+        sleep 3
+        return if attempt_reap
+        @terminate_reason = "Command execeded allowed execution time, did not respond to TERM. Killed by KILL signal."
+        logger.error("Command did not exit from TERM, sending KILL") if logger
+        Process.kill(:KILL, @child_pid)
+        reap
+
+        # Should not hit this but it's possible if something is calling waitall
+        # in a separate thread.
+      rescue Errno::ESRCH
+        nil
+      end
+
+      def should_reap?
+        # if we fail to fork, no child pid so nothing to reap
+        @child_pid && !@reaped
+      end
+
+      def reap
+        results = Process.waitpid2(@child_pid)
+        @reaped = true
+        @status = results.last
+      end
+
+      def attempt_reap
+        if results = Process.waitpid2(@child_pid, Process::WNOHANG)
+          @reaped = true
+          @status = results.last
+        else
+          nil
+        end
+      end
+
     end
   end
 end

data/lib/mixlib/shellout/version.rb

@@ -1,5 +1,5 @@
 module Mixlib
   class ShellOut
-    VERSION = "1.2.0"
+    VERSION = "1.3.0.rc.0"
   end
 end

metadata

@@ -1,48 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: mixlib-shellout
 version: !ruby/object:Gem::Version
-  version: 1.2.0
-  prerelease: 
+  version: 1.3.0.rc.0
 platform: ruby
 authors:
 - Opscode
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-19 00:00:00.000000000 Z
+date: 2013-11-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: ap
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
 description: Run external commands on Unix or Windows
 email: info@opscode.com
 executables: []
@@ -61,26 +42,25 @@ files:
 - lib/mixlib/shellout.rb
 homepage: http://wiki.opscode.com/
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ! '>'
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Run external commands on Unix or Windows
 test_files: []