ros-apartment 2.3.0.alpha1

data/spec/schemas/v1.rb

@@ -0,0 +1,16 @@
+# encoding: UTF-8
+# This file is auto-generated from the current state of the database. Instead
+# of editing this file, please use the migrations feature of Active Record to
+# incrementally modify your database, and then regenerate this schema definition.
+#
+# Note that this schema.rb definition is the authoritative source for your
+# database schema. If you need to create the application database on another
+# system, you should be using db:schema:load, not running all the migrations
+# from scratch. The latter is a flawed and unsustainable approach (the more migrations
+# you'll amass, the slower it'll run and the greater likelihood for issues).
+#
+# It's strongly recommended to check this file into your version control system.
+
+ActiveRecord::Schema.define(:version => 0) do
+
+end

data/spec/schemas/v2.rb

@@ -0,0 +1,43 @@
+# encoding: UTF-8
+# This file is auto-generated from the current state of the database. Instead
+# of editing this file, please use the migrations feature of Active Record to
+# incrementally modify your database, and then regenerate this schema definition.
+#
+# Note that this schema.rb definition is the authoritative source for your
+# database schema. If you need to create the application database on another
+# system, you should be using db:schema:load, not running all the migrations
+# from scratch. The latter is a flawed and unsustainable approach (the more migrations
+# you'll amass, the slower it'll run and the greater likelihood for issues).
+#
+# It's strongly recommended to check this file into your version control system.
+
+ActiveRecord::Schema.define(:version => 20110613152810) do
+
+  create_table "companies", :force => true do |t|
+    t.boolean "dummy"
+    t.string  "database"
+  end
+
+  create_table "delayed_jobs", :force => true do |t|
+    t.integer  "priority",   :default => 0
+    t.integer  "attempts",   :default => 0
+    t.text     "handler"
+    t.text     "last_error"
+    t.datetime "run_at"
+    t.datetime "locked_at"
+    t.datetime "failed_at"
+    t.string   "locked_by"
+    t.datetime "created_at"
+    t.datetime "updated_at"
+    t.string   "queue"
+  end
+
+  add_index "delayed_jobs", ["priority", "run_at"], :name => "delayed_jobs_priority"
+
+  create_table "users", :force => true do |t|
+    t.string   "name"
+    t.datetime "birthdate"
+    t.string   "sex"
+  end
+
+end

data/spec/schemas/v3.rb

@@ -0,0 +1,49 @@
+# encoding: UTF-8
+# This file is auto-generated from the current state of the database. Instead
+# of editing this file, please use the migrations feature of Active Record to
+# incrementally modify your database, and then regenerate this schema definition.
+#
+# Note that this schema.rb definition is the authoritative source for your
+# database schema. If you need to create the application database on another
+# system, you should be using db:schema:load, not running all the migrations
+# from scratch. The latter is a flawed and unsustainable approach (the more migrations
+# you'll amass, the slower it'll run and the greater likelihood for issues).
+#
+# It's strongly recommended to check this file into your version control system.
+
+ActiveRecord::Schema.define(:version => 20111202022214) do
+
+  create_table "books", :force => true do |t|
+    t.string   "name"
+    t.integer  "pages"
+    t.datetime "published"
+  end
+
+  create_table "companies", :force => true do |t|
+    t.boolean "dummy"
+    t.string  "database"
+  end
+
+  create_table "delayed_jobs", :force => true do |t|
+    t.integer  "priority",   :default => 0
+    t.integer  "attempts",   :default => 0
+    t.text     "handler"
+    t.text     "last_error"
+    t.datetime "run_at"
+    t.datetime "locked_at"
+    t.datetime "failed_at"
+    t.string   "locked_by"
+    t.datetime "created_at"
+    t.datetime "updated_at"
+    t.string   "queue"
+  end
+
+  add_index "delayed_jobs", ["priority", "run_at"], :name => "delayed_jobs_priority"
+
+  create_table "users", :force => true do |t|
+    t.string   "name"
+    t.datetime "birthdate"
+    t.string   "sex"
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,61 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+# Configure Rails Environment
+ENV["RAILS_ENV"] = "test"
+
+require File.expand_path("../dummy/config/environment.rb", __FILE__)
+
+# Loading dummy applications affects table_name of each excluded models
+# defined in `spec/dummy/config/initializers/apartment.rb`.
+# To make them pristine, we need to execute below lines.
+Apartment.excluded_models.each do |model|
+  klass = model.constantize
+
+  Apartment.connection_class.remove_connection(klass)
+  klass.clear_all_connections!
+  klass.reset_table_name
+end
+
+require "rspec/rails"
+require 'capybara/rspec'
+require 'capybara/rails'
+
+begin
+  require 'pry'
+  silence_warnings{ IRB = Pry }
+rescue LoadError
+end
+
+ActionMailer::Base.delivery_method = :test
+ActionMailer::Base.perform_deliveries = true
+ActionMailer::Base.default_url_options[:host] = "test.com"
+
+Rails.backtrace_cleaner.remove_silencers!
+
+# Load support files
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
+
+RSpec.configure do |config|
+
+  config.include RSpec::Integration::CapybaraSessions, type: :request
+  config.include Apartment::Spec::Setup
+
+  # Somewhat brutal hack so that rails 4 postgres extensions don't modify this file
+  config.after(:all) do
+    `git checkout -- spec/dummy/db/schema.rb`
+  end
+
+  # rspec-rails 3 will no longer automatically infer an example group's spec type
+  # from the file location. You can explicitly opt-in to the feature using this
+  # config option.
+  # To explicitly tag specs without using automatic inference, set the `:type`
+  # metadata manually:
+  #
+  #     describe ThingsController, :type => :controller do
+  #       # Equivalent to being in spec/controllers
+  #     end
+  config.infer_spec_type_from_file_location!
+end
+
+# Load shared examples, must happen after configure for RSpec 3
+Dir["#{File.dirname(__FILE__)}/examples/**/*.rb"].each { |f| require f }

