Class: Kitchen::Transport::Winrm::Connection
- Inherits:
-
Base::Connection
- Object
- Base::Connection
- Kitchen::Transport::Winrm::Connection
- Defined in:
- lib/kitchen/transport/winrm.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.
Instance Method Summary collapse
-
#close ⇒ Object
Closes the session connection, if it is still active.
-
#download(remotes, local) ⇒ Object
Download remote files or directories to local host.
-
#execute(command) ⇒ Object
Execute a command on the remote host.
-
#file_manager ⇒ Winrm::FileManager
private
A file transporter.
-
#initialize(config = {}) {|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 inherited from Base::Connection
Methods included from Logging
#banner, #debug, #error, #fatal, #info, #warn
Constructor Details
#initialize(config = {}) {|self| ... } ⇒ Connection
Create a new Connection instance.
87 88 89 90 91 |
# File 'lib/kitchen/transport/winrm.rb', line 87 def initialize(config = {}) super(config) @unelevated_session = nil @elevated_session = nil end |
Instance Method Details
#close ⇒ Object
Closes the session connection, if it is still active.
94 95 96 97 98 99 100 101 |
# File 'lib/kitchen/transport/winrm.rb', line 94 def close @unelevated_session.close if @unelevated_session @elevated_session.close if @elevated_session ensure @unelevated_session = nil @elevated_session = nil @file_transporter = nil end |
#download(remotes, local) ⇒ Object
Download remote files or directories to local host.
142 143 144 145 146 147 148 149 |
# File 'lib/kitchen/transport/winrm.rb', line 142 def download(remotes, local) # ensure the parent dir of the local target exists FileUtils.mkdir_p(File.dirname(local)) Array(remotes).each do |remote| file_manager.download(remote, local) end end |
#execute(command) ⇒ Object
Execute a command on the remote host.
104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 |
# File 'lib/kitchen/transport/winrm.rb', line 104 def execute(command) return if command.nil? logger.debug("[WinRM] #{self} (#{command})") exit_code, stderr = execute_with_exit_code(command) if logger.debug? && exit_code == 0 log_stderr_on_warn(stderr) elsif exit_code != 0 log_stderr_on_warn(stderr) raise Transport::WinrmFailed.new( "WinRM exited (#{exit_code}) for command: [#{command}]", exit_code ) end end |
#file_manager ⇒ Winrm::FileManager
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
Returns a file transporter.
153 154 155 |
# File 'lib/kitchen/transport/winrm.rb', line 153 def file_manager @file_manager ||= WinRM::FS::FileManager.new(connection) end |
#login_command ⇒ LoginCommand
Builds a LoginCommand which can be used to open an interactive session on the remote host.
122 123 124 125 126 127 128 129 130 131 132 133 134 |
# File 'lib/kitchen/transport/winrm.rb', line 122 def login_command case RbConfig::CONFIG["host_os"] when /darwin/ login_command_for_mac when /mswin|msys|mingw|cygwin|bccwin|wince|emc/ login_command_for_windows when /linux/ login_command_for_linux else raise ActionFailed, "Remote login not supported in #{self.class} " \ "from host OS '#{RbConfig::CONFIG['host_os']}'." end end |
#upload(locals, remote) ⇒ Object
Uploads local files or directories to remote host.
137 138 139 |
# File 'lib/kitchen/transport/winrm.rb', line 137 def upload(locals, remote) file_transporter.upload(locals, remote) 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.
158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 |
# File 'lib/kitchen/transport/winrm.rb', line 158 def wait_until_ready delay = 3 unelevated_session( retry_limit: max_wait_until_ready / delay, retry_delay: delay ) execute(PING_COMMAND.dup) rescue *RESCUE_EXCEPTIONS_ON_ESTABLISH => e retries ||= connection_retries.to_i raise e if (retries -= 1) < 0 logger.debug("[WinRM] PING_COMMAND failed. Retrying...") logger.debug("#{e.class}::#{e.message}") sleep(connection_retry_sleep.to_i) retry end |