heroku-rails-saas 0.1.7 → 1.0.2

data/lib/heroku-rails-saas/version.rb

@@ -0,0 +1,3 @@
+module HerokuRailsSaas
+  VERSION = "1.0.2"
+end

data/lib/heroku/rails/tasks.rb

@@ -1,22 +1,27 @@
 require 'heroku-rails-saas'
 
-HEROKU_CONFIG_FILE = File.join(HerokuRailsSaas::Config.root, 'config', 'heroku.yml')
-HEROKU_APP_SPECIFIC_CONFIG_FILES = Dir.glob("#{File.join(HerokuRailsSaas::Config.root, 'config', 'heroku')}/*.yml")
-HEROKU_CONFIG = HerokuRailsSaas::Config.new({:default => HEROKU_CONFIG_FILE, :apps => HEROKU_APP_SPECIFIC_CONFIG_FILES})
-HEROKU_RUNNER = HerokuRailsSaas::Runner.new(HEROKU_CONFIG)
+# Get callback-like rake task to step into the deploy process.
+import File.join(File.dirname(__FILE__), '../../generators/templates/heroku.rake')
+
+# Suppress warnings from ruby when trying to redefine a constant, typically due to reloding of Rails.
+silence_warnings do
+  HEROKU_CONFIG_FILE = File.join(HerokuRailsSaas::Config.root, 'config', 'heroku.yml')
+  HEROKU_APP_SPECIFIC_CONFIG_FILES = Dir.glob("#{File.join(HerokuRailsSaas::Config.root, 'config', 'heroku')}/*.yml")
+  HEROKU_CONFIG = HerokuRailsSaas::Config.new({:default => HEROKU_CONFIG_FILE, :apps => HEROKU_APP_SPECIFIC_CONFIG_FILES})
+  HEROKU_RUNNER = HerokuRailsSaas::Runner.new(HEROKU_CONFIG)
+  DISPLAYER = HerokuRailsSaas::Displayer
+end
 
 # create all the environment specific tasks
 (HEROKU_CONFIG.apps).each do |app, hsh|
   hsh.each do |env, heroku_env|
-    app_name = HerokuRailsSaas::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}
+    local_name = HerokuRailsSaas::Config.local_name(app, env)
+    desc "Select #{local_name} Heroku app for later commands"
+    task local_name do
       Rake::Task["heroku:switch_environment"].reenable
       Rake::Task["heroku:switch_environment"].invoke
 
-      HEROKU_RUNNER.add_environment(app_name)
+      HEROKU_RUNNER.add_app(local_name)
     end
   end
 end
@@ -26,168 +31,94 @@ 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)
+(HEROKU_CONFIG.all_environments).each do |environment|
+  desc "Select all Heroku apps in #{environment} environment"
+  task "all:#{environment}" do
+    HEROKU_RUNNER.add_environment(environment)
   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 '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("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
+    HEROKU_RUNNER.apps
+  end
+
+  desc "Run command on the heroku app (e.g. rake task)"
+  task :exec, :command do |t, args|
+    HEROKU_RUNNER.exec_on_all(args[:command])
   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
+    HEROKU_RUNNER.info
   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[HEROKU_RUNNER.regex_for(:production)]
-        all_tags = `git tag`
-        target_tag = `git describe --tags --abbrev=0`.chomp # Set latest 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
-        puts "Unable to determine the tag to deploy." and exit(1) if target_tag.empty?
-        to_deploy = "#{target_tag}^{}"
-      else
-        to_deploy = `git branch`.scan(/^\* (.*)\n/).flatten.first.to_s
-        puts "Unable to determine the current git branch, please checkout the branch you'd like to deploy." and exit(1) if to_deploy.empty?
-      end
-
-      @git_push_arguments ||= ['--force']
-
-      system_with_echo "git push #{repo} #{@git_push_arguments.join(' ')} #{to_deploy}:master"
-
-      system_with_echo "heroku maintenance:on --app #{app_name}"
-
-      Rake::Task["heroku:setup:config"].invoke
-      system_with_echo "#{cmd} rake --app #{app_name} db:migrate"
-
-      system_with_echo "#{cmd} \"#{HEROKU_CONFIG.rails_cli(:runner)} 'Rails.cache.clear'\" --app #{app_name}"
-      
-      system_with_echo "heroku restart --app #{app_name}"
-      
-      system_with_echo "heroku maintenance:off --app #{app_name}"
-
-      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
+    HEROKU_RUNNER.deploy
   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|