data/spec/support/apartment_helpers.rb

@@ -0,0 +1,43 @@
+module Apartment
+  module Test
+
+    extend self
+
+    def reset
+      Apartment.excluded_models = nil
+      Apartment.use_schemas = nil
+      Apartment.seed_after_create = nil
+      Apartment.default_schema = nil
+    end
+
+    def next_db
+      @x ||= 0
+      "db%d" % @x += 1
+    end
+
+    def drop_schema(schema)
+      ActiveRecord::Base.connection.execute("DROP SCHEMA IF EXISTS #{schema} CASCADE") rescue true
+    end
+
+    # Use this if you don't want to import schema.rb etc... but need the postgres schema to exist
+    # basically for speed purposes
+    def create_schema(schema)
+      ActiveRecord::Base.connection.execute("CREATE SCHEMA #{schema}")
+    end
+
+    def load_schema(version = 3)
+      file = File.expand_path("../../schemas/v#{version}.rb", __FILE__)
+
+      silence_warnings{ load(file) }
+    end
+
+    def migrate
+      ActiveRecord::Migrator.migrate(Rails.root + ActiveRecord::Migrator.migrations_path)
+    end
+
+    def rollback
+      ActiveRecord::Migrator.rollback(Rails.root + ActiveRecord::Migrator.migrations_path)
+    end
+
+  end
+end

data/spec/support/capybara_sessions.rb

@@ -0,0 +1,15 @@
+module RSpec
+  module Integration
+    module CapybaraSessions
+      
+      def in_new_session(&block)
+        yield new_session
+      end
+      
+      def new_session
+        Capybara::Session.new(Capybara.current_driver, Capybara.app)
+      end
+      
+    end
+  end
+end

data/spec/support/config.rb

@@ -0,0 +1,10 @@
+require 'yaml'
+
+module Apartment
+  module Test
+
+    def self.config
+      @config ||= YAML.load(ERB.new(IO.read('spec/config/database.yml')).result)
+    end
+  end
+end

data/spec/support/contexts.rb

@@ -0,0 +1,52 @@
+#   Some shared contexts for specs
+
+shared_context "with default schema", :default_schema => true do
+  let(:default_schema){ Apartment::Test.next_db }
+
+  before do
+    Apartment::Test.create_schema(default_schema)
+    Apartment.default_schema = default_schema
+  end
+
+  after do
+    # resetting default_schema so we can drop and any further resets won't try to access droppped schema
+    Apartment.default_schema = nil
+    Apartment::Test.drop_schema(default_schema)
+  end
+end
+
+# Some default setup for elevator specs
+shared_context "elevators", elevator: true do
+  let(:company1)  { mock_model(Company, database: db1).as_null_object }
+  let(:company2)  { mock_model(Company, database: db2).as_null_object }
+
+  let(:api)       { Apartment::Tenant }
+
+  before do
+    Apartment.reset # reset all config
+    Apartment.seed_after_create = false
+    Apartment.use_schemas = true
+    api.reload!(config)
+    api.create(db1)
+    api.create(db2)
+  end
+
+  after do
+    api.drop(db1)
+    api.drop(db2)
+  end
+end
+
+shared_context "persistent_schemas", :persistent_schemas => true do
+  let(:persistent_schemas){ ['hstore', 'postgis'] }
+
+  before do
+    persistent_schemas.map{|schema| subject.create(schema) }
+    Apartment.persistent_schemas = persistent_schemas
+  end
+
+  after do
+    Apartment.persistent_schemas = []
+    persistent_schemas.map{|schema| subject.drop(schema) }
+  end
+end

data/spec/support/requirements.rb

@@ -0,0 +1,35 @@
+module Apartment
+  module Spec
+
+    #
+    #   Define the interface methods required to
+    #   use an adapter shared example
+    #
+    #
+    module AdapterRequirements
+      extend ActiveSupport::Concern
+
+      included do
+        before do
+          subject.create(db1)
+          subject.create(db2)
+        end
+
+        after do
+          # Reset before dropping (can't drop a db you're connected to)
+          subject.reset
+
+          # sometimes we manually drop these schemas in testing, don't care if we can't drop, hence rescue
+          subject.drop(db1) rescue true
+          subject.drop(db2) rescue true
+        end
+      end
+
+      %w{subject tenant_names default_tenant}.each do |method|
+        define_method method do
+          raise "You must define a `#{method}` method in your host group"
+        end unless defined?(method)
+      end
+    end
+  end
+end

data/spec/support/setup.rb

@@ -0,0 +1,46 @@
+module Apartment
+  module Spec
+    module Setup
+
+      def self.included(base)
+        base.instance_eval do
+          let(:db1){ Apartment::Test.next_db }
+          let(:db2){ Apartment::Test.next_db }
+          let(:connection){ ActiveRecord::Base.connection }
+
+          # This around ensures that we run these hooks before and after
+          # any before/after hooks defined in individual tests
+          # Otherwise these actually get run after test defined hooks
+          around(:each) do |example|
+
+            def config
+              db = RSpec.current_example.metadata.fetch(:database, :postgresql)
+
+              Apartment::Test.config['connections'][db.to_s].symbolize_keys
+            end
+
+            # before
+            Apartment::Tenant.reload!(config)
+            ActiveRecord::Base.establish_connection config
+
+            example.run
+
+            # after
+            Rails.configuration.database_configuration = {}
+            ActiveRecord::Base.clear_all_connections!
+
+            Apartment.excluded_models.each do |model|
+              klass = model.constantize
+
+              Apartment.connection_class.remove_connection(klass)
+              klass.clear_all_connections!
+              klass.reset_table_name
+            end
+            Apartment.reset
+            Apartment::Tenant.reload!
+          end
+        end
+      end
+    end
+  end
+end

data/spec/tasks/apartment_rake_spec.rb

@@ -0,0 +1,129 @@
+require 'spec_helper'
+require 'rake'
+require 'apartment/migrator'
+require 'apartment/tenant'
+
+describe "apartment rake tasks" do
+
+  before do
+    @rake = Rake::Application.new
+    Rake.application = @rake
+    load 'tasks/apartment.rake'
+    # stub out rails tasks
+    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')
+  end
+
+  after do
+    Rake.application = nil
+    ENV['VERSION'] = nil    # linux users reported env variable carrying on between tests
+  end
+
+  after(:all) do
+    Apartment::Test.load_schema
+  end
+
+  let(:version){ '1234' }
+
+  context 'database migration' do
+
+    let(:tenant_names){ 3.times.map{ Apartment::Test.next_db } }
+    let(:tenant_count){ tenant_names.length }
+
+    before do
+      allow(Apartment).to receive(:tenant_names).and_return tenant_names
+    end
+
+    describe "apartment:migrate" do
+      before do
+        allow(ActiveRecord::Migrator).to receive(:migrate)   # don't care about this
+      end
+
+      it "should migrate public and all multi-tenant dbs" do
+        expect(Apartment::Migrator).to receive(:migrate).exactly(tenant_count).times
+        @rake['apartment:migrate'].invoke
+      end
+    end
+
+    describe "apartment:migrate:up" do
+
+      context "without a version" do
+        before do
+          ENV['VERSION'] = nil
+        end
+
+        it "requires a version to migrate to" do
+          expect{
+            @rake['apartment:migrate:up'].invoke
+          }.to raise_error("VERSION is required")
+        end
+      end
+
+      context "with version" do
+
+        before do
+          ENV['VERSION'] = version
+        end
+
+        it "migrates up to a specific version" do
+          expect(Apartment::Migrator).to receive(:run).with(:up, anything, version.to_i).exactly(tenant_count).times
+          @rake['apartment:migrate:up'].invoke
+        end
+      end
+    end
+
+    describe "apartment:migrate:down" do
+
+      context "without a version" do
+        before do
+          ENV['VERSION'] = nil
+        end
+
+        it "requires a version to migrate to" do
+          expect{
+            @rake['apartment:migrate:down'].invoke
+          }.to raise_error("VERSION is required")
+        end
+      end
+
+      context "with version" do
+
+        before do
+          ENV['VERSION'] = version
+        end
+
+        it "migrates up to a specific version" do
+          expect(Apartment::Migrator).to receive(:run).with(:down, anything, version.to_i).exactly(tenant_count).times
+          @rake['apartment:migrate:down'].invoke
+        end
+      end
+    end
+
+    describe "apartment:rollback" do
+      let(:step){ '3' }
+
+      it "should rollback dbs" do
+        expect(Apartment::Migrator).to receive(:rollback).exactly(tenant_count).times
+        @rake['apartment:rollback'].invoke
+      end
+
+      it "should rollback dbs STEP amt" do
+        expect(Apartment::Migrator).to receive(:rollback).with(anything, step.to_i).exactly(tenant_count).times
+        ENV['STEP'] = step
+        @rake['apartment:rollback'].invoke
+      end
+    end
+
+    describe "apartment:drop" do
+      it "should migrate public and all multi-tenant dbs" do
+        expect(Apartment::Tenant).to receive(:drop).exactly(tenant_count).times
+        @rake['apartment:drop'].invoke
+      end
+    end
+
+  end
+end