Class: Kitchen::Transport::Base::Connection
- Inherits:
-
Object
- Object
- Kitchen::Transport::Base::Connection
- Includes:
- Logging
- Defined in:
- lib/kitchen/transport/base.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.
Direct Known Subclasses
Instance Method Summary collapse
-
#close ⇒ Object
Closes the session connection, if it is still active.
-
#execute(command) ⇒ Object
Execute a command on the remote host.
-
#execute_with_retry(command, retryable_exit_codes = [], max_retries = 1, wait_time = 30) ⇒ Object
Execute a command on the remote host and retry.
-
#initialize(options = {}) {|self| ... } ⇒ Connection
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.
- #retry?(current_try, max_retries, retryable_exit_codes, exit_code) ⇒ Boolean
-
#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 included from Logging
#banner, #debug, #error, #fatal, #info, #warn
Constructor Details
#initialize(options = {}) {|self| ... } ⇒ Connection
Create a new Connection instance.
86 87 88 89 90 |
# File 'lib/kitchen/transport/base.rb', line 86 def initialize( = {}) () yield self if block_given? end |
Instance Method Details
#close ⇒ Object
Closes the session connection, if it is still active.
93 94 95 |
# File 'lib/kitchen/transport/base.rb', line 93 def close # this method may be left unimplemented if that is applicable end |
#execute(command) ⇒ Object
Execute a command on the remote host.
102 103 104 |
# File 'lib/kitchen/transport/base.rb', line 102 def execute(command) raise ClientError, "#{self.class}#execute must be implemented" end |
#execute_with_retry(command, retryable_exit_codes = [], max_retries = 1, wait_time = 30) ⇒ Object
Execute a command on the remote host and retry
114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 |
# File 'lib/kitchen/transport/base.rb', line 114 def execute_with_retry(command, retryable_exit_codes = [], max_retries = 1, wait_time = 30) tries = 0 begin tries += 1 debug("Attempting to execute command - try #{tries} of #{max_retries}.") execute(command) rescue Kitchen::Transport::TransportFailed => e if retry?(tries, max_retries, retryable_exit_codes, e.exit_code) close sleep wait_time retry else raise e end end end |
#login_command ⇒ LoginCommand
Builds a LoginCommand which can be used to open an interactive session on the remote host.
143 144 145 |
# File 'lib/kitchen/transport/base.rb', line 143 def login_command raise ActionFailed, "Remote login not supported in #{self.class}." end |
#retry?(current_try, max_retries, retryable_exit_codes, exit_code) ⇒ Boolean
131 132 133 134 135 |
# File 'lib/kitchen/transport/base.rb', line 131 def retry?(current_try, max_retries, retryable_exit_codes, exit_code) current_try <= max_retries && !retryable_exit_codes.nil? && retryable_exit_codes.include?(exit_code) end |
#upload(locals, remote) ⇒ Object
Uploads local files or directories to remote host.
153 154 155 |
# File 'lib/kitchen/transport/base.rb', line 153 def upload(locals, remote) # rubocop:disable Lint/UnusedMethodArgument raise ClientError, "#{self.class}#upload must be implemented" 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.
162 163 164 |
# File 'lib/kitchen/transport/base.rb', line 162 def wait_until_ready # this method may be left unimplemented if that is applicable end |