frontkick 0.5.6 → 0.5.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 63b7b2198e42097421d10d7239c37e2e54a8dfb3
-  data.tar.gz: 43d83e3462ef85f1eec58cbf1100444b394b7463
+  metadata.gz: 58c67ae20a2f6e7807c0f88329dd758548c5ff3f
+  data.tar.gz: 5da56ec31b5550c6cd723f839cf11264844119aa
 SHA512:
-  metadata.gz: f745524870d4a7c8a6a99555ef146e9c6bac60b0110d40cf3462b5c7061bddc5087d2daffa8a095c3916517c935f12abfe10680ea493e05b7c35a53d1c0cbcf6
-  data.tar.gz: 2581b317c4a408e85099b7ee495cb5d8905c4df200d0de74880376b5eec456a1b2775903c713e70818ac2b4c8698f8e30f492c842c5991f0bcad7d512972de18
+  metadata.gz: 863d2b04e91a27960ab5fd91c45c54876b71de1852447101f1bd720ea2b47cb6f957be16313088b87483506b788b3a9dc44678e6ad7c429a1685622fe3443d1c
+  data.tar.gz: 3ea6eb45338bdf1f42632a098fe32a5e0b1bdfb5859ef49e371c41368b4a8de139832a61128e66949ebb1c4a0e0cffe53c3c3ca167f913239dac06eee70730e1

data/.gitignore

@@ -11,3 +11,4 @@ doc/*
 tmp/*
 .yardoc
 pkg
+/.idea/

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+# 0.5.7 (2017/12/25)
+
+Enhancements:
+
+- Add `timeout_kill_signal` option to set the signal to send on timeout (thanks to niku4i)
+
 # 0.5.6 (2017/04/10)
 
 Fixes:

data/README.md

@@ -70,16 +70,16 @@ ruby
 └─ echo
 ```
 
-NOTE: This interface is different with Kernel.spawn or Open3.popen3, but similar to IO.popen. Kernel.spawn or Open3.popen3 works with no shell if multiple arguments are given:
+NOTE: This **no shell** interface is similar to IO.popen which work as:
 
 ```
-spawn('echo', '*')
+IO.popen(['echo', '*'])
 ```
 
-IO.popen works with no shell if an array argument is given:
+but different with Kernel.spawn, or Open3.popen3 which work as:
 
 ```
-IO.popen(['echo', '*'])
+spawn('echo', '*')
 ```
 
 ### Environment Variables
@@ -93,20 +93,27 @@ result = Frontkick.exec({"FOO"=>"BAR"}, ["echo", "*"])
 ### Dry Run Option
 
 ```ruby
-result = Frontkick.exec(["echo", "*"], :dry_run => true)
+result = Frontkick.exec(["echo", "*"], dry_run: true)
 puts result.stdout #=> echo \*
 ```
 
 ### Timeout Option
 
 ```ruby
-Frontkick.exec("sleep 2 && ls /hoge", :timeout => 1) # raises Frontkick::Timeout
+Frontkick.exec("sleep 2 && ls /hoge", timeout: 1) # raises Frontkick::Timeout
+```
+
+The default signal that is sent to the command is `SIGINT`.
+You can change the signal as below.
+
+```ruby
+Frontkick.exec("sleep 2 && ls /hoge", timeout: 1, timeout_kill_signal: 'SIGTERM') # raises Frontkick::Timeout
 ```
 
 not to kill timeouted process
 
 ```ruby
-Frontkick.exec("sleep 2 && ls /hoge", :timeout => 1, :timeout_kill => false) # raises Frontkick::Timeout
+Frontkick.exec("sleep 2 && ls /hoge", timeout: 1, timeout_kill: false) # raises Frontkick::Timeout
 ```
 
 ### Exclusive Option
@@ -114,19 +121,19 @@ Frontkick.exec("sleep 2 && ls /hoge", :timeout => 1, :timeout_kill => false) # r
 Prohibit another process to run a command concurrently
 
 ```ruby
-Frontkick.exec("sleep 2 && ls /hoge", :exclusive => "/tmp/frontkick.lock") # raises Fontkick::Locked if locked
+Frontkick.exec("sleep 2 && ls /hoge", exclusive: "/tmp/frontkick.lock") # raises Fontkick::Locked if locked
 ```
 
 If you prefer to be blocked:
 
 ```ruby
-Frontkick.exec("sleep 2 && ls /hoge", :exclusive => "/tmp/frontkick.lock", :exclusive_blocking => true)
+Frontkick.exec("sleep 2 && ls /hoge", exclusive: "/tmp/frontkick.lock", exclusive_blocking: true)
 ```
 
 ### Redirect Options (:out and :err)
 
 ```ruby
-Frontkick.exec(["ls /something_not_found"], :out => 'stdout.txt', :err => 'stderr.txt')
+Frontkick.exec(["ls /something_not_found"], out: 'stdout.txt', err: 'stderr.txt')
 ```
 
 This redirects STDOUT and STDERR into files. In this case, result.stdout, and result.stderr are the given filename.
@@ -134,7 +141,7 @@ This redirects STDOUT and STDERR into files. In this case, result.stdout, and re
 ```ruby
 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)
+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.
@@ -142,15 +149,15 @@ You can also give IO objects. In this case, result.stdout, and result.stderr are
 ### Popen2e Option (Get stdout and stderr together)
 
 ```ruby
-result = Frontkick.exec("echo foo; ls /something_not_found", :popen2e => true)
+result = Frontkick.exec("echo foo; ls /something_not_found", popen2e: true)
 puts result.output #=>
 foo
 ls: /something_not_found: No such file or directory
 ```
 
-### Popen3 Options (such as :chdir)
+### Other Popen3 Options (such as :chdir)
 
-Other options such as :chdir are treated as options of `Open3.#popen3`.
+Other options such as :chdir are treated as options of `Open3.#popen3` (or `Open3.#popen2e` for the case of `popen2e: true`)
 
 ### Kill Child Process
 

data/lib/frontkick/command.rb

@@ -17,6 +17,7 @@ module Frontkick
       cmd_array = cmd.is_a?(Array) ? cmd : [cmd]
 
       opts[:timeout_kill] = true unless opts.has_key?(:timeout_kill) # default: true
+      opts[:timeout_kill_signal] = 'SIGINT' unless opts.has_key?(:timeout_kill_signal) # default: 'SIGINT'
 
       exit_code, duration = nil
       stdin, stdout, stderr, wait_thr, pid = nil
@@ -44,9 +45,8 @@ module Frontkick
       end
 
       if opts[:dry_run]
-        stdout = env.map {|k,v| "#{k}=#{v} " }.join('')
-        stdout << "#{cmd_array.first} #{Shellwords.shelljoin(cmd_array[1..-1])}"
-        return Result.new(:stdout => stdout, :stderr => '', :exit_code => 0, :duration => 0)
+        command = build_command(env, cmd_array)
+        return Result.new(:stdout => command, :stderr => '', :exit_code => 0, :duration => 0)
       end
 
       popen3_opts = self.popen3_opts(opts)
@@ -105,11 +105,12 @@ module Frontkick
         end
       rescue Frontkick::TimeoutLocal => e
         if opts[:timeout_kill]
-          Process.kill('SIGINT', pid)
+          Process.kill(opts[:timeout_kill_signal], pid)
           exit_code = wait_thr.value.exitstatus
           process_wait(pid)
         end
-        raise Frontkick::Timeout.new(pid, Shellwords.shelljoin(cmd_array), opts[:timeout_kill])
+        command = build_command(env, cmd_array)
+        raise Frontkick::Timeout.new(pid, command, opts[:timeout_kill])
       ensure
         stdin.close if stdin and !stdin.closed?
         stdout.close if stdout and !stdout.closed?
@@ -133,9 +134,17 @@ module Frontkick
 
     # private
 
+    def self.build_command(env, cmd_array)
+      command = env.map {|k,v| "#{k}=#{v} " }.join('')
+      command << cmd_array.first
+      command << " #{cmd_array[1..-1].shelljoin}" if cmd_array.size > 1
+      command
+    end
+
     def self.popen3_opts(opts)
       opts.dup.tap {|o|
         o.delete(:timeout_kill)
+        o.delete(:timeout_kill_signal)
         o.delete(:exclusive)
         o.delete(:exclusive_blocking)
         o.delete(:timeout)

data/lib/frontkick/version.rb

@@ -1,3 +1,3 @@
 module Frontkick
-  VERSION = "0.5.6"
+  VERSION = "0.5.7"
 end

data/spec/frontkick/command_spec.rb

@@ -3,7 +3,7 @@ require 'spec_helper'
 RSpec.describe Frontkick::Command do
   describe '.exec' do
     describe 'timeout option' do
-      subject { described_class.exec('sleep 2 && ls /hoge', timeout: 1) }
+      subject { described_class.exec('sleep 2 && ls /hoge', timeout: 0.01) }
       it { expect { subject }.to raise_error Frontkick::Timeout }
     end
   end

data/spec/spec_helper.rb

@@ -8,6 +8,5 @@ Dir[File.expand_path("support/**/*.rb", ROOT)].each {|f| require f }
 require 'frontkick'
 
 RSpec.configure do |config|
-  config.treat_symbols_as_metadata_keys_with_true_values = true
   config.run_all_when_everything_filtered = true
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: frontkick
 version: !ruby/object:Gem::Version
-  version: 0.5.6
+  version: 0.5.7
 platform: ruby
 authors:
 - Naotoshi Seo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-10 00:00:00.000000000 Z
+date: 2017-12-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -108,7 +108,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: Execute a command simply!