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 collapse

STDIN_METHODS = 
%w[both stdin].freeze
ENVIRONMENT_METHODS = 
%w[both environment].freeze
PS_ARGS = 
%w[
  -NoProfile -NonInteractive -NoLogo -ExecutionPolicy Bypass
].freeze

Instance Attribute Summary

Attributes inherited from Base

#logger

Instance Method Summary collapse

Methods inherited from Base

#assert_batch_size_one, #batch_command, #batch_script, #batch_task, #batch_upload, #batches, #filter_options, #with_events

Constructor Details

#initialize(_config) ⇒ WinRM

Returns a new instance of WinRM.



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

def initialize(_config)
  super
  require 'winrm'
  require 'winrm-fs'
end

Instance Method Details

#escape_arguments(arguments) ⇒ Object 



152
153
154
155
156
157
158
159
160
 
# File 'lib/bolt/transport/winrm.rb', line 152

def escape_arguments(arguments)
  arguments.map do |arg|
    if arg =~ / /
      "\"#{arg}\""
    else
      arg
    end
  end
end

#powershell_file?(path) ⇒ Boolean

Returns:

  • (Boolean) 


122
123
124
 
# File 'lib/bolt/transport/winrm.rb', line 122

def powershell_file?(path)
  Pathname(path).extname.casecmp('.ps1').zero?
end

#process_from_extension(path) ⇒ Object 



126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
 
# File 'lib/bolt/transport/winrm.rb', line 126

def process_from_extension(path)
  case Pathname(path).extname.downcase
  when '.rb'
    [
      'ruby.exe',
      ['-S', "\"#{path}\""]
    ]
  when '.ps1'
    [
      'powershell.exe',
      [*PS_ARGS, '-File', "\"#{path}\""]
    ]
  when '.pp'
    [
      'puppet.bat',
      ['apply', "\"#{path}\""]
    ]
  else
    # Run the script via cmd, letting Windows extension handling determine how
    [
      'cmd.exe',
      ['/c', "\"#{path}\""]
    ]
  end
end

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



38
39
40
41
42
43
 
# File 'lib/bolt/transport/winrm.rb', line 38

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 



45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/bolt/transport/winrm.rb', line 45

def run_script(target, script, arguments, _options = {})
  with_connection(target) do |conn|
    conn.with_remote_file(script) do |remote_path|
      if powershell_file?(remote_path)
        mapped_args = arguments.map do |a|
          "$invokeArgs.ArgumentList += @'\n#{a}\n'@"
        end.join("\n")
        output = conn.execute(<<-PS)
$invokeArgs = @{
  ScriptBlock = (Get-Command "#{remote_path}").ScriptBlock
  ArgumentList = @()
}
#{mapped_args}

try
{
  Invoke-Command @invokeArgs
}
catch
{
  exit 1
}
    PS
      else
        path, args = *process_from_extension(remote_path)
        args += 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 



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
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
 
# File 'lib/bolt/transport/winrm.rb', line 78

def run_task(target, task, arguments, _options = {})
  input_method = task.input_method
  with_connection(target) do |conn|
    if STDIN_METHODS.include?(input_method)
      stdin = JSON.dump(arguments)
    end

    if ENVIRONMENT_METHODS.include?(input_method)
      arguments.each do |(arg, val)|
        cmd = "[Environment]::SetEnvironmentVariable('PT_#{arg}', @'\n#{val}\n'@)"
        result = conn.execute(cmd)
        if result.exit_code != 0
          raise EnvironmentVarError(var, value)
        end
      end
    end

    conn.with_remote_file(task.executable) do |remote_path|
      output =
        if powershell_file?(remote_path) && stdin.nil?
          # NOTE: cannot redirect STDIN to a .ps1 script inside of PowerShell
          # must create new powershell.exe process like other interpreters
          # fortunately, using PS with stdin input_method should never happen
          if input_method == 'powershell'
            conn.execute(<<-PS)
$private:taskArgs = Get-ContentAsJson (
  $utf8.GetString([System.Convert]::FromBase64String('#{Base64.encode64(JSON.dump(arguments))}'))
)
try { & "#{remote_path}" @taskArgs } catch { exit 1 }
        PS
          else
            conn.execute(%(try { & "#{remote_path}" } catch { exit 1 }))
          end
        else
          path, args = *process_from_extension(remote_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 



31
32
33
34
35
36
 
# File 'lib/bolt/transport/winrm.rb', line 31

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 



19
20
21
22
23
24
25
26
27
28
29
 
# File 'lib/bolt/transport/winrm.rb', line 19

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