nuex-vlad 1.3.2

data/lib/vlad/perforce.rb

@@ -0,0 +1,117 @@
+class Vlad::Perforce
+
+  set :p4_cmd, "p4"
+  set :source, Vlad::Perforce.new
+
+  ##
+  # Returns the p4 command that will checkout +revision+ into the directory
+  # +destination+.
+
+  def checkout(revision, destination)
+    "#{p4_cmd} sync ...#{rev_no(revision)}"
+  end
+
+  ##
+  # Returns the p4 command that will export +revision+ into the directory
+  # +directory+.
+
+  def export(revision_or_source, destination)
+    if revision_or_source =~ /^(\d+|head)$/i then
+      "(cd #{destination} && #{p4_cmd} sync ...#{rev_no(revision_or_source)})"
+    else
+      "cp -r #{revision_or_source} #{destination}"
+    end
+  end
+
+  ##
+  # Returns a command that maps human-friendly revision identifier +revision+
+  # into a Perforce revision specification.
+
+  def revision(revision)
+    "`#{p4_cmd} changes -s submitted -m 1 ...#{rev_no(revision)} | cut -f 2 -d\\ `"
+  end
+
+  ##
+  # Maps revision +revision+ into a Perforce revision.
+
+  def rev_no(revision)
+    case revision.to_s
+    when /head/i then
+      "#head"
+    when /^\d+$/ then
+      "@#{revision}"
+    else
+      revision
+    end
+  end
+end
+
+namespace :vlad do
+  remote_task :setup_app, :roles => :app do
+    p4data = p4port = p4user = p4passwd = nil
+
+    if ENV['P4CONFIG'] then
+      p4config_name = ENV['P4CONFIG']
+      p4config = nil
+      orig_dir = Dir.pwd.split File::SEPARATOR
+
+      until orig_dir.length == 1 do
+        p4config = orig_dir + [p4config_name]
+        p4config = File.join p4config
+        break if File.exist? p4config
+        orig_dir.pop
+      end
+
+      raise "couldn't find .p4config" unless File.exist? p4config
+
+      p4data = File.readlines(p4config).map { |line| line.strip.split '=', 2 }
+      p4data = Hash[*p4data.flatten]
+    else
+      p4data = ENV
+    end
+
+    p4port = p4data['P4PORT']
+    p4user = p4data['P4USER']
+    p4passwd = p4data['P4PASSWD']
+
+    raise "couldn't get P4PORT" if p4port.nil?
+    raise "couldn't get P4USER" if p4user.nil?
+    raise "couldn't get P4PASSWD" if p4passwd.nil?
+
+    p4client = [p4user, target_host, application].join '-'
+
+    require 'tmpdir'
+    require 'tempfile'
+
+    put File.join(scm_path, '.p4config'), 'vlad.p4config' do
+      [ "P4PORT=#{p4port}",
+        "P4USER=#{p4user}",
+        "P4PASSWD=#{p4passwd}",
+        "P4CLIENT=#{p4client}" ].join("\n")
+    end
+
+    p4client_path = File.join deploy_to, 'p4client.tmp'
+
+    put p4client_path, 'vlad.p4client' do
+      conf = <<-"CLIENT"
+Client:	#{p4client}
+
+Owner:	#{p4user}
+
+Root:	#{scm_path}
+
+View:
+  #{repository}/... //#{p4client}/...
+      CLIENT
+    end
+
+    cmds = [
+      "cd #{scm_path}",
+      "p4 client -i < #{p4client_path}",
+      "rm #{p4client_path}",
+    ]
+
+    run cmds.join(' && ')
+  end
+end
+

data/lib/vlad/subversion.rb

@@ -0,0 +1,35 @@
+class Vlad::Subversion
+
+  set :source, Vlad::Subversion.new
+  set :svn_cmd, "svn"
+
+  ##
+  # Returns the command that will check out +revision+ from the repository
+  # into directory +destination+
+
+  def checkout(revision, destination)
+    "#{svn_cmd} co -r #{revision} #{repository} #{destination}"
+  end
+
+  ##
+  # Returns the command that will export +revision+ from the repository into
+  # the directory +destination+.
+
+  def export(revision_or_source, destination)
+    "#{svn_cmd} #{deploy_via} " +
+      if revision_or_source =~ /^(\d+|head)$/i then
+        "-r #{revision_or_source} #{repository} #{destination}"
+      else
+        "#{revision_or_source} #{destination}"
+      end
+  end
+
+  ##
+  # Returns a command that maps human-friendly revision identifier +revision+
+  # into a subversion revision specification.
+
+  def revision(revision)
+    "`#{svn_cmd} info #{repository} | grep 'Revision:' | cut -f2 -d\\ `"
+  end
+end
+

data/lib/vlad/thin.rb

@@ -0,0 +1,63 @@
+# $GEM_HOME/gems/vlad-1.2.0/lib/vlad/thin.rb
+# Thin tasks for Vlad the Deployer
+# By cnantais
+require 'vlad'
+
+namespace :vlad do
+  ##
+  # Thin app server
+
+  set :thin_address,       "127.0.0.1"
+  set :thin_command,       'thin'
+  set(:thin_conf)          { "#{shared_path}/thin_cluster.conf" }
+  set :thin_environment,   "production"
+  set :thin_group,         nil
+  set :thin_log_file,      nil
+  set :thin_pid_file,      nil
+  set :thin_port,          nil
+  set :thin_socket,        "/tmp/thin.sock"
+  set :thin_prefix,        nil
+  set :thin_servers,       2
+  set :thin_user,          nil
+  set :thin_rackup,        nil
+
+  desc "Prepares application servers for deployment. thin
+configuration is set via the thin_* variables.".cleanup
+
+  remote_task :setup_app, :roles => :app do
+    cmd = [
+           "#{thin_command} config",
+           "-s #{thin_servers}",
+           "-S #{thin_socket}",
+           "-e #{thin_environment}",
+           "-c #{current_path}",
+           "-C #{thin_conf}",
+           ("-a #{thin_address}"      if thin_address),
+           ("-R #{thin_rackup}"       if thin_rackup),
+           ("-P #{thin_pid_file}"     if thin_pid_file),
+           ("-l #{thin_log_file}"     if thin_log_file),
+           ("--user #{thin_user}"     if thin_user),
+           ("--group #{thin_group}"   if thin_group),
+           ("--prefix #{thin_prefix}" if thin_prefix),
+           ("-p #{thin_port}"         if thin_port),
+          ].compact.join ' '
+
+    run cmd
+  end
+
+  def thin(cmd) # :nodoc:
+    "#{thin_command} #{cmd} -C #{thin_conf}"
+  end
+
+  desc "Restart the app servers"
+
+  remote_task :start_app, :roles => :app do
+    run thin("restart -s #{thin_servers}")
+  end
+
+  desc "Stop the app servers"
+
+  remote_task :stop_app, :roles => :app do
+    run thin("stop -s #{thin_servers}")
+  end
+end

data/lib/vlad.rb

@@ -0,0 +1,91 @@
+require 'rubygems'
+require 'thread'
+require 'rake_remote_task'
+
+$TESTING ||= false
+
+##
+# Vlad the Deployer - Pragmatic application deployment automation, without mercy.
+#
+# Please read doco/getting_started.txt or http://rubyhitsquad.com/
+#
+# === Basic scenario:
+#
+# 1. rake vlad:setup   (first time only)
+# 2. rake vlad:update
+# 3. rake vlad:migrate (optional)
+# 4. rake vlad:start
+
+module Vlad
+
+  ##
+  # This is the version of Vlad you are running.
+  VERSION = '1.4.0'
+
+  ##
+  # Base error class for all Vlad errors.
+  class Error < RuntimeError; end
+
+  ##
+  # Raised when you have incorrectly configured Vlad.
+  class ConfigurationError < Error; end
+
+  ##
+  # Raised when a remote command fails.
+  class CommandFailedError < Error; end
+
+  ##
+  # Raised when an environment variable hasn't been set.
+  class FetchError < Error; end
+
+  ##
+  # Loads tasks file +tasks_file+ and various recipe styles as a hash
+  # of category/style pairs. Recipes default to:
+  #
+  #     :app    => :passenger
+  #     :config => 'config/deploy.rb'
+  #     :core   => :core
+  #     :scm    => :subversion
+  #     :web    => :apache
+  #
+  # You can override individual values and/or set to nil to
+  # deactivate. :config will get loaded last to ensure that user
+  # variables override default values.
+  #
+  # And by all means, feel free to skip this entirely if it doesn't
+  # fit for you. All it does is a fancy-pants require. Require
+  # whatever files you need as you see fit straight from your
+  # Rakefile. YAY for simple and clean!
+  def self.load options = {}
+    options = {:config => options} if String === options
+    order = [:core, :app, :config, :scm, :web]
+    order += options.keys - order
+
+    recipes = {
+      :app    => :passenger,
+      :config => 'config/deploy.rb',
+      :core   => :core,
+      :scm    => :subversion,
+      :web    => :apache,
+    }.merge(options)
+
+    order.each do |flavor|
+      recipe = recipes[flavor]
+      next if recipe.nil? or flavor == :config
+      require "vlad/#{recipe}"
+    end
+
+    Kernel.load recipes[:config]
+    Kernel.load "config/deploy_#{ENV['to']}.rb" if ENV['to']
+  end
+end
+
+class String #:nodoc:
+  def cleanup
+    if ENV['FULL'] then
+      gsub(/\s+/, ' ').strip
+    else
+      self[/\A.*?\./]
+    end
+  end
+end

data/test/test_rake_remote_task.rb

@@ -0,0 +1,257 @@
+require 'test/vlad_test_case'
+require 'vlad'
+
+class TestRakeRemoteTask < VladTestCase
+  # TODO: move to minitest
+  def assert_silent
+    out, err = capture_io do
+      yield
+    end
+
+    assert_empty err
+    assert_empty out
+  end
+
+  def test_enhance
+    util_set_hosts
+    body = Proc.new { 5 }
+    task = @vlad.remote_task(:some_task => :foo, &body)
+    action = Rake::RemoteTask::Action.new(task, body)
+    assert_equal [action], task.remote_actions
+    assert_equal task, action.task
+    assert_equal ["foo"], task.prerequisites
+  end
+
+  def test_enhance_with_no_task_body
+    util_set_hosts
+    util_setup_task
+    assert_equal [], @task.remote_actions
+    assert_equal [], @task.prerequisites
+  end
+
+  def test_execute
+    util_set_hosts
+    set :some_variable, 1
+    x = 5
+    task = @vlad.remote_task(:some_task) { x += some_variable }
+    task.execute nil
+    assert_equal 1, task.some_variable
+    assert_equal 7, x
+  end
+
+  def test_set_false
+    set :can_set_nil, nil
+    set :lies_are, false
+
+    assert_equal nil,   task.can_set_nil
+
+    assert_equal false, task.lies_are
+    assert_equal false, Rake::RemoteTask.fetch(:lies_are)
+  end
+
+
+  def test_fetch_false
+    assert_equal false, Rake::RemoteTask.fetch(:unknown, false)
+  end
+
+  def test_execute_exposes_target_host
+    host "app.example.com", :app
+    task = remote_task(:target_task) { set(:test_target_host, target_host) }
+    task.execute nil
+    assert_equal "app.example.com", Rake::RemoteTask.fetch(:test_target_host)
+  end
+
+  def test_execute_with_no_hosts
+    @vlad.host "app.example.com", :app
+    t = @vlad.remote_task(:flunk, :roles => :db) { flunk "should not have run" }
+    e = assert_raises(Vlad::ConfigurationError) { t.execute nil }
+    assert_equal "No target hosts specified on task flunk for roles [:db]",
+                 e.message
+  end
+
+  def test_execute_with_no_roles
+    t = @vlad.remote_task(:flunk, :roles => :junk) { flunk "should not have run" }
+    e = assert_raises(Vlad::ConfigurationError) { t.execute nil }
+    assert_equal "No target hosts specified on task flunk for roles [:junk]",
+                 e.message
+  end
+
+  def test_execute_with_roles
+    util_set_hosts
+    set :some_variable, 1
+    x = 5
+    task = @vlad.remote_task(:some_task, :roles => :db) { x += some_variable }
+    task.execute nil
+    assert_equal 1, task.some_variable
+    assert_equal 6, x
+  end
+
+  def test_rsync
+    util_setup_task
+    @task.target_host = "app.example.com"
+
+    assert_silent do
+      @task.rsync 'localfile', 'host:remotefile'
+    end
+
+    commands = @task.commands
+
+    assert_equal 1, commands.size, 'not enough commands'
+    assert_equal(%w[rsync -azP --delete localfile host:remotefile],
+                 commands.first)
+  end
+
+  def test_rsync_fail
+    util_setup_task
+    @task.target_host = "app.example.com"
+    @task.action = lambda { false }
+
+    e = assert_raises Vlad::CommandFailedError do
+      assert_silent do
+        @task.rsync 'local', 'host:remote'
+      end
+    end
+    exp = "execution failed: rsync -azP --delete local host:remote"
+    assert_equal exp, e.message
+  end
+
+  def test_rsync_deprecation
+    util_setup_task
+    @task.target_host = "app.example.com"
+
+    out, err = capture_io do
+      @task.rsync 'localfile', 'remotefile'
+    end
+
+    commands = @task.commands
+
+    assert_equal 1, commands.size, 'not enough commands'
+    assert_equal(%w[rsync -azP --delete localfile app.example.com:remotefile],
+                 commands.first)
+
+    assert_equal("rsync deprecation: pass target_host:remote_path explicitly\n",
+                 err)
+    assert_empty out
+    # flunk "not yet"
+  end
+
+  def test_get
+    util_setup_task
+    @task.target_host = "app.example.com"
+
+    assert_silent do
+      @task.get 'tmp', "remote1", "remote2"
+    end
+
+    commands = @task.commands
+
+    expected = %w[rsync -azP --delete app.example.com:remote1 app.example.com:remote2 tmp]
+
+    assert_equal 1, commands.size
+    assert_equal expected, commands.first
+  end
+
+  def test_put
+    util_setup_task
+    @task.target_host = "app.example.com"
+
+    assert_silent do
+      @task.put 'dest' do
+        "whatever"
+      end
+    end
+
+    commands = @task.commands
+
+    expected  = %w[rsync -azP --delete HAPPY app.example.com:dest]
+    commands.first[3] = 'HAPPY'
+
+    assert_equal 1, commands.size
+    assert_equal expected, commands.first
+  end
+
+  def test_run
+    util_setup_task
+    @task.output << "file1\nfile2\n"
+    @task.target_host = "app.example.com"
+    result = nil
+
+    out, err = capture_io do
+      result = @task.run("ls")
+    end
+
+    commands = @task.commands
+
+    assert_equal 1, commands.size, 'not enough commands'
+    assert_equal ["ssh", "app.example.com", "ls"],
+                 commands.first, 'app'
+    assert_equal "file1\nfile2\n", result
+
+    assert_equal "file1\nfile2\n", out
+    assert_equal '', err
+  end
+
+  def test_run_failing_command
+    util_set_hosts
+    util_setup_task
+    @task.input = StringIO.new "file1\nfile2\n"
+    @task.target_host =  'app.example.com'
+    @task.action = lambda { 1 }
+
+    e = assert_raises(Vlad::CommandFailedError) { @task.run("ls") }
+    assert_equal "execution failed with status 1: ssh app.example.com ls", e.message
+
+    assert_equal 1, @task.commands.size
+  end
+
+  def test_run_sudo
+    util_setup_task
+    @task.output << "file1\nfile2\n"
+    @task.error << 'Password:'
+    @task.target_host = "app.example.com"
+    def @task.sudo_password() "my password" end # gets defined by set
+    result = nil
+
+    out, err = capture_io do
+      result = @task.run("sudo ls")
+    end
+
+    commands = @task.commands
+
+    assert_equal 1, commands.size, 'not enough commands'
+    assert_equal ['ssh', 'app.example.com', 'sudo ls'],
+                 commands.first
+
+    assert_equal "my password\n", @task.input.string
+
+    # WARN: Technically incorrect, the password line should be
+    # first... this is an artifact of changes to the IO code in run
+    # and the fact that we have a very simplistic (non-blocking)
+    # testing model.
+    assert_equal "file1\nfile2\nPassword:\n", result
+
+    assert_equal "file1\nfile2\n", out
+    assert_equal "Password:\n", err
+  end
+
+  def test_sudo
+    util_setup_task
+    @task.target_host = "app.example.com"
+    @task.sudo "ls"
+
+    commands = @task.commands
+
+    assert_equal 1, commands.size, 'wrong number of commands'
+    assert_equal ["ssh", "app.example.com", "sudo -p Password: ls"],
+                 commands.first, 'app'
+  end
+
+  def util_setup_task(options = {})
+    @task = @vlad.remote_task :test_task, options
+    @task.commands = []
+    @task.output = []
+    @task.error = []
+    @task.action = nil
+    @task
+  end
+end