with_advisory_lock 4.6.0 → 5.1.0

data/test/shared_test.rb

@@ -1,131 +1,134 @@
-require 'minitest_helper'
+# frozen_string_literal: true
 
-describe 'shared locks' do
-  def supported?
-    env_db != :mysql
-  end
-
-  class SharedTestWorker
-    def initialize(shared)
-      @shared = shared
+require 'test_helper'
+class SharedTestWorker
+  def initialize(shared)
+    @shared = shared
 
-      @locked = nil
-      @cleanup = false
-      @thread = Thread.new { work }
-    end
+    @locked = nil
+    @cleanup = false
+    @thread = Thread.new { work }
+  end
 
-    def locked?
-      sleep 0.01 while @locked.nil? && @thread.alive?
-      @locked
-    end
+  def locked?
+    sleep 0.01 while @locked.nil? && @thread.alive?
+    @locked
+  end
 
-    def cleanup!
-      @cleanup = true
-      @thread.join
-      raise if @thread.status.nil?
-    end
+  def cleanup!
+    @cleanup = true
+    @thread.join
+    raise if @thread.status.nil?
+  end
 
-    private
+  private
 
-    def work
-      ActiveRecord::Base.connection_pool.with_connection do
-        Tag.with_advisory_lock('test', timeout_seconds: 0, shared: @shared) do
-          @locked = true
-          sleep 0.01 until @cleanup
-        end
-        @locked = false
+  def work
+    ActiveRecord::Base.connection_pool.with_connection do
+      Tag.with_advisory_lock('test', timeout_seconds: 0, shared: @shared) do
+        @locked = true
         sleep 0.01 until @cleanup
       end
+      @locked = false
+      sleep 0.01 until @cleanup
     end
   end
+end
+
+class SharedLocksTest < GemTestCase
+  def supported?
+    %i[trilogy mysql2 jdbcmysql].exclude?(env_db)
+  end
 
-  it 'does not allow two exclusive locks' do
+  test 'does not allow two exclusive locks' do
     one = SharedTestWorker.new(false)
-    one.locked?.must_equal true
+    assert_predicate(one, :locked?)
 
     two = SharedTestWorker.new(false)
-    two.locked?.must_equal false
+    refute(two.locked?)
 
     one.cleanup!
     two.cleanup!
   end
+end
 
-  describe 'not supported' do
-    before do
-      skip if supported?
-    end
+class NotSupportedEnvironmentTest < SharedLocksTest
+  setup do
+    skip if supported?
+  end
 
-    it 'raises an error when attempting to use a shared lock' do
-      one = SharedTestWorker.new(true)
-      one.locked?.must_be_nil
-      exception = proc {
-        one.cleanup!
-      }.must_raise ArgumentError
-      exception.message.must_include 'not supported'
+  test 'raises an error when attempting to use a shared lock' do
+    one = SharedTestWorker.new(true)
+    assert_nil(one.locked?)
+
+    exception = assert_raises(ArgumentError) do
+      one.cleanup!
     end
