ruby-pwsh 0.9.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4290cf1b35c8aa2ca227d4db7dd4adc437f7e40b060ea88a233cf3fe33ddff98
-  data.tar.gz: ebc560396873912932449a51a694b4d0e03b007f8311cc385bb4e03f368f0d4a
+  metadata.gz: 350652f7e3803a522f6ad56512a75778277bef24bb3963fa9713522517f511cc
+  data.tar.gz: '02500121972f8b43463d6e3db9d37ab7324bcecb521b0fc482a9540d1c7bb88b'
 SHA512:
-  metadata.gz: a6f766d3740eda4d7046f0c0c20bca5c5569433a05c463fd8bee31da759a20ad050ff0c5e7701b46449bc9a50b2f0c3258769f4bec89e7496809d9be001fe2f7
-  data.tar.gz: 1a3fbe17709118963af1a278868910db76996185bca5b76200df6d3864cfb6c41a794a4f741163cd29542a70c5a371d436d2331f52e670bfa53277f89a830a83
+  metadata.gz: 5f3e181119fc56713f3f326081ec0f84540308f8918425afc7b10e89baa6813456b3e369b98b7c7ae255484ba425dee0e00239cce5d98683b013d8971ad5d27a
+  data.tar.gz: 0eaa28aeb753b121d46cd83127ff0dffdaa4cbf8bb0463b07b069fea0a339461a71d1746232e9cc3ad49413daa07b315c0a11b55eb85700f54bcda5667606db4

data/CHANGELOG.md

@@ -2,6 +2,14 @@
 
 All notable changes to this project will be documented in this file.The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](http://semver.org).
 
+## [0.10.0](https://github.com/puppetlabs/ruby-pwsh/tree/0.10.0) (2021-07-01)
+
+[Full Changelog](https://github.com/puppetlabs/ruby-pwsh/compare/0.9.0...0.10.0)
+
+### Added
+
+- \(GH-172\) Enable use of class-based DSC Resources by munging PSModulePath  [\#173](https://github.com/puppetlabs/ruby-pwsh/pull/173) ([michaeltlombardi](https://github.com/michaeltlombardi))
+
 ## [0.9.0](https://github.com/puppetlabs/ruby-pwsh/tree/0.9.0) (2021-06-28)
 
 [Full Changelog](https://github.com/puppetlabs/ruby-pwsh/compare/0.8.0...0.9.0)

data/Rakefile

@@ -110,7 +110,11 @@ namespace :dsc do
       File.symlink(File.dirname(__FILE__), File.expand_path('pwshlib', modules_folder))
       # Install each of the required modules for acceptance testing
       # Note: This only works for modules in the dsc namespace on the forge.
-      [{ name: 'powershellget', version: '2.2.5-0-1' }].each do |puppet_module|
+      puppetized_dsc_modules = [
+        { name: 'powershellget', version: '2.2.5-0-1' },
+        { name: 'jeadsc', version: '0.7.2-0-2' } # update to 0.7.2-0-3 on release
+      ]
+      puppetized_dsc_modules.each do |puppet_module|
         next if Dir.exist?(File.expand_path(puppet_module[:name], modules_folder))
 
         install_command = [

data/lib/puppet/provider/dsc_base_provider/dsc_base_provider.rb

@@ -416,7 +416,7 @@ class Puppet::Provider::DscBaseProvider
   def invocable_resource(should, context, dsc_invoke_method)
     resource = {}
     resource[:parameters] = {}
-    %i[name dscmeta_resource_friendly_name dscmeta_resource_name dscmeta_module_name dscmeta_module_version].each do |k|
+    %i[name dscmeta_resource_friendly_name dscmeta_resource_name dscmeta_resource_implementation dscmeta_module_name dscmeta_module_version].each do |k|
       resource[k] = context.type.definition[k]
     end
     should.each do |k, v|
@@ -655,6 +655,27 @@ class Puppet::Provider::DscBaseProvider
     modified_string
   end
 
+  # Parses a resource definition (as from `invocable_resource`) and, if the resource is implemented
+  # as a PowerShell class, ensures the System environment variable for PSModulePath is munged to
+  # include the vendored PowerShell modules. Due to a bug in PSDesiredStateConfiguration, class-based
+  # DSC Resources cannot be called via Invoke-DscResource by path, only by module name, *and* the
+  # module must be discoverable in the system-level PSModulePath. The postscript for invocation has
+  # logic to reset the system PSModulePath as stored in the script lines returned by this method.
+  #
+  # @param resource [Hash] a hash with the information needed to run `Invoke-DscResource`
+  # @return [String] A multi-line string which sets the PSModulePath at the system level
+  def munge_psmodulepath(resource)
+    return unless resource[:dscmeta_resource_implementation] == 'Class'
+
+    vendor_path = resource[:vendored_modules_path].gsub('/', '\\')
+    <<~MUNGE_PSMODULEPATH.strip
+      $UnmungedPSModulePath = [System.Environment]::GetEnvironmentVariable('PSModulePath','machine')
+      $MungedPSModulePath = $env:PSModulePath + ';#{vendor_path}'
+      [System.Environment]::SetEnvironmentVariable('PSModulePath', $MungedPSModulePath, [System.EnvironmentVariableTarget]::Machine)
+      $env:PSModulePath = [System.Environment]::GetEnvironmentVariable('PSModulePath','machine')
+    MUNGE_PSMODULEPATH
+  end
+
   # Parses a resource definition (as from `invocable_resource`) for any properties which are PowerShell
   # Credentials. As these values need to be serialized into PSCredential objects, return an array of
   # PowerShell lines, each of which instantiates a variable which holds the value as a PSCredential.
@@ -784,7 +805,11 @@ class Puppet::Provider::DscBaseProvider
     }
     if resource.key?(:dscmeta_module_version)
       params[:ModuleName] = {}
-      params[:ModuleName][:ModuleName] = "#{resource[:vendored_modules_path]}/#{resource[:dscmeta_module_name]}/#{resource[:dscmeta_module_name]}.psd1"
+      params[:ModuleName][:ModuleName] = if resource[:dscmeta_resource_implementation] == 'Class'
+                                           resource[:dscmeta_module_name]
+                                         else
+                                           "#{resource[:vendored_modules_path]}/#{resource[:dscmeta_module_name]}/#{resource[:dscmeta_module_name]}.psd1"
+                                         end
       params[:ModuleName][:RequiredVersion] = resource[:dscmeta_module_version]
     else
       params[:ModuleName] = resource[:dscmeta_module_name]
@@ -841,13 +866,14 @@ class Puppet::Provider::DscBaseProvider
     # The postscript defines the invocation error and result handling; expects `$InvokeParams` to be defined
     postscript    = File.new("#{template_path}/invoke_dsc_resource_postscript.ps1").read
     # The blocks define the variables to define for the postscript.
+    module_path_block = munge_psmodulepath(resource)
     credential_block = prepare_credentials(resource)
     cim_instances_block = prepare_cim_instances(resource)
     parameters_block = invoke_params(resource)
     # clean them out of the temporary cache now that they're not needed; failure to do so can goof up future executions in this run
     clear_instantiated_variables!
 
-    [functions, preamble, credential_block, cim_instances_block, parameters_block, postscript].join("\n")
+    [functions, preamble, module_path_block, credential_block, cim_instances_block, parameters_block, postscript].join("\n")
   end
 
   # Convert a Puppet/Ruby value into a PowerShell representation. Requires some slight additional

data/lib/puppet/provider/dsc_base_provider/invoke_dsc_resource_postscript.ps1

@@ -3,6 +3,12 @@ Try {
 } catch {
   $Response.errormessage   = $_.Exception.Message
   return ($Response | ConvertTo-Json -Compress)
+} Finally {
+  If (![string]::IsNullOrEmpty($UnmungedPSModulePath)) {
+    # Reset the PSModulePath
+    [System.Environment]::SetEnvironmentVariable('PSModulePath', $UnmungedPSModulePath, [System.EnvironmentVariableTarget]::Machine)
+    $env:PSModulePath = [System.Environment]::GetEnvironmentVariable('PSModulePath', 'machine')
+  }
 }
 
 # keep the switch for when Test passes back changed properties

data/lib/pwsh/version.rb

@@ -2,5 +2,5 @@
 
 module Pwsh
   # The version of the ruby-pwsh gem
-  VERSION = '0.9.0'
+  VERSION = '0.10.0'
 end

data/metadata.json

@@ -1,6 +1,6 @@
 {
   "name": "puppetlabs-pwshlib",
-  "version": "0.9.0",
+  "version": "0.10.0",
   "author": "puppetlabs",
   "summary": "Provide library code for interoperating with PowerShell.",
   "license": "MIT",

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-pwsh
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.10.0
 platform: ruby
 authors:
 - Puppet, Inc.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-06-28 00:00:00.000000000 Z
+date: 2021-07-02 00:00:00.000000000 Z
 dependencies: []
 description: PowerShell code manager for ruby.
 email: