ros-apartment 2.4.0 → 2.5.0

data/spec/examples/connection_adapter_examples.rb

@@ -1,44 +0,0 @@
-# frozen_string_literal: true
-
-require 'spec_helper'
-
-shared_examples_for 'a connection based apartment adapter' do
-  include Apartment::Spec::AdapterRequirements
-
-  let(:default_tenant) { subject.switch { ActiveRecord::Base.connection.current_database } }
-
-  describe '#init' do
-    after do
-      # Apartment::Tenant.init creates per model connection.
-      # Remove the connection after testing not to unintentionally keep the connection across tests.
-      Apartment.excluded_models.each do |excluded_model|
-        excluded_model.constantize.remove_connection
-      end
-    end
-
-    it 'should process model exclusions' do
-      Apartment.configure do |config|
-        config.excluded_models = ['Company']
-      end
-      Apartment::Tenant.init
-
-      expect(Company.connection.object_id).not_to eq(ActiveRecord::Base.connection.object_id)
-    end
-  end
-
-  describe '#drop' do
-    it 'should raise an error for unknown database' do
-      expect do
-        subject.drop 'unknown_database'
-      end.to raise_error(Apartment::TenantNotFound)
-    end
-  end
-
-  describe '#switch!' do
-    it 'should raise an error if database is invalid' do
-      expect do
-        subject.switch! 'unknown_database'
-      end.to raise_error(Apartment::TenantNotFound)
-    end
-  end
-end

data/spec/examples/generic_adapter_custom_configuration_example.rb

@@ -1,93 +0,0 @@
-# frozen_string_literal: true
-
-require 'spec_helper'
-
-shared_examples_for 'a generic apartment adapter able to handle custom configuration' do
-  let(:custom_tenant_name) { 'test_tenantwwww' }
-  let(:db) { |example| example.metadata[:database] }
-  let(:custom_tenant_names) do
-    {
-      custom_tenant_name => custom_db_conf
-    }
-  end
-
-  before do
-    Apartment.tenant_names = custom_tenant_names
-    Apartment.with_multi_server_setup = true
-  end
-
-  after do
-    Apartment.with_multi_server_setup = false
-  end
-
-  context 'database key taken from specific config' do
-    let(:expected_args) { custom_db_conf }
-
-    describe '#create' do
-      it 'should establish_connection with the separate connection with expected args' do
-        expect(Apartment::Adapters::AbstractAdapter::SeparateDbConnectionHandler).to receive(:establish_connection).with(expected_args).and_call_original
-
-        # because we dont have another server to connect to it errors
-        # what matters is establish_connection receives proper args
-        expect { subject.create(custom_tenant_name) }.to raise_error(Apartment::TenantExists)
-      end
-    end
-
-    describe '#drop' do
-      it 'should establish_connection with the separate connection with expected args' do
-        expect(Apartment::Adapters::AbstractAdapter::SeparateDbConnectionHandler).to receive(:establish_connection).with(expected_args).and_call_original
-
-        # because we dont have another server to connect to it errors
-        # what matters is establish_connection receives proper args
-        expect { subject.drop(custom_tenant_name) }.to raise_error(Apartment::TenantNotFound)
-      end
-    end
-  end
-
-  context 'database key from tenant name' do
-    let(:expected_args) do
-      custom_db_conf.tap { |args| args.delete(:database) }
-    end
-
-    describe '#switch!' do
-      it 'should connect to new db' do
-        expect(Apartment).to receive(:establish_connection) do |args|
-          db_name = args.delete(:database)
-
-          expect(args).to eq expected_args
-          expect(db_name).to match custom_tenant_name
-
-          # we only need to check args, then we short circuit
-          # in order to avoid the mess due to the `establish_connection` override
-          raise ActiveRecord::ActiveRecordError
-        end
-
-        expect { subject.switch!(custom_tenant_name) }.to raise_error(Apartment::TenantNotFound)
-      end
-    end
-  end
-
-  def specific_connection
-    {
-      postgresql: {
-        adapter: 'postgresql',
-        database: 'override_database',
-        password: 'override_password',
-        username: 'overridepostgres'
-      },
-      mysql: {
-        adapter: 'mysql2',
-        database: 'override_database',
-        username: 'root'
-      },
-      sqlite: {
-        adapter: 'sqlite3',
-        database: 'override_database'
-      }
-    }
-  end
-
-  def custom_db_conf
-    specific_connection[db.to_sym].with_indifferent_access
-  end
-end

data/spec/examples/generic_adapter_examples.rb

@@ -1,164 +0,0 @@
-# frozen_string_literal: true
-
-require 'spec_helper'
-
-shared_examples_for 'a generic apartment adapter' do
-  include Apartment::Spec::AdapterRequirements
-
-  before do
-    Apartment.prepend_environment = false
-    Apartment.append_environment = false
-  end
-
-  describe '#init' do
-    it 'should not retain a connection after railtie' do
-      # this test should work on rails >= 4, the connection pool code is
-      # completely different for 3.2 so we'd have to have a messy conditional..
-      unless Rails::VERSION::MAJOR < 4
-        ActiveRecord::Base.connection_pool.disconnect!
-
-        Apartment::Railtie.config.to_prepare_blocks.map(&:call)
-
-        num_available_connections = Apartment.connection_class.connection_pool
-                                             .instance_variable_get(:@available)
-                                             .instance_variable_get(:@queue)
-                                             .size
-
-        expect(num_available_connections).to eq(1)
-      end
-    end
-  end
-
-  #
-  #   Creates happen already in our before_filter
-  #
-  describe '#create' do
-    it 'should create the new databases' do
-      expect(tenant_names).to include(db1)
-      expect(tenant_names).to include(db2)
-    end
-
-    it 'should load schema.rb to new schema' do
-      subject.switch(db1) do
-        expect(connection.tables).to include('companies')
-      end
-    end
-
-    it 'should yield to block if passed and reset' do
-      subject.drop(db2) # so we don't get errors on creation
-
-      @count = 0 # set our variable so its visible in and outside of blocks
-
-      subject.create(db2) do
-        @count = User.count
-        expect(subject.current).to eq(db2)
-        User.create
-      end
-
-      expect(subject.current).not_to eq(db2)
-
-      subject.switch(db2) { expect(User.count).to eq(@count + 1) }
-    end
-
-    it 'should raise error when the schema.rb is missing unless Apartment.use_sql is set to true' do
-      next if Apartment.use_sql
-
-      subject.drop(db1)
-      begin
-        Dir.mktmpdir do |tmpdir|
-          Apartment.database_schema_file = "#{tmpdir}/schema.rb"
-          expect do
-            subject.create(db1)
-          end.to raise_error(Apartment::FileNotFound)
-        end
-      ensure
-        Apartment.remove_instance_variable(:@database_schema_file)
-      end
-    end
-  end
-
-  describe '#drop' do
-    it 'should remove the db' do
-      subject.drop db1
-      expect(tenant_names).not_to include(db1)
-    end
-  end
-
-  describe '#switch!' do
-    it 'should connect to new db' do
-      subject.switch!(db1)
-      expect(subject.current).to eq(db1)
-    end
-
-    it 'should reset connection if database is nil' do
-      subject.switch!
-      expect(subject.current).to eq(default_tenant)
-    end
-
-    it 'should raise an error if database is invalid' do
-      expect do
-        subject.switch! 'unknown_database'
-      end.to raise_error(Apartment::ApartmentError)
-    end
-  end
-
-  describe '#switch' do
-    it 'connects and resets the tenant' do
-      subject.switch(db1) do
-        expect(subject.current).to eq(db1)
-      end
-      expect(subject.current).to eq(default_tenant)
-    end
-
-    # We're often finding when using Apartment in tests, the `current` (ie the previously connect to db)
-    # gets dropped, but switch will try to return to that db in a test.  We should just reset if it doesn't exist
-    it 'should not throw exception if current is no longer accessible' do
-      subject.switch!(db2)
-
-      expect do
-        subject.switch(db1) { subject.drop(db2) }
-      end.to_not raise_error
-    end
-  end
-
-  describe '#reset' do
-    it 'should reset connection' do
-      subject.switch!(db1)
-      subject.reset
-      expect(subject.current).to eq(default_tenant)
-    end
-  end
-
-  describe '#current' do
-    it 'should return the current db name' do
-      subject.switch!(db1)
-      expect(subject.current).to eq(db1)
-    end
-  end
-
-  describe '#each' do
-    it 'iterates over each tenant by default' do
-      result = []
-      Apartment.tenant_names = [db2, db1]
-
-      subject.each do |tenant|
-        result << tenant
-        expect(subject.current).to eq(tenant)
-      end
-
-      expect(result).to eq([db2, db1])
-    end
-
-    it 'iterates over the given tenants' do
-      result = []
-      Apartment.tenant_names = [db2]
-
-      subject.each([db2]) do |tenant|
-        result << tenant
-        expect(subject.current).to eq(tenant)
-      end
-
-      expect(result).to eq([db2])
-    end
-  end
-end

