snipr 1.0.0 → 1.1.0

data/bin/snipe

@@ -1,4 +1,4 @@
-#!/usr/bin/ruby
+#!/usr/bin/env ruby
 require 'ostruct'
 require 'optparse'
 
@@ -59,6 +59,11 @@ parser = OptionParser.new do |config|
   config.on("-d", "--dry-run", desc) do
     options.no_signals = true
   end
+
+  desc = "Use the pkill utility to send the signal (targetted process only)"
+  config.on("--pkill", desc) do
+    options.pkill = true
+  end
 end.parse!
 
 # TODO remove me
@@ -88,6 +93,7 @@ signaller = Snipr::ProcessSignaller.new do |signaller|
   end
   signaller.signal          options.signal
   signaller.target_parent   options.target_parent
+  signaller.pkill if options.pkill
   signaller.dry_run if options.no_signals
 
   if options.bytes

data/lib/snipr/process_signaller.rb

@@ -132,14 +132,51 @@ module Snipr
       @dry_run = true
     end
 
+    ##
+    # Use pkill to ensure that the process we are attempting to signal
+    # matches what we know about it. This only works for the
+    # targetted process, not the parent.
+    def pkill
+      @pkill = which("pkill")
+      raise "pkill not found in path or is not executable!" unless @pkill
+    end
+
+    # Determine if a command exists in our PATH
+    def which(cmd)
+      ENV['PATH'].split(File::PATH_SEPARATOR).each do |path|
+        location = File.join(path, cmd)
+        return location if File.executable?(location)
+      end
+      return nil
+    end
+
+    ##
+    # Ensure that the PID we are attempting to kill still matches what we expect
+    # This is not used when pkill option is set
+    def cmd_matches?(process)
+       process.command == Snipr.exec_cmd("ps -p #{process.pid} -o 'command='").first.strip
+    end
+
+    def ppid_matches?(process)
+      Integer(process.ppid) == Integer(Snipr.exec_cmd("ps -p #{process.pid} -o 'ppid='").first.strip)
+    end
+
+    def process_matches?(process)
+      cmd_matches?(process) && ppid_matches?(process)
+    end
+
     private
     def signal_process(process)
       @before_signal.call(@signal, process)
       unless @dry_run
         if @target_parent
-          Process.kill(@signal, process.ppid)
+          Process.kill(@signal, process.ppid) if process_matches?(process)
         else
-          Process.kill(@signal, process.pid)
+          if @pkill
+            system("#{@pkill} --signal #{@signal} -P #{process.ppid} -f \"^#{Regexp.escape(process.command)}\"")
+          else
+            Process.kill(@signal, process.pid) if process_matches?(process)
+          end
         end
       end
       @after_signal.call(@signal, process)

data/lib/snipr/version.rb

@@ -1,3 +1,3 @@
 module Snipr
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

data/spec/process_signaller_spec.rb

@@ -6,6 +6,7 @@ module Snipr
     let(:signal) {Signal.list["USR1"]}
     let(:ps_output) {File.read("spec/ps_output.txt").split("\n")}
     let(:checkins) {OpenStruct.new}
+    let(:pkill) { "/bin/pkill" }
     subject do
       ProcessSignaller.new do |signaller|
         signaller.include /resque/i
@@ -64,13 +65,29 @@ module Snipr
 
       context "when process is found" do
         before do
-          expect(Snipr).to receive(:exec_cmd).and_return(ps_output).at_least(:once)
+          allow(Snipr).to receive(:exec_cmd).and_return(:default)
+          expect(Snipr).to receive(:exec_cmd).with("ps h -eo pid,ppid,%mem,%cpu,etime,command").and_return(ps_output).at_least(:once)
           subject.cpu_greater_than(90)
         end
 
         context "targetting the process itself" do
           it "should send the appropriate signal to the process and call callbacks" do
             expect(Process).to receive(:kill).with(signal, 6337)
+            expect(Snipr).to receive(:exec_cmd).with(/ps -p \d+ -o/).and_return(
+              "resque-1.24.1: Processing foo since 1410189132 [FooJob]",
+              "4347  "
+            ).twice
+            subject.send_signals
+            expect(checkins.before_signal).to eq("#{signal} > 6337")
+            expect(checkins.after_signal).to eq("#{signal} > 6337")
+          end
+
+          it "should shell out to pkill when --pkill option is set" do
+            expect(subject).to receive(:which).and_return(pkill)
+            subject.pkill
+            expect(subject).to receive(:system).with(
+              "#{pkill} --signal #{signal} -P 4347 -f \"^#{Regexp.escape('resque-1.24.1: Processing foo since 1410189132 [FooJob]')}\""
+            )
             subject.send_signals
             expect(checkins.before_signal).to eq("#{signal} > 6337")
             expect(checkins.after_signal).to eq("#{signal} > 6337")
