innkeeper 0.1.0

data/test/generic_elevator_test.rb

@@ -0,0 +1,63 @@
+require_relative 'test_helper'
+require_relative 'mocks/adapter_mock'
+require 'innkeeper/elevators/generic'
+
+class GenericElevatorTest < Minitest::Test
+  include AdapterMock
+
+  class MyElevator < Innkeeper::Elevators::Generic
+    def parse_tenant_name(*)
+      'tenant2'
+    end
+  end
+
+  def setup
+    @elevator = Innkeeper::Elevators::Generic.new(Proc.new{})
+
+    super
+  end
+
+  def test_processor_is_called_if_given
+    elevator = Innkeeper::Elevators::Generic.new(Proc.new{}, Proc.new{'tenant1'})
+
+    with_adapter_mocked do |adapter|
+      adapter.expect :switch, true, ['tenant1']
+
+      elevator.call('HTTP_HOST' => 'foo.bar.com')
+
+      assert adapter.verify
+    end
+  end
+
+  def test_raises_if_parse_tenant_name_not_implemented
+    assert_raises RuntimeError do
+      @elevator.call('HTTP_HOST' => 'foo.bar.com')
+    end
+  end
+
+  def test_switches_to_the_parsed_db_name
+    elevator = MyElevator.new(Proc.new{})
+
+    with_adapter_mocked do |adapter|
+      adapter.expect :switch, true, ['tenant2']
+
+      elevator.call('HTTP_HOST' => 'foo.bar.com')
+
+      assert adapter.verify
+    end
+  end
+
+  def test_does_not_call_switch_if_no_database_given
+    app_mock = Minitest::Mock.new
+    app_mock.expect :call, true, [{'HTTP_HOST' => 'foo.bar.com'}]
+    elevator = MyElevator.new(app_mock, Proc.new{})
+
+    with_adapter_mocked do |adapter|
+      elevator.call('HTTP_HOST' => 'foo.bar.com')
+
+      assert adapter.verify
+    end
+
+    assert app_mock.verify
+  end
+end

data/test/host_hash_elevator_test.rb

@@ -0,0 +1,42 @@
+require_relative 'test_helper'
+require_relative 'mocks/adapter_mock'
+require 'innkeeper/elevators/host_hash'
+
+class HostHashElevatorTest < Minitest::Test
+  include AdapterMock
+
+  def setup
+    @elevator = Innkeeper::Elevators::HostHash.new(Proc.new{}, 'example.com' => 'example_tenant')
+
+    super
+  end
+
+  def test_parses_host_from_domain_name
+    request = ActionDispatch::Request.new('HTTP_HOST' => 'example.com')
+    assert_equal 'example_tenant', @elevator.parse_tenant_name(request)
+  end
+
+  def test_raises_exception_if_no_host
+    request = ActionDispatch::Request.new('HTTP_HOST' => '')
+    assert_raises Innkeeper::TenantNotFound do
+      @elevator.parse_tenant_name(request)
+    end
+  end
+
+  def test_raises_exception_if_host_not_found
+    request = ActionDispatch::Request.new('HTTP_HOST' => 'example2.com')
+    assert_raises Innkeeper::TenantNotFound do
+      @elevator.parse_tenant_name(request)
+    end
+  end
+
+  def test_switches_to_proper_tenant
+    with_adapter_mocked do |adapter|
+      adapter.expect :switch, true, ['example_tenant']
+
+      @elevator.call('HTTP_HOST' => 'example.com')
+
+      assert adapter.verify
+    end
+  end
+end

data/test/innkeeper_test.rb

