master_slave_adapter 0.2.0 → 1.0.0.beta1

data/spec/mysql_master_slave_adapter_spec.rb

@@ -0,0 +1,320 @@
+$: << File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'rspec'
+
+class Mysql
+  class Error
+    CR_CONNECTION_ERROR   = 1
+    CR_CONN_HOST_ERROR    = 2
+    CR_SERVER_GONE_ERROR  = 4
+    CR_SERVER_LOST        = 8
+  end
+end
+
+require 'active_record/connection_adapters/mysql_master_slave_adapter'
+
+ActiveRecord::Base.logger =
+  Logger.new($stdout).tap { |l| l.level = Logger::DEBUG }
+
+module ActiveRecord
+  class Base
+    cattr_accessor :master_mock, :slave_mock
+    def self.mysql_connection(config)
+      config[:database] == 'slave' ? slave_mock : master_mock
+    end
+  end
+end
+
+describe ActiveRecord::ConnectionAdapters::MysqlMasterSlaveAdapter do
+  let(:default_database_setup) do
+    {
+      :adapter => 'master_slave',
+      :username => 'root',
+      :database => 'slave',
+      :connection_adapter => 'mysql',
+      :master => { :username => 'root', :database => 'master' },
+      :slaves => [{ :database => 'slave' }],
+    }
+  end
+
+  let(:database_setup) { default_database_setup }
+
+  let(:mocked_methods) do
+    {
+      :reconnect! => true,
+      :disconnect! => true,
+      :active? => true,
+    }
+  end
+
+  let!(:master_connection) do
+    mock(
+      'master connection',
+      mocked_methods.merge(:open_transactions => 0)
+    ).tap do |conn|
+      conn.stub!(:uncached).and_yield
+      ActiveRecord::Base.master_mock = conn
+    end
+  end
+
+  let!(:slave_connection) do
+    mock('slave connection', mocked_methods).tap do |conn|
+      conn.stub!(:uncached).and_yield
+      ActiveRecord::Base.slave_mock = conn
+    end
+  end
+
+  def adapter_connection
+    ActiveRecord::Base.connection
+  end
+
+  SelectMethods = [ :select_all, :select_one, :select_rows, :select_value, :select_values ]
+  Clock = ActiveRecord::ConnectionAdapters::MasterSlaveAdapter::Clock
+
+  before do
+    ActiveRecord::Base.establish_connection(database_setup)
+  end
+
+  after do
+    ActiveRecord::Base.connection_handler.clear_all_connections!
+  end
+
+  describe 'consistency' do
+    def zero
+      Clock.zero
+    end
+
+    def master_position(pos)
+      Clock.new('', pos)
+    end
+
+    def slave_should_report_clock(pos)
+      pos = Array(pos)
+      values = pos.map { |p| { 'Relay_Master_Log_File' => '', 'Exec_Master_Log_Pos' => p } }
+      slave_connection.
+        should_receive('select_one').exactly(pos.length).with('SHOW SLAVE STATUS').
+        and_return(*values)
+    end
+
+    def master_should_report_clock(pos)
+      pos = Array(pos)
+      values = pos.map { |p| { 'File' => '', 'Position' => p } }
+      master_connection.
+        should_receive('select_one').exactly(pos.length).with('SHOW MASTER STATUS').
+        and_return(*values)
+    end
+
+    SelectMethods.each do |method|
+      it "should send the method '#{method}' to the slave if nil is given" do
+        slave_should_report_clock(0)
+        slave_connection.should_receive(method).with('testing').and_return(true)
+        new_clock = ActiveRecord::Base.with_consistency(nil) do
+          adapter_connection.send(method, 'testing')
+        end
+        new_clock.should be_a(Clock)
+        new_clock.should equal(zero)
+      end
+
+      it "should send the method '#{method}' to the slave if clock.zero is given" do
+        slave_should_report_clock(0)
+        slave_connection.should_receive(method).with('testing').and_return(true)
+        old_clock = zero
+        new_clock = ActiveRecord::Base.with_consistency(old_clock) do
+          adapter_connection.send(method, 'testing')
+        end
+        new_clock.should be_a(Clock)
+        new_clock.should equal(old_clock)
+      end
+
+      it "should send the method '#{method}' to the master if slave hasn't cought up to required clock yet" do
+        slave_should_report_clock(0)
+        master_connection.should_receive(method).with('testing').and_return(true)
+        old_clock = master_position(1)
+        new_clock = ActiveRecord::Base.with_consistency(old_clock) do
+          adapter_connection.send(method, 'testing' )
+        end
+        new_clock.should be_a(Clock)
+        new_clock.should equal(old_clock)
+      end
+
+      it "should send the method '#{method}' to the master connection if there are open transactions" do
+        master_connection.stub!(:open_transactions).and_return(1)
+        master_connection.should_receive(method).with('testing').and_return(true)
+        old_clock = zero
+        new_clock = ActiveRecord::Base.with_consistency(old_clock) do
+          adapter_connection.send(method, 'testing')
+        end
+        new_clock.should be_a(Clock)
+        new_clock.should equal(zero)
+      end
+
+      it "should send the method '#{method}' to the master after a write operation" do
+        slave_should_report_clock(0)
+        master_should_report_clock(2)
+        slave_connection.should_receive(method).with('testing').and_return(true)
+        master_connection.should_receive('update').with('testing').and_return(true)
+        master_connection.should_receive(method).with('testing').and_return(true)
+        old_clock = zero
+        new_clock = ActiveRecord::Base.with_consistency(old_clock) do
+          adapter_connection.send(method, 'testing')   # slave
+          adapter_connection.send('update', 'testing') # master
+          adapter_connection.send(method, 'testing')   # master
+        end
+        new_clock.should be_a(Clock)
+        new_clock.should > old_clock
+      end
+    end
+
+    it "should update the clock after a transaction" do
+      slave_should_report_clock(0)
+      master_should_report_clock([0, 1, 1])
+
+      slave_connection.
+        should_receive('select_all').exactly(1).times.with('testing').
+        and_return(true)
+
+      master_connection.
+        should_receive('update').exactly(3).times.with('testing').
+        and_return(true)
+      master_connection.
+        should_receive('select_all').exactly(5).times.with('testing').
+        and_return(true)
+      %w(begin_db_transaction
+         commit_db_transaction
+         increment_open_transactions
+         decrement_open_transactions
+         outside_transaction?).each do |txstmt|
+        master_connection.should_receive(txstmt).exactly(1).times
+      end
+
+      master_connection.
+        should_receive('open_transactions').exactly(13).times.
+        and_return(
+          # adapter: with_consistency, select_all, update, select_all
+          0, 0, 0, 0,
+          # connection: transaction
+          0,
+          # adapter: select_all, update, select_all, commit_db_transaction
+          1, 1, 1, 0,
+          # connection: transaction (ensure)
+          0,
+          # adapter: select_all, update, select_all
+          0, 0, 0
+         )
+
+      old_clock = zero
+      new_clock = ActiveRecord::Base.with_consistency(old_clock) do
+        adapter_connection.send('select_all', 'testing') # slave  s=0 m=0
+        adapter_connection.send('update', 'testing')     # master s=0 m=1
+        adapter_connection.send('select_all', 'testing') # master s=0 m=1
+
+        ActiveRecord::Base.transaction do
+          adapter_connection.send('select_all', 'testing') # master s=0 m=1
+          adapter_connection.send('update', 'testing')     # master s=0 m=1
+          adapter_connection.send('select_all', 'testing') # master s=0 m=1
+        end
+
+        adapter_connection.send('select_all', 'testing') # master s=0 m=2
+        adapter_connection.send('update', 'testing')     # master s=0 m=3
+        adapter_connection.send('select_all', 'testing') # master s=0 m=3
+      end
+
+      new_clock.should > old_clock
+    end
+
+    context "with nested with_consistency" do
+      it "should return the same clock if not writing and no lag" do
+        slave_should_report_clock(0) # note: tests memoizing slave clock
+        slave_connection.
+          should_receive('select_one').exactly(3).times.with('testing').
+          and_return(true)
+
+        old_clock = zero
+        new_clock = ActiveRecord::Base.with_consistency(old_clock) do
+          adapter_connection.send('select_one', 'testing')
+          ActiveRecord::Base.with_consistency(old_clock) do
+            adapter_connection.send('select_one', 'testing')
+          end
+          adapter_connection.send('select_one', 'testing')
+        end
+        new_clock.should equal(old_clock)
+      end
+
+      it "requesting a newer clock should return a new clock" do
+        adapter_connection.
+          should_receive('slave_consistent?').exactly(2).times.
+          and_return(true, false)
+        slave_connection.
+          should_receive('select_all').exactly(2).times.with('testing').
+          and_return(true)
+        master_connection.
+          should_receive('select_all').exactly(1).times.with('testing').
+          and_return(true)
+
+        start_clock = zero
+        inner_clock = zero
+        outer_clock = ActiveRecord::Base.with_consistency(start_clock) do
+          adapter_connection.send('select_all', 'testing') # slave
+          inner_clock = ActiveRecord::Base.with_consistency(master_position(1)) do
+            adapter_connection.send('select_all', 'testing') # master
+          end
+          adapter_connection.send('select_all', 'testing') # slave
+        end
+
+        start_clock.should equal(outer_clock)
+        inner_clock.should > start_clock
+      end
+    end
+
+    it "should do the right thing when nested inside with_master" do
+      slave_should_report_clock(0)
+      slave_connection.should_receive('select_all').exactly(1).times.with('testing').and_return(true)
+      master_connection.should_receive('select_all').exactly(2).times.with('testing').and_return(true)
+      ActiveRecord::Base.with_master do
+        adapter_connection.send('select_all', 'testing') # master
+        ActiveRecord::Base.with_consistency(zero) do
+          adapter_connection.send('select_all', 'testing') # slave
+        end
+        adapter_connection.send('select_all', 'testing') # master
+      end
+    end
+
+    it "should do the right thing when nested inside with_slave" do
+      slave_should_report_clock(0)
+      slave_connection.should_receive('select_all').exactly(3).times.with('testing').and_return(true)
+      ActiveRecord::Base.with_slave do
+        adapter_connection.send('select_all', 'testing') # slave
+        ActiveRecord::Base.with_consistency(zero) do
+          adapter_connection.send('select_all', 'testing') # slave
+        end
+        adapter_connection.send('select_all', 'testing') # slave
+      end
+    end
+
+    it "should do the right thing when wrapping with_master" do
+      slave_should_report_clock(0)
+      slave_connection.should_receive('select_all').exactly(2).times.with('testing').and_return(true)
+      master_connection.should_receive('select_all').exactly(1).times.with('testing').and_return(true)
+      ActiveRecord::Base.with_consistency(zero) do
+        adapter_connection.send('select_all', 'testing') # slave
+        ActiveRecord::Base.with_master do
+          adapter_connection.send('select_all', 'testing') # master
+        end
+        adapter_connection.send('select_all', 'testing') # slave
+      end
+    end
+
+    it "should do the right thing when wrapping with_slave" do
+      slave_should_report_clock(0)
+      slave_connection.should_receive('select_all').exactly(1).times.with('testing').and_return(true)
+      master_connection.should_receive('select_all').exactly(2).times.with('testing').and_return(true)
+      ActiveRecord::Base.with_consistency(master_position(1)) do
+        adapter_connection.send('select_all', 'testing') # master
+        ActiveRecord::Base.with_slave do
+          adapter_connection.send('select_all', 'testing') # slave
+        end
+        adapter_connection.send('select_all', 'testing') # master
+      end
+    end
+  end # /with_consistency
+end

