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.
-
#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.
-
#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.
75 76 77 78 79 80 81 |
# File 'lib/kitchen/transport/base.rb', line 75 def initialize( = {}) () if block_given? yield self end end |
Instance Method Details
#close ⇒ Object
Closes the session connection, if it is still active.
84 85 86 |
# File 'lib/kitchen/transport/base.rb', line 84 def close # this method may be left unimplemented if that is applicable end |
#execute(command) ⇒ Object
Execute a command on the remote host.
93 94 95 |
# File 'lib/kitchen/transport/base.rb', line 93 def execute(command) # rubocop:disable Lint/UnusedMethodArgument raise ClientError, "#{self.class}#execute must be implemented" end |
#login_command ⇒ LoginCommand
Builds a LoginCommand which can be used to open an interactive session on the remote host.
103 104 105 |
# File 'lib/kitchen/transport/base.rb', line 103 def login_command raise ActionFailed, "Remote login not supported in #{self.class}." end |
#upload(locals, remote) ⇒ Object
Uploads local files or directories to remote host.
113 114 115 |
# File 'lib/kitchen/transport/base.rb', line 113 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.
122 123 124 |
# File 'lib/kitchen/transport/base.rb', line 122 def wait_until_ready # this method may be left unimplemented if that is applicable end |