HeSYINUvSBZfxqA-capistrano 2.5.21

data/test/extensions_test.rb

@@ -0,0 +1,69 @@
+require "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/config.rb

@@ -0,0 +1,5 @@
+set :application, "foo"
+set :repository, "1/2/#{application}"
+set :gateway, "#{__FILE__}.example.com"
+
+role :web, "www.example.com", :primary => true

data/test/fixtures/custom.rb

@@ -0,0 +1,3 @@
+ConfigurationLoadingTest::MockConfig.instance(:must_exist).load do
+  ping! :custom
+end

data/test/logger_test.rb

@@ -0,0 +1,123 @@
+require "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/role_test.rb

@@ -0,0 +1,11 @@
+require "utils"
+require 'capistrano/role'
+
+class RoleTest < Test::Unit::TestCase
+  def test_clearing_a_populated_role_should_yield_no_servers
+    role = Capistrano::Role.new("app1.capistrano.test", lambda { |o| "app2.capistrano.test" })
+    assert_equal 2, role.servers.size
+    role.clear
+    assert role.servers.empty?
+  end
+end

data/test/server_definition_test.rb

@@ -0,0 +1,121 @@
+require "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_default_user_should_try_to_guess_username
+    ENV.stubs(:[]).returns(nil)
+    assert_equal "not-specified", Capistrano::ServerDefinition.default_user
+    
+    ENV.stubs(:[]).returns(nil)
+    ENV.stubs(:[]).with("USERNAME").returns("ryan")
+    assert_equal "ryan", Capistrano::ServerDefinition.default_user
+
+    ENV.stubs(:[]).returns(nil)
+    ENV.stubs(:[]).with("USER").returns("jamis")
+    assert_equal "jamis", Capistrano::ServerDefinition.default_user
+  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

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,113 @@
+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_verbose_option_should_set_verbose_option_on_ssh
+    Net::SSH.expects(:start).with(@server.host, "default-user", @options).returns(success = Object.new)
+    assert_equal success, Capistrano::SSH.connect(@server, :verbose => 0)
+    Net::SSH.expects(:start).with(@server.host, "default-user", @options.merge(:verbose => :debug)).returns(success = Object.new)
+    assert_equal success, Capistrano::SSH.connect(@server, :verbose => 1)
+    Net::SSH.expects(:start).with(@server.host, "default-user", @options.merge(:verbose => :debug)).returns(success = Object.new)
+    assert_equal success, Capistrano::SSH.connect(@server, :verbose => 2)
+  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