+  desc "Restarts remote servers"
+  task :restart do
+    HEROKU_RUNNER.restart
   end
 
-  # Callback for when we switch environment
-  task :switch_environment do
+  desc "Scales heroku processes"
+  task :scale do
+    HEROKU_RUNNER.scale
   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 "Opens a remote console"
+  # task :console do
+  #   HEROKU_RUNNER.console
+  # 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
+    HEROKU_RUNNER.logs
   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}"
+  namespace :maintenance do
+    desc "Turn maintenance mode on"
+    task :on do 
+      HEROKU_RUNNER.maintenance(true)
     end
-  end
 
-  desc "Scales heroku processes"
-  task :scale do
-    HEROKU_RUNNER.scale
+    desc "Turn maintenance mode off"
+    task :off do
+      HEROKU_RUNNER.maintenance(false)
+    end
   end
 
-  namespace :setup do
+  desc "Setup Heroku deploy environment from heroku.yml config"
+  task :setup => [
+    "heroku:setup:app",
+    "heroku:setup:stack",
+    "heroku:setup:collaborators",
+    "heroku:setup:config",
+    "heroku:setup:addons",
+    "heroku:setup:domains",
+  ]
 
-    desc "Creates the apps on Heroku"
-    task :apps do
-      HEROKU_RUNNER.setup_apps
+  namespace :setup do
+    desc "Creates the app on Heroku with the default stack"
+    task :app do
+      HEROKU_RUNNER.setup_app
     end
 
     desc "Setup the Heroku stacks from heroku.yml config"
-    task :stacks do
-      HEROKU_RUNNER.setup_stacks
+    task :stack do
+      HEROKU_RUNNER.setup_stack
     end
 
     desc "Setup the Heroku collaborators from heroku.yml config"
@@ -211,66 +142,54 @@ namespace :heroku do
     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 pgbackups:capture --app #{app_name}"
-        dump = `heroku pgbackups --app #{app_name}`.split("\n").last.split(" ").first
-        system_with_echo "mkdir -p #{HerokuRailsSaas::Config.root}/db/dumps"
-        file = "#{HerokuRailsSaas::Config.root}/db/dumps/#{app_name}-#{dump}.sql.gz"
-        url = `heroku pgbackups: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} | #{HerokuRailsSaas::Config.root}/script/dbconsole"
-        # system_with_echo "rake jobs:clear"
-      end
-    end
+      HEROKU_RUNNER.exec_on_all("rake db:migrate")
+      HEROKU_RUNNER.restart
+    end
+
+    # NOTE: The following commands require the use of the heroku gem and not the heorku-api.
+    # Need to address these commands later.
+    # 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 pgbackups:capture --app #{app_name}"
+    #     dump = `heroku pgbackups --app #{app_name}`.split("\n").last.split(" ").first
+    #     system_with_echo "mkdir -p #{HerokuRailsSaas::Config.root}/db/dumps"
+    #     file = "#{HerokuRailsSaas::Config.root}/db/dumps/#{app_name}-#{dump}.sql.gz"
+    #     url = `heroku pgbackups: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} | #{HerokuRailsSaas::Config.root}/script/dbconsole"
+    #     # system_with_echo "rake jobs:clear"
+    #   end
+    # end
     
-    desc "Resets a Non Production database"
-    task :reset do
-      HEROKU_RUNNER.each_heroku_app do |heroku_env, app_name, repo|
-        unless heroku_env[HEROKU_RUNNER.regex_for(:production)]
-          system_with_echo "heroku pg:reset DATABASE_URL --app #{app_name} --confirm #{app_name}"
-        else
-          puts "Will not reset the Production database"
-        end
-      end
-    end
+    # desc "Resets a Non Production database"
+    # task :reset do
+    #   HEROKU_RUNNER.each_heroku_app do |heroku_env, app_name, repo|
+    #     unless heroku_env[HEROKU_RUNNER.regex_for(:production)]
+    #       system_with_echo "heroku pg:reset DATABASE_URL --app #{app_name} --confirm #{app_name}"
+    #     else
+    #       puts "Will not reset the Production database"
+    #     end
+    #   end
+    # end
     
