heroku-rails-saas 0.1.0

data/lib/heroku/rails/tasks.rb

@@ -0,0 +1,246 @@
+require 'heroku-rails'
+
+HEROKU_CONFIG_FILE = File.join(HerokuRails::Config.root, 'config', 'heroku.yml')
+HEROKU_APP_SPECIFIC_CONFIG_FILES = Dir.glob("#{File.join(HerokuRails::Config.root, 'config', 'heroku')}/*.yml")
+HEROKU_CONFIG = HerokuRails::Config.new({:default => HEROKU_CONFIG_FILE, :apps => HEROKU_APP_SPECIFIC_CONFIG_FILES})
+HEROKU_RUNNER = HerokuRails::Runner.new(HEROKU_CONFIG)
+
+# create all the environment specific tasks
+(HEROKU_CONFIG.apps).each do |app, hsh|
+  hsh.each do |env, heroku_env|
+    app_name = HerokuRails::Config.app_name(app, env)
+    desc "Select #{app_name} Heroku app for later commands"
+    task app_name do
+      # callback switch_environment
+      @heroku_app = {:env => heroku_env, :app_name => app_name}
+      Rake::Task["heroku:switch_environment"].reenable
+      Rake::Task["heroku:switch_environment"].invoke
+
+      HEROKU_RUNNER.add_environment(app_name)
+    end
+  end
+end
+
+desc 'Select all Heroku apps for later command (production must be explicitly declared)'
+task :all do
+  HEROKU_RUNNER.all_environments(true)
+end
+
+(HEROKU_CONFIG.all_environments).each do |env|
+  desc "Select all Heroku apps in #{env} environment"
+  task "all:#{env}" do
+    HEROKU_RUNNER.environments(env)
+  end
+end
+
+namespace :heroku do
+  def system_with_echo(*args)
+    HEROKU_RUNNER.system_with_echo(*args)
+  end
+
+  desc 'Add git remotes for all apps in this project'
+  task :remotes do
+    HEROKU_RUNNER.all_environments
+    HEROKU_RUNNER.each_heroku_app do |heroku_env, app_name, repo|
+      system_with_echo("git remote add #{app_name} #{repo}")
+    end
+  end
+
+  desc 'Lists configured apps'
+  task :apps do
+    HEROKU_RUNNER.all_environments
+    puts "\n"
+    HEROKU_RUNNER.each_heroku_app do |heroku_env, app_name, repo|
+      puts "#{heroku_env} maps to the Heroku app #{app_name} located at:"
+      puts "  #{repo}"
+      puts
+    end
+  end
+
+  desc "Get remote server information on the heroku app"
+  task :info do
+    HEROKU_RUNNER.each_heroku_app do |heroku_env, app_name, repo|
+      system_with_echo "heroku info --app #{app_name}"
+      puts "\n"
+    end
+  end
+
+  desc "Deploys, migrates and restarts latest git tag"
+  task :deploy => "heroku:before_deploy" do |t, args|
+    HEROKU_RUNNER.each_heroku_app do |heroku_env, app_name, repo|
+      puts "\n\nDeploying to #{app_name}..."
+      # set the current heroku_app so that callbacks can read the data
+      @heroku_app = {:env => heroku_env, :app_name => app_name, :repo => repo}
+      Rake::Task["heroku:before_each_deploy"].reenable
+      Rake::Task["heroku:before_each_deploy"].invoke(app_name)
+
+      cmd = HEROKU_CONFIG.cmd(heroku_env)
+      if heroku_env == "production"
+        branch = `git branch`.scan(/^\* (.*)\n/).flatten.first.to_s
+        all_tags = `git tag`
+        target_tag = all_tags[/.+\Z/] # Set lastest tag as default
+
+        begin
+          puts "\nGit tags:"
+          puts all_tags
+          print "\nPlease enter a tag to deploy (or hit Enter for \"#{target_tag}\"): "
+          input_tag = STDIN.gets.chomp
+          if input_tag.present?
+            if all_tags[/^#{input_tag}\n/].present?
+              target_tag = input_tag
+              invalid = false
+            else
+              puts "\n\nInvalid git tag!"
+              invalid = true
+            end
+          end  
+        end while invalid
+      else
+        branch = `git branch`.scan(/^\* (.*)\n/).flatten.first.to_s
+        if branch.present?
+          @git_push_arguments ||= []
+          @git_push_arguments << '--force'
+          to_deploy = "#{target_tag}^{}"
+          system_with_echo "git push #{repo} #{@git_push_arguments.join(' ')} #{branch}:master"
+          Rake::Task["heroku:setup:config"].invoke
+          system_with_echo "#{cmd} rake --app #{app_name} db:migrate && heroku restart --app #{app_name}"
+        else
+          puts "Unable to determine the current git branch, please checkout the branch you'd like to deploy."
+
+          exit(1)
+        end
+      end
+      
+      Rake::Task["heroku:after_each_deploy"].reenable
+      Rake::Task["heroku:after_each_deploy"].invoke(app_name)
+      puts "\n"
+    end
+    Rake::Task["heroku:after_deploy"].invoke
+  end
+
+  # Callback before all deploys
+  task :before_deploy do
+  end
+
+  # Callback after all deploys
+  task :after_deploy do
+  end
+
+  # Callback before each deploy
+  task :before_each_deploy, [:app_name] do |t,args|
+  end
+
+  # Callback after each deploy
+  task :after_each_deploy, [:app_name] do |t,args|
+  end
+
+  # Callback for when we switch environment
+  task :switch_environment do
+  end
+
+  desc "Force deploys, migrates and restarts latest code"
+  task :force_deploy do
+    @git_push_arguments ||= []
+    @git_push_arguments << '--force'
+    Rake::Task["heroku:deploy"].execute
+  end
+
+  desc "Captures a bundle on Heroku"
+  task :capture do
+    HEROKU_RUNNER.each_heroku_app do |heroku_env, app_name, repo|
+      system_with_echo "heroku bundles:capture --app #{app_name}"
+    end
+  end
+
+  desc "Opens a remote console"
+  task :console do
+    HEROKU_RUNNER.each_heroku_app do |heroku_env, app_name, repo|
+      cmd = HEROKU_CONFIG.cmd(heroku_env)
+      system_with_echo "#{cmd} console --app #{app_name}"
+    end
+  end
+
+  desc "Shows the Heroku logs"
+  task :logs do
+    HEROKU_RUNNER.each_heroku_app do |heroku_env, app_name, repo|
+      system_with_echo "heroku logs --app #{app_name}"
+    end
+  end
+
+  desc "Restarts remote servers"
+  task :restart do
+    HEROKU_RUNNER.each_heroku_app do |heroku_env, app_name, repo|
+      system_with_echo "heroku restart --app #{app_name}"
+    end
+  end
+
+  namespace :setup do
+
+    desc "Creates the apps on Heroku"
+    task :apps do
+      HEROKU_RUNNER.setup_apps
+    end
+
+    desc "Setup the Heroku stacks from heroku.yml config"
+    task :stacks do
+      HEROKU_RUNNER.setup_stacks
+    end
+
+    desc "Setup the Heroku collaborators from heroku.yml config"
+    task :collaborators do
+      HEROKU_RUNNER.setup_collaborators
+    end
+
+    desc "Setup the Heroku environment config variables from heroku.yml config"
+    task :config do
+      HEROKU_RUNNER.setup_config
+    end
+
+    desc "Setup the Heroku addons from heroku.yml config"
+    task :addons do
+      HEROKU_RUNNER.setup_addons
+    end
+
+    desc "Setup the Heroku domains from heroku.yml config"
+    task :domains do
+      HEROKU_RUNNER.setup_domains
+    end
+  end
+
+  desc "Setup Heroku deploy environment from heroku.yml config"
+  task :setup => [
+    "heroku:setup:apps",
+    "heroku:setup:stacks",
+    "heroku:setup:collaborators",
+    "heroku:setup:config",
+    "heroku:setup:addons",
+    "heroku:setup:domains",
+  ]
+
+  namespace :db do
+    desc "Migrates and restarts remote servers"
+    task :migrate do
+      HEROKU_RUNNER.each_heroku_app do |heroku_env, app_name, repo|
+        cmd = HEROKU_CONFIG.cmd(heroku_env)
+        system_with_echo "#{cmd} rake --app #{app_name} db:migrate && heroku restart --app #{app_name}"
+      end
+    end
+
+    desc "Pulls the database from heroku and stores it into db/dumps/"
+    task :pull do
+      HEROKU_RUNNER.each_heroku_app do |heroku_env, app_name, repo|
+        system_with_echo "heroku pgdumps:capture --app #{app_name}"
+        dump = `heroku pgdumps --app #{app_name}`.split("\n").last.split(" ").first
+        system_with_echo "mkdir -p #{HerokuRails::Config.root}/db/dumps"
+        file = "#{HerokuRails::Config.root}/db/dumps/#{dump}.sql.gz"
+        url = `heroku pgdumps:url --app #{app_name} #{dump}`.chomp
+        system_with_echo "wget", url, "-O", file
+
+        # TODO: these are a bit distructive...
+        # system_with_echo "rake db:drop db:create"
+        # system_with_echo "gunzip -c #{file} | #{HerokuRails::Config.root}/script/dbconsole"
+        # system_with_echo "rake jobs:clear"
+      end
+    end
+  end
+end

data/spec/fixtures/awesomeapp.yml

@@ -0,0 +1,32 @@
+env:
+  production: awesomeapp
+  staging: awesomeapp-staging
+
+stacks: 
+  staging: bamboo-ree-1.8.7
+
+config:
+  production: 
+    CONFIG_VAR1: "config1-production"
+  staging:
+    CONFIG_VAR1: "config1-staging"
+    STAGING_CONFIG: "special-staging"
+
+collaborators:
+  staging:
+    - "staging-user@somedomain.com"
+  production:
+    - "production-user@somedomain.com"
+
+domains:
+  staging:
+    - "staging.awesomeapp.com"
+  production:
+    - "awesomeapp.com"
+    - "www.awesomeapp.com"
+
+addons:
+  production:
+    # list production env specific addons here
+    - ssl:piggyback
+    - cron:daily

data/spec/fixtures/heroku-config.yml

@@ -0,0 +1,16 @@
+stacks: bamboo-mri-1.9.2
+
+config:
+  BUNDLE_WITHOUT: "test:development"
+  CONFIG_VAR1: "config1"
+  CONFIG_VAR2: "config2"
+
+collaborators:
+  - "all-user1@somedomain.com"
+  - "all-user2@somedomain.com"
+  - "all-user2@somedomain.com"
+
+addons:
+  # add any other addons here
+  - scheduler:standard
+  - newrelic:bronze

data/spec/fixtures/mediocreapp.yml

@@ -0,0 +1,14 @@
+env:
+  development: mediocreapp-dev1
+
+config:
+  development:
+    CONFIG_VAR1: "config-for-mediocre"
+
+collaborators:
+  development: 
+    - "mediocre-user@example.com"
+
+domains:
+  development:
+    - "mediocreapp.com"

data/spec/heroku/rails/heroku_config_spec.rb

@@ -0,0 +1,157 @@
+require 'spec_helper'
+
+module HerokuRails
+  describe Config do
+    before(:each) do
+      config_files = {:default => config_path("heroku-config.yml"), :apps => [config_path("awesomeapp.yml"), config_path("mediocreapp.yml")]}
+      @config = Config.new(config_files)
+    end
+
+    it "should read the configuration file" do
+      @config.settings.should_not be_empty
+    end
+
+    describe "#apps" do
+      it "should return the list of apps defined" do
+        @config.apps.should have(2).apps
+        @config.apps.should include("awesomeapp")
+        @config.apps.should include("mediocreapp")
+      end
+    end
+
+    describe "#app_names" do
+      it "should return the list of apps defined" do
+        @config.app_names.should have(2).names
+        @config.apps.should include("awesomeapp")
+        @config.apps.should include("mediocreapp")
+      end
+    end
+
+    describe "#app_environments" do
+      it "should return a list of the environments defined" do
+        @config.app_environments.should have(3).environments
+        @config.app_environments.should include("awesomeapp:production")
+        @config.app_environments.should include("awesomeapp:staging")
+        @config.app_environments.should include("awesomeapp:staging")
+      end
+    end
+
+    describe "#stack" do
+      it "should return the associated stack for awesomeapp:staging" do
+        @config.stack("awesomeapp:staging").should == "bamboo-ree-1.8.7"
+      end
+
+      it "should return the default stack for awesomeapp:production" do
+        @config.stack("awesomeapp:production").should == "bamboo-mri-1.9.2"
+      end
+
+      it "should default to the all setting if not explicitly defined" do
+        @config.stack("mediocreapp").should == "bamboo-mri-1.9.2"
+      end
+    end
+
+    describe "#config" do
+      context "staging environment" do
+        before(:each) do
+          @config = @config.config("awesomeapp:staging")
+        end
+        it "should include configs defined in 'staging'" do
+          @config["STAGING_CONFIG"].should == "special-staging"
+        end
+
+        it "should include configs defined in 'all'" do
+          @config["BUNDLE_WITHOUT"].should == "test:development"
+        end
+
+        it "should use configs defined in 'staging' ahead of configs defined in 'all'" do
+          @config["CONFIG_VAR1"].should == "config1-staging"
+        end
+      end
+    end
+
+    describe "#collaborators" do
+      context "awesomeapp:staging" do
+        before(:each) do
+          @collaborators = @config.collaborators('awesomeapp:staging')
+        end
+
+        it "should include the collaborators defined in 'all'" do
+          @collaborators.should include('all-user1@somedomain.com')
+          @collaborators.should include('all-user2@somedomain.com')
+          @collaborators.should have(3).collaborators
+        end
+
+        it "should include collaborators defined in 'staging'" do
+          @collaborators.should include('staging-user@somedomain.com')
+        end
+
+        it "should not include collaborators defined in 'production'" do
+          @collaborators.should_not include('production-user@somedomain.com')
+        end
+      end
+
+      context "mediocreapp:development" do
+        before(:each) do
+          @collaborators = @config.collaborators('mediocreapp:development')
+        end
+
+        it "should include the collaborators defined in 'all'" do
+          @collaborators.should include('all-user1@somedomain.com')
+          @collaborators.should include('all-user2@somedomain.com')
+          @collaborators.should have(3).collaborators
+        end
+
+        it "should include collaborators defined in 'development'" do
+          @collaborators.should include('mediocre-user@example.com')
+        end
+
+        it "should not include collaborators defined other apps" do
+          @collaborators.should_not include("staging-user@somedomain.com")
+        end
+      end
+    end
+
+    describe "#domains" do
+      context "staging environment" do
+        before(:each) do
+          @domains = @config.domains('awesomeapp:staging')
+        end
+
+        it "should include the domains defined in 'staging'" do
+          @domains.should include('staging.awesomeapp.com')
+        end
+
+        it "should not include the domains defined in 'production'" do
+          @domains.should_not include('awesomeapp.com')
+          @domains.should_not include('www.awesomeapp.com')
+        end
+      end
+
+      context "production environment" do
+        it "should include the domains defined in 'production'" do
+          @domains = @config.domains('awesomeapp:production')
+          @domains.should include('awesomeapp.com')
+          @domains.should include('www.awesomeapp.com')
+        end
+      end
+    end
+
+    describe "#addons" do
+      context "staging environment" do
+        before(:each) do
+          @addons = @config.addons('awesomeapp:staging')
+        end
+
+        it "should include addons defined in 'all'" do
+          @addons.should include('scheduler:standard')
+          @addons.should include('newrelic:bronze')
+        end
+
+        it "should not include addons defined in 'production'" do
+          @addons.should_not include('ssl:piggyback')
+        end
+      end
+    end
+
+  end
+end