mirror of
https://github.com/capistrano/capistrano
synced 2023-03-27 23:21:18 -04:00
322 lines
11 KiB
Ruby
322 lines
11 KiB
Ruby
require "utils"
|
|
require 'capistrano/command'
|
|
require 'capistrano/configuration'
|
|
|
|
class CommandTest < Test::Unit::TestCase
|
|
def test_command_should_open_channels_on_all_sessions
|
|
s1, s2, s3 = mock_session, mock_session, mock_session
|
|
assert_equal "ls", Capistrano::Command.new("ls", [s1, s2, s3]).tree.fallback.command
|
|
end
|
|
|
|
def test_command_with_newlines_should_be_properly_escaped
|
|
cmd = Capistrano::Command.new("ls\necho", [mock_session])
|
|
assert_equal "ls\\\necho", cmd.tree.fallback.command
|
|
end
|
|
|
|
def test_command_with_windows_newlines_should_be_properly_escaped
|
|
cmd = Capistrano::Command.new("ls\r\necho", [mock_session])
|
|
assert_equal "ls\\\necho", cmd.tree.fallback.command
|
|
end
|
|
|
|
def test_command_with_pty_should_request_pty_and_register_success_callback
|
|
session = setup_for_extracting_channel_action(:request_pty, true) do |ch|
|
|
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
|
|
channel = nil
|
|
session = setup_for_extracting_channel_action { |ch| channel = ch }
|
|
Capistrano::Command.new("ls", [session])
|
|
assert_equal "capistrano", channel[:host]
|
|
end
|
|
|
|
def test_open_channel_should_set_options_key_on_channel
|
|
channel = nil
|
|
session = setup_for_extracting_channel_action { |ch| channel = ch }
|
|
Capistrano::Command.new("ls", [session], :data => "here we go")
|
|
assert_equal({ :data => 'here we go' }, channel[:options])
|
|
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(:request_pty, false) 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)
|
|
channel = nil
|
|
session = setup_for_extracting_channel_action([:on_request, "exit-status"], data) { |ch| channel = ch }
|
|
Capistrano::Command.new("ls", [session])
|
|
assert_equal 5, channel[:status]
|
|
end
|
|
|
|
def test_on_request_should_log_exit_signal_if_logger_present
|
|
data = mock(:read_string => "TERM")
|
|
logger = stub_everything
|
|
|
|
session = setup_for_extracting_channel_action([:on_request, "exit-signal"], data)
|
|
logger.expects(:important).with("command received signal TERM", server("capistrano"))
|
|
|
|
Capistrano::Command.new("puppet", [session], :logger => logger)
|
|
end
|
|
|
|
def test_on_close_should_set_channel_closed
|
|
channel = nil
|
|
session = setup_for_extracting_channel_action(:on_close) { |ch| channel = ch }
|
|
Capistrano::Command.new("ls", [session])
|
|
assert channel[:closed]
|
|
end
|
|
|
|
def test_stop_should_close_all_open_channels
|
|
sessions = [mock_session(new_channel(false)),
|
|
mock_session(new_channel(true)),
|
|
mock_session(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(new_channel(true, 0)),
|
|
mock_session(new_channel(true, 0)),
|
|
mock_session(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(new_channel(true, 0)),
|
|
mock_session(new_channel(true, 0)),
|
|
mock_session(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(new_channel(true, 0)),
|
|
mock_session(new_channel(true, 0)),
|
|
mock_session(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(:to_ary)
|
|
ch.stubs(:[]).with(:closed).returns(*(returns + [true]))
|
|
ch.expects(:[]).with(:status).returns(0)
|
|
ch
|
|
end
|
|
|
|
sessions = [mock_session(new_channel[5]),
|
|
mock_session(new_channel[10]),
|
|
mock_session(new_channel[7])]
|
|
cmd = Capistrano::Command.new("ls", sessions)
|
|
assert_nothing_raised do
|
|
cmd.process!
|
|
end
|
|
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"}).returns(cmd)
|
|
Capistrano::Command.process("ls -l", %w(a b c), :foo => "bar")
|
|
end
|
|
|
|
def test_process_with_host_placeholder_should_substitute_host_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
|
|
|
|
class MockConfig
|
|
include Capistrano::Configuration::Roles
|
|
end
|
|
|
|
def test_hostroles_substitution
|
|
@config = MockConfig.new
|
|
@config.server "capistrano", :db, :worker
|
|
server = @config.roles[:db].servers.first
|
|
channel = {:server => server, :host => 'capistrano'}
|
|
tree = Capistrano::Command::Tree.new(@config) { |t| t.else("echo $CAPISTRANO:HOSTROLES$") }
|
|
result = Capistrano::Command.new(tree, []).send(:replace_placeholders, "echo $CAPISTRANO:HOSTROLES$", channel)
|
|
assert result == "echo db,worker" || result == "echo worker,db"
|
|
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
|
|
|
|
def test_input_stream_closed_when_eof_option_is_true
|
|
channel = nil
|
|
session = setup_for_extracting_channel_action { |ch| channel = ch }
|
|
channel.expects(:eof!)
|
|
Capistrano::Command.new("cat", [session], :data => "here we go", :eof => true)
|
|
assert_equal({ :data => 'here we go', :eof => true }, channel[:options])
|
|
end
|
|
|
|
private
|
|
|
|
def mock_session(channel=nil)
|
|
stub('session',
|
|
:open_channel => channel,
|
|
:preprocess => true,
|
|
:postprocess => true,
|
|
:listeners => {},
|
|
:xserver => server("capistrano"))
|
|
end
|
|
|
|
class MockChannel < Hash
|
|
def close
|
|
end
|
|
end
|
|
|
|
def new_channel(closed, status=nil)
|
|
ch = MockChannel.new
|
|
ch.update({ :closed => closed, :host => "capistrano", :server => server("capistrano") })
|
|
ch[:status] = status if status
|
|
ch.expects(:close) unless closed
|
|
ch
|
|
end
|
|
|
|
def setup_for_extracting_channel_action(action=nil, *args)
|
|
s = server("capistrano")
|
|
session = mock("session", :xserver => s)
|
|
|
|
channel = {}
|
|
session.expects(:open_channel).yields(channel)
|
|
|
|
channel.stubs(:on_data)
|
|
channel.stubs(:on_extended_data)
|
|
channel.stubs(:on_request)
|
|
channel.stubs(:on_close)
|
|
channel.stubs(:exec)
|
|
channel.stubs(:send_data)
|
|
|
|
if action
|
|
action = Array(action)
|
|
channel.expects(action.first).with(*action[1..-1]).yields(channel, *args)
|
|
end
|
|
|
|
yield channel if block_given?
|
|
|
|
session
|
|
end
|
|
end
|