frontkick 0.4.4 → 0.4.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fa4731922579e811c8e634317d8115e6dbb7231b
-  data.tar.gz: 6b9f76e34a8ff11fb612042290f3147de357e4b6
+  metadata.gz: 90e8f994ea85285a3a1f0130061293b7fc557366
+  data.tar.gz: b9e07e7c2dcd214347e6aa1fb45b523e515e323a
 SHA512:
-  metadata.gz: 131147b154b59ec5993648efce84edcbf8ef87674eafd64bd5e558e8d183abde745daa651a457ec669b38af7b413d3464fc83161cd2359972377348cd8288825
-  data.tar.gz: 798c5aff4f2aa9feaa249ff818763d3ee1de6ed71f5ddfbfe631f562bfbea8ca05e07fccd808fbde8d910adf1e0f811302f0ff764e8ed1543e7eae2f76d27608
+  metadata.gz: 210662fde91518f8c9a40dfbbe3516df357d8bbfcd00d16bd9e496cd68f0dca6fabe273ca68dd7914324cd3329fb482cf769a937ec3e7259a64cbc1dbf3ebac7
+  data.tar.gz: b1f7dc35e1542f1aa350001859b42ec0920ff63c20084478ed429ea339cde1d85d6ec1caa3046b2c2e4be9b2968ed3e6b8a607b841eb6c99365217b3dd35fdf8

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+# 0.4.5 (2016/01/05)
+
+Fixes:
+
+- Avoid pipe deadlock
+
 # 0.4.4 (2015/11/25)
 
 Fixes:

data/README.md

@@ -19,12 +19,12 @@ With frontkick, you can easily get the exit code, STDOUT, and STDERR.
 
     result = Frontkick.exec("echo *")
     puts result.successful? #=> true if exit_code is 0
-    puts result.success?    #=> alias to successful?
+    puts result.success?    #=> alias to successful?, for compatibility with Process::Status
     puts result.stdout      #=> stdout output of the command
     puts result.stderr      #=> stderr output of the command
     puts result.exit_code   #=> exit_code of the command
     puts result.status      #=> alias to exit_code
-    puts result.exitstatus  #=> alias to exit_code
+    puts result.exitstatus  #=> alias to exit_code, for compatibility with Process::Status
     puts result.duration    #=> the time used to execute the command
 
 ### Escape Command

data/example/run.rb

@@ -0,0 +1,4 @@
+require 'frontkick'
+
+result = Frontkick.exec(["#{__dir__}/../experiment/cat_64k.rb"])
+puts result.stdout

data/experiment/capture3_no_deadlock.rb

@@ -0,0 +1,8 @@
+require 'open3'
+
+# capture3 handles the deadlock problem of popen3, no deadlock occurs
+
+cmd_array = ['./cat_64k.rb']
+stdout, stderr, status = Open3.capture3(*cmd_array, :stdin_data => '')
+
+puts 'no daedlock'

data/experiment/cat_63k.rb

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+str = 'a' * (63 * 1024)
+STDERR.puts str
+STDOUT.puts str

data/experiment/cat_64k.rb

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+str = 'a' * (64 * 1024)
+STDERR.puts str
+STDOUT.puts str

data/experiment/popen3_deadlock.rb

@@ -0,0 +1,15 @@
+require 'open3'
+
+# popen3 blocks if pipe buffer size overs 64k (depends on system, this is on my Mac)
+# the child process waits its buffer to be read, but the parent process waits the child
+# process finishes and returns EOF, hence deadlocks
+
+cmd_array = ['./cat_64k.rb']
+stdin, out, err, wait_thr = Open3.popen3(*cmd_array)
+stdin.close
+pid = wait_thr.pid
+stdout = out.read
+stderr = err.read
+exit_code = wait_thr.value.exitstatus
+
+puts 'no deadlock'

data/experiment/popen3_no_deadlock.rb

@@ -0,0 +1,16 @@
+require 'open3'
+
+# popen3 without deadlock version
+# almost same with what capture3 does
+
+cmd_array = ['./cat_64k.rb']
+stdin, out, err, wait_thr = Open3.popen3(*cmd_array)
+out_reader = Thread.new { out.read }
+err_reader = Thread.new { err.read }
+stdin.close
+pid = wait_thr.pid
+stdout = out_reader.value
+stderr = err_reader.value
+exit_code = wait_thr.value.exitstatus
+
+puts 'no deadlock'

data/lib/frontkick/command.rb

@@ -22,10 +22,12 @@ module Frontkick
         timeout(opts[:timeout], Frontkick::TimeoutLocal) do # nil is for no timeout
           duration = Benchmark.realtime do
             stdin, out, err, wait_thr = Open3.popen3(*cmd_array)
+            out_reader = Thread.new { out.read }
+            err_reader = Thread.new { err.read }
             stdin.close
             pid = wait_thr.pid
-            stdout = out.read
-            stderr = err.read
+            stdout = out_reader.value
+            stderr = err_reader.value
             exit_code = wait_thr.value.exitstatus
             process_wait(pid)
           end

data/lib/frontkick/version.rb

@@ -1,3 +1,3 @@
 module Frontkick
-  VERSION = "0.4.4"
+  VERSION = "0.4.5"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: frontkick
 version: !ruby/object:Gem::Version
-  version: 0.4.4
+  version: 0.4.5
 platform: ruby
 authors:
 - Naotoshi Seo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-25 00:00:00.000000000 Z
+date: 2016-01-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -68,6 +68,12 @@ files:
 - README.md
 - Rakefile
 - example/dry_run.rb
+- example/run.rb
+- experiment/capture3_no_deadlock.rb
+- experiment/cat_63k.rb
+- experiment/cat_64k.rb
+- experiment/popen3_deadlock.rb
+- experiment/popen3_no_deadlock.rb
 - frontkick.gemspec
 - lib/frontkick.rb
 - lib/frontkick/command.rb