sqeduler 0.1.4

data/spec/worker_spec.rb

@@ -0,0 +1,275 @@
+# encoding: utf-8
+require "spec_helper"
+require "./spec/fixtures/fake_worker"
+
+def verify_callback_occured(file_path, times = 1)
+  expect(File).to exist(file_path)
+  expect(File.read(file_path).length).to eq(times)
+end
+
+def verify_callback_skipped(file_path)
+  expect(File).to_not exist(file_path)
+end
+
+def maybe_cleanup_file(file_path)
+  File.delete(file_path) if File.exist?(file_path)
+end
+
+RSpec.describe Sqeduler::Worker do
+  before do
+    Sqeduler::Service.config = Sqeduler::Config.new(
+      :redis_hash => REDIS_CONFIG,
+      :logger     => Logger.new(STDOUT).tap { |l| l.level = Logger::DEBUG }
+    )
+  end
+
+  after do
+    maybe_cleanup_file(FakeWorker::JOB_RUN_PATH)
+    maybe_cleanup_file(FakeWorker::JOB_SUCCESS_PATH)
+    maybe_cleanup_file(FakeWorker::JOB_FAILURE_PATH)
+    maybe_cleanup_file(FakeWorker::JOB_LOCK_FAILURE_PATH)
+    maybe_cleanup_file(FakeWorker::JOB_BEFORE_START_PATH)
+    maybe_cleanup_file(FakeWorker::SCHEDULE_COLLISION_PATH)
+  end
+
+  describe "#perform" do
+    context "synchronized workers" do
+      before do
+        FakeWorker.synchronize :one_at_a_time,
+                               :expiration => expiration,
+                               :timeout => timeout
+      end
+
+      let(:expiration) { work_time * 4 }
+      let(:work_time) { 0.1 }
+
+      subject do
+        threads = []
+        threads << Thread.new { FakeWorker.new.perform(work_time) }
+        threads << Thread.new do
+          sleep wait_time
+          FakeWorker.new.perform(work_time)
+        end
+        threads.each(&:join)
+      end
+
+      context "overlapping schedule" do
+        let(:wait_time) { 0 }
+
+        context "timeout is less than work_time (too short)" do
+          let(:timeout) { work_time / 2 }
+
+          it "one worker should be blocked" do
+            subject
+            verify_callback_occured(FakeWorker::JOB_LOCK_FAILURE_PATH)
+          end
+
+          it "only one worker should run" do
+            subject
+            verify_callback_occured(FakeWorker::JOB_RUN_PATH)
+          end
+
+          it "one worker should succeed" do
+            subject
+            verify_callback_occured(FakeWorker::JOB_SUCCESS_PATH, 2)
+          end
+
+          it "no worker should fail" do
+            subject
+            verify_callback_skipped(FakeWorker::JOB_FAILURE_PATH)
+          end
+
+          it "all workers should have received before_start" do
+            subject
+            verify_callback_occured(FakeWorker::JOB_BEFORE_START_PATH, 2)
+          end
+
+          it "a schedule collision should not have occurred" do
+            subject
+            verify_callback_skipped(FakeWorker::SCHEDULE_COLLISION_PATH)
+          end
+        end
+
+        context "timeout is greater than work_time" do
+          let(:timeout) { work_time * 4 }
+
+          it "no worker should be blocked" do
+            subject
+            verify_callback_skipped(FakeWorker::JOB_LOCK_FAILURE_PATH)
+          end
+
+          it "both workers should succeed" do
+            subject
+            verify_callback_occured(FakeWorker::JOB_SUCCESS_PATH, 2)
+          end
+
+          it "no worker should fail" do
+            subject
+            verify_callback_skipped(FakeWorker::JOB_FAILURE_PATH)
+          end
+
+          it "all workers should have received before_start" do
+            subject
+            verify_callback_occured(FakeWorker::JOB_BEFORE_START_PATH, 2)
+          end
+
+          it "a schedule collision should not have occurred" do
+            subject
+            verify_callback_skipped(FakeWorker::SCHEDULE_COLLISION_PATH)
+          end
+
+          context "expiration too short" do
+            let(:expiration) { work_time / 2 }
+
+            it "no worker should be blocked" do
+              subject
+              verify_callback_skipped(FakeWorker::JOB_LOCK_FAILURE_PATH)
+            end
+
+            it "all workers should run" do
+              subject
+              verify_callback_occured(FakeWorker::JOB_RUN_PATH, 2)
+            end
+
+            it "all workers should have received before_start" do
+              subject
+              verify_callback_occured(FakeWorker::JOB_BEFORE_START_PATH, 2)
+            end
+
+            it "no worker should fail" do
+              subject
+              verify_callback_occured(FakeWorker::JOB_SUCCESS_PATH, 2)
+              verify_callback_skipped(FakeWorker::JOB_FAILURE_PATH)
+            end
+
+            it "a schedule collision should occur" do
+              subject
+              verify_callback_occured(FakeWorker::SCHEDULE_COLLISION_PATH, 2)
+            end
+          end
+        end
+      end
+
+      context "non-overlapping schedule" do
+        let(:wait_time) { work_time * 2 }
+
+        context "timeout is less than work_time (too short)" do
+          let(:timeout) { work_time }
+
+          it "no workers should be blocked" do
+            subject
+            verify_callback_skipped(FakeWorker::JOB_LOCK_FAILURE_PATH)
+          end
+
+          it "all workers should run" do
+            subject
+            verify_callback_occured(FakeWorker::JOB_RUN_PATH, 2)
+          end
+
+          it "no worker should fail" do
+            subject
+            verify_callback_occured(FakeWorker::JOB_SUCCESS_PATH, 2)
+            verify_callback_skipped(FakeWorker::JOB_FAILURE_PATH)
+          end
+
+          it "all workers should have received before_start" do
+            subject
+            verify_callback_occured(FakeWorker::JOB_BEFORE_START_PATH, 2)
+          end
+
+          it "a schedule collision should not have occurred" do
+            subject
+            verify_callback_skipped(FakeWorker::SCHEDULE_COLLISION_PATH)
+          end
+        end
+
+        context "timeout is greater than work_time" do
+          let(:timeout) { work_time * 2 }
+
+          it "no worker should be blocked" do
+            subject
+            verify_callback_skipped(FakeWorker::JOB_LOCK_FAILURE_PATH)
+          end
+
+          it "both workers should succeed" do
+            subject
+            verify_callback_occured(FakeWorker::JOB_SUCCESS_PATH, 2)
+          end
+
+          it "no worker should fail" do
+            subject
+            verify_callback_skipped(FakeWorker::JOB_FAILURE_PATH)
+          end
+
+          it "all workers should have received before_start" do
+            subject
+            verify_callback_occured(FakeWorker::JOB_BEFORE_START_PATH, 2)
+          end
+
+          context "expiration too short" do
+            let(:expiration) { work_time / 2 }
+
+            it "no worker should be blocked" do
+              subject
+              verify_callback_skipped(FakeWorker::JOB_LOCK_FAILURE_PATH)
+            end
+
+            it "all workers should run" do
+              subject
+              verify_callback_occured(FakeWorker::JOB_RUN_PATH, 2)
+            end
+
+            it "all workers should have received before_start" do
+              subject
+              verify_callback_occured(FakeWorker::JOB_BEFORE_START_PATH, 2)
+            end
+
+            it "no worker should fail" do
+              subject
+              verify_callback_occured(FakeWorker::JOB_SUCCESS_PATH, 2)
+              verify_callback_skipped(FakeWorker::JOB_FAILURE_PATH)
+            end
+
+            it "a schedule collision should occur" do
+              subject
+              verify_callback_occured(FakeWorker::SCHEDULE_COLLISION_PATH, 2)
+            end
+          end
+        end
+      end
+    end
+  end
+
+  describe ".disable" do
+    before do
+      FakeWorker.disable
+    end
+
+    it "should not run" do
+      FakeWorker.new.perform(0)
+      verify_callback_skipped(FakeWorker::JOB_RUN_PATH)
+    end
+
+    it "should be disabled?" do
+      expect(FakeWorker.disabled?).to be true
+      expect(FakeWorker.enabled?).to be false
+    end
+  end
+
+  describe ".enable" do
+    before do
+      FakeWorker.disable
+      FakeWorker.enable
+    end
+
+    it "should run" do
+      FakeWorker.new.perform(0)
+      verify_callback_occured(FakeWorker::JOB_RUN_PATH)
+    end
+
+    it "should be enabled?" do
+      expect(FakeWorker.disabled?).to be false
+      expect(FakeWorker.enabled?).to be true
+    end
+  end
+end

