scmd 2.2.0 → 2.3.0

data/lib/scmd/command.rb

@@ -86,10 +86,10 @@ module Scmd
       end
     end
 
-    def kill
+    def kill(sig = nil)
       return if !running?
 
-      send_kill
+      send_kill(sig)
       wait # indefinitely until cmd is killed
     end
 
@@ -146,13 +146,13 @@ module Scmd
       send_signal 'TERM'
     end
 
-    def send_kill
-      send_signal 'KILL'
+    def send_kill(sig = nil)
+      send_signal(sig || 'KILL')
     end
 
     def send_signal(sig)
       return if !running?
-      ::Process.kill sig, @child_process.pid
+      @child_process.send_signal(sig)
     end
 
     def stringify_hash(hash)
@@ -201,6 +201,10 @@ module Scmd
         end
       end
 
+      def send_signal(sig)
+        process_kill(sig, self.pid)
+      end
+
       def flush_stdout; @stdout.read; end
       def flush_stderr; @stderr.read; end
 
@@ -218,6 +222,19 @@ module Scmd
         io.read_nonblock(size)
       end
 
+      def process_kill(sig, pid)
+        child_pids(pid).each{ |p| process_kill(sig, p) }
+        ::Process.kill(sig, pid)
+      end
+
+      def child_pids(pid)
+        Command.new("#{pgrep} -P #{pid}").run.stdout.split("\n").map(&:to_i)
+      end
+
+      def pgrep
+        @pgrep ||= Command.new('which pgrep').run.stdout.strip
+      end
+
     end
 
   end

data/lib/scmd/version.rb

@@ -1,3 +1,3 @@
 module Scmd
-  VERSION = "2.2.0"
+  VERSION = "2.3.0"
 end

data/test/system/command_tests.rb

@@ -0,0 +1,173 @@
+require "assert"
+require 'scmd/command'
+
+class Scmd::Command
+
+  class SystemTests < Assert::Context
+    desc "Scmd::Command"
+    setup do
+      @success_cmd = Scmd::Command.new("echo hi")
+      @failure_cmd = Scmd::Command.new("cd /path/that/does/not/exist")
+    end
+
+    should "run the command and set appropriate result data" do
+      @success_cmd.run
+
+      assert_not_nil @success_cmd.pid
+      assert_equal 0, @success_cmd.exitstatus
+      assert @success_cmd.success?
+      assert_equal "hi\n", @success_cmd.stdout
+      assert_equal '', @success_cmd.stderr
+
+      @failure_cmd.run
+
+      assert_not_nil @failure_cmd.pid
+      assert_not_equal 0, @failure_cmd.exitstatus
+      assert_not @failure_cmd.success?
+      assert_equal '', @failure_cmd.stdout
+      assert_not_equal '', @failure_cmd.stderr
+    end
+
+    should "raise an exception with proper backtrace on `run!`" do
+      err = begin;
+        @failure_cmd.run!
+      rescue Exception => err
+        err
+      end
+
+      assert_kind_of Scmd::RunError, err
+      assert_includes 'No such file or directory', err.message
+      assert_includes 'test/system/command_tests.rb:', err.backtrace.first
+    end
+
+    should "return itself on `run`, `run!`" do
+      assert_equal @success_cmd, @success_cmd.run
+      assert_equal @success_cmd, @success_cmd.run!
+      assert_equal @failure_cmd, @failure_cmd.run
+    end
+
+    should "start and be running until `wait` is called and the cmd exits" do
+      cmd = Scmd::Command.new("sleep .1")
+      assert_not cmd.running?
+
+      cmd.start
+      assert cmd.running?
+      assert_not_nil cmd.pid
+
+      cmd.wait
+      assert_not cmd.running?
+    end
+
+  end
+
+  class InputTests < SystemTests
+    desc "that takes input on stdin"
+    setup do
+      @cmd = Scmd::Command.new("sh")
+    end
+    subject { @cmd }
+
+    should "run the command given a single line of input" do
+      subject.run "echo hi"
+
+      assert @cmd.success?
+      assert_equal "hi\n", @cmd.stdout
+    end
+
+    should "run the command given multiple lines of input" do
+      subject.run ["echo hi", "echo err 1>&2"]
+
+      assert @cmd.success?
+      assert_equal "hi\n",  @cmd.stdout
+      assert_equal "err\n", @cmd.stderr
+    end
+
+  end
+
+  class LongRunningTests < SystemTests
+    desc "that is long running"
+    setup do
+      @long_cmd = Scmd::Command.new("sleep .3 && echo hi")
+    end
+
+    should "not timeout if wait timeout is longer than cmd time" do
+      assert_nothing_raised do
+        @long_cmd.start
+        @long_cmd.wait(1)
+      end
+      assert @long_cmd.success?
+      assert_equal "hi\n", @long_cmd.stdout
+    end
+
+    should "timeout if wait timeout is shorter than cmd time" do
+      assert_raises(Scmd::TimeoutError) do
+        @long_cmd.start
+        @long_cmd.wait(0.1)
+      end
+      assert_not @long_cmd.success?
+      assert_empty @long_cmd.stdout
+    end
+
+    should "be stoppable" do
+      @long_cmd.start
+      @long_cmd.stop
+
+      assert_not @long_cmd.running?
+    end
+
+    should "be killable" do
+      @long_cmd.start
+      @long_cmd.kill
+
+      assert_not @long_cmd.running?
+    end
+
+    should "be killable with a non-default signal" do
+      @long_cmd.start
+      @long_cmd.kill('INT')
+
+      assert_not @long_cmd.running?
+    end
+
+  end
+
+  class BufferDeadlockTests < SystemTests
+    desc "when capturing data from an output buffer"
+    setup do
+      @small_path = File.join(ROOT_PATH, 'test/support/smaller-than-64k.txt')
+      @small_data = File.read(@small_path)
+      @small_cmd  = Scmd::Command.new("cat #{@small_path}")
+
+      @big_path = File.join(ROOT_PATH, 'test/support/bigger-than-64k.txt')
+      @big_data = File.read(@big_path)
+      @big_cmd  = Scmd::Command.new("cat #{@big_path}")
+    end
+
+    should "not deadlock, just stream the data from the buffer" do
+      @small_cmd.start
+      assert_nothing_raised{ @small_cmd.wait(1) }
+      assert_equal @small_data, @small_cmd.stdout
+
+      @big_cmd.start
+      assert_nothing_raised{ @big_cmd.wait(1) }
+      assert_equal @big_data, @big_cmd.stdout
+    end
+
+  end
+
+  class WithEnvVarTests < SystemTests
+    desc "with environment variables"
+    setup do
+      @cmd = Scmd::Command.new("echo $SCMD_TEST_VAR", {
+        'SCMD_TEST_VAR' => 'test'
+      })
+    end
+
+    should "use them when running the command" do
+      @cmd.run
+      assert_equal "test\n", @cmd.stdout
+    end
+
+  end
+
+end

data/test/unit/command_tests.rb

@@ -6,10 +6,9 @@ class Scmd::Command
   class UnitTests < Assert::Context
     desc "Scmd::Command"
     setup do
-      @success_cmd = Scmd::Command.new("echo hi")
-      @failure_cmd = Scmd::Command.new("cd /path/that/does/not/exist")
+      @cmd = Scmd::Command.new("echo hi")
     end
-    subject { @success_cmd }
+    subject { @cmd }
 
     should have_readers :cmd_str, :env
     should have_readers :pid, :exitstatus, :stdout, :stderr
@@ -41,52 +40,9 @@ class Scmd::Command
       assert_equal '', subject.stderr
     end
 
-    should "run the command and set appropriate result data" do
-      @success_cmd.run
-
-      assert_not_nil @success_cmd.pid
-      assert_equal 0, @success_cmd.exitstatus
-      assert @success_cmd.success?
-      assert_equal "hi\n", @success_cmd.stdout
-      assert_equal '', @success_cmd.stderr
-
-      @failure_cmd.run
-
-      assert_not_nil @failure_cmd.pid
-      assert_not_equal 0, @failure_cmd.exitstatus
-      assert_not @failure_cmd.success?
-      assert_equal '', @failure_cmd.stdout
-      assert_not_equal '', @failure_cmd.stderr
-    end
-
-    should "raise an exception with proper backtrace on `run!`" do
-      err = begin;
-        @failure_cmd.run!
-      rescue Exception => err
-        err
-      end
-
-      assert_kind_of Scmd::RunError, err
-      assert_includes 'No such file or directory', err.message
-      assert_includes 'test/unit/command_tests.rb:', err.backtrace.first
-    end
-
-    should "return itself on `run`, `run!`" do
-      assert_equal @success_cmd, @success_cmd.run
-      assert_equal @success_cmd, @success_cmd.run!
-      assert_equal @failure_cmd, @failure_cmd.run
-    end
-
-    should "start and be running until `wait` is called and the cmd exits" do
-      cmd = Scmd::Command.new("sleep .1")
-      assert_not cmd.running?
-
-      cmd.start
-      assert cmd.running?
-      assert_not_nil cmd.pid
-
-      cmd.wait
-      assert_not cmd.running?
+    should "default its state" do
+      assert_false subject.running?
+      assert_false subject.success?
     end
 
     should "do nothing and return when told to wait but not running" do
@@ -115,107 +71,4 @@ class Scmd::Command
 
   end
 
-  class InputTests < UnitTests
-    desc "that takes input on stdin"
-    setup do
-      @cmd = Scmd::Command.new("sh")
-    end
-    subject { @cmd }
-
-    should "run the command given a single line of input" do
-      subject.run "echo hi"
-
-      assert @cmd.success?
-      assert_equal "hi\n", @cmd.stdout
-    end
-
-    should "run the command given multiple lines of input" do
-      subject.run ["echo hi", "echo err 1>&2"]
-
-      assert @cmd.success?
-      assert_equal "hi\n",  @cmd.stdout
-      assert_equal "err\n", @cmd.stderr
-    end
-
-  end
-
-  class LongRunningTests < UnitTests
-    desc "that is long running"
-    setup do
-      @long_cmd = Scmd::Command.new("sleep .3 && echo hi")
-    end
-
-    should "not timeout if wait timeout is longer than cmd time" do
-      assert_nothing_raised do
-        @long_cmd.start
-        @long_cmd.wait(1)
-      end
-      assert @long_cmd.success?
-      assert_equal "hi\n", @long_cmd.stdout
-    end
-
-    should "timeout if wait timeout is shorter than cmd time" do
-      assert_raises(Scmd::TimeoutError) do
-        @long_cmd.start
-        @long_cmd.wait(0.1)
-      end
-      assert_not @long_cmd.success?
-      assert_empty @long_cmd.stdout
-    end
-
-    should "be stoppable" do
-      @long_cmd.start
-      @long_cmd.stop
-
-      assert_not @long_cmd.running?
-    end
-
-    should "be killable" do
-      @long_cmd.start
-      @long_cmd.kill
-
-      assert_not @long_cmd.running?
-    end
-
-  end
-
-  class BufferDeadlockTests < UnitTests
-    desc "when capturing data from an output buffer"
-    setup do
-      @small_path = File.join(ROOT_PATH, 'test/support/smaller-than-64k.txt')
-      @small_data = File.read(@small_path)
-      @small_cmd  = Scmd::Command.new("cat #{@small_path}")
-
-      @big_path = File.join(ROOT_PATH, 'test/support/bigger-than-64k.txt')
-      @big_data = File.read(@big_path)
-      @big_cmd  = Scmd::Command.new("cat #{@big_path}")
-    end
-
-    should "not deadlock, just stream the data from the buffer" do
-      @small_cmd.start
-      assert_nothing_raised{ @small_cmd.wait(1) }
-      assert_equal @small_data, @small_cmd.stdout
-
-      @big_cmd.start
-      assert_nothing_raised{ @big_cmd.wait(1) }
-      assert_equal @big_data, @big_cmd.stdout
-    end
-
-  end
-
-  class WithEnvVarTests < UnitTests
-    desc "with environment variables"
-    setup do
-      @cmd = Scmd::Command.new("echo $SCMD_TEST_VAR", {
-        'SCMD_TEST_VAR' => 'test'
-      })
-    end
-
-    should "use them when running the command" do
-      @cmd.run
-      assert_equal "test\n", @cmd.stdout
-    end
-
-  end
-
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: scmd
 version: !ruby/object:Gem::Version 
-  hash: 7
+  hash: 3
   prerelease: 
   segments: 
   - 2
-  - 2
+  - 3
   - 0
-  version: 2.2.0
+  version: 2.3.0
 platform: ruby
 authors: 
 - Kelly Redding
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2014-06-13 00:00:00 Z
+date: 2014-07-31 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   requirement: &id001 !ruby/object:Gem::Requirement 
@@ -29,9 +29,9 @@ dependencies:
         - 2
         - 3
         version: "2.3"
-  version_requirements: *id001
   type: :development
   name: assert
+  version_requirements: *id001
   prerelease: false
 - !ruby/object:Gem::Dependency 
   requirement: &id002 !ruby/object:Gem::Requirement 
@@ -43,9 +43,9 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  version_requirements: *id002
   type: :runtime
   name: posix-spawn
+  version_requirements: *id002
   prerelease: false
 description: Build and run system commands.
 email: 
@@ -74,6 +74,7 @@ files:
 - test/helper.rb
 - test/support/bigger-than-64k.txt
 - test/support/smaller-than-64k.txt
+- test/system/command_tests.rb
 - test/unit/command_tests.rb
 - test/unit/scmd_tests.rb
 - tmp/.gitkeep
@@ -106,7 +107,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.8.29
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: Build and run system commands.
@@ -114,5 +115,6 @@ test_files:
 - test/helper.rb
 - test/support/bigger-than-64k.txt
 - test/support/smaller-than-64k.txt
+- test/system/command_tests.rb
 - test/unit/command_tests.rb
 - test/unit/scmd_tests.rb