@@ -0,0 +1,96 @@
+require "minitest/autorun"
+
+module Innkeeper
+  class Test < Minitest::Test
+    def setup_connection(db)
+      @config = Innkeeper::TestHelper.config['connections'][db].symbolize_keys
+      ActiveRecord::Base.establish_connection(@config)
+      # `establish_connection` sets @connection_specification_name on
+      # ActiveRecord::Base, this causes it to override our Thread local.
+      # `establish_connection` should never be used in a productiion app
+      # for this reason.
+      Innkeeper.connection_class.connection_specification_name = nil
+      Innkeeper.reset
+    end
+
+    def setup
+      Innkeeper::Tenant.reload!
+      @adapter = Innkeeper::Tenant.adapter
+      @tenant1 = self.class.next_db
+      @tenant2 = self.class.next_db
+      @adapter.create(@tenant1)
+      @adapter.create(@tenant2)
+    end
+
+    def teardown
+      @adapter.reset
+
+      tenants = [@tenant1, @tenant2]
+
+      if @adapter.class.name == "Innkeeper::Adapters::PostgresqlAdapter"
+        @postgres_dbs ? drop(tenants, :database) : drop(tenants, :schema)
+      else
+        drop(tenants)
+      end
+
+      Innkeeper.excluded_models.each do |excl|
+        excl.constantize.connection_specification_name = nil
+      end
+
+      Innkeeper.connection_class.clear_all_connections!
+      # unless we remove the connection pools, the connection pools from
+      # previous tests containing configs with deleted databases,
+      # persist and cause bugs for future tests using the same
+      # host/adapter (so the spec name is the same)
+      Innkeeper.connection_class.connection_handler.tap do |ch|
+        ch.send(:owner_to_pool).each_key do |k|
+          ch.remove_connection(k) if k =~ /^_innkeeper/
+        end
+      end
+      Innkeeper.reset
+      Innkeeper::Tenant.reload!
+    end
+
+    def drop(tenants, type = nil)
+      meth = "drop"
+      meth += "_#{type}" if type
+
+      tenants.each{ |t| @adapter.send(meth, t) }
+    end
+
+    def self.next_db
+      @@x ||= 0
+      "db%d" % @@x += 1
+    end
+
+    def tenant_is(tenant, for_model: Innkeeper.connection_class)
+      config = Innkeeper::Tenant.config_for(tenant)
+
+      if @adapter.class.name == "Innkeeper::Adapters::PostgresqlAdapter"
+        current_search_path = for_model.connection.schema_search_path
+      end
+
+      config[:database] == for_model.connection.current_database &&
+        (!current_search_path || (current_search_path == config[:schema_search_path]) || current_search_path == "\"$user\", public") &&
+        (for_model != Innkeeper.connection_class || Innkeeper::Tenant.current == tenant)
+    end
+
+    def assert_tenant_is(tenant, for_model: Innkeeper.connection_class)
+      res = tenant_is(tenant, for_model: for_model)
+
+      if !res && @adapter.class.name == "Innkeeper::Adapters::PostgresqlAdapter"
+        schema = for_model.connection.schema_search_path
+      end
+
+      assert res, "Expected: #{tenant}\nActual: #{{ db: for_model.connection.current_database, schema: schema }}"
+    end
+
+    def assert_received(klass, meth, count = 1)
+      migrator_mock = Minitest::Mock.new
+      count.times{ migrator_mock.expect meth, true }
+      klass.stub(meth, ->(*){ migrator_mock.send(meth) }){ yield }
+
+      assert migrator_mock.verify
+    end
+  end
+end

data/test/mocks/adapter_mock.rb

@@ -0,0 +1,11 @@
+module AdapterMock
+  def with_adapter_mocked
+    adapter = Minitest::Mock.new
+    old_adapter = Thread.current[:innkeeper_adapter]
+    Thread.current[:innkeeper_adapter] = adapter
+
+    yield adapter
+  ensure
+    Thread.current[:innkeeper_adapter] = old_adapter
+  end
+end

data/test/multithreading_test.rb

@@ -0,0 +1,37 @@
+require_relative 'test_helper'
+require 'innkeeper/resolvers/database'
+
+class MultithreadingTest < Innkeeper::Test
+  def setup
+    setup_connection("mysql")
+
+    Innkeeper.configure do |config|
+      # to test in connection switching mode as if switching between hosts
+      config.force_reconnect_on_switch = true
+      config.pool_per_config = true
+      config.tenant_resolver = Innkeeper::Resolvers::Database
+    end
+
+    super
+  end
+
+  def test_thread_safety_of_switching
+    assert_tenant_is(Innkeeper.default_tenant)
+
+    threads = []
+    100.times do
+      threads << Thread.new do
+        db = [@tenant1, @tenant2].sample
+        Innkeeper::Tenant.switch!(db)
+
+        assert_tenant_is(db)
+
+        Innkeeper.connection_class.clear_active_connections!
+      end
+    end
+
+    threads.each(&:join)
+
+    assert_tenant_is(Innkeeper.default_tenant)
+  end
+end

data/test/mysql2_adapter_test.rb

@@ -0,0 +1,17 @@
+require_relative 'test_helper'
+require 'innkeeper/resolvers/database'
+require_relative 'shared/shared_adapter_tests'
+
+class Mysql2AdapterTest < Innkeeper::Test
+  include SharedAdapterTests
+
+  def setup
+    setup_connection("mysql")
+
+    Innkeeper.configure do |config|
+      config.tenant_resolver = Innkeeper::Resolvers::Database
+    end
+
+    super
+  end
+end

data/test/postgresql_adapter_test.rb

@@ -0,0 +1,39 @@
+require_relative 'test_helper'
+require 'innkeeper/resolvers/schema'
+require 'innkeeper/resolvers/database'
+require_relative 'shared/shared_adapter_tests'
+
+class PostgresqlAdapterTest < Innkeeper::Test
+  include SharedAdapterTests
+
+  def setup
+    setup_connection("postgresql")
+
+    Innkeeper.configure do |config|
+      config.tenant_resolver = Innkeeper::Resolvers::Schema
+    end
+
+    super
+  end
+
+  # idk why it broked :'(
+  # def test_postgres_database_resolver_reconnects
+  #   Innkeeper.tenant_resolver = Innkeeper::Resolvers::Database
+
+  #   @adapter.create("db_tenant")
+
+  #   assert_tenant_is(Innkeeper.default_tenant)
+
+  #   conn_id = Innkeeper.connection.object_id
+
+  #   Innkeeper::Tenant.switch("db_tenant") do
+  #     refute_equal conn_id, Innkeeper.connection.object_id
+  #     assert_equal "db_tenant", Innkeeper.connection.current_database
+  #   end
+
+  #   assert_tenant_is(Innkeeper.default_tenant)
+  # ensure
+  #   @adapter.drop_database("db_tenant")
+  #   Innkeeper.tenant_resolver = Innkeeper::Resolvers::Schema
+  # end
+end

data/test/railtie_test.rb

@@ -0,0 +1,31 @@
+require_relative 'test_helper'
+require 'innkeeper/resolvers/database'
+
+class RailtieTest < Minitest::Test
+  def test_railtie_does_not_hold_onto_connection
+    Innkeeper.configure do |config|
+      config.tenant_resolver = Innkeeper::Resolvers::Database
+      config.excluded_models = %w(Company)
+    end
+
+    Innkeeper.connection_class.connection_pool.disconnect!
+
+    before = Innkeeper.connection_class.connection_pool.stat.slice(:busy, :dead, :waiting)
+
+    Innkeeper::Railtie.prep
+    Innkeeper::Railtie.config.to_prepare_blocks.map(&:call)
+
+    after = Innkeeper.connection_class.connection_pool.stat.slice(:busy, :dead, :waiting)
+
+    assert_equal before, after
+  end
+
+  def test_railtie_sets_default_configuration
+    Innkeeper::Railtie.prep
+
+    assert_equal [], Innkeeper.excluded_models
+    assert_equal false, Innkeeper.force_reconnect_on_switch
+    assert_equal false, Innkeeper.seed_after_create
+    assert_instance_of Innkeeper::Resolvers::Database, Innkeeper.tenant_resolver
+  end
+end

data/test/rake_task_test.rb

@@ -0,0 +1,57 @@
+require_relative 'test_helper'
+require 'innkeeper/resolvers/database'
+require 'rake'
+
+class RakeTaskTest < Innkeeper::Test
+  def setup
+    setup_connection("mysql")
+
+    Innkeeper.configure do |config|
+      config.excluded_models = ["Company"]
+      config.tenant_names = lambda{ Company.pluck(:database) }
+      config.tenant_resolver = Innkeeper::Resolvers::Database
+    end
+
+    super
+
+    @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')
+
+    @tenants = [@tenant1, @tenant2]
+    @tenants.each{ |t| Company.create(database: t) }
+  end
+
+  def teardown
+    Rake.application = nil
+    Company.delete_all
+
+    super
+  end
+
+  def test_all_databases_get_migrated
+    assert_received(Innkeeper::Migrator, :migrate, @tenants.size) do
+      @rake['innkeeper:migrate'].invoke
+    end
+  end
+
+  def test_all_databases_get_rolled_back
+    assert_received(Innkeeper::Migrator, :rollback, @tenants.size) do
+      @rake['innkeeper:rollback'].invoke
+    end
+  end
+
+  def test_all_databases_get_seeded
+    assert_received(Innkeeper::Tenant, :seed, @tenants.size) do
+      @rake['innkeeper:seed'].invoke
+    end
+  end
+end