data/sqeduler.gemspec

@@ -0,0 +1,33 @@
+# encoding: utf-8
+require File.expand_path("../lib/sqeduler/version", __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name          = "sqeduler"
+  gem.version       = Sqeduler::VERSION
+  gem.summary       = "Common Sidekiq infrastructure for multi-host applications."
+  gem.description   = <<-DESC
+  Works with Sidekiq scheduler to provides a highly available scheduler that can be run on
+  multiple hosts. Also provides a convenient abstract class for Sidekiq workers.
+  DESC
+  gem.license       = "Apache"
+  gem.authors       = '["Jared Jenkins"]'
+  gem.email         = "jaredjenkins@squareup.com"
+  gem.homepage      = "https://rubygems.org/gems/sqeduler"
+
+  gem.files         = `git ls-files`.split($RS)
+  gem.executables   = gem.files.grep(/^bin\//).map { |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(/^(test|spec|features)\//)
+  gem.require_paths = ["lib"]
+
+  gem.add_runtime_dependency "sidekiq"
+  gem.add_runtime_dependency "sidekiq-scheduler"
+  gem.add_runtime_dependency "activesupport"
+
+  gem.add_development_dependency "bundler", "~> 1.7"
+  gem.add_development_dependency "pry", "~> 0"
+  gem.add_development_dependency "rake", "~> 10"
+  gem.add_development_dependency "rspec", "~> 3"
+  gem.add_development_dependency "rubocop", "~> 0.24"
+  gem.add_development_dependency "timecop", "~> 0"
+  gem.add_development_dependency "yard", "~> 0"
+end

metadata

@@ -0,0 +1,233 @@
+--- !ruby/object:Gem::Specification
+name: sqeduler
+version: !ruby/object:Gem::Version
+  version: 0.1.4
+platform: ruby
+authors:
+- '["Jared Jenkins"]'
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sidekiq-scheduler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.24'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.24'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+description: |2
+    Works with Sidekiq scheduler to provides a highly available scheduler that can be run on
+    multiple hosts. Also provides a convenient abstract class for Sidekiq workers.
+email: jaredjenkins@squareup.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".document"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- ".yardopts"
+- CHANGES.md
+- CONTRIBUTING.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/sqeduler.rb
+- lib/sqeduler/config.rb
+- lib/sqeduler/lock_value.rb
+- lib/sqeduler/redis_lock.rb
+- lib/sqeduler/redis_scripts.rb
+- lib/sqeduler/service.rb
+- lib/sqeduler/trigger_lock.rb
+- lib/sqeduler/version.rb
+- lib/sqeduler/worker/callbacks.rb
+- lib/sqeduler/worker/everything.rb
+- lib/sqeduler/worker/kill_switch.rb
+- lib/sqeduler/worker/synchronization.rb
+- spec/config_spec.rb
+- spec/fixtures/env.rb
+- spec/fixtures/fake_worker.rb
+- spec/fixtures/schedule.yaml
+- spec/integration_spec.rb
+- spec/service_spec.rb
+- spec/spec_helper.rb
+- spec/sqeduler_spec.rb
+- spec/trigger_lock_spec.rb
+- spec/worker/synchronization_spec.rb
+- spec/worker_spec.rb
+- sqeduler.gemspec
+homepage: https://rubygems.org/gems/sqeduler
+licenses:
+- Apache
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: Common Sidekiq infrastructure for multi-host applications.
+test_files:
+- spec/config_spec.rb
+- spec/fixtures/env.rb
+- spec/fixtures/fake_worker.rb
+- spec/fixtures/schedule.yaml
+- spec/integration_spec.rb
+- spec/service_spec.rb
+- spec/spec_helper.rb
+- spec/sqeduler_spec.rb
+- spec/trigger_lock_spec.rb
+- spec/worker/synchronization_spec.rb
+- spec/worker_spec.rb
+has_rdoc: