heroku-schemas 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+.DS_Store
+*.dump
+Gemfile.lock
+features/support/config.yml

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2013 Tom Benner
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,94 @@
+Heroku Schemas
+==============
+Run many apps on a single database
+
+Description
+-----------
+
+Heroku Schemas lets you run multiple Heroku apps on top of a single Heroku Postgres database. A Postgres database can have multiple "schemas" (basically Postgres's word for database "namespaces"), and Heroku Schemas simply makes each app use its own schema within a single, shared database.
+
+For example, if you have five apps with small levels of traffic, instead of using five databases, you can now just use one database with five schemas to serve all of them.
+
+Installation
+------------
+
+Install the plugin:
+
+```sh
+heroku plugins:install git://github.com/tombenner/heroku-schemas.git
+```
+
+Usage
+-----
+
+To make an app use a schema named `my_schema` in the database of an app called `my-other-app`:
+
+```sh
+cd path/to/my-app
+heroku schemas:use my-other-app:my_schema
+```
+
+This copies the app's database into the new schema and makes the app use it. You can then remove the original database from your plan.
+
+Heroku Schemas also lets you see what database/schema the current app is using (`show`) and drop schemas (`drop`).
+
+Commands
+--------
+
+### Use
+
+Make the app in the current directory use a new database/schema. If the app has an existing database, it is copied to the target database/schema. 
+
+The following command makes my-app use the schema `my_schema` in the default database of my-other-app:
+
+```sh
+heroku schemas:use my-other-app:my_schema
+```
+
+If my-other-app has more than one database, you can specify which database the schema should be in: 
+```sh
+heroku schemas:use my-other-app:HEROKU_POSTGRESQL_BLUE_URL:my_schema
+```
+
+("`BLUE`"" in `HEROKU_POSTGRESQL_BLUE_URL` should be replaced with the color name in the database's name.)
+
+### Show
+
+Show which database/schema is currently being used by the app.
+
+```sh
+heroku schemas:show
+=> my-other-app:HEROKU_POSTGRESQL_BLUE_URL:my_schema
+```
+
+### Drop
+
+Drop (delete) the schema that is currently being used by the app. This is irreversible, so please be sure that you're dropping the intended schema.
+
+```sh
+heroku schemas:drop
+=> Dropped schema my-other-app:HEROKU_POSTGRESQL_BLUE_URL:my_schema
+```
+
+Tests
+-----
+
+The feature tests create and manipulate two Heroku apps; to run them, you'll need to:
+
+```sh
+cp features/support/config.example.yml features/support/config.yml
+```
+
+And then edit config.yml to include your Heroku API key and a prefix for the app names (choose something unique to avoid naming conflicts with other people who are running these tests).
+
+Notes
+-----
+
+A shared database may not be wise for significant, production apps, but it may be worthwhile if you have multiple small apps or apps that are in development.
+
+Heroku Schemas is for educational purposes. The author assumes no liability for anything that happens to your data or your Heroku account while using Heroku Schemas.
+
+License
+-------
+
+Heroku Schemas is released under the MIT License. Please see the MIT-LICENSE file for details.

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/features/drop.feature

@@ -0,0 +1,9 @@
+Feature: Drop
+  In order to drop a schema
+  A developer
+  Should be able to run a command
+
+  Scenario: App has been initialized
+    Given an app named 'current-app'
+    And I drop the schema named 'public'
+    Then no schemas should exist

data/features/migration.feature

@@ -0,0 +1,18 @@
+Feature: Migration
+  In order to move an app's database
+  A developer
+  Should be able to run a migration
+
+  Scenario: App has not been migrated
+    Given two apps named 'current-app' and 'target-app'
+    And I create a backup with the target schema
+    And I create the target schema
+    And I update the database URL
+    And I import the backup into the target schema
+    Then the first app should be using the database of the second app
+
+  Scenario: App has been migrated
+    Given two apps named 'current-app' and 'target-app'
+    And I add the current app's schema to the target app's database
+    And I run the migration
+    Then an error containing "already contains data" is raised

data/features/show.feature

@@ -0,0 +1,9 @@
+Feature: Show
+  In order to see what schema an app is using
+  A developer
+  Should be able to run a command
+
+  Scenario: App has been initialized
+    Given an app named 'current-app'
+    And I run the show command
+    Then the output should match 'current-app:[A-Z_]+:public'

data/features/step_definitions/common_steps.rb

@@ -0,0 +1,8 @@
+Given /^an app named '([\w_-]+)'$/ do |app|
+  @configuration = Configuration
+  @heroku = Heroku::API.new(:api_key => @configuration['heroku_api_key'])
+
+  prefix = @configuration['heroku_app_prefix']
+  app_name = "#{prefix}#{app}"
+  @app = HerokuSchemas::Test::App.new(app_name, HerokuSchemas::CurrentDatabase)
+end

data/features/step_definitions/drop_steps.rb

@@ -0,0 +1,12 @@
+And /^I drop the schema named '(.+)'$/ do |schema|
+  @schema = schema
+  @drop = HerokuSchemas::Drop.new(
+    context_app: @app.name,
+    string_reference: "#{@app.name}:#{@schema}"
+  )
+  @drop.perform
+end
+
+Then /^no schemas should exist$/ do
+  @drop.database.existing_schemas.should be_empty
+end

data/features/step_definitions/migration_steps.rb

@@ -0,0 +1,57 @@
+Given /^two apps named '([\w_-]+)' and '([\w_-]+)'$/ do |current_app, target_app|
+  @configuration = Configuration
+  @heroku = Heroku::API.new(:api_key => @configuration['heroku_api_key'])
+
+  prefix = @configuration['heroku_app_prefix']
+  current_app_name = "#{prefix}#{current_app}"
+  target_app_name = "#{prefix}#{target_app}"
+
+  @current_app = HerokuSchemas::Test::App.new(current_app_name, HerokuSchemas::CurrentDatabase)
+  @target_app = HerokuSchemas::Test::App.new(target_app_name, HerokuSchemas::TargetDatabase)
+  
+  @current_schema = 'public'
+  @target_schema = HerokuSchemas::SchemaUtilities.app_to_schema(current_app_name)
+  @migration = HerokuSchemas::Migration.new(
+    context_app: current_app_name,
+    string_reference: "#{target_app_name}:#{@target_schema}"
+  )
+end
+
+And /^I add the current app's schema to the target app's database$/ do
+  @target_app.add_data_to_schema(@target_schema)
+end
+
+And /^I create a backup with the target schema$/ do
+  @migration.create_backup_with_target_schema
+  @migration.backup_url.should =~ %r|^https://.+\.dump.+$|
+end
+
+And /^I update the database URL$/ do
+  @migration.update_database_url
+end
+
+And /^I create the target schema$/ do
+  @migration.create_target_schema_in_target_database
+  @migration.target_database.existing_schemas.should =~ ['public', @target_schema]
+end
+
+And /^I import the backup into the target schema$/ do
+  @migration.import_backup_into_target_database
+end
+
+And /^I run the migration$/ do
+  begin
+    @migration.perform
+  rescue Exception => @error
+  end
+end
+
+Then /an error containing "(.+)" is raised/ do |message_excerpt|
+  @error.should_not be_nil
+  @error.message.should include(message_excerpt)
+end
+
+Then /^the first app should be using the database of the second app$/ do
+  @migration.target_database.schema_tables(@target_schema).should =~ ['dummy_records']
+  @migration.target_database.select_values("SELECT dummy_records.name FROM #{@target_schema}.dummy_records").should == [@current_app.name]
+end

data/features/step_definitions/show_steps.rb

@@ -0,0 +1,12 @@
+And /^I run the show command$/ do
+  @show = HerokuSchemas::Show.new(
+    context_app: @app.name
+  )
+  @buffer = OutputBuffer.new.activate
+  @show.perform
+  @buffer.stop
+end
+
+Then /^the output should match '(.+)'$/ do |regex|
+  @buffer.to_s.should match(/#{regex}/)
+end

data/features/support/config.example.yml

@@ -0,0 +1,2 @@
+heroku_api_key: MY_API_KEY
+heroku_app_prefix: my-prefix-

data/features/support/env.rb

@@ -0,0 +1,42 @@
+$:.unshift(File.dirname(__FILE__) + '/../../lib')
+require 'rubygems'
+require 'bundler/setup'
+require 'rspec/expectations'
+require 'aruba/cucumber'
+
+require 'heroku-schemas'
+support_path = File.expand_path('../', __FILE__)
+require support_path + '/lib/configuration'
+require support_path + '/lib/heroku-schemas/test/app'
+
+Before do
+  @aruba_timeout_seconds = 120 # A long time needed some times
+  unset_bundler_env_vars
+end
+
+if(ENV['ARUBA_REPORT_DIR'])
+  # Override reporting behaviour so we don't document all files, only the ones
+  # that have been created after @aruba_report_start (a Time object). This is
+  # given a value after the Rails app is generated (see cucumber_rails_steps.rb)
+  module Aruba
+    module Reporting
+      def children(dir)
+        children = Dir["#{dir}/*"].sort
+
+        # include
+        children = children.select do |child|
+          File.directory?(child) ||
+          (@aruba_report_start && File.stat(child).mtime > @aruba_report_start)
+        end
+
+        # exclude
+        children = children.reject do |child|
+          child =~ /Gemfile/ ||
+          child =~ /\.log$/
+        end
+
+        children
+      end
+    end
+  end
+end

data/features/support/lib/configuration.rb

@@ -0,0 +1,23 @@
+require 'yaml'
+
+class Configuration
+  class << self
+    def load
+      @@config = nil
+      io = File.open(File.dirname(__FILE__) + '/../config.yml')
+      YAML::load_documents(io) { |doc| @@config = doc }
+      raise 'Could not locate a configuration named "config.yml"' unless @@config
+    end
+
+    def [] key
+      @@config[key]
+    end
+
+    def []= key, value
+      @@config[key] = value
+    end
+  end
+end
+
+Configuration.load
+@configuration = Configuration

data/features/support/lib/heroku-schemas/test/app.rb

@@ -0,0 +1,109 @@
+# Allows for manipulations of a Heroku app and its database in a testing environment
+module HerokuSchemas
+  module Test
+    class App
+      attr_reader :database, :name
+
+      def initialize(name, database)
+        @name = name
+        @database = database
+        @heroku = Heroku::API.new(:api_key => Configuration['heroku_api_key'])
+        @dummy_app_path = File.expand_path('../../../../../spec/dummy-app', __FILE__)
+        initialize_app
+      end
+
+      def initialize_app
+        if app_exists?
+          puts "Resetting app #{name}..."
+          reset_app
+        else
+          puts "Creating app #{name}..."
+          create_app
+        end
+      end
+
+      def create_app
+        begin
+          @heroku.post_app('name' => name)
+        rescue Heroku::API::Errors::RequestFailed
+        end
+
+        begin
+          @heroku.post_addon(name, 'pgbackups:plus')
+        rescue Heroku::API::Errors::RequestFailed
+        end
+
+        set_git_remote
+        Dir.chdir @dummy_app_path do
+          system "git push heroku master"
+        end
+        add_data_to_schema
+      end
+
+      def set_git_remote
+        Dir.chdir @dummy_app_path do
+          system "git remote set-url heroku git@heroku.com:#{name}.git"
+        end
+      end
+
+      def add_data_to_schema(schema=nil)
+        if schema
+          original_schema_search_path = database.connection.schema_search_path
+          database.connection.schema_search_path = schema
+          database.execute("CREATE SCHEMA #{schema}")
+        end
+        app_database = database
+        ActiveRecord::Schema.define do
+          @connection = app_database.connection
+          create_table "dummy_records", :force => true do |t|
+            t.string   "name"
+            t.datetime "created_at", :null => false
+            t.datetime "updated_at", :null => false
+          end
+        end
+        database.execute("INSERT INTO dummy_records (name, created_at, updated_at) VALUES ('#{name}', NOW(), NOW())")
+        if schema
+          database.connection.schema_search_path = original_schema_search_path
+        end 
+      end
+
+      def app_exists?
+        begin
+          app = @heroku.get_app(name)
+        rescue Heroku::API::Errors::NotFound
+          return false
+        end
+        app
+      end
+
+      def reset_app
+        database_url = reset_app_database_url
+        database.connect_to_url(database_url)
+        database.existing_schemas.each do |schema|
+          database.execute("DROP SCHEMA #{schema} CASCADE")
+        end
+        database.execute('CREATE SCHEMA public')
+        add_data_to_schema
+      end
+
+      # Reset DATABASE_URL to the value in the first HEROKU_POSTGRESQL_$COLOR_URL-style config variable
+      def reset_app_database_url
+        @heroku.get_config_vars(name).body.each do |key, value|
+          if key != 'DATABASE_URL' && key.end_with?('_URL') && value.start_with?('postgres://')
+            @heroku.put_config_vars(name, 'DATABASE_URL' => value)
+            return value
+          end
+        end
+      end
+
+      def delete_app
+        begin
+          app = @heroku.delete_app(name)
+        rescue Heroku::API::Errors::NotFound
+          return false
+        end
+        app
+      end
+    end
+  end
+end