takeoff 0.0.1

data/lib/takeoff/plan/default.rb

@@ -0,0 +1,36 @@
+require "takeoff/plan/base"
+
+require "takeoff/stage/log"
+require "takeoff/stage/look_out_for_danger"
+require "takeoff/stage/stash_changes"
+require "takeoff/stage/checkout_development_branch"
+require "takeoff/stage/verify_github_up_to_date"
+require "takeoff/stage/point_checkpoint_to_development"
+require "takeoff/stage/push_to_github"
+
+module Takeoff
+  module Plan
+    class Default < Base
+      env.merge!(
+        environment:        "production",
+        github_remote:      "github",
+        development_branch: "develop",
+        checkpoint_branch:  "master"
+      )
+      
+      stages do
+        use Stage::Log
+        use Stage::LookOutForDanger
+
+        use Stage::StashChanges
+        use Stage::CheckoutDevelopmentBranch
+        
+        use Stage::VerifyGithubUpToDate
+
+        use Stage::PointCheckpointToDevelopment
+
+        use Stage::PushToGithub
+      end
+    end
+  end
+end

data/lib/takeoff/plan/heroku.rb

@@ -0,0 +1,41 @@
+require "takeoff/plan/default"
+
+require "takeoff/stage/heroku/remember_commits"
+require "takeoff/stage/heroku/verify_server_not_already_up_to_date"
+require "takeoff/stage/heroku/disable_preboot"
+require "takeoff/stage/heroku/scale_down_workers"
+require "takeoff/stage/heroku/enable_maintenance_mode"
+require "takeoff/stage/heroku/push_to_server"
+require "takeoff/stage/heroku/migrate_database"
+
+module Takeoff
+  module Plan
+    class Heroku < Default
+      env.merge!(
+        server_remote: "heroku"
+      )
+
+      stages do
+        insert_after Stage::Log,
+          Stage::Heroku::RememberCommits
+
+        insert_after Stage::VerifyGithubUpToDate, 
+          Stage::Heroku::VerifyServerNotAlreadyUpToDate
+
+        insert_after Stage::PointCheckpointToDevelopment, [
+          Stage::Heroku::DisablePreboot,
+          Stage::Heroku::ScaleDownWorkers,
+          Stage::Heroku::EnableMaintenanceMode,
+
+          Stage::Heroku::PushToServer,
+
+          Stage::Heroku::MigrateDatabase
+        ]
+      end
+    end
+  end
+end
+
+Takeoff.configure do
+  plan :heroku, Takeoff::Plan::Heroku
+end

data/lib/takeoff/stage/base.rb

@@ -0,0 +1,17 @@
+require "takeoff/helpers"
+
+module Takeoff
+  module Stage
+    class Base
+      include Helpers
+      
+      def initialize(app)
+        @app = app
+      end
+
+      def call(env)
+        raise NotImplementedError
+      end
+    end
+  end
+end

data/lib/takeoff/stage/checkout_development_branch.rb

@@ -0,0 +1,24 @@
+require "takeoff/stage/base"
+
+module Takeoff
+  module Stage
+    class CheckoutDevelopmentBranch < Base
+      def call(env)
+        previous_branch = `git rev-parse --abbrev-ref HEAD`.strip
+        previous_branch = `git rev-parse --verify HEAD`.strip if previous_branch == "HEAD"
+
+        return @app.call(env) if previous_branch == env[:development_branch]
+
+        log     "Checking out development branch"
+        execute "git checkout #{env[:development_branch]}"
+
+        begin
+          @app.call(env)
+        ensure
+          log     "Checking out original branch '#{previous_branch}'"
+          execute "git checkout #{previous_branch}"
+        end
+      end
+    end
+  end
+end

data/lib/takeoff/stage/heroku/disable_preboot.rb

