capistrano 2.1.0 → 3.0.0

data/test/command_test.rb

@@ -1,309 +0,0 @@
-require "#{File.dirname(__FILE__)}/utils"
-require 'capistrano/command'
-
-class CommandTest < Test::Unit::TestCase
-  def test_command_should_open_channels_on_all_sessions
-    s1 = mock(:open_channel => nil)
-    s2 = mock(:open_channel => nil)
-    s3 = mock(:open_channel => nil)
-    assert_equal "ls", Capistrano::Command.new("ls", [s1, s2, s3]).command
-  end
-
-  def test_command_with_newlines_should_be_properly_escaped
-    cmd = Capistrano::Command.new("ls\necho", [mock(:open_channel => nil)])
-    assert_equal "ls\\\necho", cmd.command
-  end
-
-  def test_command_with_windows_newlines_should_be_properly_escaped
-    cmd = Capistrano::Command.new("ls\r\necho", [mock(:open_channel => nil)])
-    assert_equal "ls\\\necho", cmd.command
-  end
-
-  def test_command_with_pty_should_request_pty_and_register_success_callback
-    session = setup_for_extracting_channel_action(:on_success) do |ch|
-      ch.expects(:request_pty).with(:want_reply => true)
-      ch.expects(:exec).with(%(sh -c "ls"))
-    end
-    Capistrano::Command.new("ls", [session], :pty => true)
-  end
-
-  def test_command_with_env_key_should_have_environment_constructed_and_prepended
-    session = setup_for_extracting_channel_action do |ch|
-      ch.expects(:request_pty).never
-      ch.expects(:exec).with(%(env FOO=bar sh -c "ls"))
-    end
-    Capistrano::Command.new("ls", [session], :env => { "FOO" => "bar" })
-  end
-
-  def test_env_with_symbolic_key_should_be_accepted_as_a_string
-    session = setup_for_extracting_channel_action do |ch|
-      ch.expects(:exec).with(%(env FOO=bar sh -c "ls"))
-    end
-    Capistrano::Command.new("ls", [session], :env => { :FOO => "bar" })
-  end
-
-  def test_env_as_string_should_be_substituted_in_directly
-    session = setup_for_extracting_channel_action do |ch|
-      ch.expects(:exec).with(%(env HOWDY=there sh -c "ls"))
-    end
-    Capistrano::Command.new("ls", [session], :env => "HOWDY=there")
-  end
-
-  def test_env_with_symbolic_value_should_be_accepted_as_string
-    session = setup_for_extracting_channel_action do |ch|
-      ch.expects(:exec).with(%(env FOO=bar sh -c "ls"))
-    end
-    Capistrano::Command.new("ls", [session], :env => { "FOO" => :bar })
-  end
-
-  def test_env_value_should_be_escaped
-    session = setup_for_extracting_channel_action do |ch|
-      ch.expects(:exec).with(%(env FOO=(\\ \\\"bar\\\"\\ ) sh -c "ls"))
-    end
-    Capistrano::Command.new("ls", [session], :env => { "FOO" => '( "bar" )' })
-  end
-
-  def test_env_with_multiple_keys_should_chain_the_entries_together
-    session = setup_for_extracting_channel_action do |ch|
-      ch.expects(:exec).with do |command|
-        command =~ /^env / &&
-        command =~ /\ba=b\b/ &&
-        command =~ /\bc=d\b/ &&
-        command =~ /\be=f\b/ &&
-        command =~ / sh -c "ls"$/
-      end
-    end
-    Capistrano::Command.new("ls", [session], :env => { :a => :b, :c => :d, :e => :f })
-  end
-
-  def test_open_channel_should_set_host_key_on_channel
-    session = mock(:xserver => server("capistrano"))
-    channel = stub_everything
-
-    session.expects(:open_channel).yields(channel)
-    channel.expects(:[]=).with(:host, "capistrano")
-    channel.stubs(:[]).with(:host).returns("capistrano")
-
-    Capistrano::Command.new("ls", [session])
-  end
-
-  def test_open_channel_should_set_options_key_on_channel
-    session = mock(:xserver => server("capistrano"))
-    channel = stub_everything
-
-    session.expects(:open_channel).yields(channel)
-    channel.expects(:[]=).with(:options, {:data => "here we go"})
-    channel.stubs(:[]).with(:host).returns("capistrano")
-
-    Capistrano::Command.new("ls", [session], :data => "here we go")
-  end
-
-  def test_successful_channel_should_send_command
-    session = setup_for_extracting_channel_action do |ch|
-      ch.expects(:exec).with(%(sh -c "ls"))
-    end
-    Capistrano::Command.new("ls", [session])
-  end
-
-  def test_successful_channel_with_shell_option_should_send_command_via_specified_shell
-    session = setup_for_extracting_channel_action do |ch|
-      ch.expects(:exec).with(%(/bin/bash -c "ls"))
-    end
-    Capistrano::Command.new("ls", [session], :shell => "/bin/bash")
-  end
-
-  def test_successful_channel_with_shell_false_should_send_command_without_shell
-    session = setup_for_extracting_channel_action do |ch|
-      ch.expects(:exec).with(%(echo `hostname`))
-    end
-    Capistrano::Command.new("echo `hostname`", [session], :shell => false)
-  end
-
-  def test_successful_channel_should_send_data_if_data_key_is_present
-    session = setup_for_extracting_channel_action do |ch|
-      ch.expects(:exec).with(%(sh -c "ls"))
-      ch.expects(:send_data).with("here we go")
-    end
-    Capistrano::Command.new("ls", [session], :data => "here we go")
-  end
-
-  def test_unsuccessful_pty_request_should_close_channel
-    session = setup_for_extracting_channel_action(:on_failure) do |ch|
-      ch.expects(:close)
-    end
-    Capistrano::Command.new("ls", [session], :pty => true)
-  end
-
-  def test_on_data_should_invoke_callback_as_stdout
-    session = setup_for_extracting_channel_action(:on_data, "hello")
-    called = false
-    Capistrano::Command.new("ls", [session]) do |ch, stream, data|
-      called = true
-      assert_equal :out, stream
-      assert_equal "hello", data
-    end
-    assert called
-  end
-
-  def test_on_extended_data_should_invoke_callback_as_stderr
-    session = setup_for_extracting_channel_action(:on_extended_data, 2, "hello")
-    called = false
-    Capistrano::Command.new("ls", [session]) do |ch, stream, data|
-      called = true
-      assert_equal :err, stream
-      assert_equal "hello", data
-    end
-    assert called
-  end
-
-  def test_on_request_should_record_exit_status
-    data = mock(:read_long => 5)
-    session = setup_for_extracting_channel_action(:on_request, "exit-status", nil, data) do |ch|
-      ch.expects(:[]=).with(:status, 5)
-    end
-    Capistrano::Command.new("ls", [session])
-  end
-
-  def test_on_close_should_set_channel_closed
-    session = setup_for_extracting_channel_action(:on_close) do |ch|
-      ch.expects(:[]=).with(:closed, true)
-    end
-    Capistrano::Command.new("ls", [session])
-  end
-
-  def test_stop_should_close_all_open_channels
-    sessions = [mock("session", :open_channel => new_channel(false)),
-                mock("session", :open_channel => new_channel(true)),
-                mock("session", :open_channel => new_channel(false))]
-
-    cmd = Capistrano::Command.new("ls", sessions)
-    cmd.stop!
-  end
-
-  def test_process_should_return_cleanly_if_all_channels_have_zero_exit_status
-    sessions = [mock("session", :open_channel => new_channel(true, 0)),
-                mock("session", :open_channel => new_channel(true, 0)),
-                mock("session", :open_channel => new_channel(true, 0))]
-    cmd = Capistrano::Command.new("ls", sessions)
-    assert_nothing_raised { cmd.process! }
-  end
-
-  def test_process_should_raise_error_if_any_channel_has_non_zero_exit_status
-    sessions = [mock("session", :open_channel => new_channel(true, 0)),
-                mock("session", :open_channel => new_channel(true, 0)),
-                mock("session", :open_channel => new_channel(true, 1))]
-    cmd = Capistrano::Command.new("ls", sessions)
-    assert_raises(Capistrano::CommandError) { cmd.process! }
-  end
-
-  def test_command_error_should_include_accessor_with_host_array
-    sessions = [mock("session", :open_channel => new_channel(true, 0)),
-                mock("session", :open_channel => new_channel(true, 0)),
-                mock("session", :open_channel => new_channel(true, 1))]
-    cmd = Capistrano::Command.new("ls", sessions)
-
-    begin
-      cmd.process!
-      flunk "expected an exception to be raised"
-    rescue Capistrano::CommandError => e
-      assert e.respond_to?(:hosts)
-      assert_equal %w(capistrano), e.hosts.map { |h| h.to_s }
-    end
-  end
-
-  def test_process_should_loop_until_all_channels_are_closed
-    new_channel = Proc.new do |times|
-      ch = mock("channel")
-      returns = [false] * (times-1)
-      ch.stubs(:[]).with(:closed).returns(*(returns + [true]))
-      con = mock("connection")
-      con.expects(:process).with(true).times(times-1)
-      ch.expects(:connection).times(times-1).returns(con)
-      ch.expects(:[]).with(:status).returns(0)
-      ch
-    end
-
-    sessions = [mock("session", :open_channel => new_channel[5]),
-                mock("session", :open_channel => new_channel[10]),
-                mock("session", :open_channel => new_channel[7])]
-    cmd = Capistrano::Command.new("ls", sessions)
-    assert_nothing_raised { cmd.process! }
-  end
-
-  def test_process_should_ping_all_connections_each_second
-    now = Time.now
-
-    new_channel = Proc.new do
-      ch = mock("channel")
-      ch.stubs(:now => now)
-      def ch.[](key)
-        case key
-        when :status then 0
-        when :closed then Time.now - now < 1.1 ? false : true
-        else raise "unknown key: #{key}"
-        end
-      end
-      con = mock("connection")
-      con.stubs(:process)
-      con.expects(:ping!)
-      ch.stubs(:connection).returns(con)
-      ch
-    end
-
-    sessions = [mock("session", :open_channel => new_channel[]),
-                mock("session", :open_channel => new_channel[]),
-                mock("session", :open_channel => new_channel[])]
-    cmd = Capistrano::Command.new("ls", sessions)
-    assert_nothing_raised { cmd.process! }
-  end
-
-  def test_process_should_instantiate_command_and_process!
-    cmd = mock("command", :process! => nil)
-    Capistrano::Command.expects(:new).with("ls -l", %w(a b c), {:foo => "bar"}).yields(:command).returns(cmd)
-    parameter = nil
-    Capistrano::Command.process("ls -l", %w(a b c), :foo => "bar") { |cmd| parameter = cmd }
-    assert_equal :command, parameter
-  end
-
-  def test_process_with_host_placeholder_should_substitute_placeholder_with_each_host
-    session = setup_for_extracting_channel_action do |ch|
-      ch.expects(:exec).with(%(sh -c "echo capistrano"))
-    end
-    Capistrano::Command.new("echo $CAPISTRANO:HOST$", [session])
-  end
-
-  def test_process_with_unknown_placeholder_should_not_replace_placeholder
-    session = setup_for_extracting_channel_action do |ch|
-      ch.expects(:exec).with(%(sh -c "echo \\$CAPISTRANO:OTHER\\$"))
-    end
-    Capistrano::Command.new("echo $CAPISTRANO:OTHER$", [session])
-  end
-
-  private
-
-    def new_channel(closed, status=nil)
-      ch = mock("channel")
-      ch.expects(:[]).with(:closed).returns(closed)
-      ch.expects(:[]).with(:status).returns(status) if status
-      ch.expects(:close) unless closed
-      ch.stubs(:[]).with(:host).returns("capistrano")
-      ch.stubs(:[]).with(:server).returns(server("capistrano"))
-      ch
-    end
-
-    def setup_for_extracting_channel_action(action=nil, *args)
-      s = server("capistrano")
-      session = mock("session", :xserver => s)
-
-      channel = stub_everything
-      session.expects(:open_channel).yields(channel)
-
-      channel.stubs(:[]).with(:server).returns(s)
-      channel.stubs(:[]).with(:host).returns(s.host)
-      channel.expects(action).yields(channel, *args) if action
-
-      yield channel if block_given?
-
-      session
-    end
-end

data/test/configuration/actions/file_transfer_test.rb

@@ -1,40 +0,0 @@
-require "#{File.dirname(__FILE__)}/../../utils"
-require 'capistrano/configuration/actions/file_transfer'
-
-class ConfigurationActionsFileTransferTest < Test::Unit::TestCase
-  class MockConfig
-    include Capistrano::Configuration::Actions::FileTransfer
-  end
-
-  def setup
-    @config = MockConfig.new
-    @config.stubs(:logger).returns(stub_everything)
-  end
-
-  def test_put_should_pass_options_to_execute_on_servers
-    @config.expects(:execute_on_servers).with(:foo => "bar")
-    @config.put("some data", "test.txt", :foo => "bar")
-  end
-
-  def test_put_should_delegate_to_Upload_process
-    @config.expects(:execute_on_servers).yields(%w(s1 s2 s3).map { |s| mock(:host => s) })
-    @config.expects(:sessions).times(3).returns(Hash.new{|h,k| h[k] = k.host.to_sym})
-    Capistrano::Upload.expects(:process).with([:s1,:s2,:s3], "test.txt", :data => "some data", :mode => 0777, :logger => @config.logger)
-    @config.put("some data", "test.txt", :mode => 0777)
-  end
-
-  def test_get_should_pass_options_execute_on_servers_including_once
-    @config.expects(:execute_on_servers).with(:foo => "bar", :once => true)
-    @config.get("test.txt", "test.txt", :foo => "bar")
-  end
-
-  def test_get_should_use_sftp_get_file_to_local_path
-    sftp = mock("sftp", :state => :closed, :connect => true)
-    sftp.expects(:get_file).with("remote.txt", "local.txt")
-
-    s = server("capistrano")
-    @config.expects(:execute_on_servers).yields([s])
-    @config.expects(:sessions).returns(s => mock("session", :sftp => sftp))
-    @config.get("remote.txt", "local.txt")
-  end
-end

data/test/configuration/actions/inspect_test.rb

@@ -1,62 +0,0 @@
-require "#{File.dirname(__FILE__)}/../../utils"
-require 'capistrano/configuration/actions/inspect'
-
-class ConfigurationActionsInspectTest < Test::Unit::TestCase
-  class MockConfig
-    include Capistrano::Configuration::Actions::Inspect
-  end
-
-  def setup
-    @config = MockConfig.new
-    @config.stubs(:logger).returns(stub_everything)
-  end
-
-  def test_stream_should_pass_options_through_to_run
-    @config.expects(:invoke_command).with("tail -f foo.log", :once => true)
-    @config.stream("tail -f foo.log", :once => true)
-  end
-
-  def test_stream_should_emit_stdout_via_puts
-    @config.expects(:invoke_command).yields(mock("channel"), :out, "something streamed")
-    @config.expects(:puts).with("something streamed")
-    @config.expects(:warn).never
-    @config.stream("tail -f foo.log")
-  end
-
-  def test_stream_should_emit_stderr_via_warn
-    ch = mock("channel")
-    ch.expects(:[]).with(:server).returns(server("capistrano"))
-    @config.expects(:invoke_command).yields(ch, :err, "something streamed")
-    @config.expects(:puts).never
-    @config.expects(:warn).with("[err :: capistrano] something streamed")
-    @config.stream("tail -f foo.log")
-  end
-
-  def test_capture_should_pass_options_merged_with_once_to_run
-    @config.expects(:invoke_command).with("hostname", :foo => "bar", :once => true)
-    @config.capture("hostname", :foo => "bar")
-  end
-
-  def test_capture_with_stderr_result_should_raise_capture_error
-    @config.expects(:invoke_command).yields(mock("channel"), :err, "boom")
-    assert_raises(Capistrano::CaptureError) { @config.capture("hostname") }
-  end
-
-  def test_capture_with_stdout_should_aggregate_and_return_stdout
-    config_expects_invoke_command_to_loop_with(mock("channel"), "foo", "bar", "baz")
-    assert_equal "foobarbaz", @config.capture("hostname")
-  end
-
-  private
-
-    def config_expects_invoke_command_to_loop_with(channel, *output)
-      class <<@config
-        attr_accessor :script, :channel
-        def invoke_command(*args)
-          script.each { |item| yield channel, :out, item }
-        end
-      end
-      @config.channel = channel
-      @config.script = output
-    end
-end

data/test/configuration/actions/invocation_test.rb

@@ -1,202 +0,0 @@
-require "#{File.dirname(__FILE__)}/../../utils"
-require 'capistrano/configuration/actions/invocation'
-
-class ConfigurationActionsInvocationTest < Test::Unit::TestCase
-  class MockConfig
-    attr_reader :options
-
-    def initialize
-      @options = {}
-    end
-
-    def [](*args)
-      @options[*args]
-    end
-
-    def set(name, value)
-      @options[name] = value
-    end
-
-    def fetch(*args)
-      @options.fetch(*args)
-    end
-
-    include Capistrano::Configuration::Actions::Invocation
-  end
-
-  def setup
-    @config = MockConfig.new
-    @original_io_proc = MockConfig.default_io_proc
-    @config.stubs(:logger).returns(stub_everything)
-  end
-
-  def teardown
-    MockConfig.default_io_proc = @original_io_proc
-  end
-
-  def test_run_options_should_be_passed_to_execute_on_servers
-    @config.expects(:execute_on_servers).with(:foo => "bar")
-    @config.run "ls", :foo => "bar"
-  end
-
-  def test_run_without_block_should_use_default_io_proc
-    @config.expects(:execute_on_servers).yields(%w(s1 s2 s3).map { |s| server(s) })
-    @config.expects(:sessions).returns(Hash.new { |h,k| h[k] = k.host.to_sym }).times(3)
-    prepare_command("ls", [:s1, :s2, :s3], {:logger => @config.logger})
-    MockConfig.default_io_proc = inspectable_proc
-    @config.run "ls"
-  end
-
-  def test_run_with_block_should_use_block
-    @config.expects(:execute_on_servers).yields(%w(s1 s2 s3).map { |s| mock(:host => s) })
-    @config.expects(:sessions).returns(Hash.new { |h,k| h[k] = k.host.to_sym }).times(3)
-    prepare_command("ls", [:s1, :s2, :s3], {:logger => @config.logger})
-    MockConfig.default_io_proc = Proc.new { |a,b,c| raise "shouldn't get here" }
-    @config.run("ls", &inspectable_proc)
-  end
-
-  def test_add_default_command_options_should_return_bare_options_if_there_is_no_env_or_shell_specified
-    assert_equal({:foo => "bar"}, @config.add_default_command_options(:foo => "bar"))
-  end
-
-  def test_add_default_command_options_should_merge_default_environment_as_env
-    @config[:default_environment][:bang] = "baz"
-    assert_equal({:foo => "bar", :env => { :bang => "baz" }}, @config.add_default_command_options(:foo => "bar"))
-  end
-
-  def test_add_default_command_options_should_merge_env_with_default_environment
-    @config[:default_environment][:bang] = "baz"
-    @config[:default_environment][:bacon] = "crunchy"
-    assert_equal({:foo => "bar", :env => { :bang => "baz", :bacon => "chunky", :flip => "flop" }}, @config.add_default_command_options(:foo => "bar", :env => {:bacon => "chunky", :flip => "flop"}))
-  end
-
-  def test_add_default_command_options_should_use_default_shell_if_present
-    @config.set :default_shell, "/bin/bash"
-    assert_equal({:foo => "bar", :shell => "/bin/bash"}, @config.add_default_command_options(:foo => "bar"))
-  end
-
-  def test_add_default_command_options_should_use_shell_in_preference_of_default_shell
-    @config.set :default_shell, "/bin/bash"
-    assert_equal({:foo => "bar", :shell => "/bin/sh"}, @config.add_default_command_options(:foo => "bar", :shell => "/bin/sh"))
-  end
-
-  def test_default_io_proc_should_log_stdout_arguments_as_info
-    ch = { :host => "capistrano",
-           :server => server("capistrano"),
-           :options => { :logger => mock("logger") } }
-    ch[:options][:logger].expects(:info).with("data stuff", "out :: capistrano")
-    MockConfig.default_io_proc[ch, :out, "data stuff"]
-  end
-
-  def test_default_io_proc_should_log_stderr_arguments_as_important
-    ch = { :host => "capistrano",
-           :server => server("capistrano"),
-           :options => { :logger => mock("logger") } }
-    ch[:options][:logger].expects(:important).with("data stuff", "err :: capistrano")
-    MockConfig.default_io_proc[ch, :err, "data stuff"]
-  end
-
-  def test_sudo_should_default_to_sudo
-    @config.expects(:run).with("sudo -p 'sudo password: ' ls", {})
-    @config.sudo "ls"
-  end
-
-  def test_sudo_should_use_sudo_variable_definition
-    @config.expects(:run).with("/opt/local/bin/sudo -p 'sudo password: ' ls", {})
-    @config.options[:sudo] = "/opt/local/bin/sudo"
-    @config.sudo "ls"
-  end
-
-  def test_sudo_should_interpret_as_option_as_user
-    @config.expects(:run).with("sudo -p 'sudo password: ' -u app ls", {})
-    @config.sudo "ls", :as => "app"
-  end
-
-  def test_sudo_should_pass_options_through_to_run
-    @config.expects(:run).with("sudo -p 'sudo password: ' ls", :foo => "bar")
-    @config.sudo "ls", :foo => "bar"
-  end
-
-  def test_sudo_should_interpret_sudo_prompt_variable_as_custom_prompt
-    @config.set :sudo_prompt, "give it to me: "
-    @config.expects(:run).with("sudo -p 'give it to me: ' ls", {})
-    @config.sudo "ls"
-  end
-
-  def test_sudo_behavior_callback_should_send_password_when_prompted_with_default_sudo_prompt
-    ch = mock("channel")
-    ch.expects(:send_data).with("g00b3r\n")
-    @config.options[:password] = "g00b3r"
-    @config.sudo_behavior_callback(nil)[ch, nil, "sudo password: "]
-  end
-
-  def test_sudo_behavior_callback_should_send_password_when_prompted_with_custom_sudo_prompt
-    ch = mock("channel")
-    ch.expects(:send_data).with("g00b3r\n")
-    @config.set :sudo_prompt, "give it to me: "
-    @config.options[:password] = "g00b3r"
-    @config.sudo_behavior_callback(nil)[ch, nil, "give it to me: "]
-  end
-
-  def test_sudo_behavior_callback_with_incorrect_password_on_first_prompt
-    ch = mock("channel")
-    ch.stubs(:[]).with(:host).returns("capistrano")
-    ch.stubs(:[]).with(:server).returns(server("capistrano"))
-    @config.expects(:reset!).with(:password)
-    @config.sudo_behavior_callback(nil)[ch, nil, "blah blah try again blah blah"]
-  end
-
-  def test_sudo_behavior_callback_with_incorrect_password_on_subsequent_prompts
-    callback = @config.sudo_behavior_callback(nil)
-
-    ch = mock("channel")
-    ch.stubs(:[]).with(:host).returns("capistrano")
-    ch.stubs(:[]).with(:server).returns(server("capistrano"))
-    ch2 = mock("channel")
-    ch2.stubs(:[]).with(:host).returns("cap2")
-    ch2.stubs(:[]).with(:server).returns(server("cap2"))
-
-    @config.expects(:reset!).with(:password).times(2)
-
-    callback[ch, nil, "blah blah try again blah blah"]
-    callback[ch2, nil, "blah blah try again blah blah"] # shouldn't call reset!
-    callback[ch, nil, "blah blah try again blah blah"]
-  end
-
-  def test_sudo_behavior_callback_should_defer_to_fallback_for_other_output
-    callback = @config.sudo_behavior_callback(inspectable_proc)
-
-    a = mock("channel", :called => true)
-    b = mock("stream", :called => true)
-    c = mock("data", :called => true)
-
-    callback[a, b, c]
-  end
-
-  def test_invoke_command_should_default_to_run
-    @config.expects(:run).with("ls", :once => true)
-    @config.invoke_command("ls", :once => true)
-  end
-
-  def test_invoke_command_should_delegate_to_method_identified_by_via
-    @config.expects(:foobar).with("ls", :once => true)
-    @config.invoke_command("ls", :once => true, :via => :foobar)
-  end
-
-  private
-
-    def inspectable_proc
-      Proc.new do |ch, stream, data|
-        ch.called
-        stream.called
-        data.called
-      end
-    end
-
-    def prepare_command(command, sessions, options)
-      a = mock("channel", :called => true)
-      b = mock("stream", :called => true)
-      c = mock("data", :called => true)
-      Capistrano::Command.expects(:process).with(command, sessions, options).yields(a, b, c)
-    end
-end