travis-rollout 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6e7b70d440a7f1c5df1b7cb5f8f5b9f7ebed5396
+  data.tar.gz: 9f1ba41d70a47bd4d76083463b6cac812606fc1e
+SHA512:
+  metadata.gz: 7e9ea82639e6dd032c22c86ec80ca9d333e256ad244b41c15d09edaecd14a7cf5eee6e591e593f77a105df4eb2bdfc1bdbdc2d5245bb1e639616650db8949cea
+  data.tar.gz: ad70ac68701d6c5440660309fea0c3403a510fdc569cc8ca5364ba4e4c8ff6ce6d4bca11337504332738d859c1a193b909f7955a9c01631eb39234cccfcb64ad

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :test do
+  gem 'rspec'
+  gem 'redis'
+end

data/Gemfile.lock

@@ -0,0 +1,34 @@
+PATH
+  remote: .
+  specs:
+    travis-rollout (0.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.2.5)
+    redis (3.3.0)
+    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)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  redis
+  rspec
+  travis-rollout!
+
+BUNDLED WITH
+   1.12.5

data/LICENSE

@@ -0,0 +1,21 @@
+MIT LICENSE
+
+Copyright (c) 2016 Travis CI GmbH <contact@travis-ci.org>
+
+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,35 @@
+# travis-rollout
+
+Enable by setting an env var `ROLLOUT` and setting `ENV` to `production` or
+`staging`.
+
+## Usage
+
+```ruby
+args = { uid: 1, user: 'svenfuchs', repo: 'travis-hub' }
+Travis::Rollout.run(args) do
+  # reroute the message
+end
+```
+
+This will match:
+
+* uid against the percentage `ROLLOUT_PERCENT`
+* remaining arg values against the env vars `ROLLOUT_USERS` and `ROLLOUT_REPOS` (as comma separated values)
+
+`uid` can be a string or integer. For a string it will calculate the crc32 to
+turn it into an integer.
+
+If a redis instance is passed as an option it will additionally check redis:
+
+```ruby
+Travis::Rollout.run(args, redis: redis) do
+  # reroute the message
+end
+```
+
+It will use the value of the env var `ROLLOUT` as a namespace (e.g. `sync`), and check the keys:
+
+* enabling: `sync.rollout.enabled`
+* args: `sync.rollout.users`, `sync.rollout.repos`, `sync.rollout.owners`
+* percentage: `sync.rollout.percent`

data/exercise.md

@@ -0,0 +1,25 @@
+Refactor the class `Travis::Rollout` and remove the duplication of the methods
+`by_[owner|repo|user]?`, `[owner|repo|user]s` etc.
+
+Doing so also allow arbirary `args` hash to be passed:
+
+```
+args = {
+  uid:  1
+  user: 'carlad',
+  repo: 'travis-hub'
+  foo:  'bar'
+}
+
+Rollout.reroute(args) do
+  # reroute the message
+end
+
+```
+
+This would:
+
+* Match the `uid` against the percentage.
+* Not match the `uid` against the env var `ROLLOUT_UID` (i.e. ignore this case)
+* Match the strings `carlad`, `travis-hub` and `bar` against the respective env
+  vars `ROLLOUT_USERS`, `ROLLOUT_REPOS`, and `ROLLOUT_FOOS`

data/lib/travis/rollout/version.rb

@@ -0,0 +1,7 @@
+require 'travis/rollout'
+
+module Travis
+  class Rollout
+    VERSION = "0.0.1"
+  end
+end

data/lib/travis/rollout.rb

@@ -0,0 +1,112 @@
+require 'zlib'
+
+module Travis
+  class Rollout
+    ENVS = %w(production staging)
+
+    def self.run(*all, &block)
+      rollout = new(*all, &block)
+      rollout.run if rollout.matches?
+    end
+
+    def self.matches?(*all)
+      new(*all).matches?
+    end
+
+    attr_reader :args, :options, :block
+
+    def initialize(args = {}, options = {}, &block)
+      @args, @options, @block = args, options, block
+    end
+
+    def run
+      block.call || true
+    end
+
+    def matches?
+      production? and enabled? and (by_owner? or by_repo? or by_user? or by_percent?)
+    end
+
+    private
+
+      def production?
+        ENVS.include?(ENV['ENV'])
+      end
+
+      def enabled?
+        !!ENV['ROLLOUT'] && (!redis || redis.get(:"#{name}.rollout.enabled") == '1')
+      end
+
+      def by_owner?
+        !!owner && owners.include?(owner)
+      end
+
+      def owner
+        args[:owner]
+      end
+
+      def owners
+        read_collection('rollout', 'owners')
+      end
+
+      def by_repo?
+        !!repo && repos.include?(repo)
+      end
+
+      def repo
+        args[:repo]
+      end
+
+      def repos
+        read_collection('rollout', 'repos')
+      end
+
+      def by_user?
+        !!user && users.include?(user)
+      end
+
+      def user
+        args[:user]
+      end
+
+      def users
+        read_collection('rollout', 'users')
+      end
+
+      def by_percent?
+        !!uid && uid % 100 < percent
+      end
+
+      def uid
+        uid = args[:uid]
+        uid.is_a?(String) ? Zlib.crc32(uid).to_i & 0x7fffffff : uid
+      end
+
+      def percent
+        percent = ENV['ROLLOUT_PERCENT'] || redis && redis.get(:"#{name}.rollout.percent") || -1
+        percent.to_i
+      end
+
+      def name
+        ENV['ROLLOUT'].to_s.split('.').first
+      end
+
+      def redis
+        options[:redis]
+      end
+
+      def camelize(string)
+        string.to_s.sub(/./) { |char| char.upcase }
+      end
+
+      def read_collection(*path)
+        redis_path = path.map(&:downcase).join('.')
+        env_key = path.map(&:upcase).join('_')
+        if redis
+          redis_collection = redis.smembers(:"#{name}.#{redis_path}")
+          return redis_collection if redis_collection.any?
+        end
+        ENV.fetch(env_key, '').to_s.split(',')
+      end
+  end
+end

data/spec/rollout_spec.rb

@@ -0,0 +1,169 @@
+require 'redis'
+require 'travis/rollout'
+
+describe Travis::Rollout do
+  let(:redis) { Redis.new }
+  let(:env)   { %w(ENV ROLLOUT ROLLOUT_OWNERS ROLLOUT_REPOS ROLLOUT_USERS ROLLOUT_PERCENT) }
+
+  before  { redis.set("#{name}.rollout.enabled", '1') }
+  after   { redis.flushall }
+  after   { env.each { |key| ENV.delete(key) } }
+  subject { rollout.matches? }
+
+  shared_examples_for 'matches by owner name' do
+    context 'matches if the given owner name matches the OWNERS env var' do
+      before { ENV['ROLLOUT_OWNERS'] = owner }
+      it { should eq true }
+    end
+
+    context 'matches if the given owner name matches the redis key [name].rollout.owners' do
+      before { redis.sadd("#{name}.rollout.owners", owner) }
+      it { should eq true }
+    end
+  end
+
+  shared_examples_for 'does not match by owner name' do
+    context 'does not match even if the given owner name matches the OWNERS env var' do
+      before { ENV['ROLLOUT_OWNERS'] = owner }
+      it { should eq false }
+    end
+
+    context 'does not match even if the given owner name matches the redis key [name].rollout.owners' do
+      before { redis.sadd("#{name}.rollout.owners", owner) }
+      it { should eq false }
+    end
+  end
+
+  shared_examples_for 'matches by repo slug' do
+    context 'matches if the given repo slug matches the REPOS env var' do
+      before { ENV['ROLLOUT_REPOS'] = repo }
+      it { should eq true }
+    end
+
+    context 'matches if the given repo slug matches the redis key [name].rollout.repos' do
+      before { redis.sadd("#{name}.rollout.repos", repo) }
+      it { should eq true }
+    end
+  end
+
+  shared_examples_for 'does not match by repo slug' do
+    context 'does not match even if the given repo slug matches the REPOS env var' do
+      before { ENV['ROLLOUT_REPOS'] = repo }
+      it { should eq false }
+    end
+
+    context 'does not match even if the given repo slug matches the redis key [name].rollout.repos' do
+      before { redis.sadd("#{name}.rollout.repos", repo) }
+      it { should eq false }
+    end
+  end
+
+  shared_examples_for 'matches by user name' do
+    context 'matches if the given user name matches the REPOS env var' do
+      before { ENV['ROLLOUT_USERS'] = user }
+      it { should eq true }
+    end
+
+    context 'matches if the given user name matches the redis key [name].rollout.users' do
+      before { redis.sadd("#{name}.rollout.users", user) }
+      it { should eq true }
+    end
+  end
+
+  shared_examples_for 'does not match by user name' do
+    context 'does not match even if the given user slug matches the REPOS env var' do
+      before { ENV['ROLLOUT_USERS'] = user }
+      it { should eq false }
+    end
+
+    context 'does not match even if the given user name matches the redis key [name].rollout.users' do
+      before { redis.sadd("#{name}.rollout.users", user) }
+      it { should eq false }
+    end
+  end
+
+  shared_examples_for 'matches by percentage' do
+    context 'matches if the given id matches the ROLLOUT_PERCENT env var' do
+      before { ENV['ROLLOUT_PERCENT'] = '100' }
+      it { should eq true }
+    end
+
+    context 'matches if the given id matches the redis key [name].rollout.percent' do
+      before { redis.set("#{name}.rollout.percent", 100) }
+      it { should eq true }
+    end
+  end
+
+  shared_examples_for 'does not match by percentage' do
+    context 'does not match even if the given id matches the ROLLOUT_PERCENT env var' do
+      before { ENV['ROLLOUT_PERCENT'] = '100' }
+      it { should eq false }
+    end
+
+    context 'does not match even if the given id matches the redis key [name].rollout.percent' do
+      before { redis.set("#{name}.rollout.percent", 100) }
+      it { should eq false }
+    end
+  end
+
+  shared_examples_for 'matches by' do |type|
+    context 'with ROLLOUT being set in production' do
+      before  { ENV['ENV'] = 'production' }
+      before  { ENV['ROLLOUT'] = name }
+      include_examples "matches by #{type}"
+    end
+
+    context 'with ROLLOUT being set in staging' do
+      before  { ENV['ENV'] = 'production' }
+      before  { ENV['ROLLOUT'] = name }
+      include_examples "matches by #{type}"
+    end
+
+    context 'with ROLLOUT being set in development' do
+      before  { ENV['ENV'] = 'development' }
+      before  { ENV['ROLLOUT'] = name }
+      include_examples "does not match by #{type}"
+    end
+
+    context 'with ROLLOUT not set in production' do
+      before  { ENV['ENV'] = 'production' }
+      include_examples "does not match by #{type}"
+    end
+  end
+
+  # Gatekeeper knows an event uuid, an owner name, and a repo name
+  describe 'as used in gatekeeper' do
+    let(:name)    { 'gator' }
+    let(:id)      { '517be336-f16d-45cf-aa9b-a429547af6ad' }
+    let(:owner)   { 'carlad' }
+    let(:repo)    { 'travis-ci/travis-hub' }
+    let(:rollout) { described_class.new({ uid: id, owner: owner, repo: repo }, redis: redis) }
+
+    include_examples 'matches by', 'owner name'
+    include_examples 'matches by', 'repo slug'
+    include_examples 'matches by', 'percentage'
+  end
+
+  # Sync knows a user id, or repo id
+  describe 'as used in sync' do
+    let(:name) { 'sync' }
+
+    describe 'in the user sync worker' do
+      let(:id)      { 1 }
+      let(:user)    { 'carlad' }
+      let(:rollout) { described_class.new({ uid: id, user: user }, redis: redis) }
+
+      include_examples 'matches by', 'user name'
+      include_examples 'matches by', 'percentage'
+    end
+
+    describe 'in the repo branches sync worker' do
+      let(:id)      { 1 } # user id
+      let(:owner)   { 'carlad' }
+      let(:rollout) { described_class.new({ uid: id, owner: owner }, redis: redis) }
+
+      include_examples 'matches by', 'owner name'
+      include_examples 'matches by', 'percentage'
+    end
+  end
+end

