process-helper 1.1.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: d5801c46c90163e46beb528091ad2dfa932cafd0
-  data.tar.gz: c8fa6a8f6b5c503b3ea2369bd0b15264badef55d
+SHA256:
+  metadata.gz: 07dac3b535cb2ec0ce43d8c9ead6f4a23a8b14683b4d234b643c942bb6f743dc
+  data.tar.gz: 3f2cf28692b50322e03293409c945d6a04ef619b226c2ff2c45475baeadea16f
 SHA512:
-  metadata.gz: f78e7ad32fd2720831db9ff75982665e305f975c91be07c659f4618c885d83e86543705efcfc56d4b2b90f516b6bda43db36724082fd1ff3e787c6fd94fb390b
-  data.tar.gz: 4088d5ed29f3ad6ab9c6a01c38655c318a33b9fe35bfafb59ea6299ad6ef11278a7f2d1f6229870591d1a5456c7732450bf2e1b5ee37a2870777c5e7614ded23
+  metadata.gz: 6628d5907a0dd0cc684a6a2289ce707c1cfe0cf54f694e9b7162c4ef9bb06854cd3308ec0694d5fa093b974a17a45ed27c2a701338a2f7bf87c239a55440b750
+  data.tar.gz: 715afd5755003e0c7656bcc171495f61e4e11af76e4f5ba3d74e202c9d7e44c44301f1bc69cf6cb537347d16f3afa7f65ca4df711ec039dab71c317aa3c1717a

data/lib/process-helper.rb

@@ -20,27 +20,27 @@ module ProcessHelper
     # output_to_wait_for:: Regex containing expected output, +start+ will block until a line of STDOUT matches this regex, if this is nil, then no waiting occurs.
     # wait_timeout:: Timeout while waiting for particular output.
     # env:: Hash of extra environment variables with which to start the process.
-    def start(command_and_args = [], output_to_wait_for = nil, wait_timeout = nil, env = {})
+    def start(command_and_args = [], output_to_wait_for = nil, wait_timeout = nil, env = {}, opts = {})
       out_r, out_w = IO.pipe
-      err_r, err_w = IO.pipe
+      @out_log = ProcessLog.new(out_r, @opts).start
+      if opts[:stderr]
+        err_r, err_w = IO.pipe
+        @err_log = ProcessLog.new(err_r, @opts).start
+      else
+        err_w = out_w
+      end
       @pid = spawn(env, *command_and_args, :out => out_w, :err => err_w)
       out_w.close
-      err_w.close
-
-      log = []
-
-      @out_log = ProcessLog.new(out_r, @opts, log).start
-      @err_log = ProcessLog.new(err_r, @opts).start
-
-      @out_log.wait_for_output(output_to_wait_for, :timeout => wait_timeout) if output_to_wait_for
+      err_w.close if opts[:stderr]
+      @out_log.wait_for_output(output_to_wait_for, :timeout => wait_timeout) unless output_to_wait_for.nil?
     end
 
     # returns true if the process exited with an exit code of 0.
     def wait_for_exit
       @out_log.wait
-      @err_log.wait
+      @err_log.wait unless @err_log.nil?
 
-      Process.wait @pid
+      Process.wait(@pid)
       @exit_status = $CHILD_STATUS
 
       @pid = nil
@@ -57,7 +57,8 @@ module ProcessHelper
     # * +:out+
     # * +:err+
     def get_log(which)
-      _get_log(which).to_a
+      log = _get_log(which)
+      log.nil? ? [] : log.to_a
     end
 
     # Gets an array containing all the lines for the specified stream, emptying the stored buffer.
@@ -65,7 +66,8 @@ module ProcessHelper
     # * +:out+
     # * +:err+
     def get_log!(which)
-      _get_log(which).drain
+      log = _get_log(which)
+      log.nil? ? [] : log.drain
     end
 
     # Blocks the current thread until the specified regex has been matched in the output.
@@ -121,10 +123,10 @@ module ProcessHelper
     def wait_for_output(regex, opts = {})
       opts = { :poll_rate => 0.25 }.merge(opts)
       opts[:timeout] ||= 30
-      cutoff = DateTime.now + Rational(opts[:timeout].to_i, 86_400)
+      cutoff = Time.now + opts[:timeout].to_i
       until _any_line_matches(regex)
         sleep(opts[:poll_rate])
