Class: Bolt::Transport::LocalWindows

Inherits:
Base
  • Object
show all
Defined in:
lib/bolt/transport/local_windows.rb

Constant Summary collapse

OPTIONS = 
{
  "interpreters"   => "A map of an extension name to the absolute path of an executable, "\
                      "enabling you to override the shebang defined in a task executable. The "\
                      "extension can optionally be specified with the `.` character (`.py` and "\
                      "`py` both map to a task executable `task.py`) and the extension is case "\
                      "sensitive. When a target's name is `localhost`, Ruby tasks run with the "\
                      "Bolt Ruby interpreter by default.",
  "run-as"         => "A different user to run commands as after login.",
  "run-as-command" => "The command to elevate permissions. Bolt appends the user and command "\
                      "strings to the configured `run-as-command` before running it on the target. "\
                      "This command must not require an interactive password prompt, and the "\
                      "`sudo-password` option is ignored when `run-as-command` is specified. The "\
                      "`run-as-command` must be specified as an array.",
  "sudo-password"  => "Password to use when changing users via `run-as`.",
  "tmpdir"         => "The directory to copy and execute temporary files."
}.freeze

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, default_options, #envify_params, filter_options, #initialize, #select_implementation, #select_interpreter, #unwrap_sensitive_args, #with_events

Constructor Details

This class inherits a constructor from Bolt::Transport::Base

Class Method Details

.options ⇒ Object 



32
33
34
 
# File 'lib/bolt/transport/local_windows.rb', line 32

def self.options
  OPTIONS.keys
end

.validate(options) ⇒ Object 



45
46
47
48
49
50
 
# File 'lib/bolt/transport/local_windows.rb', line 45

def self.validate(options)
  logger = Logging.logger[self]
  if options['sudo-password'] || options['run-as'] || options['run-as-command'] || options[:run_as]
    logger.warn("run-as is not supported for Windows hosts using the local transport")
  end
end

Instance Method Details

#connected?(_targets) ⇒ Boolean

Returns:

  • (Boolean) 


216
217
218
 
# File 'lib/bolt/transport/local_windows.rb', line 216

def connected?(_targets)
  true
end

#copy_file(source, destination) ⇒ Object 



66
67
68
69
70
71
 
# File 'lib/bolt/transport/local_windows.rb', line 66

def copy_file(source, destination)
  logger.debug { "Uploading #{source}, to #{destination}" }
  FileUtils.cp_r(source, destination, remove_destination: true)
rescue StandardError => e
  raise Bolt::Node::FileError.new(e.message, 'WRITE_ERROR')
end

#default_input_method(executable) ⇒ Object 



40
41
42
43
 
# File 'lib/bolt/transport/local_windows.rb', line 40

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

#execute(*command, options) ⇒ Object 



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/bolt/transport/local_windows.rb', line 83

def execute(*command, options)
  # Interpreter can be an array or string. It will be appended to the command array.
  command.unshift(options[:interpreter]).flatten! if options[:interpreter]
  command = [options[:env]] + command if options[:env]

  if options[:stdin]
    stdout, stderr, rc = Open3.capture3(*command, stdin_data: options[:stdin], chdir: options[:dir])
  else
    stdout, stderr, rc = Open3.capture3(*command, chdir: options[:dir])
  end

  result_output = Bolt::Node::Output.new
  result_output.stdout << stdout unless stdout.nil?
  result_output.stderr << stderr unless stderr.nil?
  result_output.exit_code = rc.exitstatus
  result_output
end

#provided_features ⇒ Object 



36
37
38
 
# File 'lib/bolt/transport/local_windows.rb', line 36

def provided_features
  ['powershell']
end

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



107
108
109
110
111
112
113
114
115
116
117
 
# File 'lib/bolt/transport/local_windows.rb', line 107

def run_command(target, command, options = {})
  self.class.validate(options)
  in_tmpdir(target.options['tmpdir']) do |dir|
    output = execute(command, dir: dir)
    Bolt::Result.for_command(target,
                             output.stdout.string,
                             output.stderr.string,
                             output.exit_code,
                             'command', command)
  end
end

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



119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'lib/bolt/transport/local_windows.rb', line 119

def run_script(target, script, arguments, options = {})
  self.class.validate(options)
  with_tmpscript(File.absolute_path(script), target.options['tmpdir']) do |file, dir|
    logger.debug "Running '#{file}' with #{arguments.to_json}"

    # unpack any Sensitive data AFTER we log
    arguments = unwrap_sensitive_args(arguments)
    if Powershell.powershell_file?(file)
      command = Powershell.run_script(arguments, file)
      interpreter = ['powershell.exe', *Powershell.ps_args]
      output = execute(command, dir: dir, interpreter: interpreter)
    else
      path, args = *Powershell.process_from_extension(file)
      args += Powershell.escape_arguments(arguments)
      command = args.unshift(path).join(' ')
      output = execute(command, dir: dir)
    end
    Bolt::Result.for_command(target,
                             output.stdout.string,
                             output.stderr.string,
                             output.exit_code,
                             'script', script)
  end
end

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



144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
 
# File 'lib/bolt/transport/local_windows.rb', line 144

def run_task(target, task, arguments, options = {})
  self.class.validate(options)
  implementation = select_implementation(target, task)
  executable = implementation['path']
  input_method = implementation['input_method']
  extra_files = implementation['files']

  in_tmpdir(target.options['tmpdir']) do |dir|
    if extra_files.empty?
      script = File.join(dir, File.basename(executable))
    else
      arguments['_installdir'] = dir
      script_dest = File.join(dir, task.tasks_dir)
      FileUtils.mkdir_p([script_dest] + extra_files.map { |file| File.join(dir, File.dirname(file['name'])) })

      script = File.join(script_dest, File.basename(executable))
      extra_files.each do |file|
        dest = File.join(dir, file['name'])
        copy_file(file['path'], dest)
        File.chmod(0o750, dest)
      end
    end

    copy_file(executable, script)
    File.chmod(0o750, script)

    interpreter = select_interpreter(script, target.options['interpreters'])
    interpreter_debug = interpreter ? " using '#{interpreter}' interpreter" : nil
    # log the arguments with sensitive data redacted, do NOT log unwrapped_arguments
    logger.debug("Running '#{script}' with #{arguments.to_json}#{interpreter_debug}")
    unwrapped_arguments = unwrap_sensitive_args(arguments)

    stdin = STDIN_METHODS.include?(input_method) ? JSON.dump(unwrapped_arguments) : nil
    if ENVIRONMENT_METHODS.include?(input_method)
      environment_params = envify_params(unwrapped_arguments).each_with_object([]) do |(arg, val), list|
        list << Powershell.set_env(arg, val)
      end
      environment_params = environment_params.join("\n") + "\n"
    else
      environment_params = ""
    end

    if Powershell.powershell_file?(script) && stdin.nil?
      command = Powershell.run_ps_task(arguments, script, input_method)
      command = environment_params + Powershell.shell_init + command
      interpreter ||= ['powershell.exe', *Powershell.ps_args]
      output =
        if input_method == 'powershell'
          execute(command, dir: dir, interpreter: interpreter)
        else
          execute(command, dir: dir, stdin: stdin, interpreter: interpreter)
        end
    end
    unless output
      if interpreter
        env = ENVIRONMENT_METHODS.include?(input_method) ? envify_params(unwrapped_arguments) : nil
        output = execute(script, stdin: stdin, env: env, dir: dir, interpreter: interpreter)
      else
        path, args = *Powershell.process_from_extension(script)
        command = args.unshift(path).join(' ')
        command = environment_params + Powershell.shell_init + command
        output = execute(command, dir: dir, stdin: stdin, interpreter: 'powershell.exe')
      end
    end
    Bolt::Result.for_task(target,
                          output.stdout.string,
                          output.stderr.string,
                          output.exit_code,
                          task.name)
  end
end

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



101
102
103
104
105
 
# File 'lib/bolt/transport/local_windows.rb', line 101

def upload(target, source, destination, options = {})
  self.class.validate(options)
  copy_file(source, destination)
  Bolt::Result.for_upload(target, source, destination)
end