synchronised_migration 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 00db2582bb879e1481b044bbc394f3da0b84cfcc
-  data.tar.gz: 3afb675d990294a656eec86f7bd539c7c5d82625
+SHA256:
+  metadata.gz: 9c1431ba1cc8bb0ad840ba1020723cbefe53e2b88f3e40e80e24a203b7ab8163
+  data.tar.gz: 0faa2082f8cbceefcaa72b566d9ec16b02be2e19b27016ddf47e7a8f5d882659
 SHA512:
-  metadata.gz: 0b50bb56d5ef420e3fd398f867659eed45ef72e0ff2058b15276c4da58f2068232222b860ea726126d628d5e71a0221065624e667476345841588b1ebad54e79
-  data.tar.gz: 56d9d17730bf54bea7d9c4ba99584ce1dc0a582a046c494d03f44e283ba1ad435d00b3a9caacc53065af2ec9948ed252c4de3c80702d40c49f51b33b7160a215
+  metadata.gz: 842a04dca6b33503bf50d9563d688ea10c2ac624523b893a6f6314367dbff97c98cfecaf0dd9c82c32d0084323e1231aa81409a5616a6806b2b025b8fee9ffc2
+  data.tar.gz: d0be7428022db07f04c00d6017f29c2988035365c5ce76430cbae5177cd672d77aed79ff850e1a5a93987f25042a141cee384df6fe9ebdfabe7f117c0691fa1c

data/.gitignore

