sneakin-capistrano 2.5.5

data/test/shell_test.rb

@@ -0,0 +1,90 @@
+require "utils"
+require 'capistrano/configuration'
+require 'capistrano/shell'
+
+class ShellTest < Test::Unit::TestCase
+  def setup
+    @config = Capistrano::Configuration.new
+    @shell  = Capistrano::Shell.new(@config)
+    @shell.stubs(:puts)
+  end
+
+  def test_readline_fallback_prompt_should_write_to_stdout_and_read_from_stdin
+    STDOUT.expects(:print).with("prompt> ")
+    STDOUT.expects(:flush)
+    STDIN.expects(:gets).returns("hi\n")
+    assert_equal "hi\n", Capistrano::Shell::ReadlineFallback.readline("prompt> ")
+  end
+
+  def test_question_mark_as_input_should_trigger_help
+    @shell.expects(:read_line).returns("?")
+    @shell.expects(:help)
+    assert @shell.read_and_execute
+  end
+
+  def test_help_as_input_should_trigger_help
+    @shell.expects(:read_line).returns("help")
+    @shell.expects(:help)
+    assert @shell.read_and_execute
+  end
+
+  def test_quit_as_input_should_cause_read_and_execute_to_return_false
+    @shell.expects(:read_line).returns("quit")
+    assert !@shell.read_and_execute
+  end
+
+  def test_exit_as_input_should_cause_read_and_execute_to_return_false
+    @shell.expects(:read_line).returns("exit")
+    assert !@shell.read_and_execute
+  end
+
+  def test_set_should_parse_flag_and_value_and_call_set_option
+    @shell.expects(:read_line).returns("set -v 5")
+    @shell.expects(:set_option).with("v", "5")
+    assert @shell.read_and_execute
+  end
+
+  def test_text_without_with_or_on_gets_processed_verbatim
+    @shell.expects(:read_line).returns("hello world")
+    @shell.expects(:process_command).with(nil, nil, "hello world")
+    assert @shell.read_and_execute
+  end
+
+  def test_text_with_with_gets_processed_with_with # lol
+    @shell.expects(:read_line).returns("with app,db hello world")
+    @shell.expects(:process_command).with("with", "app,db", "hello world")
+    assert @shell.read_and_execute
+  end
+
+  def test_text_with_on_gets_processed_with_on
+    @shell.expects(:read_line).returns("on app,db hello world")
+    @shell.expects(:process_command).with("on", "app,db", "hello world")
+    assert @shell.read_and_execute
+  end
+  
+  def test_task_command_with_bang_gets_processed_by_exec_tasks
+    while_testing_post_exec_commands do
+      @shell.expects(:read_line).returns("!deploy")
+      @shell.expects(:exec_tasks).with(["deploy"])
+      assert @shell.read_and_execute
+    end
+  end
+  
+  def test_normal_command_gets_processed_by_exec_command
+    while_testing_post_exec_commands do
+      @shell.expects(:read_line).returns("uptime")
+      @shell.expects(:exec_command).with("uptime",nil)
+      @shell.expects(:connect)
+      assert @shell.read_and_execute
+    end
+  end
+  
+  
+  private
+  
+  def while_testing_post_exec_commands(&block)
+    @shell.instance_variable_set(:@mutex,Mutex.new)
+    yield
+  end
+  
+end

data/test/ssh_test.rb

@@ -0,0 +1,104 @@
+require "utils"
+require 'capistrano/ssh'
+
+class SSHTest < Test::Unit::TestCase
+  def setup
+    Capistrano::ServerDefinition.stubs(:default_user).returns("default-user")
+    @options = { :password => nil,
+                 :auth_methods => %w(publickey hostbased),
+                 :config => false }
+    @server = server("capistrano")
+    Net::SSH.stubs(:configuration_for).returns({})
+  end
+
+  def test_connect_with_bare_server_without_options_or_config_with_public_key_succeeding_should_only_loop_once
+    Net::SSH.expects(:start).with(@server.host, "default-user", @options).returns(success = Object.new)
+    assert_equal success, Capistrano::SSH.connect(@server)
+  end
+
+  def test_connect_with_bare_server_without_options_with_public_key_failing_should_try_password
+    Net::SSH.expects(:start).with(@server.host, "default-user", @options).raises(Net::SSH::AuthenticationFailed)
+    Net::SSH.expects(:start).with(@server.host, "default-user", @options.merge(:password => "f4b13n", :auth_methods => %w(password keyboard-interactive))).returns(success = Object.new)
+    assert_equal success, Capistrano::SSH.connect(@server, :password => "f4b13n")
+  end
+
+  def test_connect_with_bare_server_without_options_public_key_and_password_failing_should_raise_error
+    Net::SSH.expects(:start).with(@server.host, "default-user", @options).raises(Net::SSH::AuthenticationFailed)
+    Net::SSH.expects(:start).with(@server.host, "default-user", @options.merge(:password => "f4b13n", :auth_methods => %w(password keyboard-interactive))).raises(Net::SSH::AuthenticationFailed)
+    assert_raises(Net::SSH::AuthenticationFailed) do
+      Capistrano::SSH.connect(@server, :password => "f4b13n")
+    end
+  end
+
+  def test_connect_with_bare_server_and_user_via_public_key_should_pass_user_to_net_ssh
+    Net::SSH.expects(:start).with(@server.host, "jamis", @options).returns(success = Object.new)
+    assert_equal success, Capistrano::SSH.connect(@server, :user => "jamis")
+  end
+
+  def test_connect_with_bare_server_and_user_via_password_should_pass_user_to_net_ssh
+    Net::SSH.expects(:start).with(@server.host, "jamis", @options).raises(Net::SSH::AuthenticationFailed)
+    Net::SSH.expects(:start).with(@server.host, "jamis", @options.merge(:password => "f4b13n", :auth_methods => %w(password keyboard-interactive))).returns(success = Object.new)
+    assert_equal success, Capistrano::SSH.connect(@server, :user => "jamis", :password => "f4b13n")
+  end
+
+  def test_connect_with_bare_server_with_explicit_port_should_pass_port_to_net_ssh
+    Net::SSH.expects(:start).with(@server.host, "default-user", @options.merge(:port => 1234)).returns(success = Object.new)
+    assert_equal success, Capistrano::SSH.connect(@server, :port => 1234)
+  end
+
+  def test_connect_with_server_with_user_should_pass_user_to_net_ssh
+    server = server("jamis@capistrano")
+    Net::SSH.expects(:start).with(server.host, "jamis", @options).returns(success = Object.new)
+    assert_equal success, Capistrano::SSH.connect(server)
+  end
+
+  def test_connect_with_server_with_port_should_pass_port_to_net_ssh
+    server = server("capistrano:1235")
+    Net::SSH.expects(:start).with(server.host, "default-user", @options.merge(:port => 1235)).returns(success = Object.new)
+    assert_equal success, Capistrano::SSH.connect(server)
+  end
+
+  def test_connect_with_server_with_user_and_port_should_pass_user_and_port_to_net_ssh
+    server = server("jamis@capistrano:1235")
+    Net::SSH.expects(:start).with(server.host, "jamis", @options.merge(:port => 1235)).returns(success = Object.new)
+    assert_equal success, Capistrano::SSH.connect(server)
+  end
+
+  def test_connect_with_server_with_other_ssh_options_should_pass_ssh_options_to_net_ssh
+    server = server("jamis@capistrano:1235", :ssh_options => { :keys => %w(some_valid_key), :auth_methods => %w(a_method), :hmac => 'none' })
+    Net::SSH.expects(:start).with(server.host, "jamis", @options.merge(:port => 1235, :keys => %w(some_valid_key), :auth_methods => %w(a_method), :hmac => 'none' )).returns(success = Object.new)
+    assert_equal success, Capistrano::SSH.connect(server)
+  end
+
+  def test_connect_with_ssh_options_should_use_ssh_options
+    ssh_options = { :username => "JamisMan", :port => 8125, :config => false }
+    Net::SSH.expects(:start).with(@server.host, "JamisMan", @options.merge(:port => 8125, :config => false)).returns(success = Object.new)
+    assert_equal success, Capistrano::SSH.connect(@server, {:ssh_options => ssh_options})
+  end
+
+  def test_connect_with_options_and_ssh_options_should_see_options_override_ssh_options
+    ssh_options = { :username => "JamisMan", :port => 8125, :forward_agent => true }
+    Net::SSH.expects(:start).with(@server.host, "jamis", @options.merge(:port => 1235, :forward_agent => true)).returns(success = Object.new)
+    assert_equal success, Capistrano::SSH.connect(@server, :ssh_options => ssh_options, :user => "jamis", :port => 1235)
+  end
+
+  def test_connect_with_ssh_options_should_see_server_options_override_ssh_options
+    ssh_options = { :username => "JamisMan", :port => 8125, :forward_agent => true }
+    server = server("jamis@capistrano:1235")
+    Net::SSH.expects(:start).with(server.host, "jamis", @options.merge(:port => 1235, :forward_agent => true, :config => false)).returns(success = Object.new)
+    assert_equal success, Capistrano::SSH.connect(server, {:ssh_options => ssh_options})
+  end
+
+  def test_connect_should_add_xserver_accessor_to_connection
+    Net::SSH.expects(:start).with(@server.host, "default-user", @options).returns(success = Object.new)
+    assert_equal success, Capistrano::SSH.connect(@server)
+    assert success.respond_to?(:xserver)
+    assert success.respond_to?(:xserver)
+    assert_equal success.xserver, @server
+  end
+
+  def test_connect_should_not_retry_if_custom_auth_methods_are_given
+    Net::SSH.expects(:start).with(@server.host, "default-user", @options.merge(:auth_methods => %w(publickey))).raises(Net::SSH::AuthenticationFailed)
+    assert_raises(Net::SSH::AuthenticationFailed) { Capistrano::SSH.connect(@server, :ssh_options => { :auth_methods => %w(publickey) }) }
+  end
+end

data/test/task_definition_test.rb

@@ -0,0 +1,101 @@
+require "utils"
+require 'capistrano/task_definition'
+
+class TaskDefinitionTest < Test::Unit::TestCase
+  def setup
+    @namespace = namespace
+  end
+
+  def test_fqn_at_top_level_should_be_task_name
+    task = new_task(:testing)
+    assert_equal "testing", task.fully_qualified_name
+  end
+
+  def test_fqn_in_namespace_should_include_namespace_fqn
+    ns = namespace("outer:inner")
+    task = new_task(:testing, ns)
+    assert_equal "outer:inner:testing", task.fully_qualified_name
+  end
+
+  def test_fqn_at_top_level_when_default_should_be_default
+    task = new_task(:default)
+    assert_equal "default", task.fully_qualified_name
+  end
+
+  def test_fqn_in_namespace_when_default_should_be_namespace_fqn
+    ns = namespace("outer:inner")
+    task = new_task(:default, ns)
+    ns.stubs(:default_task => task)
+    assert_equal "outer:inner", task.fully_qualified_name
+  end
+
+  def test_task_should_require_block
+    assert_raises(ArgumentError) do
+      Capistrano::TaskDefinition.new(:testing, @namespace)
+    end
+  end
+
+  def test_description_should_return_empty_string_if_not_given
+    assert_equal "", new_task(:testing).description
+  end
+
+  def test_description_should_return_desc_attribute
+    assert_equal "something", new_task(:testing, @namespace, :desc => "something").description
+  end
+
+  def test_description_should_strip_leading_and_trailing_whitespace
+    assert_equal "something", new_task(:testing, @namespace, :desc => "   something   ").description
+  end
+
+  def test_description_should_normalize_newlines
+    assert_equal "a\nb\nc", new_task(:testing, @namespace, :desc => "a\nb\r\nc").description
+  end
+
+  def test_description_should_detect_and_remove_indentation
+    desc = <<-DESC
+      Here is some indented text \
+      and I want all of this to \
+      run together on a single line, \
+      without any extraneous spaces.
+
+        additional indentation will
+        be preserved.
+    DESC
+
+    task = new_task(:testing, @namespace, :desc => desc)
+    assert_equal "Here is some indented text and I want all of this to run together on a single line, without any extraneous spaces.\n\n  additional indentation will\n  be preserved.", task.description
+  end
+
+  def test_description_munging_should_be_sensitive_to_code_blocks
+    desc = <<-DESC
+      Here is a line \
+      wrapped      with spacing in it.
+
+        foo         bar
+        baz         bang
+    DESC
+
+    task = new_task(:testing, @namespace, :desc => desc)
+    assert_equal "Here is a line wrapped with spacing in it.\n\n  foo         bar\n  baz         bang", task.description
+  end
+
+  def test_brief_description_should_return_first_sentence_in_description
+    desc = "This is the task. It does all kinds of things."
+    task = new_task(:testing, @namespace, :desc => desc)
+    assert_equal "This is the task.", task.brief_description
+  end
+
+  def test_brief_description_should_truncate_if_length_given
+    desc = "This is the task that does all kinds of things. And then some."
+    task = new_task(:testing, @namespace, :desc => desc)
+    assert_equal "This is the task ...", task.brief_description(20)
+  end
+
+  def test_brief_description_should_not_break_at_period_in_middle_of_sentence
+    task = new_task(:testing, @namespace, :desc => "Take file.txt and copy it.")
+    assert_equal "Take file.txt and copy it.", task.brief_description
+
+    task = new_task(:testing, @namespace, :desc => "Take file.txt and copy it. Then do something else.")
+    assert_equal "Take file.txt and copy it.", task.brief_description
+  end
+end

data/test/transfer_test.rb

@@ -0,0 +1,160 @@
+require 'utils'
+require 'capistrano/transfer'
+
+class TransferTest < Test::Unit::TestCase
+  def test_class_process_should_delegate_to_instance_process
+    Capistrano::Transfer.expects(:new).with(:up, "from", "to", %w(a b c), {}).returns(mock('transfer', :process! => nil)).yields
+    yielded = false
+    Capistrano::Transfer.process(:up, "from", "to", %w(a b c), {}) { yielded = true }
+    assert yielded
+  end
+
+  def test_default_transport_is_sftp
+    transfer = Capistrano::Transfer.new(:up, "from", "to", [])
+    assert_equal :sftp, transfer.transport
+  end
+
+  def test_active_is_true_when_any_sftp_transfers_are_active
+    returns = [false, false, true]
+    sessions = [session('app1', :sftp), session('app2', :sftp), session('app3', :sftp)].each { |s| s.xsftp.expects(:upload).returns(stub('operation', :active? => returns.shift)) }
+    transfer = Capistrano::Transfer.new(:up, "from", "to", sessions, :via => :sftp)
+    assert_equal true, transfer.active?
+  end
+
+  def test_active_is_false_when_all_sftp_transfers_are_not_active
+    sessions = [session('app1', :sftp), session('app2', :sftp)].each { |s| s.xsftp.expects(:upload).returns(stub('operation', :active? => false)) }
+    transfer = Capistrano::Transfer.new(:up, "from", "to", sessions, :via => :sftp)
+    assert_equal false, transfer.active?
+  end
+
+  def test_active_is_true_when_any_scp_transfers_are_active
+    returns = [false, false, true]
+    sessions = [session('app1', :scp), session('app2', :scp), session('app3', :scp)].each do |s|
+      channel = stub('channel', :[]= => nil, :active? => returns.shift)
+      s.scp.expects(:upload).returns(channel)
+    end
+    transfer = Capistrano::Transfer.new(:up, "from", "to", sessions, :via => :scp)
+    assert_equal true, transfer.active?
+  end
+
+  def test_active_is_false_when_all_scp_transfers_are_not_active
+    sessions = [session('app1', :scp), session('app2', :scp), session('app3', :scp)].each do |s|
+      channel = stub('channel', :[]= => nil, :active? => false)
+      s.scp.expects(:upload).returns(channel)
+    end
+    transfer = Capistrano::Transfer.new(:up, "from", "to", sessions, :via => :scp)
+    assert_equal false, transfer.active?
+  end
+
+  [:up, :down].each do |direction|
+    define_method("test_sftp_#{direction}load_from_file_to_file_should_normalize_from_and_to") do
+      sessions = [session('app1', :sftp), session('app2', :sftp)]
+
+      sessions.each do |session|
+        session.xsftp.expects("#{direction}load".to_sym).with("from-#{session.xserver.host}", "to-#{session.xserver.host}",
+          :properties => { :server => session.xserver, :host => session.xserver.host })
+      end
+
+      transfer = Capistrano::Transfer.new(direction, "from-$CAPISTRANO:HOST$", "to-$CAPISTRANO:HOST$", sessions)
+    end
+
+    define_method("test_scp_#{direction}load_from_file_to_file_should_normalize_from_and_to") do
+      sessions = [session('app1', :scp), session('app2', :scp)]
+
+      sessions.each do |session|
+        session.scp.expects("#{direction}load".to_sym).returns({}).with("from-#{session.xserver.host}", "to-#{session.xserver.host}", :via => :scp)
+      end
+
+      transfer = Capistrano::Transfer.new(direction, "from-$CAPISTRANO:HOST$", "to-$CAPISTRANO:HOST$", sessions, :via => :scp)
+    end
+  end
+
+  def test_sftp_upload_from_IO_to_file_should_clone_the_IO_for_each_connection
+    sessions = [session('app1', :sftp), session('app2', :sftp)]
+    io = StringIO.new("from here")
+
+    sessions.each do |session|
+      session.xsftp.expects(:upload).with do |from, to, opts|
+        from != io && from.is_a?(StringIO) && from.string == io.string &&
+        to == "/to/here-#{session.xserver.host}" &&
+        opts[:properties][:server] == session.xserver &&
+        opts[:properties][:host] == session.xserver.host
+      end
+    end
+
+    transfer = Capistrano::Transfer.new(:up, StringIO.new("from here"), "/to/here-$CAPISTRANO:HOST$", sessions)
+  end
+
+  def test_scp_upload_from_IO_to_file_should_clone_the_IO_for_each_connection
+    sessions = [session('app1', :scp), session('app2', :scp)]
+    io = StringIO.new("from here")
+
+    sessions.each do |session|
+      channel = mock('channel')
+      channel.expects(:[]=).with(:server, session.xserver)
+      channel.expects(:[]=).with(:host, session.xserver.host)
+      session.scp.expects(:upload).returns(channel).with do |from, to, opts|
+        from != io && from.is_a?(StringIO) && from.string == io.string &&
+        to == "/to/here-#{session.xserver.host}"
+      end
+    end
+
+    transfer = Capistrano::Transfer.new(:up, StringIO.new("from here"), "/to/here-$CAPISTRANO:HOST$", sessions, :via => :scp)
+  end
+
+  def test_process_should_block_until_transfer_is_no_longer_active
+    transfer = Capistrano::Transfer.new(:up, "from", "to", [])
+    transfer.expects(:process_iteration).times(4).yields.returns(true,true,true,false)
+    transfer.expects(:active?).times(4)
+    transfer.process!
+  end
+
+  def test_errors_raised_for_a_sftp_session_should_abort_session_and_continue_with_remaining_sessions
+    s = session('app1')
+    error = ExceptionWithSession.new(s)
+    transfer = Capistrano::Transfer.new(:up, "from", "to", [])
+    transfer.expects(:process_iteration).raises(error).times(3).returns(true, false)
+    txfr = mock('transfer', :abort! => true)
+    txfr.expects(:[]=).with(:failed, true)
+    txfr.expects(:[]=).with(:error, error)
+    transfer.expects(:session_map).returns(s => txfr)
+    transfer.process!
+  end
+
+  def test_errors_raised_for_a_scp_session_should_abort_session_and_continue_with_remaining_sessions
+    s = session('app1')
+    error = ExceptionWithSession.new(s)
+    transfer = Capistrano::Transfer.new(:up, "from", "to", [], :via => :scp)
+    transfer.expects(:process_iteration).raises(error).times(3).returns(true, false)
+    txfr = mock('channel', :close => true)
+    txfr.expects(:[]=).with(:failed, true)
+    txfr.expects(:[]=).with(:error, error)
+    transfer.expects(:session_map).returns(s => txfr)
+    transfer.process!
+  end
+
+  private
+
+    class ExceptionWithSession < ::Exception
+      attr_reader :session
+
+      def initialize(session)
+        @session = session
+        super()
+      end
+    end
+
+    def session(host, mode=nil)
+      session = stub('session', :xserver => stub('server', :host => host))
+      case mode
+      when :sftp
+        sftp = stub('sftp')
+        session.expects(:sftp).with(false).returns(sftp)
+        sftp.expects(:connect).yields(sftp).returns(sftp)
+        session.stubs(:xsftp).returns(sftp)
+      when :scp
+        session.stubs(:scp).returns(stub('scp'))
+      end
+      session
+    end
+end

data/test/utils.rb

@@ -0,0 +1,38 @@
+begin
+  require 'rubygems'
+  gem     'mocha'
+rescue LoadError
+end
+
+require 'test/unit'
+require 'mocha'
+require 'capistrano/server_definition'
+
+module TestExtensions
+  def server(host, options={})
+    Capistrano::ServerDefinition.new(host, options)
+  end
+
+  def namespace(fqn=nil)
+    space = stub(:roles => {}, :fully_qualified_name => fqn, :default_task => nil)
+    yield(space) if block_given?
+    space
+  end
+
+  def role(space, name, *args)
+    opts = args.last.is_a?(Hash) ? args.pop : {}
+    space.roles[name] ||= []
+    space.roles[name].concat(args.map { |h| Capistrano::ServerDefinition.new(h, opts) })
+  end
+
+  def new_task(name, namespace=@namespace, options={}, &block)
+    block ||= Proc.new {}
+    task = Capistrano::TaskDefinition.new(name, namespace, options, &block)
+    assert_equal block, task.body
+    return task
+  end
+end
+
+class Test::Unit::TestCase
+  include TestExtensions
+end