Class: Bolt::Transport::WinRM

Inherits:
Base
  • Object
show all
Defined in:
lib/bolt/transport/winrm.rb,
lib/bolt/transport/winrm/connection.rb

Defined Under Namespace

Classes: Connection

Constant Summary

Constants inherited from Base

Base::ENVIRONMENT_METHODS, Base::STDIN_METHODS

Instance Attribute Summary

Attributes inherited from Base

#logger

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Base

#assert_batch_size_one, #batch_command, #batch_connected?, #batch_script, #batch_task, #batch_upload, #batches, #envify_params, filter_options, #select_implementation, #unwrap_sensitive_args, #with_events

Constructor Details

#initialize ⇒ WinRM

Returns a new instance of WinRM.



41
42
43
44
45
46
47
48
 
# File 'lib/bolt/transport/winrm.rb', line 41

def initialize
  super
  require 'winrm'
  require 'winrm-fs'

  @transport_logger = Logging.logger[::WinRM]
  @transport_logger.level = :warn
end

Class Method Details

.options ⇒ Object 



10
11
12
 
# File 'lib/bolt/transport/winrm.rb', line 10

def self.options
  %w[port user password connect-timeout ssl ssl-verify tmpdir cacert extensions]
end

.validate(options) ⇒ Object 



23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
 
# File 'lib/bolt/transport/winrm.rb', line 23

def self.validate(options)
  ssl_flag = options['ssl']
  unless !!ssl_flag == ssl_flag
    raise Bolt::ValidationError, 'ssl option must be a Boolean true or false'
  end

  ssl_verify_flag = options['ssl-verify']
  unless !!ssl_verify_flag == ssl_verify_flag
    raise Bolt::ValidationError, 'ssl-verify option must be a Boolean true or false'
  end

  timeout_value = options['connect-timeout']
  unless timeout_value.is_a?(Integer) || timeout_value.nil?
    error_msg = "connect-timeout value must be an Integer, received #{timeout_value}:#{timeout_value.class}"
    raise Bolt::ValidationError, error_msg
  end
end

Instance Method Details

#connected?(target) ⇒ Boolean

Returns:

  • (Boolean) 


149
150
151
152
153
 
# File 'lib/bolt/transport/winrm.rb', line 149

def connected?(target)
  with_connection(target) { true }
rescue Bolt::Node::ConnectError
  false
end

#default_input_method(executable) ⇒ Object 



18
19
20
21
 
# File 'lib/bolt/transport/winrm.rb', line 18

def default_input_method(executable)
  input_method ||= Powershell.powershell_file?(executable) ? 'powershell' : 'both'
  input_method
end

#provided_features ⇒ Object 



14
15
16
 
# File 'lib/bolt/transport/winrm.rb', line 14

def provided_features
  ['powershell']
end

#run_command(target, command, _options = {}) ⇒ Object 



69
70
71
72
73
74
 
# File 'lib/bolt/transport/winrm.rb', line 69

def run_command(target, command, _options = {})
  with_connection(target) do |conn|
    output = conn.execute(command)
    Bolt::Result.for_command(target, output.stdout.string, output.stderr.string, output.exit_code)
  end
end

#run_script(target, script, arguments, _options = {}) ⇒ Object 



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/bolt/transport/winrm.rb', line 76

def run_script(target, script, arguments, _options = {})
  # unpack any Sensitive data
  arguments = unwrap_sensitive_args(arguments)
  with_connection(target) do |conn|
    conn.with_remote_tempdir do |dir|
      remote_path = conn.write_remote_executable(dir, script)
      if Powershell.powershell_file?(remote_path)
        output = conn.execute(Powershell.run_script(arguments, remote_path))
      else
        path, args = *Powershell.process_from_extension(remote_path)
        args += Powershell.escape_arguments(arguments)
        output = conn.execute_process(path, args)
      end
      Bolt::Result.for_command(target, output.stdout.string, output.stderr.string, output.exit_code)
    end
  end
end

#run_task(target, task, arguments, _options = {}) ⇒ Object 



94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
 
# File 'lib/bolt/transport/winrm.rb', line 94

def run_task(target, task, arguments, _options = {})
  implementation = select_implementation(target, task)
  executable = implementation['path']
  input_method = implementation['input_method']
  extra_files = implementation['files']
  input_method ||= Powershell.powershell_file?(executable) ? 'powershell' : 'both'

  # unpack any Sensitive data
  arguments = unwrap_sensitive_args(arguments)
  with_connection(target) do |conn|
    conn.with_remote_tempdir do |dir|
      if extra_files.empty?
        task_dir = dir
      else
        # TODO: optimize upload of directories
        arguments['_installdir'] = dir
        task_dir = File.join(dir, task.tasks_dir)
        conn.mkdirs([task_dir] + extra_files.map { |file| File.join(dir, File.dirname(file['name'])) })
        extra_files.each do |file|
          conn.write_remote_file(file['path'], File.join(dir, file['name']))
        end
      end

      remote_task_path = conn.write_remote_executable(task_dir, executable)

      if STDIN_METHODS.include?(input_method)
        stdin = JSON.dump(arguments)
      end

      if ENVIRONMENT_METHODS.include?(input_method)
        envify_params(arguments).each do |(arg, val)|
          cmd = Powershell.set_env(arg, val)
          result = conn.execute(cmd)
          if result.exit_code != 0
            raise Bolt::Node::EnvironmentVarError.new(arg, val)
          end
        end
      end

      conn.shell_init
      output =
        if Powershell.powershell_file?(remote_task_path) && stdin.nil?
          conn.execute(Powershell.run_ps_task(arguments, remote_task_path, input_method))
        else
          path, args = *Powershell.process_from_extension(remote_task_path)
          conn.execute_process(path, args, stdin)
        end

      Bolt::Result.for_task(target, output.stdout.string,
                            output.stderr.string,
                            output.exit_code)
    end
  end
end

#upload(target, source, destination, _options = {}) ⇒ Object 



62
63
64
65
66
67
 
# File 'lib/bolt/transport/winrm.rb', line 62

def upload(target, source, destination, _options = {})
  with_connection(target) do |conn|
    conn.write_remote_file(source, destination)
    Bolt::Result.for_upload(target, source, destination)
  end
end

#with_connection(target) ⇒ Object 



50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/bolt/transport/winrm.rb', line 50

def with_connection(target)
  conn = Connection.new(target, @transport_logger)
  conn.connect
  yield conn
ensure
  begin
    conn&.disconnect
  rescue StandardError => ex
    logger.info("Failed to close connection to #{target.uri} : #{ex.message}")
  end
end