@@ -2,3 +2,4 @@
 /vendor
 /coverage
 /*.gem
+Gemfile.lock

data/.ruby-version

@@ -1 +1 @@
-2.2.7
+2.6.3

data/.travis.yml

@@ -1,3 +1,10 @@
----
 language: ruby
-script: bundle && bundle exec rspec
+rvm:
+  - 2.4
+  - 2.5
+  - 2.6
+script: bundle exec rspec
+sudo: false
+cache: bundler
+before_install:
+  - gem install bundler

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Synchronised Migration
 
+## 2.1.0
+
+* [TT-5827] Add "success key" when REDLOCK_VERSION_SUFFIX is set, preventing repeat runs
+* [TT-5830] Add rake and Rakefile for 'rake release'
+
 ## 2.0.0
 
 * [DO-168] Removed requirement for defining RedisConfig, now set on

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'

data/lib/synchronised_migration/main.rb

@@ -15,11 +15,16 @@ class SynchronisedMigration::Main
   end
 
   def call
-    lock_and_execute
+    done_or_execute
   end
 
   private
 
+  def done_or_execute
+    return Result.ok if migration_already_completed?
+    lock_and_execute
+  end
+
   def lock_and_execute
     redlock.lock! lock_key, timeout do
       execute
@@ -27,12 +32,25 @@ class SynchronisedMigration::Main
   end
 
   def execute
-    return Result.new 'Halting the script because the previous migration failed.' if previous_failed?
+    return Result.fail 'Halting the script because the previous migration failed.' if previous_failed?
     mark_failed
     migrate
-    return Result.new 'Migration failed.' if migration_failed?
+    return Result.fail 'Migration failed.' if migration_failed?
+    mark_successful
     remove_fail_marker
-    Result.new
+    return Result.ok
+  end
+
+  def migration_already_completed?
+    return false if !success_key
+    value = redis.get(success_key)
+    not value.nil? and not value.empty?
+  end
+
+  def mark_successful
+    if success_key
+      redis.set success_key, timestamp, ttl: 3600*24*30
+    end
   end
 
   def previous_failed?
@@ -41,7 +59,7 @@ class SynchronisedMigration::Main
   end
 
   def mark_failed
-    redis.set fail_key, 1
+    redis.set fail_key, timestamp, ttl: 3600
   end
 
   def remove_fail_marker
@@ -89,12 +107,16 @@ class SynchronisedMigration::Main
     )
   end
 
+  def timestamp
+    Time.now.to_i
+  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
+    ENV.fetch('REDLOCK_RETRY_DELAY_MS', 3000).to_i
   end
 
   def retry_count
@@ -106,6 +128,16 @@ class SynchronisedMigration::Main
   end
 
   def fail_key
-    ENV.fetch 'REDLOCK_FAIL_KEY', 'migration-failed'
+    ENV.fetch 'REDLOCK_FAIL_KEY', 'migration-failed' + version_suffix
+  end
+
+  def success_key
+    return false if version_suffix.empty?
+    'migration-success' + version_suffix
+  end
+
+  def version_suffix
+    suffix = ENV.fetch 'REDLOCK_VERSION_SUFFIX', false
+    suffix ? '-' + suffix : ''
   end
 end

data/lib/synchronised_migration/result.rb

@@ -10,4 +10,12 @@ class SynchronisedMigration::Result
   def success?
     error.nil?
   end
+
+  def self.ok
+    self.new
+  end
+
+  def self.fail(error)
+    self.new error
+  end
 end

data/lib/synchronised_migration/version.rb

@@ -1,3 +1,3 @@
 module SynchronisedMigration
-  VERSION = '2.0.0'
+  VERSION = '2.1.0'
 end

data/spec/synchronised_migration/main_spec.rb

@@ -9,19 +9,26 @@ describe SynchronisedMigration::Main do
     let(:redis) { double }
     let(:redlock) { double }
     let(:fail_marker_value) { nil }
+    let(:success_marker_value) { nil }
+    let(:set_version_suffix) { ENV['REDLOCK_VERSION_SUFFIX'] = 'bork' }
+    let(:time_value) { double(to_i: 123456789) }
 
     before do
+      set_version_suffix
+
       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(:get).and_return(success_marker_value, 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 }
 
+      allow(Time).to receive(:now).and_return(time_value)
+
       allow(Kernel).to receive(:system).and_wrap_original { |method, *args|
         next if args == [ 'bin/launch/migrate' ]
         method.call *args
@@ -40,11 +47,20 @@ describe SynchronisedMigration::Main 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(redis).to have_received(:get).with('migration-failed-bork')
+        expect(redis).to have_received(:set).with('migration-failed-bork', 123456789, ttl: 3600)
+        expect(redis).to have_received(:set).with('migration-success-bork', 123456789, ttl: 3600*24*30)
         expect(Kernel).to have_received(:system)
         expect(Bundler).not_to have_received(:with_original_env)
-        expect(redis).to have_received(:del).with('migration-failed')
+        expect(redis).to have_received(:del).with('migration-failed-bork')
+      end
+
+      context 'and migration completed previously' do
+        let(:success_marker_value) { '1' }
+        it 'contines without executing' do
+          expect(result).to be_success
+          expect(redlock).not_to have_received(:lock!)
+        end
       end
     end
 
@@ -77,9 +93,37 @@ describe SynchronisedMigration::Main do
 
       it 'marks the failure in Redis' do
         expect(result).not_to be_success
-        expect(redis).to have_received(:set).with('migration-failed', 1)
+        expect(redis).to have_received(:set).with('migration-failed-bork', 123456789, ttl: 3600)
         expect(redis).not_to have_received(:del)
       end
     end
+
+    context 'without version suffix' do
+      let(:set_version_suffix) { ENV.delete 'REDLOCK_VERSION_SUFFIX' }
+
+      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', 123456789, ttl: 3600)
+          expect(Kernel).to have_received(:system)
+          expect(Bundler).not_to have_received(:with_original_env)
+          expect(redis).to have_received(:del).with('migration-failed')
+        end
+      end
+
+      context 'when the task crashed' do
+        before do
+          allow_any_instance_of(Process::Status).to receive(:success?).and_return(false)
+        end
+
+        it 'marks the failure in Redis' do
+          expect(result).not_to be_success
+          expect(redis).to have_received(:set).with('migration-failed', 123456789, ttl: 3600)
+          expect(redis).not_to have_received(:del)
+        end
+      end
+    end
   end
 end

data/synchronised_migration.gemspec

@@ -16,8 +16,9 @@ Gem::Specification.new do |spec|
   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'
+  spec.add_dependency 'redlock', '>= 0.2'
+  spec.add_development_dependency 'rake'
+  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

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: synchronised_migration
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Alvin Yim
@@ -9,62 +9,76 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-17 00:00:00.000000000 Z
+date: 2019-08-06 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: rake
+  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: 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
@@ -78,9 +92,9 @@ files:
 - ".travis.yml"
 - CHANGELOG.md
 - Gemfile
-- Gemfile.lock
 - LICENSE
 - README.md
+- Rakefile
 - lib/synchronised_migration.rb
 - lib/synchronised_migration/main.rb
 - lib/synchronised_migration/railtie.rb
@@ -108,8 +122,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.5.2
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: For deploying to multiple instances simultaneously

data/Gemfile.lock

@@ -1,58 +0,0 @@
-PATH
-  remote: .
-  specs:
-    synchronised_migration (2.0.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 (4.0.1)
-    redlock (0.2.2)
-      redis (>= 3.0.0, < 5.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.16.1