module ActiveRecord::TestFixtures

Public Instance Methods

enlist_fixture_connections() click to toggle source
# File lib/active_record/test_fixtures.rb, line 179
def enlist_fixture_connections
  setup_shared_connection_pool

  ActiveRecord::Base.connection_handler.connection_pool_list.map(&:connection)
end
run_in_transaction?() click to toggle source
# File lib/active_record/test_fixtures.rb, line 98
def run_in_transaction?
  use_transactional_tests &&
    !self.class.uses_transaction?(method_name)
end
setup_fixtures(config = ActiveRecord::Base) click to toggle source
# File lib/active_record/test_fixtures.rb, line 103
def setup_fixtures(config = ActiveRecord::Base)
  if pre_loaded_fixtures && !use_transactional_tests
    raise RuntimeError, "pre_loaded_fixtures requires use_transactional_tests"
  end

  @fixture_cache = {}
  @fixture_connections = []
  @@already_loaded_fixtures ||= {}
  @connection_subscriber = nil

  # Load fixtures once and begin transaction.
  if run_in_transaction?
    @saved_pool_configs = Hash.new { |hash, key| hash[key] = {} }

    if @@already_loaded_fixtures[self.class]
      @loaded_fixtures = @@already_loaded_fixtures[self.class]
    else
      @loaded_fixtures = load_fixtures(config)
      @@already_loaded_fixtures[self.class] = @loaded_fixtures
    end

    # Begin transactions for connections already established
    @fixture_connections = enlist_fixture_connections
    @fixture_connections.each do |connection|
      connection.begin_transaction joinable: false, _lazy: false
      connection.pool.lock_thread = true if lock_threads
    end

    # When connections are established in the future, begin a transaction too
    @connection_subscriber = ActiveSupport::Notifications.subscribe("!connection.active_record") do |_, _, _, _, payload|
      spec_name = payload[:spec_name] if payload.key?(:spec_name)
      setup_shared_connection_pool

      if spec_name
        begin
          connection = ActiveRecord::Base.connection_handler.retrieve_connection(spec_name)
        rescue ConnectionNotEstablished
          connection = nil
        end

        if connection && !@fixture_connections.include?(connection)
          connection.begin_transaction joinable: false, _lazy: false
          connection.pool.lock_thread = true if lock_threads
          @fixture_connections << connection
        end
      end
    end

  # Load fixtures for every test.
  else
    ActiveRecord::FixtureSet.reset_cache
    @@already_loaded_fixtures[self.class] = nil
    @loaded_fixtures = load_fixtures(config)
  end

  # Instantiate fixtures for every test if requested.
  instantiate_fixtures if use_instantiated_fixtures
end
teardown_fixtures() click to toggle source
# File lib/active_record/test_fixtures.rb, line 162
def teardown_fixtures
  # Rollback changes if a transaction is active.
  if run_in_transaction?
    ActiveSupport::Notifications.unsubscribe(@connection_subscriber) if @connection_subscriber
    @fixture_connections.each do |connection|
      connection.rollback_transaction if connection.transaction_open?
      connection.pool.lock_thread = false
    end
    @fixture_connections.clear
    teardown_shared_connection_pool
  else
    ActiveRecord::FixtureSet.reset_cache
  end

  ActiveRecord::Base.clear_active_connections!
end

Private Instance Methods

instantiate_fixtures() click to toggle source
# File lib/active_record/test_fixtures.rb, line 227
def instantiate_fixtures
  if pre_loaded_fixtures
    raise RuntimeError, "Load fixtures before instantiating them." if ActiveRecord::FixtureSet.all_loaded_fixtures.empty?
    ActiveRecord::FixtureSet.instantiate_all_loaded_fixtures(self, load_instances?)
  else
    raise RuntimeError, "Load fixtures before instantiating them." if @loaded_fixtures.nil?
    @loaded_fixtures.each_value do |fixture_set|
      ActiveRecord::FixtureSet.instantiate_fixtures(self, fixture_set, load_instances?)
    end
  end
end
load_fixtures(config) click to toggle source
# File lib/active_record/test_fixtures.rb, line 222
def load_fixtures(config)
  fixtures = ActiveRecord::FixtureSet.create_fixtures(fixture_path, fixture_table_names, fixture_class_names, config)
  Hash[fixtures.map { |f| [f.name, f] }]
end
load_instances?() click to toggle source
# File lib/active_record/test_fixtures.rb, line 239
def load_instances?
  use_instantiated_fixtures != :no_instances
end
setup_shared_connection_pool() click to toggle source

Shares the writing connection pool with connections on other handlers.

In an application with a primary and replica the test fixtures need to share a connection pool so that the reading connection can see data in the open transaction on the writing connection.

# File lib/active_record/test_fixtures.rb, line 192
def setup_shared_connection_pool
  writing_handler = ActiveRecord::Base.connection_handlers[ActiveRecord::Base.writing_role]

  ActiveRecord::Base.connection_handlers.values.each do |handler|
    if handler != writing_handler
      handler.connection_pool_list.each do |pool|
        name = pool.spec.name
        writing_connection = writing_handler.retrieve_connection_pool(name)
        return unless writing_connection

        reading_connection = handler.send(:owner_to_pool)[name]
        next if reading_connection == writing_connection

        @saved_pool_configs[handler][name] = reading_connection
        handler.send(:owner_to_pool)[name] = writing_connection
      end
    end
  end
end
teardown_shared_connection_pool() click to toggle source
# File lib/active_record/test_fixtures.rb, line 212
def teardown_shared_connection_pool
  @saved_pool_configs.each_pair do |handler, pools|
    pools.each_pair do |name, pool|
      handler.send(:owner_to_pool)[name] = pool
    end
  end

  @saved_pool_configs.clear
end