resque-stages 0.0.1

data/spec/resque/server/views/groups.erb_spec.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+require "rails_helper"
+
+RSpec.describe "groups.erb" do
+  let(:group_list) { Resque::Plugins::Stages::StagedGroupList.new }
+  let(:descriptions) { Array.new(5) { Faker::Lorem.sentence } }
+  let!(:groups) do
+    descriptions.map do |description|
+      Resque::Plugins::Stages::StagedGroup.new(SecureRandom.uuid, description: description)
+    end
+  end
+
+  include Rack::Test::Methods
+
+  def app
+    @app ||= Resque::Server.new
+  end
+
+  context "actions" do
+    before(:each) do
+      allow(Resque::Plugins::Stages::StagedGroupList).to receive(:new).and_return group_list
+      allow(group_list).to receive(:delete_all)
+      allow(Resque::Plugins::Stages::Cleaner).to receive(:purge_all)
+      allow(Resque::Plugins::Stages::Cleaner).to receive(:cleanup_jobs)
+    end
+
+    it "should respond to /stages/delete_all_groups" do
+      post "/stages/delete_all_groups"
+
+      expect(last_response).to be_redirect
+      expect(last_response.header["Location"]).to match(/stages$/)
+      expect(group_list).to have_received(:delete_all)
+    end
+
+    it "should respond to /stages/purge_all" do
+      post "/stages/purge_all"
+
+      expect(last_response).to be_redirect
+      expect(last_response.header["Location"]).to match(/stages$/)
+      expect(Resque::Plugins::Stages::Cleaner).to have_received(:purge_all)
+    end
+
+    it "should respond to /stages/cleanup_jobs" do
+      post "/stages/cleanup_jobs"
+
+      expect(last_response).to be_redirect
+      expect(last_response.header["Location"]).to match(/stages$/)
+      expect(Resque::Plugins::Stages::Cleaner).to have_received(:cleanup_jobs)
+    end
+  end
+
+  it "should respond to /stages" do
+    get "/stages"
+
+    expect(last_response).to be_ok
+
+    expect(last_response.body).to match %r{action="/stages/delete_all_groups"}
+    expect(last_response.body).to match %r{action="/stages/purge_all"}
+    expect(last_response.body).to match %r{action="/stages/cleanup_jobs"}
+
+    expect(last_response.body).to match %r{&sort=description">(\n *)?Description\n +</a>}
+    expect(last_response.body).to match %r{&sort=num_stages">(\n *)?Num Stages\n +</a>}
+    expect(last_response.body).to match %r{&sort=created_at">(\n *)?Created\n +</a>}
+
+    groups.each do |group|
+      expect(last_response.body).to match %r{#{group.description}\n +</a>}
+      expect(last_response.body).to match %r{/group_stages_list\?#{{ group_id: group.group_id }.to_param.gsub("+", "\\\\+")}}
+    end
+  end
+
+  it "pages queues" do
+    get "/stages?page_size=2"
+
+    expect(last_response).to be_ok
+
+    expect(last_response.body).to match(%r{href="/stages?.*page_num=2})
+    expect(last_response.body).to match(%r{href="/stages?.*page_num=3})
+    expect(last_response.body).not_to match(%r{href="/stages?.*page_num=4})
+  end
+end

data/spec/resque/server/views/job_details.erb_spec.rb

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+require "rails_helper"
+
+RSpec.describe "job_details.erb" do
+  let(:group) { Resque::Plugins::Stages::StagedGroup.new(SecureRandom.uuid) }
+  let(:stage) { group.current_stage }
+  let(:test_args) do
+    rand_args = []
+    rand_args << Faker::Lorem.sentence
+    rand_args << Faker::Lorem.paragraph
+    rand_args << SecureRandom.uuid.to_s
+    rand_args << rand(0..1_000_000_000_000_000_000_000_000).to_s
+    rand_args << rand(0..1_000_000_000_000).seconds.ago.to_s
+    rand_args << rand(0..1_000_000_000_000).seconds.from_now.to_s
+    rand_args << Array.new(rand(1..5)) { Faker::Lorem.word }
+    rand_args << Array.new(rand(1..5)).each_with_object({}) do |_nil_value, sub_hash|
+      sub_hash[Faker::Lorem.word] = Faker::Lorem.word
+    end
+
+    rand_args = rand_args.sample(rand(3..rand_args.length))
+
+    if [true, false].sample
+      options_hash                    = {}
+      options_hash[Faker::Lorem.word] = Faker::Lorem.sentence
+      options_hash[Faker::Lorem.word] = Faker::Lorem.paragraph
+      options_hash[Faker::Lorem.word] = SecureRandom.uuid.to_s
+      options_hash[Faker::Lorem.word] = rand(0..1_000_000_000_000_000_000_000_000).to_s
+      options_hash[Faker::Lorem.word] = rand(0..1_000_000_000_000).seconds.ago.to_s
+      options_hash[Faker::Lorem.word] = rand(0..1_000_000_000_000).seconds.from_now.to_s
+      options_hash[Faker::Lorem.word] = Array.new(rand(1..5)) { Faker::Lorem.word }
+      options_hash[Faker::Lorem.word] = Array.new(rand(1..5)).
+          each_with_object({}) do |_nil_value, sub_hash|
+        sub_hash[Faker::Lorem.word] = Faker::Lorem.word
+      end
+
+      rand_args << options_hash.slice(*options_hash.keys.sample(rand(5..options_hash.keys.length)))
+    end
+
+    rand_args
+  end
+  let(:job_id) { job.job_id }
+  let(:job) do
+    stage.enqueue BasicJob, *test_args
+  end
+
+  include Rack::Test::Methods
+
+  def app
+    @app ||= Resque::Server.new
+  end
+
+  before(:each) do
+    allow(Resque).to receive(:enqueue).and_call_original
+    allow(Resque::Plugins::Stages::StagedJob).to receive(:new).and_return job
+    allow(job).to receive(:delete)
+    allow(job).to receive(:enqueue_job)
+  end
+
+  it "should respond to /stages/delete_job" do
+    post "/stages/delete_job?job_id=#{job.job_id}"
+
+    expect(last_response).to be_redirect
+    expect(last_response.header["Location"]).to match(/stages$/)
+
+    expect(job).to have_received(:delete)
+  end
+
+  it "should respond to /stages/queue_job" do
+    post "/stages/queue_job?job_id=#{job.job_id}"
+
+    expect(last_response).to be_redirect
+    expect(last_response.header["Location"]).to match(/stages$/)
+
+    expect(job).to have_received(:enqueue_job)
+  end
+
+  it "should respond to /stages/job_details" do
+    get "/stages/job_details?job_id=#{job.job_id}"
+
+    expect(last_response).to be_ok
+
+    expect(last_response.body).to match %r{action="/stages/delete_job\?#{{ job_id: job.job_id }.to_param}"}
+    expect(last_response.body).to match %r{action="/stages/queue_job\?#{{ job_id: job.job_id }.to_param}"}
+
+    expect(last_response.body).to match(%r{Enqueued(\n *)</td>})
+    expect(last_response.body).to match(%r{Status(\n *)</td>})
+    expect(last_response.body).to match(%r{Class(\n *)</td>})
+    expect(last_response.body).to match(%r{Params(\n *)</td>})
+    expect(last_response.body).to match(%r{Message(\n *)</td>})
+  end
+
+  it "shows the parameters for the jobs" do
+    get "/stages/job_details?job_id=#{job.job_id}"
+
+    expect(last_response).to be_ok
+
+    expect(last_response.body).to be_include("".html_safe + job.uncompressed_args.to_yaml)
+  end
+end

data/spec/resque/server/views/stage.erb_spec.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+require "rails_helper"
+
+RSpec.describe "groups.erb" do
+  let(:group) { Resque::Plugins::Stages::StagedGroup.new(SecureRandom.uuid) }
+  let(:stage) { group.current_stage }
+  let(:numbers) { Array.new(5) { |index| index } }
+  let!(:jobs) do
+    numbers.map do |number|
+      stage.enqueue BasicJob, number
+    end
+  end
+
+  include Rack::Test::Methods
+
+  def app
+    @app ||= Resque::Server.new
+  end
+
+  context "actions" do
+    before(:each) do
+      allow(Resque::Plugins::Stages::StagedGroupStage).to receive(:new).and_return stage
+      allow(stage).to receive(:delete)
+      allow(stage).to receive(:initiate)
+    end
+
+    it "should respond to /stages/initiate_stage" do
+      post "/stages/initiate_stage?group_stage_id=#{stage.group_stage_id}"
+
+      expect(last_response).to be_redirect
+      expect(last_response.header["Location"]).to match(/stages$/)
+      expect(stage).to have_received(:initiate)
+    end
+
+    it "should respond to /stages/delete_stage" do
+      post "/stages/delete_stage?group_stage_id=#{stage.group_stage_id}"
+
+      expect(last_response).to be_redirect
+      expect(last_response.header["Location"]).to match(/stages$/)
+      expect(stage).to have_received(:delete)
+    end
+  end
+
+  it "should respond to /stages/stage" do
+    get "/stages/stage?group_stage_id=#{stage.group_stage_id}"
+
+    expect(last_response).to be_ok
+
+    expect(last_response.body).to match %r{action="/stages/delete_stage\?group_stage_id=#{stage.group_stage_id}"}
+    expect(last_response.body).to match %r{action="/stages/initiate_stage\?group_stage_id=#{stage.group_stage_id}"}
+
+    jobs.each do |job|
+      expect(last_response.body).to match %r{#{job.class_name}\n +</a>}
+      expect(last_response.body).to match %r{/stages/job_details\?#{{ job_id: job.job_id }.to_param.gsub("+", "\\\\+")}}
+    end
+  end
+
+  it "pages queues" do
+    get "/stages/stage?group_stage_id=#{stage.group_stage_id}&page_size=2"
+
+    expect(last_response).to be_ok
+
+    expect(last_response.body).to match(%r{href="/stages/stage?.*group_stage_id=#{stage.group_stage_id}.*page_num=2})
+    expect(last_response.body).to match(%r{href="/stages/stage?.*group_stage_id=#{stage.group_stage_id}.*page_num=3})
+    expect(last_response.body).not_to match(%r{href="/stages/stage?.*group_stage_id=#{stage.group_stage_id}.*page_num=4})
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,104 @@
+# frozen_string_literal: true
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+
+    expectations.syntax = :expect
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # This option will default to `:apply_to_host_groups` in RSpec 4 (and will
+  # have no way to turn it off -- the option exists only for backwards
+  # compatibility in RSpec 3). It causes shared context metadata to be
+  # inherited by the metadata hash of host groups and examples, rather than
+  # triggering implicit auto-inclusion in groups with matching metadata.
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+
+  # This allows you to limit a spec run to individual examples or groups
+  # you care about by tagging them with `:focus` metadata. When nothing
+  # is tagged with `:focus`, all examples get run. RSpec also provides
+  # aliases for `it`, `describe`, and `context` that include `:focus`
+  # metadata: `fit`, `fdescribe` and `fcontext`, respectively.
+  config.filter_run_when_matching :focus
+
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  # config.example_status_persistence_file_path = "spec/examples.txt"
+  config.example_status_persistence_file_path = "log/.rspec_status"
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
+  #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = "doc"
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+end

data/spec/support/01_utils/fake_logger.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class FakeLogger
+  def self.error(*args)
+    # Do nothing!
+  end
+end

data/spec/support/config/redis-auth.yml

@@ -0,0 +1,12 @@
+########################################################################################################################
+# WARNING - Never check this into the repository (.erb OK).
+########################################################################################################################
+
+# Using a local Redis server (install with 'brew install redis')
+host: 127.0.0.1
+port: 6379
+db: 1
+
+# Using RedisToGo (don't use it on your dev station, it's only to be used on staging), otherwise we'll
+# run out of clients quickly (cap is at 10 currently)
+#url: "redis://redistogo:your_id_here@greeneye.redistogo.com:port/"

data/spec/support/fake_logger.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+RSpec.configure do |config|
+  config.before(:each) do
+    allow(FakeLogger).to receive(:error).and_return nil
+  end
+end

data/spec/support/jobs/basic_job.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+class BasicJob
+  include Resque::Plugins::Stages
+
+  def self.queue
+    "BasicJobQueue"
+  end
+
+  def self.perform(*args)
+    job = perform_job(*args)
+
+    FakeLogger.error("BasicJob.perform job_id", job.job_id)
+    FakeLogger.error("BasicJob.perform args", *args)
+    FakeLogger.error("BasicJob.perform job.args", *job.args)
+  end
+end

data/spec/support/jobs/compressed_job.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+class CompressedJob
+  def self.queue
+    "CompressedJobQueue"
+  end
+
+  def self.perform(*args)
+    job = perform_job(*args)
+
+    FakeLogger.error("CompressedJob.perform job_id", job.job_id)
+    FakeLogger.error("CompressedJob.perform args", *args)
+    FakeLogger.error("CompressedJob.perform job.args", *job.args)
+  end
+
+  extend Resque::Plugins::Compressible
+  include Resque::Plugins::Stages
+end

data/spec/support/jobs/retry_job.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+class RetryJob
+  extend Resque::Plugins::Retry
+  include Resque::Plugins::Stages
+
+  @retry_limit = 5
+  @retry_delay = 1.minute
+
+  def self.queue
+    "RetryJobQueue"
+  end
+
+  def self.perform(*args)
+    job = perform_job(*args)
+
+    FakeLogger.error("RetryJob.perform job_id", job.job_id)
+    FakeLogger.error("RetryJob.perform args", *args)
+    FakeLogger.error("RetryJob.perform job.args", *job.args)
+  end
+end