mbailey-capistrano 2.5.5

data/test/cli/execute_test.rb

@@ -0,0 +1,132 @@
+require "utils"
+require 'capistrano/cli/execute'
+
+class CLIExecuteTest < Test::Unit::TestCase
+  class MockCLI
+    attr_reader :options
+
+    def initialize
+      @options = {}
+    end
+
+    include Capistrano::CLI::Execute
+  end
+
+  def setup
+    @cli = MockCLI.new
+    @logger = stub_everything
+    @config = stub(:logger => @logger, :debug= => nil, :dry_run= => nil)
+    @config.stubs(:set)
+    @config.stubs(:load)
+    @config.stubs(:trigger)
+    @cli.stubs(:instantiate_configuration).returns(@config)
+  end
+
+  def test_execute_should_set_logger_verbosity
+    @cli.options[:verbose] = 7
+    @logger.expects(:level=).with(7)
+    @cli.execute!
+  end
+
+  def test_execute_should_set_password
+    @cli.options[:password] = "nosoup4u"
+    @config.expects(:set).with(:password, "nosoup4u")
+    @cli.execute!
+  end
+
+  def test_execute_should_set_prevars_before_loading
+    @config.expects(:load).never
+    @config.expects(:set).with(:stage, "foobar")
+    @config.expects(:load).with("standard")
+    @cli.options[:pre_vars] = { :stage => "foobar" }
+    @cli.execute!
+  end
+
+  def test_execute_should_load_sysconf_if_sysconf_set_and_exists
+    @cli.options[:sysconf] = "/etc/capistrano.conf"
+    @config.expects(:load).with("/etc/capistrano.conf")
+    File.expects(:file?).with("/etc/capistrano.conf").returns(true)
+    @cli.execute!
+  end
+
+  def test_execute_should_not_load_sysconf_when_sysconf_set_and_not_exists
+    @cli.options[:sysconf] = "/etc/capistrano.conf"
+    File.expects(:file?).with("/etc/capistrano.conf").returns(false)
+    @cli.execute!
+  end
+
+  def test_execute_should_load_dotfile_if_dotfile_set_and_exists
+    @cli.options[:dotfile] = "/home/jamis/.caprc"
+    @config.expects(:load).with("/home/jamis/.caprc")
+    File.expects(:file?).with("/home/jamis/.caprc").returns(true)
+    @cli.execute!
+  end
+
+  def test_execute_should_not_load_dotfile_when_dotfile_set_and_not_exists
+    @cli.options[:dotfile] = "/home/jamis/.caprc"
+    File.expects(:file?).with("/home/jamis/.caprc").returns(false)
+    @cli.execute!
+  end
+
+  def test_execute_should_load_recipes_when_recipes_are_given
+    @cli.options[:recipes] = %w(config/deploy path/to/extra)
+    @config.expects(:load).with("config/deploy")
+    @config.expects(:load).with("path/to/extra")
+    @cli.execute!
+  end
+
+  def test_execute_should_set_vars_and_execute_tasks
+    @cli.options[:vars] = { :foo => "bar", :baz => "bang" }
+    @cli.options[:actions] = %w(first second)
+    @config.expects(:set).with(:foo, "bar")
+    @config.expects(:set).with(:baz, "bang")
+    @config.expects(:find_and_execute_task).with("first", :before => :start, :after => :finish)
+    @config.expects(:find_and_execute_task).with("second", :before => :start, :after => :finish)
+    @cli.execute!
+  end
+
+  def test_execute_should_call_load_and_exit_triggers
+    @cli.options[:actions] = %w(first second)
+    @config.expects(:find_and_execute_task).with("first", :before => :start, :after => :finish)
+    @config.expects(:find_and_execute_task).with("second", :before => :start, :after => :finish)
+    @config.expects(:trigger).never
+    @config.expects(:trigger).with(:load)
+    @config.expects(:trigger).with(:exit)
+    @cli.execute!
+  end
+
+  def test_execute_should_call_handle_error_when_exceptions_occur
+    @config.expects(:load).raises(Exception, "boom")
+    @cli.expects(:handle_error).with { |e,| Exception === e }
+    @cli.execute!
+  end
+
+  def test_execute_should_return_config_instance
+    assert_equal @config, @cli.execute!
+  end
+
+  def test_instantiate_configuration_should_return_new_configuration_instance
+    assert_instance_of Capistrano::Configuration, MockCLI.new.instantiate_configuration
+  end
+
+  def test_handle_error_with_auth_error_should_abort_with_message_including_user_name
+    @cli.expects(:abort).with { |s| s.include?("jamis") }
+    @cli.handle_error(Net::SSH::AuthenticationFailed.new("jamis"))
+  end
+
+  def test_handle_error_with_cap_error_should_abort_with_message
+    @cli.expects(:abort).with("Wish you were here")
+    @cli.handle_error(Capistrano::Error.new("Wish you were here"))
+  end
+
+  def test_handle_error_with_other_errors_should_reraise_error
+    other_error = Class.new(RuntimeError)
+    assert_raises(other_error) { @cli.handle_error(other_error.new("boom")) }
+  end
+
+  def test_class_execute_method_should_call_parse_and_execute_with_ARGV
+    cli = mock(:execute! => nil)
+    MockCLI.expects(:parse).with(ARGV).returns(cli)
+    MockCLI.execute
+  end
+end

data/test/cli/help_test.rb

@@ -0,0 +1,165 @@
+require "utils"
+require 'capistrano/cli/help'
+
+class CLIHelpTest < Test::Unit::TestCase
+  class MockCLI
+    attr_reader :options, :called_original
+
+    def initialize
+      @options = {}
+      @called_original = false
+    end
+
+    def execute_requested_actions(config)
+      @called_original = config
+    end
+
+    include Capistrano::CLI::Help
+  end
+
+  def setup
+    @cli = MockCLI.new
+    @cli.options[:verbose] = 0
+    @ui = stub("ui", :output_cols => 80, :output_rows => 20, :page_at= => nil)
+    MockCLI.stubs(:ui).returns(@ui)
+  end
+
+  def test_execute_requested_actions_without_tasks_or_explain_should_call_original
+    @cli.execute_requested_actions(:config)
+    @cli.expects(:task_list).never
+    @cli.expects(:explain_task).never
+    assert_equal :config, @cli.called_original
+  end
+
+  def test_execute_requested_actions_with_tasks_should_call_task_list
+    @cli.options[:tasks] = true
+    @cli.expects(:task_list).with(:config, true)
+    @cli.expects(:explain_task).never
+    @cli.execute_requested_actions(:config)
+    assert !@cli.called_original
+  end
+
+  def test_execute_requested_actions_with_explain_should_call_explain_task
+    @cli.options[:explain] = "deploy_with_niftiness"
+    @cli.expects(:task_list).never
+    @cli.expects(:explain_task).with(:config, "deploy_with_niftiness")
+    @cli.execute_requested_actions(:config)
+    assert !@cli.called_original
+  end
+
+  def test_task_list_with_no_tasks_should_emit_warning
+    config = mock("config", :task_list => [])
+    @cli.expects(:warn)
+    @cli.task_list(config)
+  end
+
+  def test_task_list_should_query_all_tasks_in_all_namespaces
+    expected_max_len = 80 - 3 - MockCLI::LINE_PADDING
+    task_list = [task("c"), task("g", "c:g"), task("b", "c:b"), task("a")]
+    task_list.each { |t| t.expects(:brief_description).with(expected_max_len).returns(t.fully_qualified_name) }
+
+    config = mock("config")
+    config.expects(:task_list).with(:all).returns(task_list)
+    @cli.stubs(:puts)
+    @cli.task_list(config)
+  end
+
+  def test_task_list_should_query_tasks_with_pattern
+    expected_max_len = 80 - 3 - MockCLI::LINE_PADDING
+    task_list = [task("g", "c:g"), task("b", "c:b")]
+    task_list.each { |t| t.expects(:brief_description).with(expected_max_len).returns(t.fully_qualified_name)}
+
+    config = mock("config")
+    config.expects(:task_list).with(:all).once.returns(task_list)
+
+    @cli.stubs(:puts)
+    @cli.task_list(config, "c")
+  end
+
+  def test_task_list_should_query_for_all_tasks_when_pattern_doesnt_match
+    expected_max_len = 80 - 3 - MockCLI::LINE_PADDING
+    task_list = [task("g", "c:g"), task("b", "c:b")]
+    task_list.each { |t| t.expects(:brief_description).with(expected_max_len).returns(t.fully_qualified_name) }
+
+    config = mock("config")
+    config.expects(:task_list).with(:all).times(2).returns(task_list)
+
+    @cli.stubs(:warn)
+    @cli.stubs(:puts)
+    @cli.task_list(config, "z")
+  end
+
+  def test_task_list_should_never_use_less_than_MIN_MAX_LEN_chars_for_descriptions
+    @ui.stubs(:output_cols).returns(20)
+    t = task("c")
+    t.expects(:brief_description).with(30).returns("hello")
+    config = mock("config", :task_list => [t])
+    @cli.stubs(:puts)
+    @cli.task_list(config)
+  end
+
+  def test_task_list_should_not_include_tasks_with_blank_description_or_internal_by_default
+    t1 = task("c")
+    t1.expects(:brief_description).returns("hello")
+    t2 = task("d", "d", "[internal] howdy")
+    t2.expects(:brief_description).never
+    t3 = task("e", "e", "")
+    t3.expects(:brief_description).never
+
+    config = mock("config", :task_list => [t1, t2, t3])
+    @cli.stubs(:puts)
+    @cli.expects(:puts).never.with { |s,| (s || "").include?("[internal]") || s =~ /#\s*$/ }
+    @cli.task_list(config)
+  end
+
+  def test_task_list_should_include_tasks_with_blank_descriptions_and_internal_when_verbose
+    t1 = task("c")
+    t1.expects(:brief_description).returns("hello")
+    t2 = task("d", "d", "[internal] howdy")
+    t2.expects(:brief_description).returns("[internal] howdy")
+    t3 = task("e", "e", "")
+    t3.expects(:brief_description).returns("")
+
+    config = mock("config", :task_list => [t1, t2, t3])
+    @cli.options[:verbose] = 1
+    @cli.stubs(:puts)
+    @cli.expects(:puts).with { |s,| (s || "").include?("[internal]") || s =~ /#\s*$/ }.at_least_once
+    @cli.task_list(config)
+  end
+
+  def test_explain_task_should_warn_if_task_does_not_exist
+    config = mock("config", :find_task => nil)
+    @cli.expects(:warn).with { |s,| s =~ /`deploy_with_niftiness'/ }
+    @cli.explain_task(config, "deploy_with_niftiness")
+  end
+
+  def test_explain_task_with_task_that_has_no_description_should_emit_stub
+    t = mock("task", :description => "")
+    config = mock("config")
+    config.expects(:find_task).with("deploy_with_niftiness").returns(t)
+    @cli.stubs(:puts)
+    @cli.expects(:puts).with("There is no description for this task.")
+    @cli.explain_task(config, "deploy_with_niftiness")
+  end
+
+  def test_explain_task_with_task_should_format_description
+    t = stub("task", :description => "line1\nline2\n\nline3")
+    config = mock("config", :find_task => t)
+    @cli.stubs(:puts)
+    @cli.explain_task(config, "deploy_with_niftiness")
+  end
+
+  def test_long_help_should_load_and_format_help_txt_file
+    File.expects(:dirname).returns "a/b/c"
+    File.expects(:read).with("a/b/c/help.txt").returns("text")
+    @ui.expects(:say).with("text\n")
+    @cli.long_help
+  end
+
+  private
+
+  def task(name, fqn=name, desc="a description")
+    stub("task", :name => name, :fully_qualified_name => fqn, :description => desc)
+  end
+
+end

data/test/cli/options_test.rb

@@ -0,0 +1,317 @@
+require "utils"
+require 'capistrano/cli/options'
+
+class CLIOptionsTest < Test::Unit::TestCase
+  class ExitException < Exception; end
+
+  class MockCLI
+    def initialize
+      @args = []
+    end
+
+    attr_reader :args
+
+    include Capistrano::CLI::Options
+  end
+
+  def setup
+    @cli = MockCLI.new
+  end
+
+  def test_parse_options_should_require_non_empty_args_list
+    @cli.stubs(:warn)
+    @cli.expects(:exit).raises(ExitException)
+    assert_raises(ExitException) { @cli.parse_options! }
+  end
+  
+  def test_parse_options_with_d_should_set_debug_option
+    @cli.args << "-d"
+    @cli.parse_options!
+    assert @cli.options[:debug]
+  end
+
+  def test_parse_options_with_n_should_set_dry_run_option
+    @cli.args << "-n"
+    @cli.parse_options!
+    assert @cli.options[:dry_run]
+  end
+
+  def test_parse_options_with_dry_run_should_set_dry_run_option
+    @cli.args << "--dry-run"
+    @cli.parse_options!
+    assert @cli.options[:dry_run]
+  end
+
+  def test_parse_options_with_e_should_set_explain_option
+    @cli.args << "-e" << "sample"
+    @cli.parse_options!
+    assert_equal "sample", @cli.options[:explain]
+  end
+
+  def test_parse_options_with_f_should_add_recipe_file
+    @cli.args << "-f" << "deploy"
+    @cli.parse_options!
+    assert_equal %w(deploy), @cli.options[:recipes]
+  end
+
+  def test_parse_options_with_multiple_f_should_add_each_as_recipe_file
+    @cli.args << "-f" << "deploy" << "-f" << "monitor"
+    @cli.parse_options!
+    assert_equal %w(deploy monitor), @cli.options[:recipes]
+  end
+
+  def test_parse_options_with_H_should_show_verbose_help_and_exit
+    @cli.expects(:exit).raises(ExitException)
+    @cli.expects(:long_help)
+    @cli.args << "-H"
+    assert_raises(ExitException) { @cli.parse_options! }
+  end
+
+  def test_parse_options_with_h_should_show_options_and_exit
+    @cli.expects(:puts).with(@cli.option_parser)
+    @cli.expects(:exit).raises(ExitException)
+    @cli.args << "-h"
+    assert_raises(ExitException) { @cli.parse_options! }
+  end
+
+  def test_parse_options_with_p_should_prompt_for_password
+    MockCLI.expects(:password_prompt).returns(:the_password)
+    @cli.args << "-p"
+    @cli.parse_options!
+    assert_equal :the_password, @cli.options[:password]
+  end
+
+  def test_parse_options_without_p_should_set_proc_for_password
+    @cli.args << "-e" << "sample"
+    @cli.parse_options!
+    assert_instance_of Proc, @cli.options[:password]
+  end
+
+  def test_parse_options_with_q_should_set_verbose_to_0
+    @cli.args << "-q"
+    @cli.parse_options!
+    assert_equal 0, @cli.options[:verbose]
+  end
+
+  def test_parse_options_with_S_should_set_pre_vars
+    @cli.args << "-S" << "foo=bar"
+    @cli.parse_options!
+    assert_equal "bar", @cli.options[:pre_vars][:foo]
+  end
+
+  def test_S_should_coerce_digits_to_integers
+    @cli.args << "-S" << "foo=1234"
+    @cli.parse_options!
+    assert_equal 1234, @cli.options[:pre_vars][:foo]
+  end
+
+  def test_S_should_treat_quoted_integers_as_string
+    @cli.args << "-S" << "foo=\"1234\""
+    @cli.parse_options!
+    assert_equal "1234", @cli.options[:pre_vars][:foo]
+  end
+
+  def test_S_should_treat_digits_with_dot_as_floating_point
+    @cli.args << "-S" << "foo=3.1415"
+    @cli.parse_options!
+    assert_equal 3.1415, @cli.options[:pre_vars][:foo]
+  end
+
+  def test_S_should_treat_true_as_boolean_true
+    @cli.args << "-S" << "foo=true"
+    @cli.parse_options!
+    assert_equal true, @cli.options[:pre_vars][:foo]
+  end
+
+  def test_S_should_treat_false_as_boolean_false
+    @cli.args << "-S" << "foo=false"
+    @cli.parse_options!
+    assert_equal false, @cli.options[:pre_vars][:foo]
+  end
+
+  def test_S_should_treat_nil_as_nil
+    @cli.args << "-S" << "foo=nil"
+    @cli.parse_options!
+    assert_equal nil, @cli.options[:pre_vars][:foo]
+  end
+
+  def test_parse_options_with_s_should_set_vars
+    @cli.args << "-s" << "foo=bar"
+    @cli.parse_options!
+    assert_equal "bar", @cli.options[:vars][:foo]
+  end
+
+  def test_s_should_coerce_digits_to_integers
+    @cli.args << "-s" << "foo=1234"
+    @cli.parse_options!
+    assert_equal 1234, @cli.options[:vars][:foo]
+  end
+
+  def test_s_should_treat_quoted_integers_as_string
+    @cli.args << "-s" << "foo=\"1234\""
+    @cli.parse_options!
+    assert_equal "1234", @cli.options[:vars][:foo]
+  end
+
+  def test_s_should_treat_digits_with_dot_as_floating_point
+    @cli.args << "-s" << "foo=3.1415"
+    @cli.parse_options!
+    assert_equal 3.1415, @cli.options[:vars][:foo]
+  end
+
+  def test_s_should_treat_true_as_boolean_true
+    @cli.args << "-s" << "foo=true"
+    @cli.parse_options!
+    assert_equal true, @cli.options[:vars][:foo]
+  end
+
+  def test_s_should_treat_false_as_boolean_false
+    @cli.args << "-s" << "foo=false"
+    @cli.parse_options!
+    assert_equal false, @cli.options[:vars][:foo]
+  end
+
+  def test_s_should_treat_nil_as_nil
+    @cli.args << "-s" << "foo=nil"
+    @cli.parse_options!
+    assert_equal nil, @cli.options[:vars][:foo]
+  end
+
+  def test_parse_options_with_T_should_set_tasks_option_and_set_verbose_off
+    @cli.args << "-T"
+    @cli.parse_options!
+    assert @cli.options[:tasks]
+    assert_equal 0, @cli.options[:verbose]
+  end
+
+  def test_parse_options_with_V_should_show_version_and_exit
+    @cli.args << "-V"
+    @cli.expects(:puts).with { |s| s.include?(Capistrano::Version::STRING) }
+    @cli.expects(:exit).raises(ExitException)
+    assert_raises(ExitException) { @cli.parse_options! }
+  end
+
+  def test_parse_options_with_v_should_set_verbose_to_1
+    @cli.args << "-v"
+    @cli.parse_options!
+    assert_equal 1, @cli.options[:verbose]
+  end
+
+  def test_parse_options_with_multiple_v_should_set_verbose_accordingly
+    @cli.args << "-vvvvvvv"
+    @cli.parse_options!
+    assert_equal 7, @cli.options[:verbose]
+  end
+
+  def test_parse_options_without_X_should_set_sysconf
+    @cli.args << "-v"
+    @cli.parse_options!
+    assert @cli.options.key?(:sysconf)
+  end
+
+  def test_parse_options_with_X_should_unset_sysconf
+    @cli.args << "-X"
+    @cli.parse_options!
+    assert !@cli.options.key?(:sysconf)
+  end
+
+  def test_parse_options_without_x_should_set_dotfile
+    @cli.args << "-v"
+    @cli.parse_options!
+    assert @cli.options.key?(:dotfile)
+  end
+
+  def test_parse_options_with_x_should_unset_dotfile
+    @cli.args << "-x"
+    @cli.parse_options!
+    assert !@cli.options.key?(:dotfile)
+  end
+
+  def test_parse_options_without_q_or_v_should_set_verbose_to_3
+    @cli.args << "-x"
+    @cli.parse_options!
+    assert_equal 3, @cli.options[:verbose]
+  end
+
+  def test_should_search_for_default_recipes_if_f_not_given
+    @cli.expects(:look_for_default_recipe_file!)
+    @cli.args << "-v"
+    @cli.parse_options!
+  end
+
+  def test_should_not_search_for_default_recipes_if_f_given
+    @cli.expects(:look_for_default_recipe_file!).never
+    @cli.args << "-f" << "hello"
+    @cli.parse_options!
+  end
+
+  def test_F_should_search_for_default_recipes_even_if_f_is_given
+    @cli.expects(:look_for_default_recipe_file!)
+    @cli.args << "-Ff" << "hello"
+    @cli.parse_options!
+  end
+
+  def test_should_extract_env_vars_from_command_line
+    assert_nil ENV["HELLO"]
+    assert_nil ENV["ANOTHER"]
+
+    @cli.args << "HELLO=world" << "hello" << "ANOTHER=value"
+    @cli.parse_options!
+
+    assert_equal "world", ENV["HELLO"]
+    assert_equal "value", ENV["ANOTHER"]
+  ensure
+    ENV.delete("HELLO")
+    ENV.delete("ANOTHER")
+  end
+
+  def test_remaining_args_should_be_added_to_actions_list
+    @cli.args << "-v" << "HELLO=world" << "-f" << "foo" << "something" << "else"
+    @cli.parse_options!
+    assert_equal %w(something else), @cli.args
+  ensure
+    ENV.delete("HELLO")
+  end
+
+  def test_search_for_default_recipe_file_should_look_for_Capfile
+    File.stubs(:file?).returns(false)
+    File.expects(:file?).with("Capfile").returns(true)
+    @cli.args << "-v"
+    @cli.parse_options!
+    assert_equal %w(Capfile), @cli.options[:recipes]
+  end
+
+  def test_search_for_default_recipe_file_should_look_for_capfile
+    File.stubs(:file?).returns(false)
+    File.expects(:file?).with("capfile").returns(true)
+    @cli.args << "-v"
+    @cli.parse_options!
+    assert_equal %w(capfile), @cli.options[:recipes]
+  end
+
+  def test_search_for_default_recipe_should_hike_up_the_directory_tree_until_it_finds_default_recipe
+    File.stubs(:file?).returns(false)
+    File.expects(:file?).with("capfile").times(2).returns(false,true)
+    Dir.expects(:pwd).times(3).returns(*%w(/bar/baz /bar/baz /bar))
+    Dir.expects(:chdir).with("..")
+    @cli.args << "-v"
+    @cli.parse_options!
+    assert_equal %w(capfile), @cli.options[:recipes]
+  end
+
+  def test_search_for_default_recipe_should_halt_at_root_directory
+    File.stubs(:file?).returns(false)
+    Dir.expects(:pwd).times(7).returns(*%w(/bar/baz /bar/baz /bar /bar / / /))
+    Dir.expects(:chdir).with("..").times(3)
+    Dir.expects(:chdir).with("/bar/baz")
+    @cli.args << "-v"
+    @cli.parse_options!
+    assert @cli.options[:recipes].empty?
+  end
+
+  def test_parse_should_instantiate_new_cli_and_call_parse_options
+    cli = mock("cli", :parse_options! => nil)
+    MockCLI.expects(:new).with(%w(a b c)).returns(cli)
+    assert_equal cli, MockCLI.parse(%w(a b c))
+  end
+end

data/test/cli/ui_test.rb

@@ -0,0 +1,28 @@
+require "utils"
+require 'capistrano/cli/ui'
+
+class CLIUITest < Test::Unit::TestCase
+  class MockCLI
+    include Capistrano::CLI::UI
+  end
+
+  def test_ui_should_return_highline_instance
+    assert_instance_of HighLine, MockCLI.ui
+  end
+
+  def test_password_prompt_should_have_default_prompt_and_set_echo_false
+    q = mock("question")
+    q.expects(:echo=).with(false)
+    ui = mock("ui")
+    ui.expects(:ask).with("Password: ").yields(q).returns("sayuncle")
+    MockCLI.expects(:ui).returns(ui)
+    assert_equal "sayuncle", MockCLI.password_prompt
+  end
+
+  def test_password_prompt_with_custom_prompt_should_use_custom_prompt
+    ui = mock("ui")
+    ui.expects(:ask).with("Give the passphrase: ").returns("sayuncle")
+    MockCLI.expects(:ui).returns(ui)
+    assert_equal "sayuncle", MockCLI.password_prompt("Give the passphrase: ")
+  end
+end

data/test/cli_test.rb

@@ -0,0 +1,17 @@
+require "utils"
+require 'capistrano/cli'
+
+class CLI_Test < Test::Unit::TestCase
+  def test_options_ui_and_help_modules_should_integrate_successfully_with_configuration
+    cli = Capistrano::CLI.parse(%w(-T))
+    cli.expects(:puts).at_least_once
+    cli.execute!
+  end
+
+  def test_options_and_execute_modules_should_integrate_successfully_with_configuration
+    path = "#{File.dirname(__FILE__)}/fixtures/cli_integration.rb"
+    cli = Capistrano::CLI.parse(%W(-q -f #{path} testing))
+    config = cli.execute!
+    assert config[:testing_occurred]
+  end
+end