Class: Kitchen::Transport::Base
- Inherits:
-
Object
- Object
- Kitchen::Transport::Base
- Includes:
- Configurable, Logging
- Defined in:
- lib/kitchen/transport/base.rb
Overview
Base class for a transport.
Defined Under Namespace
Classes: Connection
Instance Attribute Summary
Attributes included from Configurable
Class Method Summary collapse
-
.kitchen_transport_api_version(version) ⇒ Object
Sets the API version for this transport.
Instance Method Summary collapse
-
#connection(state) ⇒ Connection
Creates a new Connection, configured by a merging of configuration and state data.
-
#initialize(config = {}) ⇒ Base
constructor
Create a new transport by providing a configuration hash.
Methods included from Logging
#banner, #debug, #error, #fatal, #info, #warn
Methods included from Configurable
#[], #bourne_shell?, #calculate_path, #config_keys, #diagnose, #diagnose_plugin, #finalize_config!, included, #name, #powershell_shell?, #remote_path_join, #unix_os?, #verify_dependencies, #windows_os?
Constructor Details
#initialize(config = {}) ⇒ Base
Create a new transport by providing a configuration hash.
45 46 47 |
# File 'lib/kitchen/transport/base.rb', line 45 def initialize(config = {}) init_config(config) end |
Class Method Details
.kitchen_transport_api_version(version) ⇒ Object
Sets the API version for this transport. If the transport does not set
this value, then nil
will be used and reported.
Sets the API version for this transport
164 165 166 |
# File 'lib/kitchen/transport/base.rb', line 164 def self.kitchen_transport_api_version(version) @api_version = version end |
Instance Method Details
#connection(state) ⇒ Connection
Creates a new Connection, configured by a merging of configuration and state data. Depending on the implementation, the Connection could be saved or cached to speed up multiple calls, given the same state hash as input.
57 58 59 |
# File 'lib/kitchen/transport/base.rb', line 57 def connection(state) # rubocop:disable Lint/UnusedMethodArgument raise ClientError, "#{self.class}#connection must be implemented" end |