@@ -80,6 +97,10 @@ module Snipr
         context "targetting the parent process" do
           it "should send the appropriate signal to the parent process and call callbacks" do
             subject.target_parent true
+            expect(Snipr).to receive(:exec_cmd).with(/ps -p \d+ -o/).and_return(
+              "resque-1.24.1: Processing foo since 1410189132 [FooJob]",
+              "4347  "
+            ).twice
             expect(Process).to receive(:kill).with(signal, 4347)
             subject.send_signals
             expect(checkins.before_signal).to eq("#{signal} > 6337")
@@ -89,6 +110,7 @@ module Snipr
 
         context "when encountering an error signalling a process" do
           it "should call the on_error callback" do
+            expect(subject).to receive(:process_matches?).and_return(true)
             expect(Process).to receive(:kill).with(signal, 6337).and_raise('Ouch!')
             subject.send_signals
             expect(checkins.on_error).to eq("Ouch! #{signal} > 6337")
@@ -105,6 +127,13 @@ module Snipr
           end
         end
       end
+
+      context "when --pkill is set but no pkill is found in the path" do
+        it "raise an exception" do
+          expect(subject).to receive(:which).and_return(nil)
+          expect{ subject.pkill }.to raise_error
+        end
+      end
     end
   end
 end

metadata

@@ -1,7 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: snipr
 version: !ruby/object:Gem::Version 
-  version: 1.0.0
+  hash: 19
+  prerelease: 
+  segments: 
+  - 1
+  - 1
+  - 0
+  version: 1.1.0
 platform: ruby
 authors: 
 - Lance Woodson
@@ -9,49 +15,69 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2014-11-25 00:00:00 Z
+date: 2017-10-27 00:00:00 -05:00
+default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: bundler
-  prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 1
+        - 6
         version: "1.6"
-  type: :development
   version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: rake
   prerelease: false
+  type: :development
+  name: bundler
+- !ruby/object:Gem::Dependency 
   requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
+        hash: 35
+        segments: 
+        - 10
+        - 0
         version: "10.0"
-  type: :development
   version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: rspec
   prerelease: false
+  type: :development
+  name: rake
+- !ruby/object:Gem::Dependency 
   requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 3
+        - 1
+        - 0
         version: 3.1.0
-  type: :development
   version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: pry
   prerelease: false
+  type: :development
+  name: rspec
+- !ruby/object:Gem::Dependency 
   requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
-    - &id005 
-      - ">="
+    - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
         version: "0"
-  type: :development
   version_requirements: *id004
+  prerelease: false
+  type: :development
+  name: pry
 description: |
   Ruby classes and executables for targetting and sending signals to
   *nix processes that match/don't match command name patterns, memory
@@ -84,28 +110,39 @@ files:
 - spec/process_signaller_spec.rb
 - spec/ps_output.txt
 - spec/spec_helper.rb
+has_rdoc: true
 homepage: ""
 licenses: 
 - MIT
-metadata: {}
-
 post_install_message: 
 rdoc_options: []
 
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
-  - *id005
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
-  - *id005
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 2.0.14
+rubygems_version: 1.6.2
 signing_key: 
-specification_version: 4
+specification_version: 3
 summary: Take aim and fire at runaway processes using ruby
 test_files: 
 - spec/process_locator_spec.rb

checksums.yaml

@@ -1,7 +0,0 @@
---- 
-SHA1: 
-  data.tar.gz: 0432d5218407fc9b0a154390e2ac486f87e6df94
-  metadata.gz: d415fed3259b55fbfaa03a951951f79ed5620fde
-SHA512: 
-  data.tar.gz: bc24aca5874832df60f75758f0958e96628af0bcedbb2ab7284dff51cadd46cc2af3c31e125f4808b7695cc25ad497e8be9291e71818fc6ddd3162ccda56f3e8
-  metadata.gz: cc023afbc9374259e1f1923b1c720e8ad6e1729fe9809c3adffb36855a849a76488f99f3e0b97812cfe25ef4a26057a1e03ce927089bd8c309dd2ca76b29bb4b