frontkick 0.4.9 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 16a532fb426a342a5850b7b64badbcc69e66e718
-  data.tar.gz: d0e33fb6cab10d114c247f53d6b9ea309bf831f7
+  metadata.gz: c1ec1035f37f85a6c2df0efac9c9a2bf94f924aa
+  data.tar.gz: f86e5798517525996d28f8e9ea37752864771b50
 SHA512:
-  metadata.gz: 777ce58833f2764f2115bf012ffea28d9cb8d99fa3d596678a1c7664e1fb05503b37513fc281207813b36425878b6cce0c370b0d3d1ef9575450f3c9d9f82a4e
-  data.tar.gz: 05092c48d5d8c3972e0d50e966458ca45d895efc14f7ffcf4e1b6e1b0b66eb1f54dc03fdc5d94ec00820546b7ab5335b72e1b752666f4d9495425a1a0f2495fb
+  metadata.gz: 15f13d612326c77c06c274c0a21be7d80c5da51018a1060f8092ead9170387079cf99bc77447acc7aab34dd51a125b72cd0bf3dc46118aa7f682e6c54cf3c6f3
+  data.tar.gz: 13eb2a6ddc5fd04aba31e499428c17ba982e5a0ac6c80a80f6c668bf8cfb3cacdf7a1b056e98bb5d1488b1b0d527b08435680f252331bfc806dcc2b4fa97b1ca

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+# 0.5.0 (2016/01/22)
+
+Enhancements:
+
+- Add :out and :err options to redirects STDOUT and STDERR
+
 # 0.4.9 (2016/01/22)
 
 Enhancements:

data/README.md

@@ -67,12 +67,17 @@ NOTE: Shoud use `[]` form, otherwirse `sh -c 'sleep 100'` is ran, and frotkick k
 
 Other options such as :chdir are treated as options of `Kernel.#spawn`. See http://ruby-doc.org/core-2.3.0/Kernel.html#method-i-spawn for available options.
 
-### Hint: Redirect stderr to stdout
+### Redirect Options
 
-Frontkick itself does not aid anything, but you can do as
+    Frontkick.exec(["ls /something_not_found"], :out => 'stdout.txt', :err => 'stderr.txt')
 
-    result = Frontkick.exec(["ls /something_not_found 2>&1"])
-    puts result.stdout #=> ls: /something_not_found: No such file or directory
+This redirects STDOUT and STDERR into files. In this case, result.stdout, and result.stderr are the given filename.
+
+    out = File.open('stdout.txt', 'w').tap {|fp| fp.sync = true }
+    err = File.open('stderr.txt', 'w').tap {|fp| fp.sync = true }
+    Frontkick.exec(["ls /something_not_found"], :out => out, :err => err)
+
+You can also give IO objects. In this case, result.stdout, and result.stderr are the given IO objects.
 
 ## Contributing
 

data/example/out_err.rb

@@ -0,0 +1,8 @@
+require 'frontkick'
+
+out = '/tmp/frontkick_stdout.txt'
+err = '/tmp/frontkick_stderr.txt'
+result = Frontkick.exec(["ls /something_not_found"], :out => out, :err => err)
+puts "write to #{result.stdout} and #{result.stderr}"
+puts File.read(result.stdout)
+puts File.read(result.stderr)

data/lib/frontkick/command.rb

@@ -7,8 +7,30 @@ module Frontkick
     def self.exec(cmd, opts = {})
       opts[:timeout_kill] = true unless opts.has_key?(:timeout_kill) # default: true
 
-      stdout, stderr, exit_code, duration = nil
-      stdin, out, err, wait_thr, pid = nil
+      exit_code, duration = nil
+      stdin, stdout, stderr, wait_thr, pid = nil
+
+      if opts[:out]
+        if opts[:out].is_a?(String)
+          out = File.open(opts[:out], 'w')
+          out.sync = true
+        else
+          out = opts[:out] # IO
+        end
+      else
+        out = StringIO.new
+      end
+
+      if opts[:err]
+        if opts[:err].is_a?(String)
+          err = File.open(opts[:err], 'w')
+          err.sync = true
+        else
+          err = opts[:err] # IO
+        end
+      else
+        err = StringIO.new
+      end
 
       cmd_array = cmd.kind_of?(Array) ? cmd : [cmd]
       command = "#{cmd_array.first} #{Shellwords.shelljoin(cmd_array[1..-1])}"
@@ -23,9 +45,23 @@ module Frontkick
       begin
         ::Timeout.timeout(opts[:timeout], Frontkick::TimeoutLocal) do # nil is for no timeout
           duration = Benchmark.realtime do
-            stdin, out, err, wait_thr = Open3.popen3(*cmd_array, spawn_opts)
-            out_reader = Thread.new { out.read }
-            err_reader = Thread.new { err.read }
+            stdin, stdout, stderr, wait_thr = Open3.popen3(*cmd_array, spawn_opts)
+            out_thread = Thread.new {
+              begin
+                while true
+                  out.write stdout.readpartial(4096)
+                end
+              rescue EOFError
+              end
+            }
+            err_thread = Thread.new {
+              begin
+                while true
+                  err.write stderr.readpartial(4096)
+                end
+              rescue EOFError
+              end
+            }
             stdin.close
             pid = wait_thr.pid
 
@@ -33,8 +69,8 @@ module Frontkick
               trap_signal(pid)
             end
 
-            stdout = out_reader.value
-            stderr = err_reader.value
+            out_thread.join
+            err_thread.join
             exit_code = wait_thr.value.exitstatus
             process_wait(pid)
           end
@@ -52,9 +88,19 @@ module Frontkick
         err.close if err and !err.closed?
         wait_thr.kill if wait_thr and !wait_thr.stop?
         lock_fd.flock(File::LOCK_UN) if lock_fd
+        if opts[:out] and opts[:out].is_a?(String)
+          out.close rescue nil
+        end
+        if opts[:err] and opts[:err].is_a?(String)
+          err.close rescue nil
+        end
       end
-      
-      Result.new(:stdout => stdout, :stderr => stderr, :exit_code => exit_code, :duration => duration)
+
+      Result.new(
+        :stdout => opts[:out] ? opts[:out] : out.string,
+        :stderr => opts[:err] ? opts[:err] : err.string,
+        :exit_code => exit_code, :duration => duration
+      )
     end
 
     # private

data/lib/frontkick/result.rb

@@ -6,7 +6,7 @@ module Frontkick
     alias :exitstatus :exit_code # for compatibility with Open3 Process::Status
     alias :exitstatus= :exit_code= # for compatibility with Open3 Process::Status
 
-    def initialize(params)
+    def initialize(params = {})
       @stdout = params[:stdout] || ""
       @stderr = params[:stderr] || ""
       @exit_code = params[:exit_code] || 0

data/lib/frontkick/version.rb

@@ -1,3 +1,3 @@
 module Frontkick
-  VERSION = "0.4.9"
+  VERSION = "0.5.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: frontkick
 version: !ruby/object:Gem::Version
-  version: 0.4.9
+  version: 0.5.0
 platform: ruby
 authors:
 - Naotoshi Seo
@@ -69,6 +69,7 @@ files:
 - Rakefile
 - example/dry_run.rb
 - example/kill_child.rb
+- example/out_err.rb
 - example/run.rb
 - example/spawn_opts.rb
 - experiment/capture3_no_deadlock.rb