Class: Train::Transports::WinRM::Connection

Inherits:
BaseConnection
  • Object
show all
Defined in:
lib/train/transports/winrm_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:

Defined Under Namespace

Classes: OS

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ Connection

Returns a new instance of Connection.



31
32
33
34
35
36
37
38
39
40
 
# File 'lib/train/transports/winrm_connection.rb', line 31

def initialize(options)
  super(options)
  @endpoint               = @options.delete(:endpoint)
  @rdp_port               = @options.delete(:rdp_port)
  @winrm_transport        = @options.delete(:winrm_transport)
  @connection_retries     = @options.delete(:connection_retries)
  @connection_retry_sleep = @options.delete(:connection_retry_sleep)
  @max_wait_until_ready   = @options.delete(:max_wait_until_ready)
  @files                  = {}
end

Instance Method Details

#close ⇒ Object 



43
44
45
46
47
48
49
 
# File 'lib/train/transports/winrm_connection.rb', line 43

def close
  return if @session.nil?

  session.close
ensure
  @session = nil
end

#file(path) ⇒ Object 



55
56
57
 
# File 'lib/train/transports/winrm_connection.rb', line 55

def file(path)
  @files[path] ||= WindowsFile.new(self, path)
end

#login_command ⇒ Object 



72
73
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/train/transports/winrm_connection.rb', line 72

def 
  case RbConfig::CONFIG['host_os']
  when /darwin/
    
  when /mswin|msys|mingw|cygwin|bccwin|wince|emc/
    
  when /linux/
    
  else
    fail ActionFailed,
         "Remote login not supported in #{self.class} " \
         "from host OS '#{RbConfig::CONFIG['host_os']}'."
  end
end

#os ⇒ Object 



51
52
53
 
# File 'lib/train/transports/winrm_connection.rb', line 51

def os
  @os ||= OS.new(self)
end

#run_command(command) ⇒ Object 



59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/train/transports/winrm_connection.rb', line 59

def run_command(command)
  return if command.nil?
  logger.debug("[WinRM] #{self} (#{command})")
  out = ''

  response = session.run_powershell_script(command) do |stdout, _|
    out << stdout if stdout
  end

  CommandResult.new(out, response.stderr, response[:exitcode])
end

#upload(locals, remote) ⇒ Object 



88
89
90
 
# File 'lib/train/transports/winrm_connection.rb', line 88

def upload(locals, remote)
  file_transporter.upload(locals, remote)
end

#wait_until_ready ⇒ Object 



93
94
95
96
97
98
99
100
 
# File 'lib/train/transports/winrm_connection.rb', line 93

def wait_until_ready
  delay = 3
  session(
    retry_limit: @max_wait_until_ready / delay,
    retry_delay: delay,
  )
  execute(PING_COMMAND.dup)
end