Used to force connections to be made to the current task's servers. Connections are normally made lazily in Capistrano--you can use this to force them open before performing some operation that might be time-sensitive.
# File lib/capistrano/configuration/connections.rb, line 100 def connect!(options={}) execute_on_servers(options) { } end
Returns the object responsible for establishing new SSH connections. The factory will respond to connect_to, which can be used to establish connections to servers defined via ServerDefinition objects.
# File lib/capistrano/configuration/connections.rb, line 107 def connection_factory @connection_factory ||= begin if exists?(:gateway) logger.debug "establishing connection to gateway `#{fetch(:gateway).inspect}'" GatewayConnectionFactory.new(fetch(:gateway), self) else DefaultConnectionFactory.new(self) end end end
Ensures that there are active sessions for each server in the list.
# File lib/capistrano/configuration/connections.rb, line 119 def establish_connections_to(servers) failed_servers = [] # force the connection factory to be instantiated synchronously, # otherwise we wind up with multiple gateway instances, because # each connection is done in parallel. connection_factory threads = Array(servers).map { |server| establish_connection_to(server, failed_servers) } threads.each { |t| t.join } if failed_servers.any? errors = failed_servers.map { |h| "#{h[:server]} (#{h[:error].class}: #{h[:error].message})" } error = ConnectionError.new("connection failed for: #{errors.join(', ')}") error.hosts = failed_servers.map { |h| h[:server] } raise error end end
Determines the set of servers within the current task's scope and establishes connections to them, and then yields that list of servers.
# File lib/capistrano/configuration/connections.rb, line 152 def execute_on_servers(options={}) raise ArgumentError, "expected a block" unless block_given? if task = current_task servers = find_servers_for_task(task, options) if servers.empty? if ENV['HOSTFILTER'] || task.options.merge(options)[:on_no_matching_servers] == :continue logger.info "skipping `#{task.fully_qualified_name}' because no servers matched" return else raise Capistrano::NoMatchingServersError, "`#{task.fully_qualified_name}' is only run for servers matching #{task.options.inspect}, but no servers matched" end end if task.continue_on_error? servers.delete_if { |s| has_failed?(s) } return if servers.empty? end else servers = find_servers(options) if servers.empty? raise Capistrano::NoMatchingServersError, "no servers found to match #{options.inspect}" if options[:on_no_matching_servers] != :continue return end end servers = [servers.first] if options[:once] logger.trace "servers: #{servers.map { |s| s.host }.inspect}" max_hosts = (options[:max_hosts] || (task && task.max_hosts) || servers.size).to_i is_subset = max_hosts < servers.size # establish connections to those servers in groups of max_hosts, as necessary servers.each_slice(max_hosts) do |servers_slice| begin establish_connections_to(servers_slice) rescue ConnectionError => error raise error unless task && task.continue_on_error? error.hosts.each do |h| servers_slice.delete(h) failed!(h) end end begin yield servers_slice rescue RemoteError => error raise error unless task && task.continue_on_error? error.hosts.each { |h| failed!(h) } end # if dealing with a subset (e.g., :max_hosts is less than the # number of servers available) teardown the subset of connections # that were just made, so that we can make room for the next subset. teardown_connections_to(servers_slice) if is_subset end end
Indicate that the given server could not be connected to.
# File lib/capistrano/configuration/connections.rb, line 86 def failed!(server) Thread.current[:failed_sessions] << server end
Query whether previous connection attempts to the given server have failed.
# File lib/capistrano/configuration/connections.rb, line 92 def has_failed?(server) Thread.current[:failed_sessions].include?(server) end
A hash of the SSH sessions that are currently open and available. Because sessions are constructed lazily, this will only contain connections to those servers that have been the targets of one or more executed tasks. Stored on a per-thread basis to improve thread-safety.
# File lib/capistrano/configuration/connections.rb, line 75 def sessions Thread.current[:sessions] ||= {} end
Destroys sessions for each server in the list.
# File lib/capistrano/configuration/connections.rb, line 139 def teardown_connections_to(servers) servers.each do |server| begin sessions.delete(server).close rescue IOError # the TCP connection is already dead end end end
Generated with the Darkfish Rdoc Generator 2.