-        fail "Timeout of #{opts[:timeout]} seconds exceeded while waiting for output that matches '#{regex}'" if DateTime.now > cutoff
+        fail "Timeout of #{opts[:timeout]} seconds exceeded while waiting for output that matches '#{regex}'" if Time.now > cutoff
         fail "EOF encountered while waiting for output that matches '#{regex}'" if eof and !_any_line_matches(regex)
       end
     end

data/spec/process_helper_spec.rb

@@ -1,8 +1,16 @@
 require 'spec_helper'
 
+def run(*args)
+  process = ProcessHelper::ProcessHelper.new
+  process.start(*args)
+  process.wait_for_exit
+  process
+end
+
 module ProcessHelper
+
   describe ProcessHelper do
-    context 'Things...' do
+    context 'Tests' do
       it 'It should start a process and capture the exit status (success)' do
         process = ProcessHelper.new
         process.start('true')
@@ -33,23 +41,20 @@ module ProcessHelper
       end
 
       it 'It should expose stdout' do
-        process = ProcessHelper.new
-        process.start(['sh', '-c', 'echo hello ; echo there'])
-        process.wait_for_exit
+        process = run(['sh', '-c', 'echo hello ; echo there'])
         out = process.get_log(:out)
-        expect(out.count).to eq(2)
-        expect(out[0]).to eq("hello\n")
-        expect(out[1]).to eq("there\n")
+        expect(out).to eq(["hello\n", "there\n"])
+      end
+
+      it 'It should expose stdout and stderr' do
+        process = run(['sh', '-c', 'echo hello; echo there >&2'])
+        expect(process.get_log(:out)).to eq(["hello\n", "there\n"])
+        expect(process.get_log(:err)).to eq([])
       end
 
       it 'It should expose stderr' do
-        process = ProcessHelper.new
-        process.start(['sh', '-c', 'echo hello >&2; echo there >&2'])
-        process.wait_for_exit
-        err = process.get_log(:err)
-        expect(err.count).to eq(2)
-        expect(err[0]).to eq("hello\n")
-        expect(err[1]).to eq("there\n")
+        process = run(['sh', '-c', 'echo hello >&2; echo there >&2'], nil, nil, {}, stderr: true)
+        expect(process.get_log(:err)).to eq(["hello\n", "there\n"])
       end
 
       it 'It should expose the pid' do
@@ -63,9 +68,7 @@ module ProcessHelper
 
       it 'It should timestamp the logs' do
         t0 = Time.now
-        process = ProcessHelper.new
-        process.start(['sh', '-c', 'echo a ; sleep 1 ; echo b ; sleep 1 ; echo c'])
-        process.wait_for_exit
+        process = run(['sh', '-c', 'echo a ; sleep 1 ; echo b ; sleep 1 ; echo c'])
         t1 = Time.now
 
         out = process.get_log(:out)
@@ -85,7 +88,7 @@ module ProcessHelper
         process = ProcessHelper.new
         process.start(
           ['sh', '-c', 'echo frog >&2 ; sleep 1 ; echo cat ; sleep 1 ; echo dog ; sleep 1 ; echo frog'],
-          /fro/
+          /fro/, nil, {}, stderr: true
         )
         t1 = Time.now
 
@@ -117,7 +120,7 @@ module ProcessHelper
         process = ProcessHelper.new
         process.start(
           ['sh', '-c', 'echo frog >&2 ; sleep 1 ; echo cat ; sleep 1 ; echo dog ; sleep 1 ; echo frog; sleep 3; echo goat'],
-          /fro/
+          /fro/, nil, {}, stderr: true
         )
         t1 = Time.now
 
@@ -133,7 +136,8 @@ module ProcessHelper
       it 'It should support draining the logs' do
         process = ProcessHelper.new
         process.start(
-          ['bash', '-c', 'for ((i=0; $i<10; i=$i+1)) ; do echo out $i ; echo err $i >&2 ; sleep 1 ; done']
+          ['bash', '-c', 'for ((i=0; $i<10; i=$i+1)) ; do echo out $i ; echo err $i >&2 ; sleep 1 ; done'],
+          nil, nil, {}, stderr: true
         )
 
         sleep 3

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: process-helper
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.1
 platform: ruby
 authors:
 - rachel evans
@@ -56,8 +56,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.3
+rubygems_version: 3.2.3
 signing_key: 
 specification_version: 4
 summary: Utility for managing sub processes.