Class: Beaker::SshConnection

Inherits:
Object
  • Object
show all
Defined in:
lib/beaker/ssh_connection.rb

Constant Summary collapse

RETRYABLE_EXCEPTIONS = 
[
  SocketError,
  Timeout::Error,
  Errno::ETIMEDOUT,
  Errno::EHOSTDOWN,
  Errno::EHOSTUNREACH,
  Errno::ECONNREFUSED,
  Errno::ECONNRESET,
  Errno::ENETUNREACH,
  Net::SSH::Disconnect,
  Net::SSH::AuthenticationFailed,
]

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(hostname, user = nil, ssh_opts = {}, options = {}) ⇒ SshConnection

Returns a new instance of SshConnection.



23
24
25
26
27
28
 
# File 'lib/beaker/ssh_connection.rb', line 23

def initialize hostname, user = nil, ssh_opts = {}, options = {}
  @hostname = hostname
  @user = user
  @ssh_opts = ssh_opts
  @logger = options[:logger]
end

Instance Attribute Details

#logger ⇒ Object

Returns the value of attribute logger.



8
9
10
 
# File 'lib/beaker/ssh_connection.rb', line 8

def logger
  @logger
end

Class Method Details

.connect(hostname, user = 'root', ssh_opts = {}, options = {}) ⇒ Object 



30
31
32
33
34
 
# File 'lib/beaker/ssh_connection.rb', line 30

def self.connect hostname, user = 'root', ssh_opts = {}, options = {}
  connection = new hostname, user, ssh_opts, options
  connection.connect
  connection
end

Instance Method Details

#close ⇒ Object 



60
61
62
63
64
65
66
67
 
# File 'lib/beaker/ssh_connection.rb', line 60

def close
  begin
    @ssh.close if @ssh
  rescue
    @ssh.shutdown!
  end
  @ssh = nil
end

#connect ⇒ Object 



36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/beaker/ssh_connection.rb', line 36

def connect
  try = 1
  last_wait = 0
  wait = 1
  @ssh ||= begin
             Net::SSH.start(@hostname, @user, @ssh_opts)
           rescue *RETRYABLE_EXCEPTIONS => e
             if try <= 11
               @logger.warn "Try #{try} -- Host #{@hostname} unreachable: #{e.message}"
               @logger.warn "Trying again in #{wait} seconds"
               sleep wait
              (last_wait, wait) = wait, last_wait + wait
               try += 1
               retry
             else
               # why is the logger not passed into this class?
               @logger.error "Failed to connect to #{@hostname}"
               raise
             end
           end
  @logger.debug "Created ssh connection to #{@hostname}, user: #{@user}, opts: #{@ssh_opts}"
  self
end

#execute(command, options = {}, stdout_callback = nil, stderr_callback = stdout_callback) ⇒ Object 



101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/beaker/ssh_connection.rb', line 101

def execute command, options = {}, stdout_callback = nil,
            stderr_callback = stdout_callback
  attempt = true
  begin
    result = try_to_execute(command, options, stdout_callback, stderr_callback)
  rescue *RETRYABLE_EXCEPTIONS => e
    if attempt
      attempt = false
      @logger.error "Command execution failed, attempting to reconnect to #{@hostname}"
      close
      connect
      retry
    else
      raise
    end
  end

  result
end

#process_stdin_for(channel, stdin) ⇒ Object 



156
157
158
159
160
161
162
163
164
 
# File 'lib/beaker/ssh_connection.rb', line 156

def process_stdin_for channel, stdin
  # queue stdin data, force it to packets, and signal eof: this
  # triggers action in many remote commands, notably including
  # 'puppet apply'.  It must be sent at some point before the rest
  # of the action.
  channel.send_data stdin.to_s
  channel.process
  channel.eof!
end

#register_exit_code_for(channel, output) ⇒ Object 



150
151
152
153
154
 
# File 'lib/beaker/ssh_connection.rb', line 150

def register_exit_code_for channel, output
  channel.on_request("exit-status") do |ch, data|
    output.exit_code = data.read_long
  end
end

#register_stderr_for(channel, output, callback = nil) ⇒ Object 



140
141
142
143
144
145
146
147
148
 
# File 'lib/beaker/ssh_connection.rb', line 140

def register_stderr_for channel, output, callback = nil
  channel.on_extended_data do |ch, type, data|
    if type == 1
      callback[data] if callback
      output.stderr << data
      output.output << data
    end
  end
end

#register_stdout_for(channel, output, callback = nil) ⇒ Object 



132
133
134
135
136
137
138
 
# File 'lib/beaker/ssh_connection.rb', line 132

def register_stdout_for channel, output, callback = nil
  channel.on_data do |ch, data|
    callback[data] if callback
    output.stdout << data
    output.output << data
  end
end

#request_terminal_for(channel, command) ⇒ Object 



121
122
123
124
125
126
127
128
129
130
 
# File 'lib/beaker/ssh_connection.rb', line 121

def request_terminal_for channel, command
  channel.request_pty do |ch, success|
    if success
      @logger.info "Allocated a PTY on #{@hostname} for #{command.inspect}"
    else
      abort "FAILED: could not allocate a pty when requested on " +
        "#{@hostname} for #{command.inspect}"
    end
  end
end

#scp_from(source, target, options = {}, dry_run = false) ⇒ Object 



191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
 
# File 'lib/beaker/ssh_connection.rb', line 191

def scp_from source, target, options = {}, dry_run = false
  return if dry_run

  local_opts = options.dup
  if local_opts[:recursive].nil?
    local_opts[:recursive] = true
  end
  local_opts[:chunk_size] ||= 16384

  result = Result.new(@hostname, [source, target])
  result.stdout = "\n"
  @ssh.scp.download! source, target, local_opts do |ch, name, sent, total|
    result.stdout << "\tcopying %s: %10d/%d\n" % [name, sent, total]
  end

  # Setting these values allows reporting via result.log(test_name)
  result.stdout << "  SCP'ed file #{@hostname}:#{source} to #{target}"

  # Net::Scp always returns 0, so just set the return code to 0.
  result.exit_code = 0

  result.finalize!
  result
end

#scp_to(source, target, options = {}, dry_run = false) ⇒ Object 



166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
 
# File 'lib/beaker/ssh_connection.rb', line 166

def scp_to source, target, options = {}, dry_run = false
  return if dry_run

  local_opts = options.dup
  if local_opts[:recursive].nil?
    local_opts[:recursive] = File.directory?(source)
  end
  local_opts[:chunk_size] ||= 16384

  result = Result.new(@hostname, [source, target])
  result.stdout = "\n"
  @ssh.scp.upload! source, target, local_opts do |ch, name, sent, total|
    result.stdout << "\tcopying %s: %10d/%d\n" % [name, sent, total]
  end

  # Setting these values allows reporting via result.log(test_name)
  result.stdout << "  SCP'ed file #{source} to #{@hostname}:#{target}"

  # Net::Scp always returns 0, so just set the return code to 0.
  result.exit_code = 0

  result.finalize!
  return result
end

#try_to_execute(command, options = {}, stdout_callback = nil, stderr_callback = stdout_callback) ⇒ Object 



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/beaker/ssh_connection.rb', line 69

def try_to_execute command, options = {}, stdout_callback = nil,
            stderr_callback = stdout_callback

  result = Result.new(@hostname, command)
  # why are we getting to this point on a dry run anyways?
  # also... the host creates connections through the class method,
  # which automatically connects, so you can't do a dry run unless you also
  # can connect to your hosts?
  return result if options[:dry_run]

  @ssh.open_channel do |channel|
    request_terminal_for( channel, command ) if options[:pty]

    channel.exec(command) do |terminal, success|
      abort "FAILED: to execute command on a new channel on #{@hostname}" unless success
      register_stdout_for terminal, result, stdout_callback
      register_stderr_for terminal, result, stderr_callback
      register_exit_code_for terminal, result

      process_stdin_for( terminal, options[:stdin] ) if options[:stdin]
    end
  end

  # Process SSH activity until we stop doing that - which is when our
  # channel is finished with...
  @ssh.loop

  result.finalize!
  @logger.last_result = result
  result
end