sidekiq-canary 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e1d70babb0731334a12b32373daf2ec13ca6c1e5
+  data.tar.gz: 459773c95cf6d8315d9cd378acc0b5045c55381d
+SHA512:
+  metadata.gz: 18b96079386ac88bf0cc2d933eb48dac506e2eb729caa8318540d1660de213f3b5f5e2f6c9ba32ac342766dca2a232e3403ddf433a183c4d6a361a6d830e37c4
+  data.tar.gz: fdcc0401f4f20cb6b5ef4584f89b4c5b962cb2ba20144254e80f342fcda72767ccdf05ac0de2aa8594c8cd372de97b95573b28cb56797b1480cb9dd75696e317

data/.gitignore

@@ -0,0 +1,2 @@
+.bundle
+

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/Gemfile.lock

@@ -0,0 +1,64 @@
+PATH
+  remote: .
+  specs:
+    sidekiq-canary (0.0.1)
+      sidekiq (~> 3.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    celluloid (0.17.3)
+      celluloid-essentials
+      celluloid-extras
+      celluloid-fsm
+      celluloid-pool
+      celluloid-supervision
+      timers (>= 4.1.1)
+    celluloid-essentials (0.20.5)
+      timers (>= 4.1.1)
+    celluloid-extras (0.20.5)
+      timers (>= 4.1.1)
+    celluloid-fsm (0.20.5)
+      timers (>= 4.1.1)
+    celluloid-pool (0.20.5)
+      timers (>= 4.1.1)
+    celluloid-supervision (0.20.5)
+      timers (>= 4.1.1)
+    connection_pool (2.2.0)
+    diff-lcs (1.2.5)
+    hitimes (1.2.4)
+    json (1.8.3)
+    redis (3.3.0)
+    redis-namespace (1.5.2)
+      redis (~> 3.0, >= 3.0.4)
+    rspec (3.4.0)
+      rspec-core (~> 3.4.0)
+      rspec-expectations (~> 3.4.0)
+      rspec-mocks (~> 3.4.0)
+    rspec-core (3.4.4)
+      rspec-support (~> 3.4.0)
+    rspec-expectations (3.4.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-mocks (3.4.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-support (3.4.1)
+    sidekiq (3.5.4)
+      celluloid (~> 0.17.2)
+      connection_pool (~> 2.2, >= 2.2.0)
+      json (~> 1.0)
+      redis (~> 3.2, >= 3.2.1)
+      redis-namespace (~> 1.5, >= 1.5.2)
+    timers (4.1.1)
+      hitimes
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rspec
+  sidekiq-canary!
+
+BUNDLED WITH
+   1.12.1

data/LICENSE

@@ -0,0 +1,24 @@
+Copyright (c) 2016 Damien Mathieu
+
+Portions of initial project skeleton are copyright (c) 2012 Gabe Evans
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,4 @@
+# Sidekiq Canary
+[![Build Status](https://travis-ci.org/dmathieu/sidekiq-canary.svg?branch=master)](https://travis-ci.org/dmathieu/sidekiq-canary)
+
+Deploy sidekiq sensitive changes in canaries

data/Rakefile

@@ -0,0 +1,6 @@
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+task :default => :spec

data/lib/sidekiq-canary.rb

@@ -0,0 +1 @@
+require 'sidekiq/canary'

data/lib/sidekiq/canary.rb

@@ -0,0 +1,21 @@
+module Sidekiq
+  module Canary
+    def get_sidekiq_options
+      options = super
+      options.merge('queue' => queue(options["queue"]))
+    end
+
+    def queue(default)
+      use_canary_queue?(default) ? "#{default}_canary" : default
+    end
+
+    def use_canary_queue?(default)
+      rand(100) < canary_percent(default)
+    end
+
+    def canary_percent(default)
+      ENV["#{default.upcase}_CANARY_PERCENT"].to_i
+    end
+
+  end
+end

data/lib/sidekiq/canary/version.rb

@@ -0,0 +1,5 @@
+module Sidekiq
+  module Canary
+    VERSION = "0.0.1"
+  end
+end

data/sidekiq-canary.gemspec

@@ -0,0 +1,23 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sidekiq/canary/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = 'sidekiq-canary'
+  gem.version       = Sidekiq::Canary::VERSION
+  gem.authors       = ['Damien Mathieu']
+  gem.email         = ['42@dmathieu.com']
+  gem.description   = %q{Sidekiq canary deployments}
+  gem.summary       = %q{Sidekiq Canary allows you to do canary deployments with your sidekiq workers}
+  gem.homepage      = 'https://github.com/dmathieu/sidekiq-canary'
+  gem.license       = 'MIT'
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ['lib']
+
+  gem.add_dependency 'sidekiq', '~> 3.0'
+
+  gem.add_development_dependency 'rspec'
+end

data/spec/canary_spec.rb

@@ -0,0 +1,43 @@
+require 'spec_helper'
+
+describe Sidekiq::Canary do
+
+  before :each do
+    RegularSpecWorker.jobs.clear
+    OtherQueueSpecWorker.jobs.clear
+  end
+
+  it "runs the worker" do
+    expect do
+      RegularSpecWorker.perform_async
+    end.to change(RegularSpecWorker.jobs, :size).by(1)
+    expect(RegularSpecWorker.jobs.first["queue"]).to eql("default")
+  end
+
+  it "runs the worker on the canary queue" do
+    allow(ENV).to receive(:[]).and_call_original
+    allow(ENV).to receive(:[]).with("DEFAULT_CANARY_PERCENT").and_return(100)
+
+    expect do
+      RegularSpecWorker.perform_async
+    end.to change(RegularSpecWorker.jobs, :size).by(1)
+    expect(RegularSpecWorker.jobs.first["queue"]).to eql("default_canary")
+  end
+
+  it "runs a worker on another queue" do
+    expect do
+      OtherQueueSpecWorker.perform_async
+    end.to change(OtherQueueSpecWorker.jobs, :size).by(1)
+    expect(OtherQueueSpecWorker.jobs.first["queue"]).to eql("critical")
+  end
+
+  it "runs the worker on the canary queue" do
+    allow(ENV).to receive(:[]).and_call_original
+    allow(ENV).to receive(:[]).with("CRITICAL_CANARY_PERCENT").and_return(100)
+
+    expect do
+      OtherQueueSpecWorker.perform_async
+    end.to change(OtherQueueSpecWorker.jobs, :size).by(1)
+    expect(OtherQueueSpecWorker.jobs.first["queue"]).to eql("critical_canary")
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'rspec'
+require 'sidekiq/testing'
+require 'sidekiq/canary'
+
+RSpec.configure do |config|
+  # 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'
+end
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }

data/spec/support/worker.rb

@@ -0,0 +1,19 @@
+class RegularSpecWorker
+  include Sidekiq::Worker
+  extend Sidekiq::Canary
+
+  def perform
+    # no-op
+  end
+end
+
+class OtherQueueSpecWorker
+  include Sidekiq::Worker
+  extend Sidekiq::Canary
+
+  sidekiq_options queue: 'critical'
+
+  def perform
+    # no-op
+  end
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: sidekiq-canary
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Damien Mathieu
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-06-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: Sidekiq canary deployments
+email:
+- 42@dmathieu.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- lib/sidekiq-canary.rb
+- lib/sidekiq/canary.rb
+- lib/sidekiq/canary/version.rb
+- sidekiq-canary.gemspec
+- spec/canary_spec.rb
+- spec/spec_helper.rb
+- spec/support/worker.rb
+homepage: https://github.com/dmathieu/sidekiq-canary
+licenses:
+- MIT
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Sidekiq Canary allows you to do canary deployments with your sidekiq workers
+test_files:
+- spec/canary_spec.rb
+- spec/spec_helper.rb
+- spec/support/worker.rb
+has_rdoc: