sidekiq-client-cli 0.1.3 → 0.1.4

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    NTgyYzgzOGEyYzEwMGJhM2FiNGNjZDE0NDFmN2U4ZjQ2YTIzMGUxYg==
+    YmU4MTg4ZWJlZjFiOTU3NjVkNWEyYWYyYWZhMjY1ZDJmMThiZGMyOA==
   data.tar.gz: !binary |-
-    ZTdiZDI4YTNkYTZlM2Y4ZWJjOTM1MzU4ZDg1MWQyMzNmNTQyODQ5NA==
+    NzZiMTBlODYyZGEyMTExNzJiMDBiNjU4YmQwNWFkY2Y0ODdmMGMxMA==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    NWVkODk5YzcwMDE2Y2Y0NTY4NmY4Mjc3NmRmMDBmNDk5ZDBhYTBmNjVlMDZh
-    MGUzNGRlOGU1YTIyYzdhYmM2YzhkYzExNWE0ZGE2ZGMyZGI5ZTJkYWYxMWY0
-    MWMwZDJkMmMyZDEyYzRiN2U5MWIwOWJjMzNjYWE0NDhkNjFiMGU=
+    NWViYTdhZGM4ODNjZDE4ZWYxNTY0Yjk5ZjM1ZDM3YzJiMTBkNWU3ZDkxODk5
+    YmVkNGVjNjZmNzk2ZDhmMzkyMGVjOWVmZmI4MTljYzRlNTAxYjY3MjI1ODU5
+    OWZhOWZlMjFlYWM4NDFiMWZiNGE4NDQ1Yjc4MDliNDMzODVlMzk=
   data.tar.gz: !binary |-
-    NzdmMDU3Y2YyMTE0N2U0NTZmMTVkMGM2Y2MzYjAwYjY2MmNkYjVhY2QzOTM4
-    NTAzNmQ0ZWE0NWQxMzI3N2NiMTRkNzZmYTE4ZjZiM2I3Y2I5OTk5NjEwMTQ2
-    NDk2NzFjOWY3MzE1MGMxNzM2ZGU1ZWIzZjQ1ZmMxZjM5ZmUzODk=
+    ODk5Y2Q5OGFjYmFmODM2Yzk2M2Q1NmYxYTRjMjI1MDFlYWQ0OTczOWFmOTE4
+    NTM4NDVhMmRiNGE4ZGEwZWU1MjMwM2M4OWU3ZDNiMDk0MjU3Njk0YzMzZjc3
+    ZDJjZTQwOTgyNzViMzE0MDllMzQ4NzNhMDU1Y2E0Y2U4N2E1ZDQ=

data/README.md

@@ -37,6 +37,14 @@ You can also specify a specific queue to push the jobs to :
 
     $ sidekiq-client -q my_queue push MyWorker OtherWorker
 
+You can specify that the job should not be retried, if it fails :
+
+    $ sidekiq-client -r false push MyWorker OtherWorker
+
+You can also specify the number of times a job should be retried, if it fails :
+
+    $ sidekiq-client -r 5 push MyWorker OtherWorker
+
 For help :
 
     $ sidekiq-client --help

data/lib/sidekiq_client_cli.rb

@@ -12,6 +12,7 @@ class SidekiqClientCLI
     @settings = CLI.new do
       option :config_path, :short => :c, :default => DEFAULT_CONFIG_PATH, :description => "Sidekiq client config file path"
       option :queue, :short => :q, :description => "Queue to place job on"
+      option :retry, :short => :r, :cast => lambda { |r| SidekiqClientCLI.cast_retry_option(r) }, :description => "Retry option for job"
       argument :command, :description => "'push' to push a job to the queue"
       arguments :command_args, :required => false, :description => "command arguments"
     end.parse! do |settings|
@@ -23,12 +24,19 @@ class SidekiqClientCLI
     end
   end
 
+  def self.cast_retry_option(retry_option)
+    return true if !!retry_option.match(/^(true|t|yes|y)$/i)
+    return false if !!retry_option.match(/^(false|f|no|n|0)$/i)
+    return retry_option.to_i if !!retry_option.match(/^\d+$/)
+  end
+
   def run
     # load the config file
     load settings.config_path if File.exists?(settings.config_path)
 
-    # set queue if not given
+    # set queue or retry if they are not given
     settings.queue ||= Sidekiq.default_worker_options['queue']
+    settings.retry ||= Sidekiq.default_worker_options['retry']
 
     self.send settings.command.to_sym
   end
@@ -36,8 +44,11 @@ class SidekiqClientCLI
   def push
     settings.command_args.each do |arg|
       begin
-        jid = Sidekiq::Client.push('class' => arg, 'queue' => settings.queue, 'args' => [])
-        p "Posted #{arg} to queue '#{settings.queue}', Job ID : #{jid}"
+        jid = Sidekiq::Client.push({ 'class' => arg,
+                                     'queue' => settings.queue,
+                                     'args'  => [],
+                                     'retry' => settings.retry })
+        p "Posted #{arg} to queue '#{settings.queue}', Job ID : #{jid}, Retry : #{settings.retry}"
       rescue StandardError => ex
         p "Failed to push to queue : #{ex.message}"
       end

data/lib/sidekiq_client_cli/version.rb

@@ -1,3 +1,3 @@
 class SidekiqClientCLI
-  VERSION = "0.1.3"
+  VERSION = "0.1.4"
 end

data/spec/sidekiq_client_cli_spec.rb

@@ -2,6 +2,7 @@ require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
 describe SidekiqClientCLI do
   let(:default_queue) { Sidekiq.default_worker_options['queue'] }
+  let(:default_retry_option) { Sidekiq.default_worker_options['retry'] }
 
   before(:each) { @client = SidekiqClientCLI.new }
 
@@ -47,6 +48,7 @@ describe SidekiqClientCLI do
       @client.settings.command_args.should eq worker_klasses
       @client.settings.config_path.should eq SidekiqClientCLI::DEFAULT_CONFIG_PATH
       @client.settings.queue.should eq nil
+      @client.settings.retry.should eq nil
     end
 
     it "parses push with a configuration file" do
@@ -69,6 +71,26 @@ describe SidekiqClientCLI do
       @client.settings.queue.should eq "my_queue"
     end
 
+    it 'parses push with a boolean retry' do
+      worker_klasses = %w{FirstWorker SecondWorker}
+      ARGV = %w{ -r false push }.concat(worker_klasses)
+      @client.parse
+      @client.settings.command.should eq "push"
+      @client.settings.command_args.should eq worker_klasses
+      @client.settings.config_path.should eq SidekiqClientCLI::DEFAULT_CONFIG_PATH
+      @client.settings.retry.should eq false
+    end
+
+    it 'parses push with an integer retry' do
+      worker_klasses = %w{FirstWorker SecondWorker}
+      ARGV = %w{ -r 42 push }.concat(worker_klasses)
+      @client.parse
+      @client.settings.command.should eq "push"
+      @client.settings.command_args.should eq worker_klasses
+      @client.settings.config_path.should eq SidekiqClientCLI::DEFAULT_CONFIG_PATH
+      @client.settings.retry.should eq 42
+    end
+
   end
 
   describe "run" do
@@ -78,6 +100,7 @@ describe SidekiqClientCLI do
       @client.settings.stub(:config_path).and_return(config_path)
       @client.settings.stub(:command).and_return("mycommand")
       @client.settings.stub(:queue).and_return(default_queue)
+      @client.settings.stub(:retry).and_return(default_retry_option)
       @client.should_receive(:mycommand)
 
       File.should_receive(:exists?).with(config_path).and_return true
@@ -86,12 +109,13 @@ describe SidekiqClientCLI do
       @client.run
     end
 
-    it "loads the config file if existing and runs the command" do
+    it "won't load a non-existant config file and the command is run" do
       config_path = "sidekiq.conf"
       settings = double("settings")
       settings.stub(:config_path).and_return(config_path)
       settings.stub(:command).and_return("mycommand")
       settings.stub(:queue).and_return(default_queue)
+      settings.stub(:retry).and_return(default_retry_option)
 
       @client.settings = settings
       @client.should_receive(:mycommand)
@@ -105,45 +129,97 @@ describe SidekiqClientCLI do
   end
 
   describe 'push' do
-    it "pushes the worker classes" do
-      klass1 = "FirstWorker"
-      klass2 = "SecondWorker"
-      settings = double("settings")
+    let(:settings) { double("settings") }
+    let(:klass1) { "FirstWorker" }
+    let(:klass2) { "SecondWorker" }
+
+    before(:each) do
       settings.stub(:command_args).and_return [klass1, klass2]
+    end
+
+    it "pushes the worker classes" do
       settings.stub(:queue).and_return default_queue
+      settings.stub(:retry).and_return default_retry_option
       @client.settings = settings
-
-      Sidekiq::Client.should_receive(:push).with('class' => klass1, 'args' => [], 'queue' => default_queue)
-      Sidekiq::Client.should_receive(:push).with('class' => klass2, 'args' => [], 'queue' => default_queue)
+      Sidekiq::Client.should_receive(:push).with('class' => klass1,
+                                                 'args' => [],
+                                                 'queue' => default_queue,
+                                                 'retry' => default_retry_option)
+      Sidekiq::Client.should_receive(:push).with('class' => klass2,
+                                                 'args' => [],
+                                                 'queue' => default_queue,
+                                                 'retry' => default_retry_option)
 
       @client.push
     end
 
     it "pushes the worker classes to the correct queue" do
       queue = "Queue"
-      klass1 = "FirstWorker"
-      klass2 = "SecondWorker"
-      settings = double("settings")
-      settings.stub(:command_args).and_return [klass1, klass2]
       settings.stub(:queue).and_return queue
+      settings.stub(:retry).and_return default_retry_option
       @client.settings = settings
 
-      Sidekiq::Client.should_receive(:push).with('class' => klass1, 'args' => [], 'queue' => queue)
-      Sidekiq::Client.should_receive(:push).with('class' => klass2, 'args' => [], 'queue' => queue)
+      Sidekiq::Client.should_receive(:push).with('class' => klass1,
+                                                 'args' => [],
+                                                 'queue' => queue,
+                                                 'retry' => default_retry_option)
+      Sidekiq::Client.should_receive(:push).with('class' => klass2,
+                                                 'args' => [],
+                                                 'queue' => queue,
+                                                 'retry' => default_retry_option)
+
+      @client.push
+    end
+
+    it 'pushes the worker classes with retry disabled' do
+      retry_option = false
+      settings.stub(:queue).and_return default_queue
+      settings.stub(:retry).and_return retry_option
+      @client.settings = settings
+
+      Sidekiq::Client.should_receive(:push).with('class' => klass1,
+                                                 'args' => [],
+                                                 'queue' => default_queue,
+                                                 'retry' => retry_option)
+      Sidekiq::Client.should_receive(:push).with('class' => klass2,
+                                                 'args' => [],
+                                                 'queue' => default_queue,
+                                                 'retry' => retry_option)
+
+      @client.push
+    end
+
+    it 'pushes the worker classes with a set retry number' do
+      retry_attempts = 5
+      settings.stub(:queue).and_return default_queue
+      settings.stub(:retry).and_return retry_attempts
+      @client.settings = settings
+
+      Sidekiq::Client.should_receive(:push).with('class' => klass1,
+                                                 'args' => [],
+                                                 'queue' => default_queue,
+                                                 'retry' => retry_attempts)
+      Sidekiq::Client.should_receive(:push).with('class' => klass2,
+                                                 'args' => [],
+                                                 'queue' => default_queue,
+                                                 'retry' => retry_attempts)
 
       @client.push
     end
 
     it "prints and continues if an exception is raised" do
-      klass1 = "FirstWorker"
-      klass2 = "SecondWorker"
-      settings = double("settings")
-      settings.stub(:command_args).and_return [klass1, klass2]
       settings.stub(:queue).and_return default_queue
+      settings.stub(:retry).and_return default_retry_option
       @client.settings = settings
 
-      Sidekiq::Client.should_receive(:push).with('class' => klass1, 'args' => [], 'queue' => default_queue).and_raise
-      Sidekiq::Client.should_receive(:push).with('class' => klass2, 'args' => [], 'queue' => default_queue)
+      Sidekiq::Client.should_receive(:push).with('class' => klass1,
+                                                 'args' => [],
+                                                 'queue' => default_queue,
+                                                 'retry' => default_retry_option).and_raise
+      Sidekiq::Client.should_receive(:push).with('class' => klass2,
+                                                 'args' => [],
+                                                 'queue' => default_queue,
+                                                 'retry' => default_retry_option)
 
       out = IOHelper.stdout_read do
         @client.push
@@ -153,4 +229,29 @@ describe SidekiqClientCLI do
 
   end
 
+  describe 'cast_retry_option' do
+    subject { SidekiqClientCLI }
+
+    it 'returns false if the string matches false|f|no|n|0' do
+      subject.cast_retry_option('false').should == false
+      subject.cast_retry_option('f').should == false
+      subject.cast_retry_option('no').should == false
+      subject.cast_retry_option('n').should == false
+      subject.cast_retry_option('0').should == false
+    end
+
+    it 'returns true if the string matches true|t|yes|y' do
+      subject.cast_retry_option('true').should == true
+      subject.cast_retry_option('t').should == true
+      subject.cast_retry_option('yes').should == true
+      subject.cast_retry_option('y').should == true
+    end
+
+    it 'returns an integer if the passed string is an integer' do
+      subject.cast_retry_option('1').should == 1
+      subject.cast_retry_option('42').should == 42
+    end
+
+  end
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-client-cli
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Adil Haritah
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-04 00:00:00.000000000 Z
+date: 2013-11-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler