(FM-8475) Replace library code

Prior to this commit the PowerShell module providers
depended on a vendored version of the PowerShell code
manager library in the PuppetX namespace.

This commit updates the providers and their tests to
leverage the ruby-pwsh gem from the pwshlib Puppet
module instead. This reduces the amount of maintenance
required and simplifies the code base.

Author: michaeltlombardi

.rubocop_todo.yml

@@ -1,12 +1,19 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2018-08-13 13:07:27 +0800 using RuboCop version 0.49.1.
+# on 2019-10-18 11:01:56 -0500 using RuboCop version 0.49.1.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
-# Offense count: 3
-RSpec/LetBeforeExamples:
+# Offense count: 4
+GetText/DecorateFunctionMessage:
   Exclude:
-    - 'spec/integration/puppet_x/puppetlabs/powershell_manager_spec.rb'
+    - 'lib/puppet/provider/exec/powershell.rb'
+    - 'lib/puppet/provider/exec/pwsh.rb'
+    - 'spec/spec_helper_acceptance.rb'
+
+# Offense count: 1
+GetText/DecorateString:
+  Exclude:
+    - 'lib/puppet/provider/exec/powershell.rb'

lib/puppet/provider/exec/powershell.rb

@@ -1,18 +1,10 @@
 require 'puppet/provider/exec'
-require File.join(File.dirname(__FILE__), '../../../puppet_x/puppetlabs/powershell/compatible_powershell_version')
-require File.join(File.dirname(__FILE__), '../../../puppet_x/puppetlabs/powershell/powershell_manager')
+require 'ruby-pwsh'
 
 Puppet::Type.type(:exec).provide :powershell, :parent => Puppet::Provider::Exec do
   confine :operatingsystem => :windows
 
-  commands :powershell =>
-    if File.exists?("#{ENV['SYSTEMROOT']}\\sysnative\\WindowsPowershell\\v1.0\\powershell.exe")
-      "#{ENV['SYSTEMROOT']}\\sysnative\\WindowsPowershell\\v1.0\\powershell.exe"
-    elsif File.exists?("#{ENV['SYSTEMROOT']}\\system32\\WindowsPowershell\\v1.0\\powershell.exe")
-      "#{ENV['SYSTEMROOT']}\\system32\\WindowsPowershell\\v1.0\\powershell.exe"
-    else
-      'powershell.exe'
-    end
+  commands :powershell => Pwsh::Manager.powershell_path
 
   desc <<-EOT
     Executes Powershell commands. One of the `onlyif`, `unless`, or `creates`
@@ -55,20 +47,13 @@ def self.upgrade_message
     @upgrade_warning_issued = true
   end
 
-  def self.powershell_args
-    ps_args = ['-NoProfile', '-NonInteractive', '-NoLogo', '-ExecutionPolicy', 'Bypass']
-    ps_args << '-Command' if !PuppetX::PowerShell::PowerShellManager.supported?
-
-    ps_args
-  end
-
   def ps_manager
     debug_output = Puppet::Util::Log.level == :debug
-    PuppetX::PowerShell::PowerShellManager.instance(command(:powershell), self.class.powershell_args(), debug: debug_output)
+    Pwsh::Manager.instance(command(:powershell), Pwsh::Manager.powershell_args, debug: debug_output)
   end
 
   def run(command, check = false)
-    if !PuppetX::PowerShell::PowerShellManager.supported?
+    unless Pwsh::Manager.windows_powershell_supported?
       self.class.upgrade_message
       write_script(command) do |native_path|
         # Ideally, we could keep a handle open on the temp file in this
@@ -82,8 +67,33 @@ def run(command, check = false)
         return super("cmd.exe /c \"\"#{native_path(command(:powershell))}\" #{legacy_args} -Command - < \"#{native_path}\"\"", check)
       end
     else
-      return ps_manager.execute_resource(command, resource)
+      return execute_resource(command, resource)
+    end
+  end
+
+  def execute_resource(powershell_code, resource)
+    working_dir = resource[:cwd]
+    if (!working_dir.nil?)
+      fail "Working directory '#{working_dir}' does not exist" unless File.directory?(working_dir)
+    end
+    timeout_ms = resource[:timeout].nil? ? nil : resource[:timeout] * 1000
+    environment_variables = resource[:environment].nil? ? [] : resource[:environment]
+
+    result = ps_manager.execute(powershell_code, timeout_ms, working_dir, environment_variables)
+    stdout     = result[:stdout]
+    native_out = result[:native_stdout]
+    stderr     = result[:stderr]
+    exit_code  = result[:exitcode]
+
+    unless stderr.nil?
+      stderr.each { |e| Puppet.debug "STDERR: #{e.chop}" unless e.empty? }
     end
+
+    Puppet.debug "STDERR: #{result[:errormessage]}" unless result[:errormessage].nil?
+
+    output = Puppet::Util::Execution::ProcessOutput.new(stdout.to_s + native_out.to_s, exit_code)
+
+    return output, output
   end
 
   def checkexe(command)

lib/puppet/provider/exec/pwsh.rb

@@ -1,4 +1,5 @@
 require 'puppet/provider/exec'
+require 'ruby-pwsh'
 
 Puppet::Type.type(:exec).provide :pwsh, :parent => Puppet::Provider::Exec do
   desc <<-EOT
@@ -17,8 +18,8 @@
   def run(command, check = false)
     @pwsh ||= get_pwsh_command
     self.fail 'pwsh could not be found' if @pwsh.nil?
-    if PuppetX::PowerShell::PowerShellManager.supported_on_pwsh?
-      return ps_manager.execute_resource(command, resource)
+    if Pwsh::Manager.pwsh_supported?
+      return execute_resource(command, resource)
     else
       write_script(command) do |native_path|
         # Ideally, we could keep a handle open on the temp file in this
@@ -49,35 +50,11 @@ def validatecmd(command)
   #
   # @return [String] the absolute path to the found pwsh executable.  Returns nil when it does not exist
   def get_pwsh_command
-    if Puppet::Util::Platform.windows?
-      # Environment variables on Windows are not case sensitive however ruby hash keys are.
-      # Convert all the key names to upcase so we can be sure to find PATH etc.
-      # Also while ruby can have difficulty changing the case of some UTF8 characters, we're
-      # only going to use plain ASCII names so this is safe.
-      current_env = Hash[Puppet::Util.get_environment.map {|k, v| [k.upcase, v] }]
-    else
-      # We don't force a case change on non-Windows platforms because it is perfectly
-      # ok to have 'Path' and 'PATH'
-      current_env = Puppet::Util.get_environment
-    end
     # If the resource specifies a search path use that. Otherwise use the default
     # PATH from the environment.
-    search_paths = @resource.nil? || @resource['path'].nil? ?
-      current_env['PATH'] :
-      resource[:path].join(File::PATH_SEPARATOR)
-
-    # If we're on Windows, try the default installation locations as a last resort.
-    # https://docs.microsoft.com/en-us/powershell/scripting/install/installing-powershell-core-on-windows?view=powershell-6#msi
-    if Puppet::Util::Platform.windows?
-      search_paths += ";#{current_env['PROGRAMFILES']}\\PowerShell\\6" +
-        ";#{current_env['PROGRAMFILES(X86)']}\\PowerShell\\6"
-    end
-
-    # Note that just like when we run the command in Puppet::Provider::Exec, the
-    # resource[:path] replaces the PATH, it doesn't add to it.
-    Puppet::Util.withenv({'PATH' => search_paths}, Puppet::Util.default_env) do
-      return Puppet::Util.which('pwsh')
-    end
+    @resource.nil? || @resource['path'].nil? ?
+      Pwsh::Manager.pwsh_path :
+      Pwsh::Manager.pwsh_path(resource[:path])
   end
 
   def pwsh_args
@@ -89,10 +66,35 @@ def pwsh_args
   # Retrieves the PowerShell manager specific to our pwsh binary in this resource
   #
   # @api private
-  # @return [PuppetX::PowerShell::PowerShellManager] The PowerShell manager for this resource
+  # @return [Pwsh::Manager] The PowerShell manager for this resource
   def ps_manager
     debug_output = Puppet::Util::Log.level == :debug
-    PuppetX::PowerShell::PowerShellManager.instance(@pwsh, pwsh_args, debug: debug_output)
+    Pwsh::Manager.instance(@pwsh, pwsh_args, debug: debug_output)
+  end
+
+  def execute_resource(powershell_code, resource)
+    working_dir = resource[:cwd]
+    if (!working_dir.nil?)
+      fail "Working directory '#{working_dir}' does not exist" unless File.directory?(working_dir)
+    end
+    timeout_ms = resource[:timeout].nil? ? nil : resource[:timeout] * 1000
+    environment_variables = resource[:environment].nil? ? [] : resource[:environment]
+
+    result = ps_manager.execute(powershell_code, timeout_ms, working_dir, environment_variables)
+    stdout     = result[:stdout]
+    native_out = result[:native_stdout]
+    stderr     = result[:stderr]
+    exit_code  = result[:exitcode]
+
+    unless stderr.nil?
+      stderr.each { |e| Puppet.debug "STDERR: #{e.chop}" unless e.empty? }
+    end
+
+    Puppet.debug "STDERR: #{result[:errormessage]}" unless result[:errormessage].nil?
+
+    output = Puppet::Util::Execution::ProcessOutput.new(stdout.to_s + native_out.to_s, exit_code)
+
+    return output, output
   end
 
   def write_script(content, &block)