capistrano 1.4.2 → 2.0.0

data/test/extensions_test.rb

@@ -0,0 +1,69 @@
+require "#{File.dirname(__FILE__)}/utils"
+require 'capistrano'
+
+class ExtensionsTest < Test::Unit::TestCase
+  module CustomExtension
+    def do_something(command)
+      run(command)
+    end
+  end
+
+  def setup
+    @config = Capistrano::Configuration.new
+  end
+
+  def teardown
+    Capistrano::EXTENSIONS.keys.each { |e| Capistrano.remove_plugin(e) }
+  end
+
+  def test_register_plugin_should_add_instance_method_on_configuration_and_return_true
+    assert !@config.respond_to?(:custom_stuff)
+    assert Capistrano.plugin(:custom_stuff, CustomExtension)
+    assert @config.respond_to?(:custom_stuff)
+  end
+
+  def test_register_plugin_that_already_exists_should_return_false
+    assert Capistrano.plugin(:custom_stuff, CustomExtension)
+    assert !Capistrano.plugin(:custom_stuff, CustomExtension)
+  end
+
+  def test_register_plugin_with_public_method_name_should_fail
+    method = Capistrano::Configuration.public_instance_methods.first
+    assert_not_nil method, "need a public instance method for testing"
+    assert_raises(Capistrano::Error) { Capistrano.plugin(method, CustomExtension) }
+  end
+
+  def test_register_plugin_with_protected_method_name_should_fail
+    method = Capistrano::Configuration.protected_instance_methods.first
+    assert_not_nil method, "need a protected instance method for testing"
+    assert_raises(Capistrano::Error) { Capistrano.plugin(method, CustomExtension) }
+  end
+
+  def test_register_plugin_with_private_method_name_should_fail
+    method = Capistrano::Configuration.private_instance_methods.first
+    assert_not_nil method, "need a private instance method for testing"
+    assert_raises(Capistrano::Error) { Capistrano.plugin(method, CustomExtension) }
+  end
+
+  def test_unregister_plugin_that_does_not_exist_should_return_false
+    assert !Capistrano.remove_plugin(:custom_stuff)
+  end
+
+  def test_unregister_plugin_should_remove_method_and_return_true
+    assert Capistrano.plugin(:custom_stuff, CustomExtension)
+    assert @config.respond_to?(:custom_stuff)
+    assert Capistrano.remove_plugin(:custom_stuff)
+    assert !@config.respond_to?(:custom_stuff)
+  end
+
+  def test_registered_plugin_proxy_should_return_proxy_object
+    Capistrano.plugin(:custom_stuff, CustomExtension)
+    assert_instance_of Capistrano::ExtensionProxy, @config.custom_stuff
+  end
+
+  def test_proxy_object_should_delegate_to_configuration
+    Capistrano.plugin(:custom_stuff, CustomExtension)
+    @config.expects(:run).with("hello")
+    @config.custom_stuff.do_something("hello")
+  end
+end

data/test/fixtures/cli_integration.rb

@@ -0,0 +1,5 @@
+role :test, "www.capistrano.test"
+
+task :testing, :roles => :test do
+  set :testing_occurred, true
+end

data/test/fixtures/custom.rb

@@ -1,3 +1,3 @@
-Capistrano.configuration(:must_exist).load do
-  set :gateway, "foo"
+ConfigurationLoadingTest::MockConfig.instance(:must_exist).load do
+  ping! :custom
 end

data/test/gateway_test.rb

