RubyGems - switchtower - Versions diffs - 0.9.0 - Mend

switchtower 0.9.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (30) hide show

data/bin/switchtower +11 -0
data/examples/sample.rb +113 -0
data/lib/switchtower.rb +1 -0
data/lib/switchtower/actor.rb +350 -0
data/lib/switchtower/cli.rb +220 -0
data/lib/switchtower/command.rb +85 -0
data/lib/switchtower/configuration.rb +193 -0
data/lib/switchtower/gateway.rb +106 -0
data/lib/switchtower/generators/rails/deployment/deployment_generator.rb +25 -0
data/lib/switchtower/generators/rails/deployment/templates/deploy.rb +116 -0
data/lib/switchtower/generators/rails/deployment/templates/switchtower.rake +33 -0
data/lib/switchtower/generators/rails/loader.rb +20 -0
data/lib/switchtower/logger.rb +56 -0
data/lib/switchtower/recipes/standard.rb +175 -0
data/lib/switchtower/recipes/templates/maintenance.rhtml +53 -0
data/lib/switchtower/scm/base.rb +43 -0
data/lib/switchtower/scm/cvs.rb +73 -0
data/lib/switchtower/scm/darcs.rb +27 -0
data/lib/switchtower/scm/subversion.rb +104 -0
data/lib/switchtower/ssh.rb +30 -0
data/lib/switchtower/version.rb +9 -0
data/test/actor_test.rb +261 -0
data/test/command_test.rb +43 -0
data/test/configuration_test.rb +210 -0
data/test/fixtures/config.rb +5 -0
data/test/scm/cvs_test.rb +164 -0
data/test/scm/subversion_test.rb +100 -0
data/test/ssh_test.rb +104 -0
data/test/utils.rb +41 -0
metadata +88 -0

data/lib/switchtower/recipes/templates/maintenance.rhtml ADDED Viewed

@@ -0,0 +1,53 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+       "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <meta http-equiv="content-type" content="text/html;charset=UTF-8" />
+  <title>System down for maintenance</title>
+  <style type="text/css">
+    div.outer {
+      position: absolute;
+      left: 50%;
+      top: 50%;
+      width: 500px;
+      height: 300px;
+      margin-left: -260px;
+      margin-top: -150px;
+    }
+    .DialogBody {
+      margin: 0;
+      padding: 10px;
+      text-align: left;
+      border: 1px solid #ccc;
+      border-right: 1px solid #999;
+      border-bottom: 1px solid #999;
+      background-color: #fff;
+    }
+    body { background-color: #fff; }
+  </style>
+</head>
+<body>
+  <div class="outer">
+     <div class="DialogBody" style="text-align: center;">
+       <div style="text-align: center; width: 200px; margin: 0 auto;">
+         <p style="color: red; font-size: 16px; line-height: 20px;">
+           The system is down for <%= reason ? reason : "maintenance" %>
+           as of <%= Time.now.strftime("%H:%M %Z") %>.
+         </p>
+         <p style="color: #666;">
+           It'll be back <%= deadline ? "by #{deadline}" : "shortly" %>.
+         </p>
+       </div>
+     </div>
+  </div>
+</body>
+</html>

data/lib/switchtower/scm/base.rb ADDED Viewed

@@ -0,0 +1,43 @@
+module SwitchTower
+  module SCM
+    # The ancestor class of the various SCM module implementations.
+    class Base
+      attr_reader :configuration
+      def initialize(configuration) #:nodoc:
+        @configuration = configuration
+      end
+      def latest_revision
+        nil
+      end
+      def current_revision(actor)
+        raise "#{self.class} doesn't support querying the deployed revision"
+      end
+      def diff(actor, from=nil, to=nil)
+        raise "#{self.class} doesn't support diff(from, to)"
+      end
+      private
+        def run_checkout(actor, guts, &block)
+          log = "#{configuration.deploy_to}/revisions.log"
+          directory = File.basename(configuration.release_path)
+          command = <<-STR
+            if [[ ! -d #{configuration.release_path} ]]; then
+              #{guts}
+              echo `date +"%Y-%m-%d %H:%M:%S"` $USER #{configuration.revision} #{directory} >> #{log};
+              chmod 666 #{log};
+            fi
+          STR
+          actor.run(command, &block)
+        end
+    end
+  end
+end

data/lib/switchtower/scm/cvs.rb ADDED Viewed

@@ -0,0 +1,73 @@
+require 'time'
+require 'switchtower/scm/base'
+module SwitchTower
+  module SCM
+    # An SCM module for using CVS as your source control tool. You can
+    # specify it by placing the following line in your configuration:
+    #
+    #   set :scm, :cvs
+    #
+    # Also, this module accepts a <tt>:cvs</tt> configuration variable,
+    # which (if specified) will be used as the full path to the cvs
+    # executable on the remote machine:
+    #
+    #   set :cvs, "/opt/local/bin/cvs"
+    #
+    # You can specify the location of your local copy (used to query
+    # the revisions, etc.) via the <tt>:local</tt> variable, which defaults to
+    # ".".
+    #
+    # Also, you can specify the CVS_RSH variable to use on the remote machine(s)
+    # via the <tt>:cvs_rsh</tt> variable. This defaults to the value of the
+    # CVS_RSH environment variable locally, or if it is not set, to "ssh".
+    class Cvs < Base
+      # Return a string representing the date of the last revision (CVS is
+      # seriously retarded, in that it does not give you a way to query when
+      # the last revision was made to the repository, so this is a fairly
+      # expensive operation...)
+      def latest_revision
+        return @latest_revision if @latest_revision
+        configuration.logger.debug "querying latest revision..."
+        @latest_revision = cvs_log(configuration.local).
+          split(/\r?\n/).
+          grep(/^date: (.*?);/) { Time.parse($1).strftime("%F %T") }.
+          sort.
+          last
+      end
+      # Check out (on all servers associated with the current task) the latest
+      # revision. Uses the given actor instance to execute the command.
+      def checkout(actor)
+        cvs = configuration[:cvs] || "cvs"
+        cvs_rsh = configuration[:cvs_rsh] || ENV['CVS_RSH'] || "ssh"
+        command = <<-CMD
+          cd #{configuration.releases_path};
+          CVS_RSH="#{cvs_rsh}" #{cvs} -d #{configuration.repository} -Q co -D "#{configuration.revision}" -d #{File.basename(actor.release_path)} #{actor.application};
+        CMD
+        run_checkout(actor, command) do |ch, stream, out|
+          prefix = "#{stream} :: #{ch[:host]}"
+          actor.logger.info out, prefix
+          if out =~ %r{password:}
+            actor.logger.info "CVS is asking for a password", prefix
+            ch.send_data "#{actor.password}\n"
+          elsif out =~ %r{^Enter passphrase}
+            message = "CVS needs your key's passphrase and cannot proceed"
+            actor.logger.info message, prefix
+            raise message
+          end
+        end
+      end
+      private
+        def cvs_log(path)
+          `cd #{path || "."} && cvs -q log -N -rHEAD`
+        end
+    end
+  end
+end

data/lib/switchtower/scm/darcs.rb ADDED Viewed

@@ -0,0 +1,27 @@
+require 'switchtower/scm/base'
+module SwitchTower
+  module SCM
+    # An SCM module for using darcs as your source control tool. Use it by
+    # specifying the following line in your configuration:
+    #
+    #   set :scm, :darcs
+    #
+    # Also, this module accepts a <tt>:darcs</tt> configuration variable,
+    # which (if specified) will be used as the full path to the darcs
+    # executable on the remote machine:
+    #
+    #   set :darcs, "/opt/local/bin/darcs"
+    class Darcs < Base
+      # Check out (on all servers associated with the current task) the latest
+      # revision. Uses the given actor instance to execute the command.
+      def checkout(actor)
+        darcs = configuration[:darcs] ? configuration[:darcs] : "darcs"
+        revision = configuration[:revision] ? %(--to-match "#{configuration.revision}") : ""
+        run_checkout(actor, "#{darcs} get -q --set-scripts-executable #{revision} #{configuration.repository} #{actor.release_path};")
+      end
+    end
+  end
+end

data/lib/switchtower/scm/subversion.rb ADDED Viewed

@@ -0,0 +1,104 @@
+require 'switchtower/scm/base'
+module SwitchTower
+  module SCM
+    # An SCM module for using subversion as your source control tool. This
+    # module is used by default, but you can explicitly specify it by
+    # placing the following line in your configuration:
+    #
+    #   set :scm, :subversion
+    #
+    # Also, this module accepts a <tt>:svn</tt> configuration variable,
+    # which (if specified) will be used as the full path to the svn
+    # executable on the remote machine:
+    #
+    #   set :svn, "/opt/local/bin/svn"
+    class Subversion < Base
+      # Return an integer identifying the last known revision in the svn
+      # repository. (This integer is currently the revision number.) If latest
+      # revision does not exist in the given repository, this routine will
+      # walk up the directory tree until it finds it.
+      def latest_revision
+        configuration.logger.debug "querying latest revision..." unless @latest_revision
+        repo = configuration.repository
+        until @latest_revision
+          match = svn_log(repo).scan(/r(\d+)/).first
+          @latest_revision = match ? match.first : nil
+          if @latest_revision.nil?
+            # if a revision number was not reported, move up a level in the path
+            # and try again.
+            repo = File.dirname(repo)
+          end
+        end
+        @latest_revision
+      end
+      # Return the number of the revision currently deployed.
+      def current_revision(actor)
+        latest = actor.releases.last
+        grep = %(grep " #{latest}$" #{configuration.deploy_to}/revisions.log)
+        result = ""
+        actor.run(grep, :once => true) do |ch, str, out|
+          result << out if str == :out
+          raise "could not determine current revision" if str == :err
+        end
+        date, time, user, rev, dir = result.split
+        raise "current revision not found in revisions.log" unless dir == latest
+        rev.to_i
+      end
+      # Return a string containing the diff between the two revisions. +from+
+      # and +to+ may be in any format that svn recognizes as a valid revision
+      # identifier. If +from+ is +nil+, it defaults to the last deployed
+      # revision. If +to+ is +nil+, it defaults to HEAD.
+      def diff(actor, from=nil, to=nil)
+        from ||= current_revision(actor)
+        to ||= "HEAD"
+        `svn diff #{configuration.repository}@#{from} #{configuration.repository}@#{to}`
+      end
+      # Check out (on all servers associated with the current task) the latest
+      # revision. Uses the given actor instance to execute the command. If
+      # svn asks for a password this will automatically provide it (assuming
+      # the requested password is the same as the password for logging into the
+      # remote server.)
+      def checkout(actor)
+        svn = configuration[:svn] ? configuration[:svn] : "svn"
+        command = "#{svn} co -q -r#{configuration.revision} #{configuration.repository} #{actor.release_path};"
+        run_checkout(actor, command) do |ch, stream, out|
+          prefix = "#{stream} :: #{ch[:host]}"
+          actor.logger.info out, prefix
+          if out =~ /^Password.*:/
+            actor.logger.info "subversion is asking for a password", prefix
+            ch.send_data "#{actor.password}\n"
+          elsif out =~ %r{\(yes/no\)}
+            actor.logger.info "subversion is asking whether to connect or not",
+              prefix
+            ch.send_data "yes\n"
+          elsif out =~ %r{passphrase}
+            message = "subversion needs your key's passphrase, sending empty string"
+            actor.logger.info message, prefix
+            ch.send_data "\n"
+          elsif out =~ %r{The entry \'(\w+)\' is no longer a directory}
+            message = "subversion can't update because directory '#{$1}' was replaced. Please add it to svn:ignore."
+            actor.logger.info message, prefix
+            raise message
+          end
+        end
+      end
+      private
+        def svn_log(path)
+          `svn log -q -rhead #{path}`
+        end
+    end
+  end
+end

data/lib/switchtower/ssh.rb ADDED Viewed

@@ -0,0 +1,30 @@
+require 'net/ssh'
+module SwitchTower
+  # A helper class for dealing with SSH connections.
+  class SSH
+    # An abstraction to make it possible to connect to the server via public key
+    # without prompting for the password. If the public key authentication fails
+    # this will fall back to password authentication.
+    #
+    # If a block is given, the new session is yielded to it, otherwise the new
+    # session is returned.
+    def self.connect(server, config, port=22, &block)
+      methods = [ %w(publickey hostbased), %w(password keyboard-interactive) ]
+      password_value = nil
+      begin
+        Net::SSH.start(server,
+          :username => config.user,
+          :password => password_value,
+          :port => port,
+          :auth_methods => methods.shift,
+          &block)
+      rescue Net::SSH::AuthenticationFailed
+        raise if methods.empty?
+        password_value = config.password
+        retry
+      end
+    end
+  end
+end

data/lib/switchtower/version.rb ADDED Viewed

@@ -0,0 +1,9 @@
+module SwitchTower
+  module Version #:nodoc:
+    MAJOR = 0
+    MINOR = 9
+    TINY  = 0
+    STRING = [MAJOR, MINOR, TINY].join(".")
+  end
+end

data/test/actor_test.rb ADDED Viewed

@@ -0,0 +1,261 @@
+$:.unshift File.dirname(__FILE__) + "/../lib"
+require 'stringio'
+require 'test/unit'
+require 'switchtower/actor'
+require 'switchtower/logger'
+class ActorTest < Test::Unit::TestCase
+  class TestingConnectionFactory
+    def initialize(config)
+    end
+    def connect_to(server)
+      server
+    end
+  end
+  class GatewayConnectionFactory
+    def connect_to(server)
+      server
+    end
+  end
+  class TestingCommand
+    def self.invoked!
+      @invoked = true
+    end
+    def self.invoked?
+      @invoked
+    end
+    def self.reset!
+      @invoked = nil
+    end
+    def initialize(*args)
+    end
+    def process!
+      self.class.invoked!
+    end
+  end
+  class TestActor < SwitchTower::Actor
+    attr_reader :factory
+    self.connection_factory = TestingConnectionFactory
+    self.command_factory = TestingCommand
+    def establish_gateway
+      GatewayConnectionFactory.new
+    end
+  end
+  class MockConfiguration
+    Role = Struct.new(:host, :options)
+    attr_accessor :gateway, :pretend
+    def delegated_method
+      "result of method"
+    end
+    ROLES = { :db  => [ Role.new("01.example.com", :primary => true),
+                        Role.new("02.example.com", {}),
+                        Role.new("all.example.com", {})],
+              :web => [ Role.new("03.example.com", {}),
+                        Role.new("04.example.com", {}),
+                        Role.new("all.example.com", {})],
+              :app => [ Role.new("05.example.com", {}),
+                        Role.new("06.example.com", {}),
+                        Role.new("07.example.com", {}),
+                        Role.new("all.example.com", {})] }
+    def roles
+      ROLES
+    end
+    def logger
+      @logger ||= SwitchTower::Logger.new(:output => StringIO.new)
+    end
+  end
+  def setup
+    TestingCommand.reset!
+    @actor = TestActor.new(MockConfiguration.new)
+  end
+  def test_define_task_creates_method
+    @actor.define_task :hello do
+      "result"
+    end
+    assert @actor.respond_to?(:hello)
+    assert_equal "result", @actor.hello
+  end
+  def test_define_task_with_successful_transaction
+    class << @actor
+      attr_reader :rolled_back
+      attr_reader :history
+    end
+    @actor.define_task :hello do
+      (@history ||= []) << :hello
+      on_rollback { @rolled_back = true }
+      "hello"
+    end
+    @actor.define_task :goodbye do
+      (@history ||= []) << :goodbye
+      transaction do
+        hello
+      end
+      "goodbye"
+    end
+    assert_nothing_raised { @actor.goodbye }
+    assert !@actor.rolled_back
+    assert_equal [:goodbye, :hello], @actor.history
+  end
+  def test_define_task_with_failed_transaction
+    class << @actor
+      attr_reader :rolled_back
+      attr_reader :history
+    end
+    @actor.define_task :hello do
+      (@history ||= []) << :hello
+      on_rollback { @rolled_back = true }
+      "hello"
+    end
+    @actor.define_task :goodbye do
+      (@history ||= []) << :goodbye
+      transaction do
+        hello
+        raise "ouch"
+      end
+      "goodbye"
+    end
+    assert_raise(RuntimeError) do
+      @actor.goodbye
+    end
+    assert @actor.rolled_back
+    assert_equal [:goodbye, :hello], @actor.history
+  end
+  def test_delegates_to_configuration
+    @actor.define_task :hello do
+      delegated_method
+    end
+    assert_equal "result of method", @actor.hello
+  end
+  def test_task_servers_with_duplicates
+    @actor.define_task :foo do
+      run "do this"
+    end
+    assert_equal %w(01.example.com 02.example.com 03.example.com 04.example.com 05.example.com 06.example.com 07.example.com all.example.com), @actor.tasks[:foo].servers(@actor.configuration).sort
+  end
+  def test_run_in_task_without_explicit_roles_selects_all_roles
+    @actor.define_task :foo do
+      run "do this"
+    end
+    @actor.foo
+    assert_equal %w(01.example.com 02.example.com 03.example.com 04.example.com 05.example.com 06.example.com 07.example.com all.example.com), @actor.sessions.keys.sort
+  end
+  def test_run_in_task_with_single_role_selects_that_role
+    @actor.define_task :foo, :roles => :db do
+      run "do this"
+    end
+    @actor.foo
+    assert_equal %w(01.example.com 02.example.com all.example.com), @actor.sessions.keys.sort
+  end
+  def test_run_in_task_with_multiple_roles_selects_those_roles
+    @actor.define_task :foo, :roles => [:db, :web] do
+      run "do this"
+    end
+    @actor.foo
+    assert_equal %w(01.example.com 02.example.com 03.example.com 04.example.com all.example.com), @actor.sessions.keys.sort
+  end
+  def test_run_in_task_with_only_restricts_selected_roles
+    @actor.define_task :foo, :roles => :db, :only => { :primary => true } do
+      run "do this"
+    end
+    @actor.foo
+    assert_equal %w(01.example.com), @actor.sessions.keys.sort
+  end
+  def test_establish_connection_uses_gateway_if_specified
+    @actor.configuration.gateway = "10.example.com"
+    @actor.define_task :foo, :roles => :db do
+      run "do this"
+    end
+    @actor.foo
+    assert_instance_of GatewayConnectionFactory, @actor.factory
+  end
+  def test_run_when_not_pretend
+    @actor.define_task :foo do
+      run "do this"
+    end
+    @actor.configuration.pretend = false
+    @actor.foo
+    assert TestingCommand.invoked?
+  end
+  def test_run_when_pretend
+    @actor.define_task :foo do
+      run "do this"
+    end
+    @actor.configuration.pretend = true
+    @actor.foo
+    assert !TestingCommand.invoked?
+  end
+  def test_task_before_hook
+    history = []
+    @actor.define_task :foo do
+      history << "foo"
+    end
+    @actor.define_task :before_foo do
+      history << "before_foo"
+    end
+    @actor.foo
+    assert_equal %w(before_foo foo), history
+  end
+  def test_task_after_hook
+    history = []
+    @actor.define_task :foo do
+      history << "foo"
+    end
+    @actor.define_task :after_foo do
+      history << "after_foo"
+    end
+    @actor.foo
+    assert_equal %w(foo after_foo), history
+  end
+end