-    desc "Copies a database over a Non Production database"
-    task :copy,[ :source]  => :reset do |t, args|
-      HEROKU_RUNNER.each_heroku_app do |heroku_env, app_name, repo|
-        raise "missing source" unless HEROKU_CONFIG.app_name_on_heroku(args.source)
-          
-        unless heroku_env[HEROKU_RUNNER.regex_for(:production)]
-          source_app_name = HEROKU_CONFIG.app_name_on_heroku(args.source)
-          system_with_echo "heroku pgbackups:restore DATABASE_URL `heroku pgbackups:url --app #{source_app_name}` --app #{app_name} --confirm #{app_name}"
-        else
-          puts "Will not overwrite the Production database"
-        end
-      end
-    end
-
+    # desc "Copies a database over a Non Production database"
+    # task :copy, [:source] => :reset do |t, args|
+    #   HEROKU_RUNNER.each_heroku_app do |heroku_env, app_name, repo|
+    #     raise "missing source" unless HEROKU_CONFIG.app_name_on_heroku(args.source)
+    #     unless heroku_env[HEROKU_RUNNER.regex_for(:production)]
+    #       source_app_name = HEROKU_CONFIG.app_name_on_heroku(args.source)
+    #       system_with_echo "heroku pgbackups:restore DATABASE_URL `heroku pgbackups:url --app #{source_app_name}` --app #{app_name} --confirm #{app_name}"
+    #     else
+    #       puts "Will not overwrite the Production database"
+    #     end
+    #   end
+    # end
   end
 end

data/spec/fixtures/awesomeapp.yml

@@ -25,11 +25,18 @@ domains:
     - "awesomeapp.com"
     - "www.awesomeapp.com"
 
+region:
+  staging: "UK"
+  production: "EU"
+
 addons:
   production:
     # list production env specific addons here
     - ssl:piggyback
     - cron:daily
+  staging:
+    - cron:daily
+    - multi_tier:paid
 
 scale:
   production:

data/spec/fixtures/example.netrc

@@ -0,0 +1,3 @@
+machine api.heroku.com
+  login user@example.com
+  password THIS_IS_YOU_API_TOKEN

data/spec/fixtures/heroku-config.yml

@@ -14,3 +14,4 @@ addons:
   # add any other addons here
   - scheduler:standard
   - newrelic:bronze
+  - multi_tier:free

data/spec/heroku-rails-saas/config_spec.rb

@@ -0,0 +1,214 @@
+require 'spec_helper'
+
+describe HerokuRailsSaas::Config do
+  before(:each) do
+    config_files = {:default => config_path("heroku-config.yml"), :apps => [config_path("awesomeapp.yml"), config_path("mediocreapp.yml")]}
+    @config = described_class.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
+
+      it "should override addons with a different tier with the one defined in 'staging'" do
+        @addons.should include('multi_tier:paid')
+        @addons.should_not include('multi_tier:free')
+      end
+    end
+  end
+
+  describe "#scale" do
+    context "mediocreapp" do
+      it "should include the scaling settings defined in 'all'" do
+        @scale = @config.scale('mediocreapp:development')
+        @scale['web'].should_not be_nil
+        @scale['worker'].should_not be_nil
+        @scale['web'].should eql 1
+        @scale['worker'].should eql 0
+      end
+    end
+
+    context "staging environment" do
+      it "should include the scaling settings defined in 'staging'" do
+        @scale = @config.scale('awesomeapp:staging')
+        @scale['web'].should_not be_nil
+        @scale['worker'].should_not be_nil
+        @scale['web'].should eql 2
+        @scale['worker'].should eql 1
+      end
+    end
+
+    context "production environment" do
+      it "should include the scaling settings defined in 'production'" do
+        @scale = @config.scale('awesomeapp:production')
+        @scale['web'].should_not be_nil
+        @scale['worker'].should_not be_nil
+        @scale['web'].should eql 3
+        @scale['worker'].should eql 2
+      end
+    end
+  end
+
+  describe "#region" do
+    context "staging environment" do
+      before(:each) do
+        @region = @config.region('awesomeapp:staging')
+      end
+
+      it "should include the region defined in 'staging'" do
+        @region.should include('UK')
+      end
+
+      it "should not include the region defined in 'production'" do
+        @region.should_not include('EU')
+      end
+    end
+
+    context "production environment" do
+      it "should include the region defined in 'production'" do
+        @region = @config.region('awesomeapp:production')
+        @region.should include('EU')
+      end
+    end
+  end
+end