Class: Kitchen::Transport::Ssh::Connection

Inherits:
Base::Connection show all
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.

Author:

Instance Method Summary collapse

Methods inherited from Base::Connection

#execute_with_retry, #retry?

Methods included from Logging

#banner, #debug, #error, #fatal, #info, #warn

Constructor Details

#initialize(config = {}) {|self| ... } ⇒ Object

Create a new Connection instance.

Parameters:

  • options (Hash) —

    connection options

Yields:

  • (self) —

    yields itself for block-style invocation



111
112
113
114
 
# File 'lib/kitchen/transport/ssh.rb', line 111

def initialize(config = {})
  super(config)
  @session = nil
end

Instance Method Details

#close ⇒ Object

Closes the session connection, if it is still active.



117
118
119
120
121
122
123
124
 
# File 'lib/kitchen/transport/ssh.rb', line 117

def close
  return if @session.nil?

  logger.debug("[SSH] closing connection to #{self}")
  session.close
ensure
  @session = nil
end

#execute(command) ⇒ Object

Execute a command on the remote host.

Parameters:

  • command (String) —

    command string to execute

Raises:

  • (TransportFailed) —

    if the command does not exit successfully, which may vary by implementation



127
128
129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'lib/kitchen/transport/ssh.rb', line 127

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.message})"
end

#login_command ⇒ LoginCommand

Builds a LoginCommand which can be used to open an interactive session on the remote host.

Returns:

  • (LoginCommand) —

    an object containing the array of command line tokens and exec options to be used in a fork/exec

Raises:



143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
 
# File 'lib/kitchen/transport/ssh.rb', line 143

def 
  args  = %w{ -o UserKnownHostsFile=/dev/null }
  args += %w{ -o StrictHostKeyChecking=no }
  args += %w{ -o IdentitiesOnly=yes } if options[:keys]
  args += %W{ -o LogLevel=#{logger.debug? ? 'VERBOSE' : 'ERROR'} }
  if options.key?(:forward_agent)
    args += %W{ -o ForwardAgent=#{options[:forward_agent] ? 'yes' : 'no'} }
  end
  if ssh_gateway
    gateway_command = "ssh -q #{ssh_gateway_username}@#{ssh_gateway} nc #{hostname} #{port}"
    # Should support other ports than 22 for ssh gateways
    args += %W{ -o ProxyCommand=#{gateway_command} -p 22 }
  end
  Array(options[: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.

Parameters:

  • locals (Array<String>) —

    paths to local files or directories

  • remote (String) —

    path to remote destination

Raises:

  • (TransportFailed) —

    if the files could not all be uploaded successfully, which may vary by implementation



164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
 
# File 'lib/kitchen/transport/ssh.rb', line 164

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.message})"
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.



185
186
187
188
189
190
191
192
193
194
 
# File 'lib/kitchen/transport/ssh.rb', line 185

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