data/spec/examples/schema_adapter_examples.rb

@@ -1,239 +0,0 @@
-# frozen_string_literal: true
-
-require 'spec_helper'
-
-# rubocop:disable Metrics/BlockLength
-shared_examples_for 'a schema based apartment adapter' do
-  include Apartment::Spec::AdapterRequirements
-
-  let(:schema1) { db1 }
-  let(:schema2) { db2 }
-  let(:public_schema) { default_tenant }
-
-  describe '#init' do
-    before do
-      Apartment.configure do |config|
-        config.excluded_models = ['Company']
-      end
-    end
-
-    after do
-      # Apartment::Tenant.init creates per model connection.
-      # Remove the connection after testing not to unintentionally keep the connection across tests.
-      Apartment.excluded_models.each do |excluded_model|
-        excluded_model.constantize.remove_connection
-      end
-    end
-
-    it 'should process model exclusions' do
-      Apartment::Tenant.init
-
-      expect(Company.table_name).to eq('public.companies')
-    end
-
-    context 'with a default_schema', default_schema: true do
-      it 'should set the proper table_name on excluded_models' do
-        Apartment::Tenant.init
-
-        expect(Company.table_name).to eq("#{default_schema}.companies")
-      end
-
-      it 'sets the search_path correctly' do
-        Apartment::Tenant.init
-
-        expect(User.connection.schema_search_path).to match(/|#{default_schema}|/)
-      end
-    end
-
-    context 'persistent_schemas', persistent_schemas: true do
-      it 'sets the persistent schemas in the schema_search_path' do
-        Apartment::Tenant.init
-        expect(connection.schema_search_path).to end_with persistent_schemas.map { |schema| %("#{schema}") }.join(', ')
-      end
-    end
-  end
-
-  #
-  #   Creates happen already in our before_filter
-  #
-  describe '#create' do
-    it 'should load schema.rb to new schema' do
-      connection.schema_search_path = schema1
-      expect(connection.tables).to include('companies')
-    end
-
-    it 'should yield to block if passed and reset' do
-      subject.drop(schema2) # so we don't get errors on creation
-
-      @count = 0 # set our variable so its visible in and outside of blocks
-
-      subject.create(schema2) do
-        @count = User.count
-        expect(connection.schema_search_path).to start_with %("#{schema2}")
-        User.create
-      end
-
-      expect(connection.schema_search_path).not_to start_with %("#{schema2}")
-
-      subject.switch(schema2) { expect(User.count).to eq(@count + 1) }
-    end
-
-    context 'numeric database names' do
-      let(:db) { 1234 }
-      it 'should allow them' do
-        expect do
-          subject.create(db)
-        end.to_not raise_error
-        expect(tenant_names).to include(db.to_s)
-      end
-
-      after { subject.drop(db) }
-    end
-  end
-
-  describe '#drop' do
-    it 'should raise an error for unknown database' do
-      expect do
-        subject.drop 'unknown_database'
-      end.to raise_error(Apartment::TenantNotFound)
-    end
-
-    context 'numeric database names' do
-      let(:db) { 1234 }
-
-      it 'should be able to drop them' do
-        subject.create(db)
-        expect do
-          subject.drop(db)
-        end.to_not raise_error
-        expect(tenant_names).not_to include(db.to_s)
-      end
-
-      after do
-        begin
-          subject.drop(db)
-        rescue StandardError => _e
-          nil
-        end
-      end
-    end
-  end
-
-  describe '#switch' do
-    it 'connects and resets' do
-      subject.switch(schema1) do
-        expect(connection.schema_search_path).to start_with %("#{schema1}")
-      end
-
-      expect(connection.schema_search_path).to start_with %("#{public_schema}")
-    end
-  end
-
-  describe '#reset' do
-    it 'should reset connection' do
-      subject.switch!(schema1)
-      subject.reset
-      expect(connection.schema_search_path).to start_with %("#{public_schema}")
-    end
-
-    context 'with default_schema', default_schema: true do
-      it 'should reset to the default schema' do
-        subject.switch!(schema1)
-        subject.reset
-        expect(connection.schema_search_path).to start_with %("#{default_schema}")
-      end
-    end
-
-    context 'persistent_schemas', persistent_schemas: true do
-      before do
-        subject.switch!(schema1)
-        subject.reset
-      end
-
-      it 'maintains the persistent schemas in the schema_search_path' do
-        expect(connection.schema_search_path).to end_with persistent_schemas.map { |schema| %("#{schema}") }.join(', ')
-      end
-
-      context 'with default_schema', default_schema: true do
-        it 'prioritizes the switched schema to front of schema_search_path' do
-          subject.reset # need to re-call this as the default_schema wasn't set at the time that the above reset ran
-          expect(connection.schema_search_path).to start_with %("#{default_schema}")
-        end
-      end
-    end
-  end
-
-  describe '#switch!' do
-    it 'should connect to new schema' do
-      subject.switch!(schema1)
-      expect(connection.schema_search_path).to start_with %("#{schema1}")
-    end
-
-    it 'should reset connection if database is nil' do
-      subject.switch!
-      expect(connection.schema_search_path).to eq(%("#{public_schema}"))
-    end
-
-    it 'should raise an error if schema is invalid' do
-      expect do
-        subject.switch! 'unknown_schema'
-      end.to raise_error(Apartment::TenantNotFound)
-    end
-
-    context 'numeric databases' do
-      let(:db) { 1234 }
-
-      it 'should connect to them' do
-        subject.create(db)
-        expect do
-          subject.switch!(db)
-        end.to_not raise_error
-
-        expect(connection.schema_search_path).to start_with %("#{db}")
-      end
-
-      after { subject.drop(db) }
-    end
-
-    describe 'with default_schema specified', default_schema: true do
-      before do
-        subject.switch!(schema1)
-      end
-
-      it 'should switch out the default schema rather than public' do
-        expect(connection.schema_search_path).not_to include default_schema
-      end
-
-      it 'should still switch to the switched schema' do
-        expect(connection.schema_search_path).to start_with %("#{schema1}")
-      end
-    end
-
-    context 'persistent_schemas', persistent_schemas: true do
-      before { subject.switch!(schema1) }
-
-      it 'maintains the persistent schemas in the schema_search_path' do
-        expect(connection.schema_search_path).to end_with persistent_schemas.map { |schema| %("#{schema}") }.join(', ')
-      end
-
-      it 'prioritizes the switched schema to front of schema_search_path' do
-        expect(connection.schema_search_path).to start_with %("#{schema1}")
-      end
-    end
-  end
-
-  describe '#current' do
-    it 'should return the current schema name' do
-      subject.switch!(schema1)
-      expect(subject.current).to eq(schema1)
-    end
-
-    context 'persistent_schemas', persistent_schemas: true do
-      it 'should exlude persistent_schemas' do
-        subject.switch!(schema1)
-        expect(subject.current).to eq(schema1)
-      end
-    end
-  end
-end
-# rubocop:enable Metrics/BlockLength

data/spec/integration/apartment_rake_integration_spec.rb

@@ -1,107 +0,0 @@
-# frozen_string_literal: true
-
-require 'spec_helper'
-require 'rake'
-
-describe 'apartment rake tasks', database: :postgresql do
-  before do
-    @rake = Rake::Application.new
-    Rake.application = @rake
-    Dummy::Application.load_tasks
-
-    # rails tasks running F up the schema...
-    Rake::Task.define_task('db:migrate')
-    Rake::Task.define_task('db:seed')
-    Rake::Task.define_task('db:rollback')
-    Rake::Task.define_task('db:migrate:up')
-    Rake::Task.define_task('db:migrate:down')
-    Rake::Task.define_task('db:migrate:redo')
-
-    Apartment.configure do |config|
-      config.use_schemas = true
-      config.excluded_models = ['Company']
-      config.tenant_names = -> { Company.pluck(:database) }
-    end
-    Apartment::Tenant.reload!(config)
-
-    # fix up table name of shared/excluded models
-    Company.table_name = 'public.companies'
-  end
-
-  after { Rake.application = nil }
-
-  context 'with x number of databases' do
-    let(:x) { rand(1..5) } # random number of dbs to create
-    let(:db_names) { x.times.map { Apartment::Test.next_db } }
-    let!(:company_count) { db_names.length }
-
-    before do
-      db_names.collect do |db_name|
-        Apartment::Tenant.create(db_name)
-        Company.create database: db_name
-      end
-    end
-
-    after do
-      db_names.each { |db| Apartment::Tenant.drop(db) }
-      Company.delete_all
-    end
-
-    context 'with ActiveRecord below 5.2.0' do
-      before do
-        allow(ActiveRecord::Migrator).to receive(:migrations_paths) { %w[spec/dummy/db/migrate] }
-        allow(Apartment::Migrator).to receive(:activerecord_below_5_2?) { true }
-      end
-
-      describe '#migrate' do
-        it 'should migrate all databases' do
-          expect(ActiveRecord::Migrator).to receive(:migrate).exactly(company_count).times
-
-          @rake['apartment:migrate'].invoke
-        end
-      end
-
-      describe '#rollback' do
-        it 'should rollback all dbs' do
-          expect(ActiveRecord::Migrator).to receive(:rollback).exactly(company_count).times
-
-          @rake['apartment:rollback'].invoke
-        end
-      end
-    end
-
-    context 'with ActiveRecord above or equal to 5.2.0' do
-      let(:migration_context_double) { double(:migration_context) }
-
-      before do
-        allow(Apartment::Migrator).to receive(:activerecord_below_5_2?) { false }
-      end
-
-      describe '#migrate' do
-        it 'should migrate all databases' do
-          allow(ActiveRecord::Base.connection).to receive(:migration_context) { migration_context_double }
-          expect(migration_context_double).to receive(:migrate).exactly(company_count).times
-
-          @rake['apartment:migrate'].invoke
-        end
-      end
-
-      describe '#rollback' do
-        it 'should rollback all dbs' do
-          allow(ActiveRecord::Base.connection).to receive(:migration_context) { migration_context_double }
-          expect(migration_context_double).to receive(:rollback).exactly(company_count).times
-
-          @rake['apartment:rollback'].invoke
-        end
-      end
-    end
-
-    describe 'apartment:seed' do
-      it 'should seed all databases' do
-        expect(Apartment::Tenant).to receive(:seed).exactly(company_count).times
-
-        @rake['apartment:seed'].invoke
-      end
-    end
-  end
-end