synchronised_migration 0.1.0.pre.alpha.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3ab84276b5cbc3b6a059da59e59c414496f72a69
+  data.tar.gz: ba49512428c7d3554fbafa2d98b6746204f3d4ad
+SHA512:
+  metadata.gz: f18218af70a990a21ccdb7a88944bcf5482d56fc84b9181b52b48ee60339d1b412f27dcf91922849d617e59f0ca4dcc8429b8c5cfea32eef707d4286633c489c
+  data.tar.gz: 3dc0653bc15b35736138bacbdb9752e76589f571657966bc0b5ef641e1f67350d1fa4b201690320c54aa00fcc38001e74ce44c3cd8d10c262d21bbfca67c0180

data/.gitignore

@@ -0,0 +1,3 @@
+/.bundle
+/vendor
+/coverage

data/.ruby-version

@@ -0,0 +1 @@
+2.2.7

data/.travis.yml

@@ -0,0 +1,3 @@
+---
+language: ruby
+script: bundle && bundle exec rspec

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Synchronised Migration
+
+## 0.1.0 Unreleased
+
+* [DO-70] Use Redis to synchronise migrations across multiple deployments

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,58 @@
+PATH
+  remote: .
+  specs:
+    synchronised_migration (0.1.0)
+      redlock (~> 0.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    byebug (9.1.0)
+    coderay (1.1.2)
+    diff-lcs (1.3)
+    docile (1.1.5)
+    json (2.1.0)
+    method_source (0.8.2)
+    pry (0.10.4)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    pry-byebug (3.5.0)
+      byebug (~> 9.1)
+      pry (~> 0.10)
+    redis (3.3.3)
+    redlock (0.2.0)
+      redis (~> 3, >= 3.0.0)
+    rspec (3.6.0)
+      rspec-core (~> 3.6.0)
+      rspec-expectations (~> 3.6.0)
+      rspec-mocks (~> 3.6.0)
+    rspec-core (3.6.0)
+      rspec-support (~> 3.6.0)
+    rspec-expectations (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-mocks (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-support (3.6.0)
+    simplecov (0.15.0)
+      docile (~> 1.1.0)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    simplecov-rcov (0.2.3)
+      simplecov (>= 0.4.1)
+    slop (3.6.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  pry-byebug (~> 3.5)
+  rspec (~> 3.6)
+  simplecov-rcov (~> 0.2)
+  synchronised_migration!
+
+BUNDLED WITH
+   1.15.4

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 SeaLink Travel Group Limited
+
+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,44 @@
+# Synchronised Migration
+
+[![Build Status](https://travis-ci.org/sealink/synchronised-migration-rb.svg?branch=master)](https://travis-ci.org/sealink/synchronised-migration-rb)
+
+This gem makes it possible to deploy multiple instances with data migration
+simultaneously.  It uses Redis to ensure that there will be only one migration
+running.
+
+This gem works out of the box with a Rails project.  It should work with other
+Ruby projects so long as you load the rake task in Rakefile instead of relying
+on Railtie.
+
+This is a Ruby port of the same logic written in PHP in our [Craft
+Docker](https://github.com/sealink/craft-docker) project.
+
+## Usage
+
+Class `RedisConfig` needs to be provided as follow.
+
+```
+RedisConfig.get[:host] # example.com
+RedisConfig.get[:port] # 6379
+RedisConfig.get[:db] # 0
+```
+
+You may override these settings through environment variables.
+
+```
+SYNC_RAKE_TASK=launch:migrate
+REDLOCK_TIMEOUT_MS=3600000
+REDLOCK_RETRY_DELAY_MS=200
+REDLOCK_LOCK_KEY=migration-in-progress
+REDLOCK_FAIL_KEY=migration-failed
+```
+
+Run this before you launch the application during deployment.
+
+```
+$ rake synchronised_migrate:execute
+```
+
+## Testing
+
+Please refer to `.travis.yml` for testing.

data/lib/synchronised_migration/main.rb

@@ -0,0 +1,99 @@
+require 'synchronised_migration'
+require 'synchronised_migration/result'
+require 'redis'
+require 'redlock'
+require 'singleton'
+
+class SynchronisedMigration::Main
+  include Singleton
+
+  Result = SynchronisedMigration::Result
+
+  class << self
+    extend Forwardable
+    def_delegators :instance, :call
+  end
+
+  def call
+    lock_and_execute
+  end
+
+  private
+
+  def lock_and_execute
+    redlock.lock! lock_key, timeout do
+      execute
+    end
+  end
+
+  def execute
+    return Result.new 'Halting the script because the previous migration failed.' if previous_failed?
+    mark_failed
+    migrate
+    remove_fail_marker
+    Result.new
+  end
+
+  def previous_failed?
+    value = redis.get(fail_key)
+    not value.nil? and not value.empty?
+  end
+
+  def mark_failed
+    redis.set fail_key, 1
+  end
+
+  def remove_fail_marker
+    redis.del fail_key
+  end
+
+  def migrate
+    Rake::Task[target_rake_task].invoke
+  end
+
+  def target_rake_task
+    ENV.fetch 'SYNC_RAKE_TASK', 'launch:migrate'
+  end
+
+  def redis
+    @redis ||= Redis.new(url: redis_url)
+  end
+
+  def redlock
+    @redlock ||= Redlock::Client.new(
+      [ redis_url ], {
+        retry_count: retry_count,
+        retry_delay: retry_delay
+      }
+    )
+  end
+
+  def redis_url
+    sprintf(
+      'redis:://%s:%s/%s',
+      RedisConfig.get[:host],
+      RedisConfig.get[:port],
+      RedisConfig.get[:db]
+    )
+  end
+
+  def timeout
+    ENV.fetch('REDLOCK_TIMEOUT_MS', 3_600_000).to_i
+  end
+
+  def retry_delay
+    ENV.fetch('REDLOCK_RETRY_DELAY_MS', 200).to_i
+  end
+
+  def retry_count
+    timeout / retry_delay
+  end
+
+  def lock_key
+    ENV.fetch 'REDLOCK_LOCK_KEY', 'migration-in-progress'
+  end
+
+  def fail_key
+    ENV.fetch 'REDLOCK_FAIL_KEY', 'migration-failed'
+  end
+end

data/lib/synchronised_migration/railtie.rb

@@ -0,0 +1,5 @@
+class SynchronisedMigration::Railtie < Rails::Railtie
+  rake_tasks do
+    load 'tasks/synchronised_migration.rake'
+  end
+end

data/lib/synchronised_migration/result.rb

@@ -0,0 +1,13 @@
+require 'synchronised_migration'
+
+class SynchronisedMigration::Result
+  attr_accessor :error
+
+  def initialize(error = nil)
+    @error = error
+  end
+
+  def success?
+    error.nil?
+  end
+end

data/lib/synchronised_migration/version.rb

@@ -0,0 +1,3 @@
+module SynchronisedMigration
+  VERSION = '0.1.0-alpha.1'
+end

data/lib/synchronised_migration.rb

@@ -0,0 +1,4 @@
+module SynchronisedMigration
+end
+
+require 'synchronised_migration/railtie' if defined?(Rails)

data/lib/tasks/synchronised_migration.rake

@@ -0,0 +1,9 @@
+require 'synchronised_migration/main'
+
+namespace :synchronised_migration do
+  task :execute do
+    result = SynchronisedMigration::Main.call
+    next if result.success?
+    fail result.error
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require 'pry'
+require 'simplecov'
+require 'simplecov-rcov'
+
+SimpleCov.formatter = SimpleCov::Formatter::RcovFormatter
+SimpleCov.minimum_coverage 100
+SimpleCov.start do
+  add_filter %r{^/vendor}
+end

data/spec/synchronised_migration/main_spec.rb

@@ -0,0 +1,76 @@
+require 'spec_helper'
+require 'synchronised_migration/main'
+
+describe SynchronisedMigration::Main do
+  subject { described_class }
+  let(:result) { subject.call }
+
+  context 'when the prerequisites are meet' do
+    let(:redis) { double }
+    let(:redlock) { double }
+    let(:fail_marker_value) { nil }
+    let(:rake_task) { double }
+
+    before do
+      subject.instance.instance_variable_set :@redis, nil
+      subject.instance.instance_variable_set :@redlock, nil
+
+      allow(Redis).to receive(:new).and_return(redis)
+      allow(redis).to receive(:get).and_return(fail_marker_value)
+      allow(redis).to receive(:set)
+      allow(redis).to receive(:del)
+
+      allow(Redlock::Client).to receive(:new).and_return(redlock)
+      allow(redlock).to receive(:lock!) { |lock_key, timeout, &block| block.call }
+
+      stub_const 'Rake', Module.new
+      stub_const 'Rake::Task', { 'launch:migrate' => rake_task }
+
+      allow(rake_task).to receive(:invoke)
+
+      stub_const(
+        'RedisConfig', double(
+          get: {
+            host: 'example.com',
+            port: 6379,
+            db: 0
+          }
+        )
+      )
+    end
+
+    context 'in the happy path' do
+      it 'executes the migration successfully' do
+        expect(result).to be_success
+        expect(redlock).to have_received(:lock!)
+        expect(redis).to have_received(:get).with('migration-failed')
+        expect(redis).to have_received(:set).with('migration-failed', 1)
+        expect(rake_task).to have_received(:invoke)
+        expect(redis).to have_received(:del).with('migration-failed')
+      end
+    end
+
+    context 'after a deployment failed previously' do
+      let(:fail_marker_value) { '1' }
+
+      it "doesn't execute the migration" do
+        expect(result).not_to be_success
+        expect(rake_task).not_to have_received(:invoke)
+      end
+    end
+
+    context 'when the task crashed' do
+      before do
+        allow(rake_task).to receive(:invoke) do
+          fail 'An error message'
+        end
+      end
+
+      it 'marks the failure in Redis' do
+        expect { result }.to raise_error('An error message')
+        expect(redis).to have_received(:set).with('migration-failed', 1)
+        expect(redis).not_to have_received(:del)
+      end
+    end
+  end
+end

data/synchronised_migration.gemspec

@@ -0,0 +1,23 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'synchronised_migration/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'synchronised_migration'
+  spec.version       = SynchronisedMigration::VERSION
+  spec.authors       = ['Alvin Yim']
+  spec.email         = 'support@travellink.com.au'
+  spec.description   = 'Use Redis to record the data migration status'
+  spec.summary       = 'For deploying to multiple instances simultaneously'
+  spec.homepage      = 'https://github.com/sealink/synchronised-migration-rb'
+
+  spec.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'redlock', '~> 0.2'
+  spec.add_development_dependency 'simplecov-rcov', '~> 0.2'
+  spec.add_development_dependency 'rspec', '~> 3.6'
+  spec.add_development_dependency 'pry-byebug', '~> 3.5'
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: synchronised_migration
+version: !ruby/object:Gem::Version
+  version: 0.1.0.pre.alpha.1
+platform: ruby
+authors:
+- Alvin Yim
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-09-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: redlock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: simplecov-rcov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+description: Use Redis to record the data migration status
+email: support@travellink.com.au
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-version"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- lib/synchronised_migration.rb
+- lib/synchronised_migration/main.rb
+- lib/synchronised_migration/railtie.rb
+- lib/synchronised_migration/result.rb
+- lib/synchronised_migration/version.rb
+- lib/tasks/synchronised_migration.rake
+- spec/spec_helper.rb
+- spec/synchronised_migration/main_spec.rb
+- synchronised_migration.gemspec
+homepage: https://github.com/sealink/synchronised-migration-rb
+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: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.2
+signing_key: 
+specification_version: 4
+summary: For deploying to multiple instances simultaneously
+test_files:
+- spec/spec_helper.rb
+- spec/synchronised_migration/main_spec.rb