@@ -0,0 +1,167 @@
+require "#{File.dirname(__FILE__)}/utils"
+require 'capistrano/gateway'
+
+class GatewayTest < Test::Unit::TestCase
+  def teardown
+    Thread.list { |t| t.kill unless Thread.current == t }
+  end
+
+  def test_initialize_should_open_and_set_session_value
+    run_test_initialize_should_open_and_set_session_value
+  end
+
+  def test_initialize_when_connect_lags_should_open_and_set_session_value
+    run_test_initialize_should_open_and_set_session_value do |expects|
+      expects.with { |*args| sleep 0.2; true }
+    end
+  end
+
+  def test_shutdown_without_any_open_connections_should_terminate_session
+    gateway = new_gateway
+    gateway.shutdown!
+    assert !gateway.thread.alive?
+    assert !gateway.session.looping?
+  end
+
+  def test_connect_to_should_start_local_ports_at_65535
+    gateway = new_gateway
+    expect_connect_to(:host => "127.0.0.1", :port => 65535).returns(result = sess_with_xserver("app1"))
+    newsess = gateway.connect_to(server("app1"))
+    assert_equal result, newsess
+    assert_equal [65535, "app1", 22], gateway.session.forward.active_locals[65535]
+  end
+
+  def test_connect_to_should_decrement_port_and_retry_if_ports_are_in_use
+    gateway = new_gateway(:reserved => lambda { |n| n > 65000 })
+    expect_connect_to(:host => "127.0.0.1", :port => 65000).returns(result = sess_with_xserver("app1"))
+    newsess = gateway.connect_to(server("app1"))
+    assert_equal result, newsess
+    assert_equal [65000, "app1", 22], gateway.session.forward.active_locals[65000]
+  end
+
+  def test_connect_to_should_honor_user_specification_in_server_definition
+    gateway = new_gateway
+    expect_connect_to(:host => "127.0.0.1", :user => "jamis", :port => 65535).returns(result = sess_with_xserver("app1"))
+    newsess = gateway.connect_to(server("jamis@app1"))
+    assert_equal result, newsess
+    assert_equal [65535, "app1", 22], gateway.session.forward.active_locals[65535]
+  end
+
+  def test_connect_to_should_honor_port_specification_in_server_definition
+    gateway = new_gateway
+    expect_connect_to(:host => "127.0.0.1", :port => 65535).returns(result = sess_with_xserver("app1"))
+    newsess = gateway.connect_to(server("app1:1234"))
+    assert_equal result, newsess
+    assert_equal [65535, "app1", 1234], gateway.session.forward.active_locals[65535]
+  end
+
+  def test_connect_to_should_set_xserver_to_tunnel_target
+    gateway = new_gateway
+    expect_connect_to(:host => "127.0.0.1", :port => 65535).returns(result = sess_with_xserver("app1"))
+    newsess = gateway.connect_to(server("app1:1234"))
+    assert_equal result, newsess
+  end
+
+  def test_shutdown_should_cancel_active_forwarded_ports
+    gateway = new_gateway
+    expect_connect_to(:host => "127.0.0.1", :port => 65535).returns(sess_with_xserver("app1"))
+    gateway.connect_to(server("app1"))
+    assert !gateway.session.forward.active_locals.empty?
+    gateway.shutdown!
+    assert gateway.session.forward.active_locals.empty?
+  end
+
+  def test_error_while_connecting_should_cause_connection_to_fail
+    gateway = new_gateway
+    expect_connect_to(:host => "127.0.0.1").raises(RuntimeError)
+    gateway.expects(:warn).times(2)
+    assert_raises(Capistrano::ConnectionError) { gateway.connect_to(server("app1")) }
+  end
+  
+  def test_connection_error_should_include_accessor_with_host_array
+    gateway = new_gateway
+    expect_connect_to(:host => "127.0.0.1").raises(RuntimeError)
+    gateway.expects(:warn).times(2)
+  
+    begin
+      gateway.connect_to(server("app1"))
+      flunk "expected an exception to be raised"
+    rescue Capistrano::ConnectionError => e
+      assert e.respond_to?(:hosts)
+      assert_equal %w(app1), e.hosts.map { |h| h.to_s }
+    end
+  end
+
+  private
+
+    def sess_with_xserver(host)
+      s = server(host)
+      sess = mock("session")
+      sess.expects(:xserver=).with { |v| v.host == host }
+      sess
+    end
+
+    def expect_connect_to(options={})
+      Capistrano::SSH.expects(:connect).with do |server,config|
+        options.all? do |key, value|
+          case key
+          when :host then server.host == value
+          when :user then server.user == value
+          when :port then server.port == value
+          else false
+          end
+        end
+      end
+    end
+
+    def new_gateway(options={})
+      expect_connect_to(:host => "capistrano").yields(MockSession.new(options))
+      Capistrano::Gateway.new(server("capistrano"))
+    end
+
+    def run_test_initialize_should_open_and_set_session_value
+      session = mock("Net::SSH session")
+      session.expects(:loop)
+      expectation = Capistrano::SSH.expects(:connect).yields(session)
+      yield expectation if block_given?
+      gateway = Capistrano::Gateway.new(server("capistrano"))
+      gateway.thread.join
+      assert_equal session, gateway.session
+    end
+
+    class MockForward
+      attr_reader :active_locals
+
+      def initialize(options)
+        @options = options
+        @active_locals = {}
+      end
+
+      def cancel_local(port)
+        @active_locals.delete(port)
+      end
+
+      def local(lport, host, rport)
+        raise Errno::EADDRINUSE if @options[:reserved] && @options[:reserved][lport]
+        @active_locals[lport] = [lport, host, rport]
+      end
+    end
+
+    class MockSession
+      attr_reader :forward
+
+      def initialize(options={})
+        @forward = MockForward.new(options)
+      end
+
+      def looping?
+        @looping
+      end
+
+      def loop
+        @looping = true
+        sleep 0.1 while yield
+        @looping = false
+      end
+    end
+end

data/test/logger_test.rb

@@ -0,0 +1,123 @@
+require "#{File.dirname(__FILE__)}/utils"
+require 'capistrano/logger'
+require 'stringio'
+
+class LoggerTest < Test::Unit::TestCase
+  def setup
+    @io = StringIO.new
+    @logger = Capistrano::Logger.new(:output => @io)
+  end
+
+  def test_logger_should_use_STDERR_by_default
+    logger = Capistrano::Logger.new
+    assert_equal STDERR, logger.device
+  end
+
+  def test_logger_should_use_output_option_if_output_responds_to_puts
+    logger = Capistrano::Logger.new(:output => STDOUT)
+    assert_equal STDOUT, logger.device
+  end
+
+  def test_logger_should_open_file_if_output_does_not_respond_to_puts
+    File.expects(:open).with("logs/capistrano.log", "a").returns(:mock)
+    logger = Capistrano::Logger.new(:output => "logs/capistrano.log")
+    assert_equal :mock, logger.device
+  end
+
+  def test_close_should_not_close_device_if_device_is_default
+    logger = Capistrano::Logger.new
+    logger.device.expects(:close).never
+    logger.close
+  end
+
+  def test_close_should_not_close_device_is_device_is_explicitly_given
+    logger = Capistrano::Logger.new(:output => STDOUT)
+    STDOUT.expects(:close).never
+    logger.close
+  end
+
+  def test_close_should_close_device_when_device_was_implicitly_opened
+    f = mock("file", :close => nil)
+    File.expects(:open).with("logs/capistrano.log", "a").returns(f)
+    logger = Capistrano::Logger.new(:output => "logs/capistrano.log")
+    logger.close
+  end
+
+  def test_log_with_level_greater_than_threshold_should_ignore_message
+    @logger.level = 3
+    @logger.log(4, "message")
+    assert @io.string.empty?
+  end
+
+  def test_log_with_level_equal_to_threshold_should_log_message
+    @logger.level = 3
+    @logger.log(3, "message")
+    assert @io.string.include?("message")
+  end
+
+  def test_log_with_level_less_than_threshold_should_log_message
+    @logger.level = 3
+    @logger.log(2, "message")
+    assert @io.string.include?("message")
+  end
+
+  def test_log_with_multiline_message_should_log_each_line_separately
+    @logger.log(0, "first line\nsecond line")
+    assert @io.string.include?("*** first line")
+    assert @io.string.include?("*** second line")
+  end
+
+  def test_log_with_line_prefix_should_insert_line_prefix_before_message
+    @logger.log(0, "message", "prefix")
+    assert @io.string.include?("*** [prefix] message")
+  end
+
+  def test_log_with_level_0_should_have_strong_indent
+    @logger.log(0, "message")
+    assert @io.string.match(/^\*\*\* message/)
+  end
+
+  def test_log_with_level_1_should_have_weaker_indent
+    @logger.level = 1
+    @logger.log(1, "message")
+    assert @io.string.match(/^ \*\* message/)
+  end
+
+  def test_log_with_level_2_should_have_weaker_indent
+    @logger.level = 2
+    @logger.log(2, "message")
+    assert @io.string.match(/^  \* message/)
+  end
+
+  def test_log_with_level_3_should_have_weakest_indent
+    @logger.level = 3
+    @logger.log(3, "message")
+    assert @io.string.match(/^    message/)
+  end
+
+  def test_important_should_delegate_to_log_with_level_IMPORTANT
+    @logger.expects(:log).with(Capistrano::Logger::IMPORTANT, "message", "prefix")
+    @logger.important("message", "prefix")
+  end
+
+  def test_info_should_delegate_to_log_with_level_INFO
+    @logger.expects(:log).with(Capistrano::Logger::INFO, "message", "prefix")
+    @logger.info("message", "prefix")
+  end
+
+  def test_debug_should_delegate_to_log_with_level_DEBUG
+    @logger.expects(:log).with(Capistrano::Logger::DEBUG, "message", "prefix")
+    @logger.debug("message", "prefix")
+  end
+
+  def test_trace_should_delegate_to_log_with_level_TRACE
+    @logger.expects(:log).with(Capistrano::Logger::TRACE, "message", "prefix")
+    @logger.trace("message", "prefix")
+  end
+
+  def test_ordering_of_levels
+    assert Capistrano::Logger::IMPORTANT < Capistrano::Logger::INFO
+    assert Capistrano::Logger::INFO < Capistrano::Logger::DEBUG
+    assert Capistrano::Logger::DEBUG < Capistrano::Logger::TRACE
+  end
+end

data/test/server_definition_test.rb

@@ -0,0 +1,108 @@
+require "#{File.dirname(__FILE__)}/utils"
+require 'capistrano/server_definition'
+
+class ServerDefinitionTest < Test::Unit::TestCase
+  def test_new_without_credentials_or_port_should_set_values_to_defaults
+    server = Capistrano::ServerDefinition.new("www.capistrano.test")
+    assert_equal "www.capistrano.test", server.host
+    assert_nil   server.user
+    assert_nil   server.port
+  end
+
+  def test_new_with_encoded_user_should_extract_user_and_use_default_port
+    server = Capistrano::ServerDefinition.new("jamis@www.capistrano.test")
+    assert_equal "www.capistrano.test", server.host
+    assert_equal "jamis", server.user
+    assert_nil   server.port
+  end
+
+  def test_new_with_encoded_port_should_extract_port_and_use_default_user
+    server = Capistrano::ServerDefinition.new("www.capistrano.test:8080")
+    assert_equal "www.capistrano.test", server.host
+    assert_nil   server.user
+    assert_equal 8080, server.port
+  end
+
+  def test_new_with_encoded_user_and_port_should_extract_user_and_port
+    server = Capistrano::ServerDefinition.new("jamis@www.capistrano.test:8080")
+    assert_equal "www.capistrano.test", server.host
+    assert_equal "jamis", server.user
+    assert_equal 8080, server.port
+  end
+
+  def test_new_with_user_as_option_should_use_given_user
+    server = Capistrano::ServerDefinition.new("www.capistrano.test", :user => "jamis")
+    assert_equal "www.capistrano.test", server.host
+    assert_equal "jamis", server.user
+    assert_nil   server.port
+  end
+
+  def test_new_with_port_as_option_should_use_given_user
+    server = Capistrano::ServerDefinition.new("www.capistrano.test", :port => 8080)
+    assert_equal "www.capistrano.test", server.host
+    assert_nil   server.user
+    assert_equal 8080, server.port
+  end
+
+  def test_encoded_value_should_override_hash_option
+    server = Capistrano::ServerDefinition.new("jamis@www.capistrano.test:8080", :user => "david", :port => 8081)
+    assert_equal "www.capistrano.test", server.host
+    assert_equal "jamis", server.user
+    assert_equal 8080, server.port
+    assert server.options.empty?
+  end
+
+  def test_new_with_option_should_dup_option_hash
+    options = {}
+    server = Capistrano::ServerDefinition.new("www.capistrano.test", options)
+    assert_not_equal options.object_id, server.options.object_id
+  end
+
+  def test_new_with_options_should_keep_options
+    server = Capistrano::ServerDefinition.new("www.capistrano.test", :primary => true)
+    assert_equal true, server.options[:primary]
+  end
+
+  def test_comparison_should_match_when_host_user_port_are_same
+    s1 = server("jamis@www.capistrano.test:8080")
+    s2 = server("www.capistrano.test", :user => "jamis", :port => 8080)
+    assert_equal s1, s2
+    assert_equal s1.hash, s2.hash
+    assert s1.eql?(s2)
+  end
+
+  def test_servers_should_be_comparable
+    s1 = server("jamis@www.capistrano.test:8080")
+    s2 = server("www.alphabet.test:1234")
+    s3 = server("jamis@www.capistrano.test:8075")
+    s4 = server("billy@www.capistrano.test:8080")
+
+    assert s2 < s1
+    assert s3 < s1
+    assert s4 < s1
+    assert s2 < s3
+    assert s2 < s4
+    assert s3 < s4
+  end
+
+  def test_comparison_should_not_match_when_any_of_host_user_port_differ
+    s1 = server("jamis@www.capistrano.test:8080")
+    s2 = server("bob@www.capistrano.test:8080")
+    s3 = server("jamis@www.capistrano.test:8081")
+    s4 = server("jamis@app.capistrano.test:8080")
+    assert_not_equal s1, s2
+    assert_not_equal s1, s3
+    assert_not_equal s1, s4
+    assert_not_equal s2, s3
+    assert_not_equal s2, s4
+    assert_not_equal s3, s4
+  end
+
+  def test_to_s
+    assert_equal "www.capistrano.test", server("www.capistrano.test").to_s
+    assert_equal "www.capistrano.test", server("www.capistrano.test:22").to_s
+    assert_equal "www.capistrano.test:1234", server("www.capistrano.test:1234").to_s
+    assert_equal "jamis@www.capistrano.test", server("jamis@www.capistrano.test").to_s
+    assert_equal "jamis@www.capistrano.test:1234", server("jamis@www.capistrano.test:1234").to_s
+  end
+end