Class: Train::Plugins::Transport::BaseConnection

Inherits:
Object
  • Object
show all
Includes:
Extras
Defined in:
lib/train/plugins/base_connection.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

Constructor Details

#initialize(options = nil) {|self| ... } ⇒ BaseConnection

Create a new Connection instance.

Parameters:

  • options (Hash) (defaults to: nil) —

    connection options

Yields:

  • (self) —

    yields itself for block-style invocation



22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
 
# File 'lib/train/plugins/base_connection.rb', line 22

def initialize(options = nil)
  @options = options || {}
  @logger = @options.delete(:logger) || Logger.new(STDOUT)
  Train::Platforms::Detect::Specifications::OS.load
  Train::Platforms::Detect::Specifications::Api.load

  # default caching options
  @cache_enabled = {
    file: true,
    command: false,
  }

  @cache = {}
  @cache_enabled.each_key do |type|
    clear_cache(type)
  end
end

Instance Method Details

#cache_enabled?(type) ⇒ Boolean

Returns:

  • (Boolean) 


59
60
61
 
# File 'lib/train/plugins/base_connection.rb', line 59

def cache_enabled?(type)
  @cache_enabled[type.to_sym]
end

#cached_client(type, key) ⇒ Object

Returns cached client if caching enabled. Otherwise returns whatever is given in the block.

Examples:


def demo_client
  cached_client(:api_call, :demo_connection) do
    DemoClient.new(args)
  end
end

Parameters:

  • type (symbol) —

    one of [:api_call, :file, :command]

  • key (symbol) —

    for your cached connection



53
54
55
56
57
 
# File 'lib/train/plugins/base_connection.rb', line 53

def cached_client(type, key)
  return yield unless cache_enabled?(type)

  @cache[type][key] ||= yield
end

#close ⇒ Object

Closes the session connection, if it is still active.



77
78
79
 
# File 'lib/train/plugins/base_connection.rb', line 77

def close
  # this method may be left unimplemented if that is applicable
end

#disable_cache(type) ⇒ Object 



70
71
72
73
74
 
# File 'lib/train/plugins/base_connection.rb', line 70

def disable_cache(type)
  fail Train::UnknownCacheType, "#{type} is not a valid cache type" unless @cache_enabled.keys.include?(type.to_sym)
  @cache_enabled[type.to_sym] = false
  clear_cache(type.to_sym)
end

#enable_cache(type) ⇒ Object

Enable caching types for Train. Currently we support :file and :command types



65
66
67
68
 
# File 'lib/train/plugins/base_connection.rb', line 65

def enable_cache(type)
  fail Train::UnknownCacheType, "#{type} is not a valid cache type" unless @cache_enabled.keys.include?(type.to_sym)
  @cache_enabled[type.to_sym] = true
end

#file(path, *args) ⇒ Object

This is the main file call for all connections. This will call the private file_via_connection on the connection with optional caching



124
125
126
127
128
 
# File 'lib/train/plugins/base_connection.rb', line 124

def file(path, *args)
  return file_via_connection(path, *args) unless cache_enabled?(:file)

  @cache[:file][path] ||= file_via_connection(path, *args)
end

#force_platform!(name, platform_details = nil) ⇒ Object Also known as: direct_platform 



94
95
96
97
98
99
100
101
 
# File 'lib/train/plugins/base_connection.rb', line 94

def force_platform!(name, platform_details = nil)
  plat = Train::Platforms.name(name)
  plat.backend = self
  plat.platform = platform_details unless platform_details.nil?
  plat.find_family_hierarchy
  plat.add_platform_methods
  plat
end

#load_json(j) ⇒ Object 



87
88
89
90
91
92
 
# File 'lib/train/plugins/base_connection.rb', line 87

def load_json(j)
  require 'train/transports/mock'
  j['files'].each do |path, jf|
    @cache[:file][path] = Train::Transports::Mock::Connection::File.from_json(jf)
  end
end

#login_command ⇒ LoginCommand

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

Returns:



134
135
136
 
# File 'lib/train/plugins/base_connection.rb', line 134

def 
  fail NotImplementedError, "#{self.class} does not implement #login_command()"
end

#platform ⇒ Platform Also known as: os

Get information on the operating system which this transport connects to.

Returns:

  • (Platform) —

    system information



108
109
110
 
# File 'lib/train/plugins/base_connection.rb', line 108

def platform
  @platform ||= Train::Platforms::Detect.scan(self)
end

#run_command(cmd) ⇒ Object

This is the main command call for all connections. This will call the private run_command_via_connection on the connection with optional caching



116
117
118
119
120
 
# File 'lib/train/plugins/base_connection.rb', line 116

def run_command(cmd)
  return run_command_via_connection(cmd) unless cache_enabled?(:command)

  @cache[:command][cmd] ||= run_command_via_connection(cmd)
end

#to_json ⇒ Object 



81
82
83
84
85
 
# File 'lib/train/plugins/base_connection.rb', line 81

def to_json
  {
    'files' => Hash[@cache[:file].map { |x, y| [x, y.to_json] }],
  }
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.



143
144
145
 
# File 'lib/train/plugins/base_connection.rb', line 143

def wait_until_ready
  # this method may be left unimplemented if that is applicablelog
end