metadata

@@ -1,19 +1,21 @@
 --- !ruby/object:Gem::Specification
 name: master_slave_adapter
 version: !ruby/object:Gem::Version
-  version: 0.2.0
-  prerelease: 
+  version: 1.0.0.beta1
+  prerelease: 6
 platform: ruby
 authors:
 - Mauricio Linhares
 - Torsten Curdt
 - Kim Altintop
 - Omid Aladini
+- Tiago Loureiro
+- Tobias Schmidt
 - SoundCloud
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-21 00:00:00.000000000 Z
+date: 2012-05-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -63,8 +65,8 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 2.3.9
-description: (MySQL) Replication Aware Master/Slave Database Adapter for Rails/ActiveRecord
-email: kim@soundcloud.com tcurdt@soundcloud.com omid@soundcloud.com
+description: (MySQL) Replication Aware Master/Slave Database Adapter for ActiveRecord
+email: kim@soundcloud.com tcurdt@soundcloud.com ts@soundcloud
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -77,12 +79,16 @@ files:
 - Rakefile
 - Readme.md
 - TODO.txt
-- VERSION
 - lib/active_record/connection_adapters/master_slave_adapter.rb
+- lib/active_record/connection_adapters/master_slave_adapter/circuit_breaker.rb
+- lib/active_record/connection_adapters/master_slave_adapter/clock.rb
+- lib/active_record/connection_adapters/master_slave_adapter/version.rb
 - lib/active_record/connection_adapters/mysql_master_slave_adapter.rb
 - lib/master_slave_adapter.rb
 - master_slave_adapter.gemspec
+- spec/circuit_breaker_spec.rb
 - spec/master_slave_adapter_spec.rb
+- spec/mysql_master_slave_adapter_spec.rb
 homepage: http://github.com/soundcloud/master_slave_adapter
 licenses: []
 post_install_message: 
@@ -94,7 +100,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
-      version: 1.9.2
+      version: 1.8.7
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -106,6 +112,8 @@ rubyforge_project:
 rubygems_version: 1.8.21
 signing_key: 
 specification_version: 3
-summary: Replication Aware Master/Slave Database Adapter for Rails/ActiveRecord
+summary: Replication Aware Master/Slave Database Adapter for ActiveRecord
 test_files:
+- spec/circuit_breaker_spec.rb
 - spec/master_slave_adapter_spec.rb
+- spec/mysql_master_slave_adapter_spec.rb

data/VERSION

@@ -1 +0,0 @@
-0.2.0