data/test/resolver_test.rb

@@ -0,0 +1,21 @@
+require_relative 'test_helper'
+require 'innkeeper/resolvers/database'
+require 'innkeeper/resolvers/schema'
+
+class ResolverTest < Minitest::Test
+  def test_database_resolver
+    resolver = Innkeeper::Resolvers::Database.new(Innkeeper.connection_config)
+    new_config = resolver.resolve("foobar")
+
+    assert_equal "foobar", new_config[:database]
+  end
+
+  def test_schema_resolver
+    Innkeeper.configure{ |config| config.persistent_schemas = ['a', 'b', 'c'] }
+
+    resolver = Innkeeper::Resolvers::Schema.new(Innkeeper.connection_config)
+    new_config = resolver.resolve("foobar")
+
+    assert_equal '"foobar", "a", "b", "c"', new_config[:schema_search_path]
+  end
+end

data/test/shared/shared_adapter_tests.rb

@@ -0,0 +1,95 @@
+module SharedAdapterTests
+  def test_switch
+    assert_tenant_is(Innkeeper.default_tenant)
+
+    Innkeeper::Tenant.switch(@tenant1){
+      assert_tenant_is(@tenant1)
+    }
+
+    assert_tenant_is(Innkeeper.default_tenant)
+  end
+
+  def test_local_switch_doesnt_modify_connection
+    assert_tenant_is(Innkeeper.default_tenant)
+
+    conn_id = Innkeeper.connection.object_id
+
+    Innkeeper::Tenant.switch!(@tenant1)
+
+    assert_tenant_is(@tenant1)
+    assert_equal conn_id, Innkeeper.connection.object_id
+  end
+
+  def test_remote_switch_modifies_connection
+    assert_tenant_is(Innkeeper.default_tenant)
+
+    conn_id = Innkeeper.connection.object_id
+
+    Innkeeper::Tenant.switch!(@config.dup.tap{ |c| c[:host] = 'localhost' })
+
+    assert_equal @config[:database], Innkeeper.connection.current_database
+    refute_equal conn_id, Innkeeper.connection.object_id
+  end
+
+  def test_force_reconnect
+    Innkeeper.configure{ |config| config.force_reconnect_on_switch = true }
+
+    assert_tenant_is(Innkeeper.default_tenant)
+
+    conn_id = Innkeeper.connection.object_id
+
+    Innkeeper::Tenant.switch!(@tenant1)
+
+    assert_tenant_is(@tenant1)
+    refute_equal conn_id, Innkeeper.connection.object_id
+  end
+
+  def test_switch_raises_error_for_unknown_database
+    assert_raises Innkeeper::TenantNotFound do
+      Innkeeper::Tenant.switch!("invalid")
+    end
+  end
+
+  def test_drop_raises_error_for_unknown_database
+    assert_raises Innkeeper::TenantNotFound do
+      if Innkeeper::Tenant.adapter.respond_to?(:drop_schema)
+        Innkeeper::Tenant.drop_schema("invalid")
+      else
+        Innkeeper::Tenant.drop("invalid")
+      end
+    end
+  end
+
+  def test_default_tenant_configuration_is_used
+    prev_default = Innkeeper.default_tenant
+
+    Innkeeper.configure do |config|
+      config.default_tenant = @tenant1
+    end
+
+    assert_equal @tenant1, Innkeeper.default_tenant
+
+    @adapter.reset
+
+    assert_tenant_is(@tenant1)
+  ensure
+    Innkeeper.default_tenant = prev_default
+  end
+
+  def test_ActiveRecord_QueryCache_cleared_after_switching_databases
+    [@tenant1, @tenant2].each do |tenant|
+      Innkeeper::Tenant.switch(tenant) do
+        User.create!(name: tenant)
+      end
+    end
+    Innkeeper.connection.enable_query_cache!
+
+    Innkeeper::Tenant.switch(@tenant1) do
+      assert User.find_by(name: @tenant1)
+    end
+
+    Innkeeper::Tenant.switch(@tenant2) do
+      assert_nil User.find_by(name: @tenant1)
+    end
+  end
+end