@@ -0,0 +1,37 @@
+require "takeoff/stage/base"
+
+module Takeoff
+  module Stage
+    module Heroku
+      class DisablePreboot < Base
+        def run?(env)
+          features = `heroku features --remote #{env[:server_remote]}`
+          preboot_line = features.split("\n").find { |feature| feature =~ /\A\[[+ ]\] preboot/ }
+          preboot_enabled = preboot_line.start_with?("[+]")
+
+          preboot_enabled
+        end
+
+        def call(env)
+          unless env[:dangerous]
+            log "Skipping disabling preboot because nothing dangerous is going on"
+
+            return @app.call(env) 
+          end
+
+          return @app.call(env) unless run?(env)
+
+          log     "Disabling preboot"
+          execute "heroku features:disable preboot --remote #{env[:server_remote]}"
+
+          begin
+            @app.call(env)
+          ensure
+            log     "Enabling preboot"
+            execute "heroku features:enable preboot --remote #{env[:server_remote]}"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/takeoff/stage/heroku/enable_maintenance_mode.rb

@@ -0,0 +1,27 @@
+require "takeoff/stage/base"
+
+module Takeoff
+  module Stage
+    module Heroku
+      class EnableMaintenanceMode < Base
+        def call(env)
+          unless env[:dangerous]
+            log "Skipping maintenance mode because nothing dangerous is going on"
+            
+            return @app.call(env) 
+          end
+
+          log     "Enabling maintenance mode"
+          execute "heroku maintenance:on --remote #{env[:server_remote]}"
+
+          begin
+            @app.call(env)
+          ensure
+            log     "Disabling maintenance mode"
+            execute "heroku maintenance:off --remote #{env[:server_remote]}"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/takeoff/stage/heroku/migrate_database.rb

@@ -0,0 +1,52 @@
+require "takeoff/stage/base"
+
+module Takeoff
+  module Stage
+    module Heroku
+      class MigrateDatabase < Base
+        def self.dangerous?(env)
+          new(nil).dangerous?(env)
+        end
+
+        def dangerous?(env)
+          return @dangerous if defined?(@dangerous)
+
+          return @dangerous = false unless run?(env)
+
+          diff = diff(env[:deployed_commit], env[:new_commit], ["db/migrate"])
+          
+          unsafe_active_record_terms  = /change_column|change_table|drop_table|remove_column|remove_index|rename_column|execute/
+          unsafe_mongoid_terms        = /renameCollection|\.drop|$rename|$set|$unset|indexes\.create|indexes\.drop/
+          unsafe_terms = Regexp.union(unsafe_active_record_terms, unsafe_mongoid_terms)
+
+          @dangerous = diff.split("\n").any? do |line|
+            line =~ unsafe_terms && line !~ /#\s*safe/i
+          end
+        end
+
+        def run?(env)
+          files_have_changed?(env[:deployed_commit], env[:new_commit], ["db/migrate"])
+        end
+        
+        def call(env)
+          unless run?(env)
+            log "Skipping database migrations"
+
+            return @app.call(env) 
+          end
+
+          log     "Running database migrations"
+          execute "heroku run rake db:migrate --remote #{env[:server_remote]}"
+
+          # If ActiveRecord needs to rebuild its column name cache, restart the app.
+          if dangerous?(env)
+            log     "Restarting application"
+            execute "heroku restart --remote #{env[:server_remote]}"
+          end
+
+          @app.call(env)
+        end
+      end
+    end
+  end
+end

data/lib/takeoff/stage/heroku/precompile_and_sync_assets.rb

@@ -0,0 +1,45 @@
+require "takeoff/stage/base"
+
+module Takeoff
+  module Stage
+    module Heroku
+      class PrecompileAndSyncAssets < Base
+        def run?(env)
+          files = %w(app/assets lib/assets vendor/asset Gemfile.lock config/initializers/assets.rb)
+          files_have_changed?(env[:deployed_commit], env[:new_commit], files)
+        end
+
+        def call(env)
+          unless run?(env)
+            log "Skipping precompilation of assets"
+            
+            return @app.call(env)
+          end
+
+          begin
+            log     "Precompiling assets"
+            execute "RAILS_ENV=#{env[:environment]} bundle exec rake assets:precompile"
+
+            log     "Syncing assets"
+            execute "RAILS_ENV=#{env[:environment]} bundle exec rake assets:sync"
+
+            if file_has_changed_locally?("public/assets/manifest-#{env[:environment]}.json")
+              log     "Committing updated asset manifests"
+              execute "git add public/assets/manifest-#{env[:environment]}.json"            
+              execute "git commit -m 'Update asset manifest for #{env[:environment]}.' -m '[ci skip]'"
+
+              log     "Pushing development branch to GitHub"
+              execute "git push github #{env[:development_branch]}:#{env[:development_branch]} --force"
+            end
+          ensure
+            log     "Deleting precompiled assets"
+            execute "git ls-files -o --exclude-standard public/assets | xargs rm"
+            # We can't use `rm -r ./public/assets` because we still need the manifest files.
+          end
+
+          @app.call(env)
+        end
+      end
+    end
+  end
+end

data/lib/takeoff/stage/heroku/push_to_server.rb

@@ -0,0 +1,16 @@
+require "takeoff/stage/base"
+
+module Takeoff
+  module Stage
+    module Heroku
+      class PushToServer < Base
+        def call(env)
+          log     "Pushing to server"
+          execute "git push #{env[:server_remote]} #{env[:checkpoint_branch]}:master --force"
+
+          @app.call(env)
+        end
+      end
+    end
+  end
+end

data/lib/takeoff/stage/heroku/remember_commits.rb

@@ -0,0 +1,19 @@
+require "takeoff/stage/base"
+
+module Takeoff
+  module Stage
+    module Heroku
+      class RememberCommits < Base      
+        def call(env)
+          log     "Fetching from server"
+          execute "git fetch #{env[:server_remote]}"
+          
+          env[:deployed_commit] = latest_commit("#{env[:server_remote]}/master")
+          env[:new_commit]      = latest_commit(env[:development_branch])
+
+          @app.call(env)
+        end
+      end
+    end
+  end
+end

data/lib/takeoff/stage/heroku/scale_down_workers.rb

@@ -0,0 +1,33 @@
+require "takeoff/stage/base"
+
+module Takeoff
+  module Stage
+    module Heroku
+      class ScaleDownWorkers < Base
+        def call(env)
+          unless env[:dangerous]
+            log "Skipping scaling down workers because nothing dangerous is going on"
+            
+            return @app.call(env) 
+          end
+          
+          number_of_workers = execute(
+            "heroku ps --remote #{env[:server_remote]} | grep '^worker.' | wc -l | tr -d ' '"
+          ).to_i
+
+          return @app.call(env) if number_of_workers == 0
+
+          log     "Scaling down workers"
+          execute "heroku scale worker=0 --remote #{env[:server_remote]}"
+
+          begin
+            @app.call(env)
+          ensure
+            log     "Scaling up workers"
+            execute "heroku scale worker=#{number_of_workers || 0} --remote #{env[:server_remote]}"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/takeoff/stage/heroku/verify_server_not_already_up_to_date.rb

@@ -0,0 +1,17 @@
+require "takeoff/stage/base"
+
+module Takeoff
+  module Stage
+    module Heroku
+      class VerifyServerNotAlreadyUpToDate < Base
+        def call(env)
+          if env[:deployed_commit] == env[:new_commit]
+            raise "The server is already up to date."
+          end
+
+          @app.call(env)
+        end
+      end
+    end
+  end
+end

data/lib/takeoff/stage/heroku/verify_staging_up_to_date.rb

@@ -0,0 +1,28 @@
+require "takeoff/stage/base"
+
+module Takeoff
+  module Stage
+    module Heroku
+      class VerifyStagingUpToDate < Base
+        def call(env)
+          unless Takeoff.plan?("staging")
+            log "WARNING: Skipping verification that the staging server is up to date because a launch plan for the staging environment has not been set up"
+            
+            return @app.call(env)
+          end
+
+          staging_takeoff = Takeoff[:staging]
+
+          log     "Fetching from staging server"
+          execute "git fetch #{staging_takeoff.env[:server_remote]}"
+
+          unless branches_up_to_date?("#{staging_takeoff.env[:server_remote]}/master", env[:development_branch])
+            raise "The staging server is not up to date with branch '#{env[:development_branch]}'. Deploy to staging first."
+          end
+
+          @app.call(env)
+        end
+      end
+    end
+  end
+end

data/lib/takeoff/stage/log.rb

@@ -0,0 +1,28 @@
+require "takeoff/stage/base"
+
+module Takeoff
+  module Stage
+    class Log < Base      
+      def call(env)
+        log "Ready for takeoff! Deploying to #{env[:environment]} server..."
+
+        start_time = Time.now
+
+        begin
+          @app.call(env)
+        rescue
+          end_time = Time.now
+
+          log "Deploying failed in #{end_time - start_time} seconds. Takeoff unsuccessful."
+          puts
+
+          raise
+        else
+          end_time = Time.now
+
+          log "Deploying finished in #{end_time - start_time} seconds. Takeoff successful."
+        end
+      end
+    end
+  end
+end

data/lib/takeoff/stage/look_out_for_danger.rb

@@ -0,0 +1,15 @@
+require "takeoff/stage/base"
+
+module Takeoff
+  module Stage
+    class LookOutForDanger < Base      
+      def call(env)
+        env[:stages]            = env[:plan].stages.middlewares
+        env[:dangerous_stages]  = env[:stages].select { |stage| stage.respond_to?(:dangerous?) && stage.dangerous?(env) }
+        env[:dangerous]         = env[:dangerous_stages].count > 0
+
+        @app.call(env)
+      end
+    end
+  end
+end

data/lib/takeoff/stage/point_checkpoint_to_development.rb

@@ -0,0 +1,22 @@
+require "takeoff/stage/base"
+
+module Takeoff
+  module Stage
+    class PointCheckpointToDevelopment < Base
+      def call(env)
+        return @app.call(env) if env[:development_branch] == env[:checkpoint_branch]
+
+        log     "Pointing checkpoint branch to development branch"
+        execute "git checkout #{env[:checkpoint_branch]}"
+
+        begin
+          execute "git reset --hard #{env[:development_branch]}"
+        ensure
+          execute "git checkout #{env[:development_branch]}"
+        end
+
+        @app.call(env)
+      end
+    end
+  end
+end

data/lib/takeoff/stage/push_to_github.rb

@@ -0,0 +1,14 @@
+require "takeoff/stage/base"
+
+module Takeoff
+  module Stage
+    class PushToGithub < Base      
+      def call(env)
+        log     "Pushing checkpoint branch to GitHub"
+        execute "git push github #{env[:checkpoint_branch]}:#{env[:checkpoint_branch]} --force"
+
+        @app.call(env)
+      end
+    end
+  end
+end

data/lib/takeoff/stage/stash_changes.rb

@@ -0,0 +1,31 @@
+require "takeoff/stage/base"
+
+module Takeoff
+  module Stage
+    class StashChanges < Base      
+      def call(env)
+        status = `git status --untracked-files --short`
+        return @app.call(env) if status.blank?
+
+        stash_name = "Takeoff Auto-Stash: #{Time.now}"
+
+        log     "Stashing uncommitted changes"
+        execute "git stash save -u #{Shellwords.escape(stash_name)}"
+
+        begin
+          @app.call(env)
+        ensure
+          log "Applying previously stashed uncommitted changes"
+
+          stashes       = `git stash list`
+          matched_stash = stashes.split("\n").find { |stash| stash.include?(stash_name) }
+          label         = matched_stash.match(/^([^:]+)/)
+
+          execute "git clean -fd"
+          execute "git stash apply #{label}"
+          execute "git stash drop #{label}"
+        end
+      end
+    end
+  end
+end

data/lib/takeoff/stage/verify_circle_ci_status.rb

