Ticket #6547: allow_multiple_ssh_ports_and_usernames_in_capistrano_with_gateways_too.diff

test/actor_test.rb

@@ -316 +316 @@
-    @actor.foo
-    assert_instance_of GatewayConnectionFactory, @actor.factory
-  end
+  
+  def test_establish_connection_uses_gateway_if_specified_with_username_and_port
+    @actor.configuration.gateway = "demo@10.example.com:8088"
+    @actor.define_task :foo, :roles => :db do
+      run "do this"
+    end
+    @actor.foo
+    assert_instance_of GatewayConnectionFactory, @actor.factory
+  end
-
-  def test_run_when_not_pretend
-    @actor.define_task :foo do

test/ssh_test.rb

@@ -42 +42 @@
-      MockSSH.invocations.first[1][:auth_methods]
-    assert_nil MockSSH.invocations.first[2]
-  end
+  
+  def test_explicit_ssh_ports_in_server_string_no_block
+    Net.const_during(:SSH, MockSSH) do
+      Capistrano::SSH.connect('demo.server.i:8088', @config)
+    end
-
+    assert_equal 1, MockSSH.invocations.length
+    assert_equal 'demo.server.i', MockSSH.invocations.first[0]
+    assert_equal '8088', MockSSH.invocations.first[1][:port]
+    assert_equal 'demo', MockSSH.invocations.first[1][:username]
+  end
+  
+  def test_explicit_ssh_username_in_server_string_no_block
+    Net.const_during(:SSH, MockSSH) do
+      Capistrano::SSH.connect('bob@demo.server.i', @config)
+    end
+
+    assert_equal 1, MockSSH.invocations.length
+    assert_equal 'demo.server.i', MockSSH.invocations.first[0]
+    assert_equal 22, MockSSH.invocations.first[1][:port]
+    assert_equal 'bob', MockSSH.invocations.first[1][:username]
+  end
+  
+  def test_explicit_ssh_username_and_port_in_server_string_no_block
+    Net.const_during(:SSH, MockSSH) do
+      Capistrano::SSH.connect('bob@demo.server.i:8088', @config)
+    end
+
+    assert_equal 1, MockSSH.invocations.length
+    assert_equal 'demo.server.i', MockSSH.invocations.first[0]
+    assert_equal '8088', MockSSH.invocations.first[1][:port]
+    assert_equal 'bob', MockSSH.invocations.first[1][:username]
+  end
+
-  def test_publickey_auth_succeeds_explicit_port_no_block
-    Net.const_during(:SSH, MockSSH) do
-      Capistrano::SSH.connect('demo.server.i', @config, 23)
@@ -53 +86 @@
-    assert_nil MockSSH.invocations.first[2]
-  end
-
+
+  def test_explicit_ssh_ports_in_server_string_with_block
+    Net.const_during(:SSH, MockSSH) do
+      Capistrano::SSH.connect('demo.server.i:8088', @config) do |session|
+      end
+    end
+    assert_equal 'demo.server.i', MockSSH.invocations.first[0]
+    assert_equal '8088', MockSSH.invocations.first[1][:port]
+    assert_equal 1, MockSSH.invocations.length
+    assert_instance_of Proc, MockSSH.invocations.first[2]
+  end
+  
+  def test_explicit_ssh_username_in_server_string_with_block
+    Net.const_during(:SSH, MockSSH) do
+      Capistrano::SSH.connect('bob@demo.server.i', @config) do |session|
+      end
+    end
+    assert_equal 'demo.server.i', MockSSH.invocations.first[0]
+    assert_equal 22, MockSSH.invocations.first[1][:port]
+    assert_equal 1, MockSSH.invocations.length
+    assert_equal 'bob', MockSSH.invocations.first[1][:username]
+    assert_instance_of Proc, MockSSH.invocations.first[2]
+  end
+  
+  def test_explicit_ssh_username_and_port_in_server_string_with_block
+    Net.const_during(:SSH, MockSSH) do
+      Capistrano::SSH.connect('bob@demo.server.i:8088', @config) do |session|
+      end
+    end
+    assert_equal 'demo.server.i', MockSSH.invocations.first[0]
+    assert_equal '8088', MockSSH.invocations.first[1][:port]
+    assert_equal 1, MockSSH.invocations.length
+    assert_equal 'bob', MockSSH.invocations.first[1][:username]
+    assert_instance_of Proc, MockSSH.invocations.first[2]
+  end
+
+  def test_parse_server
+    assert_equal(['bob', 'demo.server.i', '8088'], 
+                 Capistrano::SSH.parse_server("bob@demo.server.i:8088"))
+    assert_equal([nil, 'demo.server.i', '8088'], 
+                 Capistrano::SSH.parse_server("demo.server.i:8088"))                 
+    assert_equal(['bob', 'demo.server.i', nil], 
+                 Capistrano::SSH.parse_server("bob@demo.server.i"))
+    assert_equal([nil, 'demo.server.i', nil], 
+                 Capistrano::SSH.parse_server("demo.server.i"))
+  end  
+
-  def test_publickey_auth_succeeds_with_block
-    Net.const_during(:SSH, MockSSH) do
-      Capistrano::SSH.connect('demo.server.i', @config) do |session|

lib/capistrano/ssh.rb

@@ -27 +27 @@
-                        :password => password_value,
-                        :port => port,
-                        :auth_methods => methods.shift }.merge(config.ssh_options)
+                        
+        user, server, port = parse_server(server)         
+        ssh_options[:username] = user if user   
+        ssh_options[:port] = port if port
+        
-        Net::SSH.start(server,ssh_options,&block)
-      rescue Net::SSH::AuthenticationFailed
-        raise if methods.empty?
@@ -34 +39 @@
-        retry
-      end
-    end
+    
+    # This regex is used for its byproducts, the $1-9 match vars.
+    # This regex will always match the ssh hostname and if there 
+    # is a username or port they will be matched as well. This 
+    # allows us to set the username and ssh port right in the 
+    # server string:  "username@123.12.123.12:8088"
+    # This remains fully backwards compatible and can still be
+    # intermixed with the old way of doing things. usernames
+    # and ports will be used from the server string if present
+    # but they will fall back to the regular defaults when not
+    # present. Returns and array like:
+    # ['bob', 'demo.server.com', '8088']
+    # will always at least return the server:
+    # [nil, 'demo.server.com', nil]
+    def self.parse_server(server)
+      server =~ /^(?:([^;,:=]+)@|)(.*?)(?::(\d+)|)$/
+      [$1, $2, $3]
+    end  
-  end
-end

lib/capistrano/gateway.rb

@@ -69 +69 @@
-    def connect_to(server)
-      connection = nil
-      @config.logger.trace "establishing connection to #{server} via gateway"
-
+local_
-
-      thread = Thread.new do
-        begin
-
-
+
+
+
+
+
-          @config.logger.trace "connection to #{server} via gateway established"
-        rescue Errno::EADDRINUSE
-          port = next_port