heroku_san 1.3.0 → 2.0.rc.1

data/lib/tasks.rb

@@ -0,0 +1,284 @@
+require 'git'
+include Git
+
+@heroku_san = HerokuSan::Project.new(Rails.root.join('config', 'heroku.yml'))
+
+@heroku_san.all.each do |stage|
+  desc "Select #{stage} Heroku app for later commands"
+  task stage do
+    @heroku_san << stage
+  end
+end
+
+desc 'Select all Heroku apps for later command'
+task :all do
+  @heroku_san << @heroku_san.all
+end
+
+namespace :heroku do
+  desc "Creates the Heroku app"
+  task :create do
+    each_heroku_app do |stage|
+      stage.create
+    end
+  end
+
+  desc "Generate the Heroku gems manifest from gem dependencies"
+  task :gems => 'gems:base' do
+    raise HerokuSan::Deprecated
+  end
+
+  desc 'Add git remotes for all apps in this project'
+  task :remotes do
+    each_heroku_app do |stage|
+      sh "git remote add #{stage.name} #{stage.repo}"
+    end
+  end
+
+  desc 'Adds a collaborator'
+  task :share do
+    print "Email address of collaborator to add: "
+    $stdout.flush
+    email = $stdin.gets
+    each_heroku_app do |stage|
+      stage.sharing_add email
+    end
+  end
+
+  desc 'Removes a collaborator'
+  task :unshare do
+    print "Email address of collaborator to remove: "
+    $stdout.flush
+    email = $stdin.gets
+    each_heroku_app do |stage|
+      stage.sharing_remove email
+    end
+  end
+
+  desc 'Lists configured apps'
+  task :apps => :all do
+    each_heroku_app do |stage|
+      puts  "#{stage.name} is shorthand for the Heroku app #{stage.app} located at:"
+      puts  "  #{stage.repo}"
+      print "  @ "
+      rev = `git ls-remote -h #{stage.repo}`.split(' ').first
+      if rev.blank?
+        puts 'not deployed'
+      else
+        puts `git name-rev #{rev}`
+      end
+      puts
+    end
+  end
+
+  namespace :apps do
+    desc 'Lists configured apps without hitting heroku'
+    task :local => :all do
+      each_heroku_app do |stage|
+        puts "#{stage.name} is shorthand for the Heroku app #{stage.app} located at:"
+        puts "  #{stage.repo}"
+        puts "  the #{stage.name} TAG is '#{stage.tag}'" if stage.tag
+        puts
+      end
+    end
+  end
+
+  desc 'Add proper RACK_ENV to each application'
+  task :rack_env => :all do
+    each_heroku_app do |stage|
+      command = "heroku config --app #{stage.app}"
+      puts command
+      config = Hash[`#{command}`.scan(/^(.+?)\s*=>\s*(.+)$/)]
+      if config['RACK_ENV'] != stage.name
+        sh "heroku config:add --app #{stage.app} RACK_ENV=#{stage.name}"
+      end
+    end
+  end
+
+  desc 'Add config:vars to each application.'
+  task :config do
+    each_heroku_app do |stage|
+      command = "heroku config:add --app #{stage.app}"
+      stage.config.each do |var, value|
+        command += " #{var}=#{value}"
+      end
+      sh(command)
+    end
+  end
+
+  desc 'Creates an example configuration file'
+  task :create_config do
+    filename = %Q{#{@heroku_san.config_file.to_s}}
+    if @heroku_san.create_config
+      puts "Copied example config to #{filename.inspect}"
+      if ENV['EDITOR'].present?
+        sh "#{ENV['EDITOR']} #{filename}"
+      else
+        puts "Please edit #{filename.inspect} with your application's settings."
+      end
+    else
+      puts "#{filename.inspect} already exists"
+    end
+  end
+
+  namespace :config do
+    desc "Lists config variables as set on Heroku"
+    task :list do
+      each_heroku_app do |stage|
+        puts "#{stage.name}:"
+        stage.long_config
+      end
+    end
+
+    namespace :list do
+      desc "Lists local config variables without setting them"
+      task :local do
+        each_heroku_app do |stage|
+          (stage.config).each do |var, value|
+            puts "#{stage.name} #{var}: '#{value}'"
+          end
+        end
+      end
+    end
+  end
+  
+  desc 'Runs a rake task remotely'
+  task :rake, [:task] do |t, args|
+    each_heroku_app do |stage|
+      stage.run 'rake', args.task
+    end
+  end
+
+  desc "Pushes the given commit (default: HEAD)"
+  task :push, :commit do |t, args|
+    each_heroku_app do |stage|
+      git_push(args[:commit] || git_parsed_tag(stage.tag), stage.repo)
+    end
+  end
+
+  namespace :push do
+    desc "Force-pushes the given commit (default: HEAD)"
+    task :force, :commit do |t, args|
+      each_heroku_app do |stage|
+        git_push(args[:commit] || git_parsed_tag(stage.tag), stage.repo, %w[--force])
+      end
+    end
+  end
+
+  desc "Enable maintenance mode"
+  task :maintenance do
+    each_heroku_app do |stage|
+      stage.maintenance :on
+    end
+  end
+
+  desc "Enable maintenance mode"
+  task :maintenance_on do
+    each_heroku_app do |stage|
+      stage.maintenance :on
+    end
+  end
+
+  desc "Disable maintenance mode"
+  task :maintenance_off do
+    each_heroku_app do |stage|
+      stage.maintenance :off
+    end
+  end
+end
+
+desc "Pushes the given commit, migrates and restarts (default: HEAD)"
+task :deploy, [:commit] => [:before_deploy] do |t, args|
+  each_heroku_app do |stage|
+    git_push(args[:commit] || git_parsed_tag(stage.tag), stage.repo)
+    stage.migrate
+  end
+  Rake::Task[:after_deploy].execute
+end
+
+namespace :deploy do
+  desc "Force-pushes the given commit, migrates and restarts (default: HEAD)"
+  task :force, [:commit] => [:before_deploy] do |t, args|
+    each_heroku_app do |stage|
+      git_push(args[:commit] || git_parsed_tag(stage.tag), stage.repo, %w[--force])
+      stage.migrate
+    end
+    Rake::Task[:after_deploy].execute
+  end
+end
+
+task :force_deploy do
+  raise Deprecated
+end
+
+desc "Callback before deploys"
+task :before_deploy do
+end
+
+desc "Callback after deploys"
+task :after_deploy do
+end
+
+desc "Captures a bundle on Heroku"
+task :capture do
+  raise Deprecated
+end
+
+desc "Opens a remote console"
+task :console do
+  each_heroku_app do |stage|
+    stage.run 'console'
+  end
+end
+
+desc "Restarts remote servers"
+task :restart do
+  each_heroku_app do |stage|
+    stage.restart
+  end
+end
+
+desc "Migrates and restarts remote servers"
+task :migrate do
+  each_heroku_app do |stage|
+    stage.migrate
+  end
+end
+
+desc "Shows the Heroku logs"
+task :logs do
+  each_heroku_app do |stage|
+    stage.logs
+  end
+end
+
+namespace :db do
+  task :pull do
+    each_heroku_app do |stage|
+      sh "heroku pgdumps:capture --app #{stage.app}"
+      dump = `heroku pgdumps --app #{stage.app}`.split("\n").last.split(" ").first
+      sh "mkdir -p #{Rails.root}/db/dumps"
+      file = "#{Rails.root}/db/dumps/#{dump}.sql.gz"
+      url = `heroku pgdumps:url --app #{stage.app} #{dump}`.chomp
+      sh "wget", url, "-O", file
+      sh "rake db:drop db:create"
+      sh "gunzip -c #{file} | #{Rails.root}/script/dbconsole"
+      sh "rake jobs:clear"
+    end
+  end
+end
+
+def each_heroku_app(&block)
+  @heroku_san.each_app(&block)
+  puts
+rescue HerokuSan::NoApps => e
+  puts "You must first specify at least one Heroku app:
+    rake <app> [<app>] <command>
+    rake production restart
+    rake demo staging deploy"
+
+  puts "\nYou can use also command all Heroku apps for this project:
+    rake all heroku:share"
+
+  exit(1)
+end

data/lib/templates/heroku.example.yml

@@ -1,15 +1,18 @@
 #
 # Format:
 # 
-# <heroku_san shorthand name>:
+# <stage name>:
 #   app: <Heroku app name>
 #   stack: <Heroku stack, optional>
+#   tag: <git tag pattern, optional>
+#   repo: <git repository, optional>
 #   config:
 #     - <Heroku config:var name>: <Heroku config:var value>
 #
 production: 
   app: awesomeapp
   stack: bamboo-ree-1.8.7
+  tag: production/*
   config:
     BUNDLE_WITHOUT: "development:test"
     GOOGLE_ANALYTICS: "UA-12345678-1"

data/spec/fixtures/example.yml

@@ -0,0 +1,26 @@
+#
+# Format:
+# 
+# <heroku_san shorthand name>:
+#   app: <Heroku app name>
+#   tag: <git tag pattern>
+#   config:
+#     - <Heroku config:var name>: <Heroku config:var value>
+#
+production: 
+  app: awesomeapp
+  tag: production/*
+  config:
+    BUNDLE_WITHOUT: "development:test"
+    GOOGLE_ANALYTICS: "UA-12345678-1"
+
+staging:
+  app: awesomeapp-staging
+  stack: bamboo-ree-1.8.7
+  config: &default
+    BUNDLE_WITHOUT: "development:test"
+
+demo: 
+  app: awesomeapp-demo
+  stack: cedar
+  config: *default

data/spec/fixtures/extended_config.yml

@@ -0,0 +1,7 @@
+config_repo: 'file:///<%= File.join(File.expand_path(File.dirname(__FILE__)), '..', '..', '..', 'features', 'data', 'test-config') %>'
+production: 
+  app: awesomeapp
+staging:
+  app: awesomeapp-staging
+demo: 
+  app: awesomeapp-demo

data/spec/fixtures/old_format.yml

@@ -0,0 +1,10 @@
+#
+# Format:
+# 
+# apps:
+#   shorthand: <Heroku app name>
+#
+apps:
+  production: awesomeapp
+  staging: awesomeapp-staging
+  demo: awesomeapp-demo

data/spec/fixtures/single_app.yml

@@ -0,0 +1,6 @@
+production: 
+  app: awesomeapp
+  tag: production/*
+  config:
+    BUNDLE_WITHOUT: "development:test"
+    GOOGLE_ANALYTICS: "UA-12345678-1"

data/spec/git_spec.rb

@@ -0,0 +1,55 @@
+require 'spec_helper'
+require 'git'
+
+class GitTest; include Git; end
+
+describe GitTest do
+  describe "#git_push" do    
+    it "pushes to heroku" do
+      subject.should_receive(:sh).with("git update-ref refs/heroku_san/deploy HEAD")
+      subject.should_receive(:sh).with("git push git@heroku.com:awesomeapp.git  refs/heroku_san/deploy:refs/heads/master")
+      subject.should_receive(:sh).with("git update-ref -d refs/heroku_san/deploy")
+      subject.git_push(nil, 'git@heroku.com:awesomeapp.git')
+    end
+    
+    it "pushes a specific commit to heroku" do
+      subject.should_receive(:sh).with("git update-ref refs/heroku_san/deploy kommit")
+      subject.should_receive(:sh).with("git push git@heroku.com:awesomeapp.git  refs/heroku_san/deploy:refs/heads/master")
+      subject.should_receive(:sh).with("git update-ref -d refs/heroku_san/deploy")
+      subject.git_push('kommit', 'git@heroku.com:awesomeapp.git')
+    end
+    
+    it "includes options, too" do
+      subject.should_receive(:sh).with("git update-ref refs/heroku_san/deploy HEAD")
+      subject.should_receive(:sh).with("git push git@heroku.com:awesomeapp.git --force -v refs/heroku_san/deploy:refs/heads/master")
+      subject.should_receive(:sh).with("git update-ref -d refs/heroku_san/deploy")
+      subject.git_push(nil, 'git@heroku.com:awesomeapp.git', %w[--force -v])
+    end
+  end
+
+  describe "#git_tag" do
+    it "returns the latest tag that matches the pattern" do
+      subject.should_receive("`").with("git tag -l 'pattern*'") { "x\n\y\n\z\n" }
+      subject.git_tag('pattern*').should == "z"
+    end
+    it "returns nil if no tags match the pattern" do
+      subject.should_receive("`").with("git tag -l 'pattern*'") { "\n" }
+      subject.git_tag('pattern*').should == nil
+    end
+    it "returns nil for a nil tag" do
+      subject.should_not_receive("`").with("git tag -l ''") { "\n" }
+      subject.git_tag(nil).should == nil
+    end
+  end
+  
+  describe "#git_rev_parse" do
+    it "returns the rev based on the tag" do
+      subject.should_receive("`").with("git rev-parse prod/1234567890") { "sha\n" }
+      subject.git_rev_parse('prod/1234567890').should == "sha"
+    end
+    it "returns nil for a blank tag" do
+      subject.should_not_receive("`").with("git rev-parse ") { "\n" }
+      subject.git_rev_parse(nil).should == nil
+    end
+  end
+end

data/spec/heroku_san/project_spec.rb

@@ -0,0 +1,107 @@
+require 'spec_helper'
+require 'tmpdir'
+
+describe HerokuSan::Project do
+  specify ".new with a missing config file" do
+    heroku_san = HerokuSan::Project.new("/u/should/never/get/here")
+    heroku_san.all.should == []
+  end
+  
+  context "using the example config file" do
+    let(:heroku_config_file) { File.join(SPEC_ROOT, "fixtures", "example.yml") }
+    let(:template_config_file) { 
+      path = File.join(SPEC_ROOT, "..", "lib/templates", "heroku.example.yml")
+      (File.respond_to? :realpath) ? File.realpath(path) : path
+    }
+    let(:heroku_san) { HerokuSan::Project.new(heroku_config_file) }
+    
+    it "#all" do
+      heroku_san.all.should =~ %w[production staging demo]
+    end
+    
+    context "using the heroku_san format" do
+      let(:heroku_san) { HerokuSan::Project.new(File.join(SPEC_ROOT, "fixtures", "old_format.yml")) }
+
+      it "returns a list of apps" do
+        heroku_san.all.should =~ %w[production staging demo]
+      end
+    end
+        
+    describe "Adding an app to the deploy list" do
+      it "appends known shorthands to apps" do
+        heroku_san.apps.should == []
+        heroku_san << 'production'
+        heroku_san.apps.should == %w[production]
+        heroku_san << 'staging'
+        heroku_san.apps.should == %w[production staging]
+        heroku_san << 'unknown'
+        heroku_san.apps.should == %w[production staging]
+      end
+    
+      it "appends .all (or any array)" do
+        heroku_san << heroku_san.all
+        heroku_san.apps.should == heroku_san.all
+      end
+    end
+    
+    describe "#apps extra default behaviors" do
+      specify "on a git branch that matches an app name" do
+        heroku_san.should_receive(:git_active_branch) { "staging" }
+        $stdout.should_receive(:puts).with("Defaulting to 'staging' as it matches the current branch")
+        heroku_san.apps.should == %w[staging]
+      end
+      
+      specify "on a git branch that doesn't matches an app name" do
+        heroku_san.should_receive(:git_active_branch) { "master" }
+        heroku_san.apps.should == %w[]
+      end
+      
+      context "but only a single configured app" do        
+        let(:heroku_san) { HerokuSan::Project.new(File.join(SPEC_ROOT, "fixtures", "single_app.yml")) }
+        it "returns the app" do
+          $stdout.should_receive(:puts).with('Defaulting to "production" since only one app is defined')
+          heroku_san.apps.should == %w[production]
+        end
+      end
+    end
+    
+    describe "#each_app" do    
+      it "raises an error is no apps were specified" do
+        expect { heroku_san.each_app do true; end }.to raise_error HerokuSan::NoApps
+      end
+      
+      it "yields to a block with args" do
+        heroku_san << 'production'
+        block = double('block')
+        block.should_receive(:action).with(heroku_san['production'])
+        heroku_san.each_app do |stage|
+          block.action(stage)
+        end
+      end
+    end
+    
+    describe "#[]" do
+      it "returns a config section" do
+        heroku_san.all.each do |app|
+          heroku_san[app].should be_a HerokuSan::Stage
+        end
+      end
+    end
+
+    describe "#create_config" do
+      it "creates a new file using the example file" do
+        Dir.mktmpdir do |dir|
+          tmp_config_file = File.join dir, 'config.yml'
+          heroku_san = HerokuSan::Project.new(tmp_config_file)
+          FileUtils.should_receive(:cp).with(File.expand_path(template_config_file), tmp_config_file)
+          heroku_san.create_config.should be_true
+        end
+      end
+      
+      it "does not overwrite an existing file" do
+        FileUtils.should_not_receive(:cp)
+        heroku_san.create_config.should be_false
+      end
+    end    
+  end
+end

data/spec/heroku_san/stage_spec.rb

@@ -0,0 +1,138 @@
+require 'spec_helper'
+
+describe HerokuSan::Stage do
+  subject { HerokuSan::Stage.new('production', {"app" => "awesomeapp", "stack" => "bamboo-ree-1.8.7"})}
+
+  context "initializes" do
+    subject { HerokuSan::Stage.new('production', 
+      {"stack" => "cedar", 
+       "app"   => "awesomeapp-demo", 
+       "tag"   => "demo/*", 
+       "config"=> {"BUNDLE_WITHOUT"=>"development:test"}
+      })}
+
+    its(:name)   { should == 'production' }
+    its(:app)    { should == 'awesomeapp-demo' }
+    its(:stack)  { should == 'cedar' }
+    its(:tag)    { should == "demo/*" }
+    its(:config) { should == {"BUNDLE_WITHOUT"=>"development:test"} }
+    its(:repo)   { should == 'git@heroku.com:awesomeapp-demo.git' }
+  end
+  
+  context "celadon cedar stack has a different API" do
+    describe "#stack" do
+      it "returns the name of the stack from Heroku" do
+        subject = HerokuSan::Stage.new('production', {"app" => "awesomeapp"})
+        subject.should_receive("`").with("heroku stack --app awesomeapp") {
+<<EOT
+  aspen-mri-1.8.6
+* bamboo-mri-1.9.2
+  bamboo-ree-1.8.7
+  cedar (beta)
+EOT
+        }
+        subject.stack.should == 'bamboo-mri-1.9.2'
+      end
+    
+      it "returns the stack name from the config if it is set there" do
+        subject = HerokuSan::Stage.new('production', {"app" => "awesomeapp", "stack" => "cedar"})
+        subject.should_not_receive("`")
+        subject.stack.should == 'cedar'
+      end
+    end
+        
+    describe "#run" do
+      it "runs commands using the pre-cedar format" do
+        subject.should_receive(:sh).with("heroku run:rake foo bar bleh --app awesomeapp")
+        subject.run 'rake', 'foo bar bleh'
+      end
+      it "runs commands using the new cedar format" do
+        subject = HerokuSan::Stage.new('production', {"app" => "awesomeapp", "stack" => "cedar"})
+        subject.should_receive(:sh).with("heroku run worker foo bar bleh --app awesomeapp")
+        subject.run 'worker', 'foo bar bleh'
+      end
+    end
+  end
+
+  describe "#migrate" do
+    it "runs rake db:migrate" do
+      subject.should_receive(:sh).with("heroku run:rake db:migrate --app awesomeapp")
+      subject.should_receive(:sh).with("heroku restart --app awesomeapp")
+      subject.migrate
+    end
+  end
+  
+  describe "#maintenance" do      
+    it ":on" do
+      subject.should_receive(:sh).with("heroku maintenance:on --app awesomeapp")
+      subject.maintenance :on
+    end
+
+    it ":off" do
+      subject.should_receive(:sh).with("heroku maintenance:off --app awesomeapp")
+      subject.maintenance :off
+    end
+    
+    it "otherwise raises an ArgumentError" do
+      expect do
+        subject.maintenance :busy
+      end.to raise_error ArgumentError, "Action #{:busy.inspect} must be one of (:on, :off)"      
+    end
+  end
+
+  describe "#create" do
+    it "creates an app on heroku" do
+      subject.should_receive(:sh).with("heroku apps:create awesomeapp --stack bamboo-ree-1.8.7")
+      subject.create
+    end
+    it "uses the default stack if none is given" do
+      subject = HerokuSan::Stage.new('production', {"app" => "awesomeapp"})
+      subject.should_receive(:sh).with("heroku apps:create awesomeapp")
+      subject.create
+    end
+  end
+  
+  describe "#sharing_add" do
+    it "add collaborators" do
+      subject.should_receive(:sh).with("heroku sharing:add email@example.com --app awesomeapp")
+      subject.sharing_add 'email@example.com'
+    end
+  end
+
+  describe "#sharing_remove" do
+    it "removes collaborators" do
+      subject.should_receive(:sh).with("heroku sharing:remove email@example.com --app awesomeapp")
+      subject.sharing_remove 'email@example.com'
+    end
+  end
+
+  describe "#long_config" do
+    it "prints out the remote config" do
+      subject.should_receive(:sh).with("heroku config --long --app awesomeapp") {
+<<EOT
+BUNDLE_WITHOUT      => development:test
+DATABASE_URL        => postgres://thnodhxrzn:T0-UwxLyFgXcnBSHmyhv@ec2-50-19-216-194.compute-1.amazonaws.com/thnodhxrzn
+LANG                => en_US.UTF-8
+RACK_ENV            => production
+SHARED_DATABASE_URL => postgres://thnodhxrzn:T0-UwxLyFgXcnBSHmyhv@ec2-50-19-216-194.compute-1.amazonaws.com/thnodhxrzn
+EOT
+      }
+      subject.long_config
+    end
+  end
+
+  describe "#restart" do
+    it "restarts an app" do
+      subject.should_receive(:sh).with("heroku restart --app awesomeapp")
+      subject.restart
+    end
+  end
+  
+  describe "#logs" do
+    it "returns log files" do
+      subject.should_receive(:sh).with("heroku logs --app awesomeapp")
+      subject.logs
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,21 @@
+require 'bundler'
+Bundler.setup
+
+SPEC_ROOT = File.dirname(__FILE__)
+
+# Requires supporting ruby files with custom matchers and macros, etc,
+# in spec/support/ and its subdirectories.
+Dir[File.join(SPEC_ROOT, "support/**/*.rb")].each {|f| require f}
+
+RSpec.configure do |config|
+  # == Mock Framework
+  #
+  # If you prefer to use mocha, flexmock or RR, uncomment the appropriate line:
+  #
+  # config.mock_with :mocha
+  # config.mock_with :flexmock
+  # config.mock_with :rr
+  config.mock_with :rspec
+end
+
+require File.join(SPEC_ROOT, '/../lib/heroku_san')