@@ -0,0 +1,46 @@
+require "uri"
+require "net/http"
+require "json"
+
+require "takeoff/stage/base"
+
+module Takeoff
+  module Stage
+    class VerifyCircleCiStatus < Base      
+      def call(env)
+        unless env[:github_repo] && ENV["GITHUB_OAUTH_TOKEN"]
+          log "WARNING: Skipping verification of Circle CI status because GitHub repo or OAuth token isn't set."
+
+          return @app.call(env)
+        end
+
+        raise "A GitHub OAuth token is required to check the Circle CI status." unless ENV["GITHUB_OAUTH_TOKEN"]
+
+        sha = latest_commit(env[:development_branch])
+
+        uri = URI.parse("https://api.github.com/repos/#{env[:github_repo]}/statuses/#{sha}")
+
+        connection = Net::HTTP.new(uri.host, uri.port)
+        connection.use_ssl = true
+
+        request = Net::HTTP::Get.new(uri.request_uri)
+        request["Authorization"] = "token #{ENV["GITHUB_OAUTH_TOKEN"]}"
+        response = connection.request(request)
+
+        statuses = JSON.parse(response.body)
+
+        if statuses.find { |s| s["state"] == "success" }
+          # Success
+        elsif status = statuses.find { |s| %w(failure error).include?(s["state"]) }
+          raise "The Circle CI tests for branch '#{env[:development_branch]}' (commit #{sha}) failed. Fix them and try again. See #{status["target_url"]}"
+        elsif status = statuses.find { |s| s["state"] == "pending"}
+          raise "The Circle CI tests for branch '#{env[:development_branch]}' (commit #{sha}) are still running. Wait for them to finish successfully. See #{status["target_url"]}"
+        else
+          raise "The Circle CI tests for branch '#{env[:development_branch]}' (commit #{sha}) have not run yet. Wait for them to start and finish successfully."
+        end
+
+        @app.call(env)
+      end
+    end
+  end
+end

data/lib/takeoff/stage/verify_github_up_to_date.rb

@@ -0,0 +1,18 @@
+require "takeoff/stage/base"
+
+module Takeoff
+  module Stage
+    class VerifyGithubUpToDate < Base      
+      def call(env)
+        log     "Fetching from GitHub"
+        execute "git fetch #{env[:github_remote]}"
+
+        unless branches_up_to_date?("#{env[:github_remote]}/#{env[:development_branch]}", env[:development_branch])
+          raise "GitHub is not up to date on branch '#{env[:development_branch]}'. Pull and push to synchronize your changes first."
+        end
+
+        @app.call(env)
+      end
+    end
+  end
+end

data/lib/takeoff/version.rb

@@ -0,0 +1,3 @@
+module Takeoff
+  VERSION = "0.0.1"
+end

data/lib/takeoff.rb

@@ -0,0 +1,44 @@
+require "active_support/core_ext"
+
+require "takeoff/version"
+require "takeoff/configuration"
+
+require "takeoff/plan/base"
+require "takeoff/plan/default"
+
+module Takeoff
+  class << self
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def configure(source = nil, source_location = nil, &block)
+      if source
+        if source_location
+          configuration.instance_eval(source, source_location) 
+        else
+          configuration.instance_eval(source) 
+        end
+      end
+
+      if block
+        if block.arity == 1
+          block.call(configuration)
+        else
+          configuration.instance_eval(&block)
+        end
+      end
+    end
+
+    delegate :plans, :[], :plan?, :default_plan, to: :configuration
+
+    def logger
+      @logger ||= Logger.new
+    end
+  end
+
+  configure do
+    plan :base,     Plan::Base
+    plan :default,  Plan::Default
+  end
+end

data/takeoff.gemspec

@@ -0,0 +1,23 @@
+$:.unshift File.expand_path("../lib", __FILE__)
+require "takeoff/version"
+
+Gem::Specification.new do |spec|
+  spec.name           = "takeoff"
+  spec.version        = Takeoff::VERSION
+  spec.author         = "Douwe Maan"
+  spec.email          = "douwe@selenight.nl"
+  spec.summary        = "Sit back, relax and let Takeoff deploy your app."
+  spec.description    = "Takeoff is a command line tool that helps you deploy your web applications. Configure it once, and from then on Takeoff will take care of responsibly deploying your app, giving you time to get more coffee."
+  spec.homepage       = "https://github.com/DouweM/takeoff"
+  spec.license        = "MIT"
+  
+  spec.files          = `git ls-files -z`.split("\x0")
+  spec.executables    = ["takeoff"]
+  spec.require_paths  = ["lib"]
+  
+  spec.add_dependency "activesupport"
+  spec.add_dependency "middleware"
+  spec.add_dependency "thor"
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+end