data/travis-rollout.gemspec

@@ -0,0 +1,18 @@
+# encoding: utf-8
+
+$:.unshift File.expand_path('../lib', __FILE__)
+require 'travis/rollout/version'
+
+Gem::Specification.new do |s|
+  s.name          = 'travis-rollout'
+  s.version       = Travis::Rollout::VERSION
+  s.authors       = ['Travis CI']
+  s.email         = 'contact@travis-ci.org'
+  s.homepage      = 'https://github.com/travis-ci/travis-rollout'
+  s.summary       = 'Small helper class for rolling out apps'
+  s.description   = "#{s.summary}."
+
+  s.files         = Dir['{lib/**/*,spec/**/*,[A-Z]*}']
+  s.platform      = Gem::Platform::RUBY
+  s.require_paths = ['lib']
+end

metadata

@@ -0,0 +1,53 @@
+--- !ruby/object:Gem::Specification
+name: travis-rollout
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Travis CI
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-09-27 00:00:00.000000000 Z
+dependencies: []
+description: Small helper class for rolling out apps.
+email: contact@travis-ci.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- exercise.md
+- lib/travis/rollout.rb
+- lib/travis/rollout/version.rb
+- spec/rollout_spec.rb
+- spec/spec_helper.rb
+- travis-rollout.gemspec
+homepage: https://github.com/travis-ci/travis-rollout
+licenses: []
+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.5
+signing_key: 
+specification_version: 4
+summary: Small helper class for rolling out apps
+test_files: []
+has_rdoc: