snipr 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 --- 
 SHA512: 
-  metadata.gz: 0431e21ba622f828ce67bbef64c3ea2bd900e9dac1e6069dbeb88feb0389c6837f9dd1a5654918dd3a2059b69ce52c836927522ea5f1a6c4aa5bec1f74d51bd3
-  data.tar.gz: f2f45b0e24e2576610dd7883ac64b9828dd2ef6586320399d77832b54a597183a297e11e18a252a93130179c86cb11da4d7c610b9d4b90d5acb6a86afb5421ea
+  data.tar.gz: 3f2677c94a34966b9d5348c73d2d40b26051390251eefac5a3f8e1ec39c1a3b697b23fcfacdaa17da42a7b5b4073302686cf79b9ce2fc01e55a718cbc7f2063d
+  metadata.gz: 832f8d4ad90744c629518ca67a98762c57a70c4c6373d805c2346c097ca47bf0238fb2e0aa856d29ee84151fd544cd321dfbe7052d519507f4edcb1a14916662
 SHA1: 
-  metadata.gz: e4ba65cbad1a2cd5acb11c37237b5f843328a176
-  data.tar.gz: 9ab5063ba228c17e50ab64634c58efea2fc6aee4
+  data.tar.gz: 4d56124489b903a171f4c73ea3f11016faf5b17c
+  metadata.gz: c9cda0f35966f40058ad8dc4d53efd4cdd8d702a

data/.gitignore

@@ -11,4 +11,5 @@
 *.so
 *.o
 *.a
+*.gem
 mkmf.log

data/bin/reap_resque_workers

@@ -39,6 +39,11 @@ parser = OptionParser.new do |config|
   config.on("-s", "--signal [SIGNAL]", desc) do |signal|
     options.signal = signal
   end
+
+  desc = "Perform a dry run which will identify workers to be reaped but not send any signals"
+  config.on("-d", "--dry-run", desc) do
+    options.no_signals = true
+  end
 end.parse!
 
 # TODO remove me
@@ -52,12 +57,15 @@ unless options.bytes || options.keys || options.alive
   Kernel.exit(-1)
 end
 
+output.info("*** DRY RUN ***") if options.no_signals
+
 signaller = Snipr::ProcessSignaller.new do |signaller|
   signaller.signal          options.signal
   signaller.target_parent   true
   signaller.include         /resque/
   signaller.include         /processing/i
   signaller.exclude         /scheduler/i
+  signaller.dry_run if options.no_signals
 
   if options.bytes
     signaller.memory_greater_than(options.bytes)

data/lib/snipr/process_signaller.rb

@@ -12,6 +12,7 @@ module Snipr
   #   signaller.exclude       /scheduler/
   #   signaller.signal        "USR1"
   #   signaller.target_parent false
+  #   singaller.dry_run
   #
   #   signaller.on_no_processes do
   #     puts "No processes"
@@ -50,7 +51,8 @@ module Snipr
     end
 
     ##
-    # Send the specified signal to all located processes
+    # Send the specified signal to all located processes, invoking
+    # callbacks as appropriate.
     def send_signals
       processes = @locator.locate
 
@@ -65,6 +67,11 @@ module Snipr
       @on_error.call(e)
     end
 
+    ##
+    # Specify the signal to send to the targetted processes.  This should
+    # be a string that maps one of the values listed here:
+    #
+    # http://ruby-doc.org/core-1.8.7/Signal.html#method-c-list
     def signal(signal)
       @signal = Signal.list[signal.to_s.upcase].tap do |sig|
         unless sig
@@ -73,37 +80,67 @@ module Snipr
       end
     end
 
+    ##
+    # Specify or access the locator collaborator that is responsible for
+    # collecting the processes to operate on
     def locator(locator=nil)
       @locator ||= (locator || ProcessLocator.new)
     end
 
+    ##
+    # Callback invoked when no processes are found
     def on_no_processes(&callback)
       @on_no_processes = callback
     end
 
+    ##
+    # Callback invoked immediately before sending a signal to a process.
+    # Will send both the signal and the KernelProcess object as returned
+    # by the locator.
     def before_signal(&callback)
       @before_signal = callback
     end
 
+    ##
+    # Callback invoked immediately after sending a signal to a process.
+    # Will send both the signal and the KernelProcess object as returned
+    # by the locator.
     def after_signal(&callback)
       @after_signal = callback
     end
 
+    ##
+    # Callback invoked if an error is encountered.  If this is within
+    # the context of attempting to send a signal to a process, then
+    # the exception, signal and KernelProcess object are sent.  Otherwise,
+    # only the exception is sent.
     def on_error(&callback)
       @on_error = callback
     end
 
+    ##
+    # Set to true if the signal should be sent to the parent of any
+    # located processes.  Defaults to false.
     def target_parent(flag=false)
       @target_parent = flag
     end
 
+    ##
+    # Invoke if you want to have callbacks invoked, but not actually
+    # send signals to located processes.
+    def dry_run
+      @dry_run = true
+    end
+
     private
     def signal_process(process)
       @before_signal.call(@signal, process)
-      if @target_parent
-        Process.kill(@signal, process.ppid)
-      else
-        Process.kill(@signal, process.pid)
+      unless @dry_run
+        if @target_parent
+          Process.kill(@signal, process.ppid)
+        else
+          Process.kill(@signal, process.pid)
+        end
       end
       @after_signal.call(@signal, process)
     rescue StandardError => e

data/lib/snipr/version.rb

@@ -1,3 +1,3 @@
 module Snipr
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/spec/process_signaller_spec.rb

@@ -76,7 +76,7 @@ module Snipr
             expect(checkins.after_signal).to eq("#{signal} > 6337")
           end
         end
-        
+
         context "targetting the parent process" do
           it "should send the appropriate signal to the parent process and call callbacks" do
             subject.target_parent true
@@ -94,6 +94,16 @@ module Snipr
             expect(checkins.on_error).to eq("Ouch! #{signal} > 6337")
           end
         end
+
+        context "when doing a dry run" do
+          it "should not send any signals to the process or its parent" do
+            expect(Process).to_not receive(:kill)
+            subject.dry_run
+            subject.send_signals
+            expect(checkins.before_signal).to eq("#{signal} > 6337")
+            expect(checkins.after_signal).to eq("#{signal} > 6337")
+          end
+        end
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: snipr
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors: 
 - Lance Woodson