Class: Kitchen::Transport::Ssh::Connection
- Inherits:
-
Base::Connection
- Object
- Base::Connection
- Kitchen::Transport::Ssh::Connection
- Defined in:
- lib/kitchen/transport/ssh.rb
Overview
A Connection instance can be generated and re-generated, given new connection details such as connection port, hostname, credentials, etc. This object is responsible for carrying out the actions on the remote host such as executing commands, transferring files, etc.
Instance Method Summary collapse
-
#close ⇒ Object
Closes the session connection, if it is still active.
-
#download(remotes, local) ⇒ Object
Download remote files or directories to local host.
-
#execute(command) ⇒ Object
Execute a command on the remote host.
-
#initialize(config = {}) {|self| ... } ⇒ Object
constructor
Create a new Connection instance.
-
#login_command ⇒ LoginCommand
Builds a LoginCommand which can be used to open an interactive session on the remote host.
-
#upload(locals, remote) ⇒ Object
Uploads local files or directories to remote host.
-
#wait_until_ready ⇒ Object
Block and return only when the remote host is prepared and ready to execute command and upload files.
Methods inherited from Base::Connection
Methods included from Logging
#banner, #debug, #error, #fatal, #info, #warn
Constructor Details
#initialize(config = {}) {|self| ... } ⇒ Object
Create a new Connection instance.
120 121 122 123 |
# File 'lib/kitchen/transport/ssh.rb', line 120 def initialize(config = {}) super(config) @session = nil end |
Instance Method Details
#close ⇒ Object
Closes the session connection, if it is still active.
126 127 128 129 130 131 132 133 |
# File 'lib/kitchen/transport/ssh.rb', line 126 def close return if @session.nil? logger.debug("[SSH] closing connection to #{self}") session.close ensure @session = nil end |
#download(remotes, local) ⇒ Object
Download remote files or directories to local host.
194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 |
# File 'lib/kitchen/transport/ssh.rb', line 194 def download(remotes, local) # ensure the parent dir of the local target exists FileUtils.mkdir_p(File.dirname(local)) Array(remotes).each do |file| begin logger.debug("Attempting to download '#{file}' as file") session.scp.download!(file, local) rescue Net::SCP::Error begin logger.debug("Attempting to download '#{file}' as directory") session.scp.download!(file, local, recursive: true) rescue Net::SCP::Error logger.warn( "SCP download failed for file or directory '#{file}', perhaps it does not exist?" ) end end end rescue Net::SSH::Exception => ex raise SshFailed, "SCP download failed (#{ex.})" end |
#execute(command) ⇒ Object
Execute a command on the remote host.
136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 |
# File 'lib/kitchen/transport/ssh.rb', line 136 def execute(command) return if command.nil? logger.debug("[SSH] #{self} (#{command})") exit_code = execute_with_exit_code(command) if exit_code != 0 raise Transport::SshFailed.new( "SSH exited (#{exit_code}) for command: [#{command}]", exit_code ) end rescue Net::SSH::Exception => ex raise SshFailed, "SSH command failed (#{ex.})" end |
#login_command ⇒ LoginCommand
Builds a LoginCommand which can be used to open an interactive session on the remote host.
153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 |
# File 'lib/kitchen/transport/ssh.rb', line 153 def login_command args = %w{ -o UserKnownHostsFile=/dev/null } args += %w{ -o StrictHostKeyChecking=no } args += %w{ -o IdentitiesOnly=yes } if [:keys] args += %W{ -o LogLevel=#{logger.debug? ? "VERBOSE" : "ERROR"} } if .key?(:forward_agent) args += %W{ -o ForwardAgent=#{[:forward_agent] ? "yes" : "no"} } end if ssh_gateway gateway_command = "ssh -q #{ssh_gateway_username}@#{ssh_gateway} nc #{hostname} #{port}" args += %W{ -o ProxyCommand=#{gateway_command} -p #{ssh_gateway_port} } end Array([:keys]).each { |ssh_key| args += %W{ -i #{ssh_key} } } args += %W{ -p #{port} } args += %W{ #{username}@#{hostname} } LoginCommand.new("ssh", args) end |
#upload(locals, remote) ⇒ Object
Uploads local files or directories to remote host.
173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 |
# File 'lib/kitchen/transport/ssh.rb', line 173 def upload(locals, remote) logger.debug("TIMING: scp async upload (Kitchen::Transport::Ssh)") elapsed = Benchmark.measure do waits = [] Array(locals).map do |local| opts = File.directory?(local) ? { recursive: true } : {} waits.push session.scp.upload(local, remote, opts) do |_ch, name, sent, total| logger.debug("Async Uploaded #{name} (#{total} bytes)") if sent == total end waits.shift.wait while waits.length >= max_ssh_sessions end waits.each(&:wait) end delta = Util.duration(elapsed.real) logger.debug("TIMING: scp async upload (Kitchen::Transport::Ssh) took #{delta}") rescue Net::SSH::Exception => ex raise SshFailed, "SCP upload failed (#{ex.})" end |
#wait_until_ready ⇒ Object
Block and return only when the remote host is prepared and ready to execute command and upload files. The semantics and details will vary by implementation, but a round trip through the hosted service is preferred to simply waiting on a socket to become available.
218 219 220 221 222 223 224 225 226 227 |
# File 'lib/kitchen/transport/ssh.rb', line 218 def wait_until_ready delay = 3 session( retries: max_wait_until_ready / delay, delay: delay, message: "Waiting for SSH service on #{hostname}:#{port}, " \ "retrying in #{delay} seconds" ) execute(PING_COMMAND.dup) end |