+
+    assert_match(/#{Regexp.escape('not supported')}/, exception.message)
   end
+end
 
-  describe 'supported' do
-    before do
-      skip unless supported?
-    end
+class SupportedEnvironmentTest < SharedLocksTest
+  setup do
+    skip unless supported?
+  end
 
-    it 'does allow two shared locks' do
-      one = SharedTestWorker.new(true)
-      one.locked?.must_equal true
+  test 'does allow two shared locks' do
+    one = SharedTestWorker.new(true)
+    assert_predicate(one, :locked?)
 
-      two = SharedTestWorker.new(true)
-      two.locked?.must_equal true
+    two = SharedTestWorker.new(true)
+    assert_predicate(two, :locked?)
 
-      one.cleanup!
-      two.cleanup!
-    end
+    one.cleanup!
+    two.cleanup!
+  end
 
-    it 'does not allow exclusive lock with shared lock' do
-      one = SharedTestWorker.new(true)
-      one.locked?.must_equal true
+  test 'does not allow exclusive lock with shared lock' do
+    one = SharedTestWorker.new(true)
+    assert_predicate(one, :locked?)
 
-      two = SharedTestWorker.new(false)
-      two.locked?.must_equal false
+    two = SharedTestWorker.new(false)
+    refute(two.locked?)
 
-      three = SharedTestWorker.new(true)
-      three.locked?.must_equal true
+    three = SharedTestWorker.new(true)
+    assert_predicate(three, :locked?)
 
-      one.cleanup!
-      two.cleanup!
-      three.cleanup!
-    end
+    one.cleanup!
+    two.cleanup!
+    three.cleanup!
+  end
 
-    it 'does not allow shared lock with exclusive lock' do
-      one = SharedTestWorker.new(false)
-      one.locked?.must_equal true
+  test 'does not allow shared lock with exclusive lock' do
+    one = SharedTestWorker.new(false)
+    assert_predicate(one, :locked?)
 
-      two = SharedTestWorker.new(true)
-      two.locked?.must_equal false
+    two = SharedTestWorker.new(true)
+    refute(two.locked?)
 
-      one.cleanup!
-      two.cleanup!
-    end
+    one.cleanup!
+    two.cleanup!
+  end
 
-    describe 'PostgreSQL' do
-      before do
-        skip unless env_db == :postgresql
-      end
+  class PostgreSQLTest < SupportedEnvironmentTest
+    setup do
+      skip unless env_db == :postgresql
+    end
 
-      def pg_lock_modes
-        ActiveRecord::Base.connection.select_values("SELECT mode FROM pg_locks WHERE locktype = 'advisory';")
-      end
+    def pg_lock_modes
+      ActiveRecord::Base.connection.select_values("SELECT mode FROM pg_locks WHERE locktype = 'advisory';")
+    end
 
-      it 'allows shared lock to be upgraded to an exclusive lock' do
-        pg_lock_modes.must_equal %w[]
-        Tag.with_advisory_lock 'test', shared: true do
-          pg_lock_modes.must_equal %w[ShareLock]
-          Tag.with_advisory_lock 'test', shared: false do
-            pg_lock_modes.must_equal %w[ShareLock ExclusiveLock]
-          end
+    test 'allows shared lock to be upgraded to an exclusive lock' do
+      assert_empty(pg_lock_modes)
+      Tag.with_advisory_lock 'test', shared: true do
+        assert_equal(%w[ShareLock], pg_lock_modes)
+        Tag.with_advisory_lock 'test', shared: false do
+          assert_equal(%w[ShareLock ExclusiveLock], pg_lock_modes)
         end
-        pg_lock_modes.must_equal %w[]
       end
+      assert_empty(pg_lock_modes)
     end
   end
 end

data/test/test_helper.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require 'erb'
+require 'active_record'
+require 'with_advisory_lock'
+require 'tmpdir'
+require 'securerandom'
+begin
+  require 'activerecord-trilogy-adapter'
+  ActiveSupport.on_load(:active_record) do
+    require "trilogy_adapter/connection"
+    ActiveRecord::Base.public_send :extend, TrilogyAdapter::Connection
+  end
+rescue LoadError
+  # do nothing
+end
+
+ActiveRecord::Base.configurations = {
+  default_env: {
+    url: ENV.fetch('DATABASE_URL', "sqlite3://#{Dir.tmpdir}/#{SecureRandom.hex}.sqlite3"),
+    properties: { allowPublicKeyRetrieval: true } # for JRuby madness
+  }
+}
+
+ENV['WITH_ADVISORY_LOCK_PREFIX'] ||= SecureRandom.hex
+
+ActiveRecord::Base.establish_connection
+
+def env_db
+  @env_db ||= ActiveRecord::Base.connection_db_config.adapter.to_sym
+end
+
+ActiveRecord::Migration.verbose = false
+
+require 'test_models'
+require 'minitest'
+require 'maxitest/autorun'
+require 'mocha/minitest'
+
+class GemTestCase < ActiveSupport::TestCase
+  setup do
+    ENV['FLOCK_DIR'] = Dir.mktmpdir
+    Tag.delete_all
+    TagAudit.delete_all
+    Label.delete_all
+  end
+  teardown do
+    FileUtils.remove_entry_secure ENV['FLOCK_DIR']
+  end
+end
+
+puts "Testing with #{env_db} database, ActiveRecord #{ActiveRecord.gem_version} and #{RUBY_ENGINE} #{RUBY_ENGINE_VERSION} as #{RUBY_VERSION}"

data/test/test_models.rb

@@ -1,12 +1,14 @@
-ActiveRecord::Schema.define(:version => 0) do
-  create_table "tags", :force => true do |t|
-    t.string "name"
+# frozen_string_literal: true
+
+ActiveRecord::Schema.define(version: 0) do
+  create_table 'tags', force: true do |t|
+    t.string 'name'
   end
-  create_table "tag_audits", :id => false, :force => true do |t|
-    t.string "tag_name"
+  create_table 'tag_audits', id: false, force: true do |t|
+    t.string 'tag_name'
   end
-  create_table "labels", :id => false, :force => true do |t|
-    t.string "name"
+  create_table 'labels', id: false, force: true do |t|
+    t.string 'name'
   end
 end
 

data/test/thread_test.rb

@@ -1,16 +1,17 @@
-require 'minitest_helper'
+# frozen_string_literal: true
 
-describe 'separate thread tests' do
-  let(:lock_name) { 'testing 1,2,3' } # OMG COMMAS
+require 'test_helper'
 
-  before do
+class SeparateThreadTest < GemTestCase
+  setup do
+    @lock_name = 'testing 1,2,3' # OMG COMMAS
     @mutex = Mutex.new
     @t1_acquired_lock = false
     @t1_return_value = nil
 
     @t1 = Thread.new do
       ActiveRecord::Base.connection_pool.with_connection do
-        @t1_return_value = Label.with_advisory_lock(lock_name) do
+        @t1_return_value = Label.with_advisory_lock(@lock_name) do
           @mutex.synchronize { @t1_acquired_lock = true }
           sleep
           't1 finished'
@@ -19,42 +20,42 @@ describe 'separate thread tests' do
     end
 
     # Wait for the thread to acquire the lock:
-    until @mutex.synchronize { @t1_acquired_lock } do
-      sleep(0.1)
-    end
+    sleep(0.1) until @mutex.synchronize { @t1_acquired_lock }
     ActiveRecord::Base.connection.reconnect!
   end
 
-  after do
+  teardown do
     @t1.wakeup if @t1.status == 'sleep'
     @t1.join
   end
 
-  it '#with_advisory_lock with a 0 timeout returns false immediately' do
-    response = Label.with_advisory_lock(lock_name, 0) do
-      fail 'should not be yielded to'
+  test '#with_advisory_lock with a 0 timeout returns false immediately' do
+    response = Label.with_advisory_lock(@lock_name, 0) do
+      raise 'should not be yielded to'
     end
-    response.must_be_false
+    assert_not(response)
   end
 
-  it '#with_advisory_lock yields to the provided block' do
-    @t1_acquired_lock.must_be_true
+  test '#with_advisory_lock yields to the provided block' do
+    assert(@t1_acquired_lock)
   end
 
-  it '#advisory_lock_exists? returns true when another thread has the lock' do
-    Tag.advisory_lock_exists?(lock_name).must_be_true
+  test '#advisory_lock_exists? returns true when another thread has the lock' do
+    assert(Tag.advisory_lock_exists?(@lock_name))
   end
 
-  it 'can re-establish the lock after the other thread releases it' do
+  test 'can re-establish the lock after the other thread releases it' do
     @t1.wakeup
     @t1.join
-    @t1_return_value.must_equal 't1 finished'
+    assert_equal('t1 finished', @t1_return_value)
 
     # We should now be able to acquire the lock immediately:
     reacquired = false
-    Label.with_advisory_lock(lock_name, 0) do
+    lock_result = Label.with_advisory_lock(@lock_name, 0) do
       reacquired = true
-    end.must_be_true
-    reacquired.must_be_true
+    end
+
+    assert(lock_result)
+    assert(reacquired)
   end
 end

data/test/transaction_test.rb

@@ -1,70 +1,68 @@
-require 'minitest_helper'
+# frozen_string_literal: true
 
-describe 'transaction scoping' do
+require 'test_helper'
+
+class TransactionScopingTest < GemTestCase
   def supported?
-    env_db == :postgresql
+    %i[postgresql jdbcpostgresql].include?(env_db)
   end
 
-  describe 'not supported' do
-    before do
-      skip if supported?
-    end
+  test 'raises an error when attempting to use transaction level locks if not supported' do
+    skip if supported?
 
-    it 'raises an error when attempting to use transaction level locks' do
-      Tag.transaction do
-        exception = proc {
-          Tag.with_advisory_lock 'test', transaction: true do
-            raise 'should not get here'
-          end
-        }.must_raise ArgumentError
-        exception.message.must_include 'not supported'
+    Tag.transaction do
+      exception = assert_raises(ArgumentError) do
+        Tag.with_advisory_lock 'test', transaction: true do
+          raise 'should not get here'
+        end
       end
+
+      assert_match(/#{Regexp.escape('not supported')}/, exception.message)
     end
   end
 
-  describe 'supported' do
-    before do
+  class PostgresqlTest < TransactionScopingTest
+    setup do
       skip unless env_db == :postgresql
+      @pg_lock_count = lambda do
+        ActiveRecord::Base.connection.select_value("SELECT COUNT(*) FROM pg_locks WHERE locktype = 'advisory';").to_i
+      end
     end
 
-    def pg_lock_count
-      ActiveRecord::Base.connection.select_value("SELECT COUNT(*) FROM pg_locks WHERE locktype = 'advisory';").to_i
-    end
-
-    specify 'session locks release after the block executes' do
+    test 'session locks release after the block executes' do
       Tag.transaction do
-        pg_lock_count.must_equal 0
+        assert_equal(0, @pg_lock_count.call)
         Tag.with_advisory_lock 'test' do
-          pg_lock_count.must_equal 1
+          assert_equal(1, @pg_lock_count.call)
         end
-        pg_lock_count.must_equal 0
+        assert_equal(0, @pg_lock_count.call)
       end
     end
 
-    specify 'session locks release when transaction fails inside block' do
+    test 'session locks release when transaction fails inside block' do
       Tag.transaction do
-        pg_lock_count.must_equal 0
+        assert_equal(0, @pg_lock_count.call)
 
-        exception = proc {
+        exception = assert_raises(ActiveRecord::StatementInvalid) do
           Tag.with_advisory_lock 'test' do
             Tag.connection.execute 'SELECT 1/0;'
           end
-        }.must_raise ActiveRecord::StatementInvalid
-        exception.message.must_include 'division by zero'
+        end
 
-        pg_lock_count.must_equal 0
+        assert_match(/#{Regexp.escape('division by zero')}/, exception.message)
+        assert_equal(0, @pg_lock_count.call)
       end
     end
 
-    specify 'transaction level locks hold until the transaction completes' do
+    test 'transaction level locks hold until the transaction completes' do
       Tag.transaction do
-        pg_lock_count.must_equal 0
+        assert_equal(0, @pg_lock_count.call)
         Tag.with_advisory_lock 'test', transaction: true do
-          pg_lock_count.must_equal 1
+          assert_equal(1, @pg_lock_count.call)
         end
-        pg_lock_count.must_equal 1
+        assert_equal(1, @pg_lock_count.call)
       end
-      pg_lock_count.must_equal 0
+      assert_equal(0, @pg_lock_count.call)
     end
   end
 end

data/with_advisory_lock.gemspec

@@ -1,29 +1,35 @@
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'with_advisory_lock/version'
+# frozen_string_literal: true
 
-Gem::Specification.new do |gem|
-  gem.name          = "with_advisory_lock"
-  gem.version       = WithAdvisoryLock::VERSION
-  gem.authors       = ['Matthew McEachen']
-  gem.email         = %w(matthew+github@mceachen.org)
-  gem.homepage      = 'https://github.com/mceachen/with_advisory_lock'
-  gem.summary       = %q{Advisory locking for ActiveRecord}
-  gem.description   = %q{Advisory locking for ActiveRecord}
-  gem.license       = 'MIT'
+require 'English'
+require_relative 'lib/with_advisory_lock/version'
 
-  gem.files         = `git ls-files`.split($/)
-  gem.test_files    = gem.files.grep(%r{^test/})
-  gem.require_paths = %w(lib)
-  gem.required_ruby_version = '>= 2.2.10'
+Gem::Specification.new do |spec|
+  spec.name          = 'with_advisory_lock'
+  spec.version       = WithAdvisoryLock::VERSION
+  spec.authors       = ['Matthew McEachen', 'Abdelkader Boudih']
+  spec.email         = %w[matthew+github@mceachen.org terminale@gmail.com]
+  spec.homepage      = 'https://github.com/ClosureTree/with_advisory_lock'
+  spec.summary       = 'Advisory locking for ActiveRecord'
+  spec.description   = 'Advisory locking for ActiveRecord'
+  spec.license       = 'MIT'
 
-  gem.add_runtime_dependency 'activerecord', '>= 4.2'
+  spec.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
+  spec.test_files    = spec.files.grep(%r{^test/})
+  spec.require_paths = %w[lib]
+  spec.metadata      = { 'rubyspecs_mfa_required' => 'true' }
+  spec.required_ruby_version = '>= 2.7.0'
+  spec.metadata['yard.run'] = 'yri'
 
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/ClosureTree/with_advisory_lock'
+  spec.metadata['changelog_uri'] = 'https://github.com/ClosureTree/with_advisory_lock/blob/master/CHANGELOG.md'
 
-  gem.add_development_dependency 'yard'
-  gem.add_development_dependency 'minitest'
-  gem.add_development_dependency 'minitest-great_expectations'
-  gem.add_development_dependency 'minitest-reporters'
-  gem.add_development_dependency 'mocha'
-  gem.add_development_dependency 'appraisal'
+  spec.add_runtime_dependency 'activerecord', '>= 6.1'
+  spec.add_runtime_dependency 'zeitwerk', '>= 2.6'
+
+  spec.add_development_dependency 'appraisal'
+  spec.add_development_dependency 'maxitest'
+  spec.add_development_dependency 'minitest-reporters'
+  spec.add_development_dependency 'mocha'
+  spec.add_development_dependency 'yard'
 end