process_helper 0.1.0 → 0.1.1.pre.beta.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e70edb04eaa1cef03255ffd6976dca7b6218afaf
-  data.tar.gz: a5d9dc19df23427d66e3974504cefeea00e636f8
+  metadata.gz: 6c2a977c3f8a1d8982bb46d4bf4468ee89211ab8
+  data.tar.gz: 351b82ea95ddab8f1145ed76ec89c125debe307e
 SHA512:
-  metadata.gz: 1ed2dd1a21c2e738f34971adf8b3328f1a30a1991dccf81b7bb6431e59fd2a0343f0e04cae2aaebf4091887148adf044d15ed52459c003d772c8db413e469ba5
-  data.tar.gz: 84a8dda43af5ac0486e709a3edd7b963221f5f34fac2c2daa1b39b87604c39ba8e081904b5500b192007d6a380e828002c0944c2bbe39b279d1772fafb23500a
+  metadata.gz: c9d4da553d29cd0bda49283e252d67cb4235980664228b94ccee75fdb6c64a2065698f014bed10541e6e651ae097880f073f0011995a31b24e967965cd5f42b5
+  data.tar.gz: 36e04a719ad86b5da40bcc4575b1a24162c8d00dd133cf0063ee2301830f088c52c7bfa22a7f7b1fd545c461a44f7f760457229b2461ad050ebe42c0115bb144

data/lib/process_helper.rb

@@ -10,7 +10,7 @@ require 'stringio'
 # Full documentation at https://github.com/thewoolleyman/process_helper
 module ProcessHelper
   # Don't forget to keep version in sync with gemspec
-  VERSION = '0.1.0'.freeze
+  VERSION = '0.1.1.pre.beta.1'.freeze
 
   # rubocop:disable Style/ModuleFunction
   extend self
@@ -48,11 +48,20 @@ module ProcessHelper
   end
 
   def process_with_pseudo_terminal(cmd, options)
+    max_seconds_to_wait_for_pid_to_exit = options[:timeout] || 60
     PTY.spawn(cmd) do |stdout_and_stderr, stdin, pid|
       output = get_output(stdin, stdout_and_stderr, options)
-      process_status = PTY.check(pid)
-      # TODO: come up with a test that illustrates pid not exiting
-      fail "ERROR: pid #{pid} did not exit" unless process_status
+      # TODO: come up with a test that illustrates pid not exiting by the time PTY exits
+      process_status = nil
+      begin
+        Timeout.timeout(max_seconds_to_wait_for_pid_to_exit) do
+          process_status = PTY.check(pid) until process_status
+          sleep 0.1 unless process_status
+        end
+      rescue Timeout::Error
+        additional_msg = "Pid #{pid} did not exit after its pseudo-terminal (PTY) returned."
+        handle_timeout_error(output, options, max_seconds_to_wait_for_pid_to_exit, additional_msg)
+      end
       return [output, process_status]
     end
   end
@@ -119,8 +128,9 @@ module ProcessHelper
     output
   end
 
-  def handle_timeout_error(output, options)
-    msg = "Timed out after #{options.fetch(:timeout)} seconds."
+  def handle_timeout_error(output, options, seconds = nil, additional_msg = nil)
+    msg = "Timed out after #{options.fetch(:timeout, seconds)} seconds."
+    msg += " #{additional_msg}" if additional_msg
     if options[:include_output_in_exception]
       msg += " Command output prior to timeout: \"#{output}\""
     end

data/process_helper.gemspec

@@ -3,7 +3,7 @@
 Gem::Specification.new do |spec|
   spec.name = 'process_helper'
   # Don't forget to keep version in sync with ProcessHelper::Version
-  spec.version = '0.1.0'
+  spec.version = '0.1.1.pre.beta.1'
   spec.authors = ['Chad Woolley', 'Glenn Oppegard']
   spec.email = ['oppegard@gmail.com', 'thewoolleyman@gmail.com']
   spec.summary = "Makes it easier to spawn ruby sub-processes with proper capturing /

data/spec/pty_handling_spec.rb

@@ -34,14 +34,23 @@ RSpec.describe 'pty handling' do
   end
 
   it 'handles linux behavior of raising Errno::EIO when pty slave is closed' do
-    # nothing really special about this test, all the specs in this file
-    # fail on linux, just documenting...
     expect do
       clazz.process('echo "hi" && exit 1', pty: true, exp_st: 1)
     end.to output(/hi/).to_stdout
       .and(not_output.to_stderr)
   end
 
+  it 'can timeout if process does not exit when pty ends' do
+    @max_process_wait = 0.2
+    allow(PTY).to receive(:check).and_return(nil)
+    expect do
+      clazz.process('echo', pty: true, exp_st: 1, timeout: @max_process_wait)
+    end.to raise_error(
+      ProcessHelper::TimeoutError,
+      %r(Timed out after #{@max_process_wait} seconds..*did not exit.*PTY.*)
+    )
+  end
+
   it 'does not require a newline or flush via getch' do
     skip('TODO: this test just hangs, including in a debugger')
     expect do

data/spec/timeout_handling_spec.rb

@@ -22,6 +22,19 @@ RSpec.describe 'timout handling with non-exiting blocking cmd requiring timeout'
     )
   end
 
+  it 'raises on sleep with a PTY' do
+    expect do
+      clazz.process(
+        'sleep 999',
+        timeout: max_process_wait,
+        pty: true
+      )
+    end.to raise_error(
+      ProcessHelper::TimeoutError,
+      "Timed out after #{@max_process_wait} seconds. Command output prior to timeout: \"\""
+    )
+  end
+
   it 'does not raise error if timeout is not exceeded' do
     expect do
       clazz.process(

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: process_helper
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1.pre.beta.1
 platform: ruby
 authors:
 - Chad Woolley
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-19 00:00:00.000000000 Z
+date: 2017-05-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -185,12 +185,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 1.9.2
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: Makes it easier to spawn ruby sub-processes with proper capturing / of stdout