frontkick 0.3.5 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 60f95541b62fdc0a191da6d51f297f809b737f52
-  data.tar.gz: f4a733e629822159ef9199cc54fbeca4fba221b3
+  metadata.gz: 9bc4c44cc031f5977ca8d93417ae56abbd2e6d36
+  data.tar.gz: eb941fc286e02a0fe3abf28fe0bc975e5e4da86a
 SHA512:
-  metadata.gz: b9d959c6869e3a069aca2b1eb6f5596fb5e919ae0a1a2471ff014af01e25e73c8262181a671e91516a5523f771783eba32189ae2fe322bcc26328b238b0a34b7
-  data.tar.gz: 85c4a12db6391cbeb5d1fc18d7d1317384d7c64ffe41232bc8c2532b31e36e374cdcc07baa2007708fda1dea86bfd4f5f70d86c9a0194024b9dceb13613256cb
+  metadata.gz: a02886dbdc4ac359d9ab8b263ea8a34c0902a7c24a7690c00a2ff65db23b0924c1cd8fe22e31083878a7090640cf44697ae785536edf2a8c125430a872d661bd
+  data.tar.gz: 93ef0cc02ea29058914f4fc828b42b672c749f4833187fdb5cf79b3b381f8d75ef024d1cf7f54bf113c08257652c4260f6f8ca5d0e09f00b4ac896d16b4874e9

data/CHANGELOG.md

@@ -1,3 +1,17 @@
+# 0.4.1 (2015/08/15)
+
+Changes:
+
+- :timeout option now raises Frontkick::Timeout
+
+Enhancements:
+
+- Add :timeout_kill => false option not to kill timeouted process
+
+# 0.4.0 (2015/08/15)
+
+yanked
+
 # 0.3.5 (2015/08/13)
 
 Enhancements:

data/README.md

@@ -33,7 +33,11 @@ With frontkick, you can easily get the exit code, STDOUT, and STDERR.
 
 ### Timeout Option
 
-    Frontkick.exec("sleep 2 && ls /hoge", :timeout => 1)
+    Frontkick.exec("sleep 2 && ls /hoge", :timeout => 1) # raises Frontkick::Timeout
+
+not to kill timeouted process
+
+    Frontkick.exec("sleep 2 && ls /hoge", :timeout => 1, :timeout_kill => false) # raises Frontkick::Timeout
 
 ### Exclusive Option
 

data/lib/frontkick/command.rb

@@ -4,13 +4,16 @@ require 'open3'
 module Frontkick
   class Command
     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
 
       cmd_array = cmd.kind_of?(Array) ? cmd : [cmd]
+      command = cmd_array.join(' ')
       lock_fd = file_lock(opts[:exclusive], opts[:exclusive_blocking]) if opts[:exclusive]
       begin
-        timeout(opts[:timeout]) do # nil is for no 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)
             stdin.close
@@ -21,13 +24,13 @@ module Frontkick
             process_wait(pid)
           end
         end
-      rescue Timeout::Error => e
-        Process.kill('SIGINT', pid)
-        exit_code = wait_thr.value.exitstatus
-        process_wait(pid)
-        duration = opts[:timeout]
-        stdout = ""
-        stderr = "pid:#{pid}\tcommand:#{cmd_array.join(' ')} is timeout!"
+      rescue Frontkick::TimeoutLocal => e
+        if opts[:timeout_kill]
+          Process.kill('SIGINT', pid)
+          exit_code = wait_thr.value.exitstatus
+          process_wait(pid)
+        end
+        raise Frontkick::Timeout.new(pid, command, opts[:timeout_kill])
       ensure
         stdin.close if stdin and !stdin.closed?
         out.close if out and !out.closed?

data/lib/frontkick/error.rb

@@ -1,3 +1,23 @@
+require 'json'
+require 'timeout'
+
 module Frontkick
+  # ref. http://docs.ruby-lang.org/ja/1.9.3/class/Timeout=3a=3aError.html
+  class TimeoutLocal < ::Timeout::Error; end
   class Locked < StandardError; end
+  class Timeout < StandardError
+    attr_reader :pid, :command, :killed
+
+    def initialize(pid, command, killed)
+      @pid = pid
+      @command = command
+      @killed = killed
+    end
+
+    def to_s
+      {pid: @pid, command: @command, killed: @killed}.to_json
+    end
+
+    alias_method :message, :to_s
+  end
 end

data/lib/frontkick/version.rb

@@ -1,3 +1,3 @@
 module Frontkick
-  VERSION = "0.3.5"
+  VERSION = "0.4.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: frontkick
 version: !ruby/object:Gem::Version
-  version: 0.3.5
+  version: 0.4.1
 platform: ruby
 authors:
 - Naotoshi Seo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-13 00:00:00.000000000 Z
+date: 2015-08-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake