module Chef::Mixin::PowershellOut

Public Instance Methods

powershell_out(*command_args) click to toggle source

Run a command under powershell with the same API as shell_out. The options hash is extended to take an “architecture” flag which can be set to :i386 or :x86_64 to force the windows architecture.

@param script [String] script to run @param interpreter [Symbol] the interpreter type, `:powershell` or `:pwsh` @param options [Hash] options hash @return [Mixlib::Shellout] mixlib-shellout object

# File lib/chef/mixin/powershell_out.rb, line 34
def powershell_out(*command_args)
  script = command_args.first
  options = command_args.last.is_a?(Hash) ? command_args.last : nil
  interpreter = command_args[1].is_a?(Symbol) ? command_args[1] : :powershell

  raise ArgumentError, "Expected interpreter of :powershell or :pwsh" unless %i{powershell pwsh}.include?(interpreter)

  run_command_with_os_architecture(script, interpreter, options)
end
powershell_out!(*command_args) click to toggle source

Run a command under powershell with the same API as shell_out! (raises exceptions on errors)

@param script [String] script to run @param interpreter [Symbol] the interpreter type, `:powershell` or `:pwsh` @param options [Hash] options hash @return [Mixlib::Shellout] mixlib-shellout object

# File lib/chef/mixin/powershell_out.rb, line 51
def powershell_out!(*command_args)
  cmd = powershell_out(*command_args)
  cmd.error!
  cmd
end

Private Instance Methods

build_powershell_command(script, interpreter) click to toggle source

Helper to build a powershell command around the script to run.

@param script [String] script to run @param interpreter [Symbol] the interpreter type, `:powershell` or `:pwsh` @return [String] powershell command to execute

# File lib/chef/mixin/powershell_out.rb, line 85
def build_powershell_command(script, interpreter)
  flags = [
    # Hides the copyright banner at startup.
    "-NoLogo",
    # Does not present an interactive prompt to the user.
    "-NonInteractive",
    # Does not load the Windows PowerShell profile.
    "-NoProfile",
    # always set the ExecutionPolicy flag
    # see http://technet.microsoft.com/en-us/library/ee176961.aspx
    "-ExecutionPolicy Unrestricted",
    # PowerShell will hang if STDIN is redirected
    # http://connect.microsoft.com/PowerShell/feedback/details/572313/powershell-exe-can-hang-if-stdin-is-redirected
    "-InputFormat None",
  ]

  "#{interpreter}.exe #{flags.join(" ")} -Command \"#{script.gsub('"', '\"')}\""
end
run_command_with_os_architecture(script, interpreter, options) click to toggle source

Helper function to run shell_out and wrap it with the correct flags to possibly disable WOW64 redirection (which we often need because chef-client runs as a 32-bit app on 64-bit windows).

@param script [String] script to run @param interpreter [Symbol] the interpreter type, `:powershell` or `:pwsh` @param options [Hash] options hash @return [Mixlib::Shellout] mixlib-shellout object

# File lib/chef/mixin/powershell_out.rb, line 67
def run_command_with_os_architecture(script, interpreter, options)
  options ||= {}
  options = options.dup
  arch = options.delete(:architecture)

  with_os_architecture(nil, architecture: arch) do
    shell_out(
      build_powershell_command(script, interpreter),
      **options
    )
  end
end