ruby-pwsh 0.9.0 → 0.10.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4290cf1b35c8aa2ca227d4db7dd4adc437f7e40b060ea88a233cf3fe33ddff98
-  data.tar.gz: ebc560396873912932449a51a694b4d0e03b007f8311cc385bb4e03f368f0d4a
+  metadata.gz: c0192c9fd1e6f719c01cfbc185c847943ec0878c1fbfda56749a52dfd5d7fca7
+  data.tar.gz: 5d40c16d7f2efe2585a0c65d0e6050aaa72e4083510cbac376038a85ec725264
 SHA512:
-  metadata.gz: a6f766d3740eda4d7046f0c0c20bca5c5569433a05c463fd8bee31da759a20ad050ff0c5e7701b46449bc9a50b2f0c3258769f4bec89e7496809d9be001fe2f7
-  data.tar.gz: 1a3fbe17709118963af1a278868910db76996185bca5b76200df6d3864cfb6c41a794a4f741163cd29542a70c5a371d436d2331f52e670bfa53277f89a830a83
+  metadata.gz: 1e1356eb57e96fa78906861bdd6bf887c5f9eb14175f5408e4db779a3b66ac1bc9bf92d1436f36d019da8b3e18f0bfbc175170d8e3058eff6c3e51235b433ac0
+  data.tar.gz: de4bdce317e05453eb9179df50f065c09c16da4529b304ed0adb7e4becc3c8378ea0f67d69444209ac72d6a5f19881b594f624c311412e8fa32fdcb4bdb9b34d

data/.gitignore

@@ -18,4 +18,6 @@ Gemfile.lock
 /ruby-pwsh-*.gem
 
 # Acceptance Testing fixtures
-/spec/fixtures/modules/
+/spec/fixtures/modules/
+/spec/fixtures/test.pp
+/spec/fixtures/website/

data/CHANGELOG.md

@@ -2,6 +2,31 @@
 
 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).
 
+## [v0.10.2](https://github.com/puppetlabs/ruby-pwsh/tree/v0.10.2) - 2022-06-24
+
+[Full Changelog](https://github.com/puppetlabs/ruby-pwsh/compare/0.10.1...v0.10.2)
+
+### Fixed
+
+- (GH-188) Filter current environment variables [#189](https://github.com/puppetlabs/ruby-pwsh/pull/189) ([chelnak](https://github.com/chelnak))
+
+## [0.10.1](https://github.com/puppetlabs/ruby-pwsh/tree/0.10.1) (2021-08-23)
+
+[Full Changelog](https://github.com/puppetlabs/ruby-pwsh/compare/0.10.0...0.10.1)
+
+### Fixed
+
+- \(GH-180\) Ensure instance\_key respects full uniqueness of options [\#181](https://github.com/puppetlabs/ruby-pwsh/pull/181) ([michaeltlombardi](https://github.com/michaeltlombardi))
+- \(GH-165\) Ensure null-value nested cim instance arrays are appropriately munged [\#177](https://github.com/puppetlabs/ruby-pwsh/pull/177) ([michaeltlombardi](https://github.com/michaeltlombardi))
+
+## [0.10.0](https://github.com/puppetlabs/ruby-pwsh/tree/0.10.0) (2021-07-02)
+
+[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

@@ -99,6 +99,63 @@ task :build_module do
   File.open('README.md', 'wb') { |file| file.write(actual_readme_content) }
 end
 
+# Used in vendor_dsc_module
+TAR_LONGLINK = '././@LongLink'
+
+# Vendor a Puppetized DSC Module to spec/fixtures/modules.
+#
+# This is necessary because `puppet module install` fails on modules with
+# long file paths, like xpsdesiredstateconfiguration
+#
+# @param command [String] command to execute.
+# @return [Object] the standard out stream.
+def vendor_dsc_module(name, version, destination)
+  require 'open-uri'
+  require 'rubygems/package'
+  require 'zlib'
+
+  module_uri = "https://forge.puppet.com/v3/files/dsc-#{name}-#{version}.tar.gz"
+  tar_gz_archive = File.expand_path("#{name}.tar.gz", ENV['TEMP'])
+
+  # Download the archive from the forge
+  File.open(tar_gz_archive, 'wb') do |file|
+    file.write(URI.open(module_uri).read) # rubocop:disable Security/Open
+  end
+
+  # Unzip to destination
+  # Taken directly from StackOverflow:
+  # - https://stackoverflow.com/a/19139114
+  Gem::Package::TarReader.new(Zlib::GzipReader.open(tar_gz_archive)) do |tar|
+    dest = nil
+    tar.each do |entry|
+      if entry.full_name == TAR_LONGLINK
+        dest = File.join(destination, entry.read.strip)
+        next
+      end
+      dest ||= File.join(destination, entry.full_name)
+      if entry.directory?
+        File.delete(dest) if File.file?(dest)
+        FileUtils.mkdir_p(dest, mode: entry.header.mode, verbose: false)
+      elsif entry.file?
+        FileUtils.rm_rf(dest) if File.directory?(dest)
+        File.open(dest, 'wb') do |f|
+          f.print(entry.read)
+        end
+        FileUtils.chmod(entry.header.mode, dest, verbose: false)
+      elsif entry.header.typeflag == '2' # Symlink!
+        File.symlink(entry.header.linkname, dest)
+      end
+      dest = nil
+    end
+  end
+
+  # Rename folder to just the module name, as needed by Puppet
+  Dir.glob("#{destination}/*#{name}*").each do |existing_folder|
+    new_folder = File.expand_path(name, destination)
+    FileUtils.mv(existing_folder, new_folder)
+  end
+end
+
 namespace :dsc do
   namespace :acceptance do
     desc 'Prep for running DSC acceptance tests'
@@ -107,20 +164,21 @@ namespace :dsc do
       modules_folder = File.expand_path('spec/fixtures/modules', File.dirname(__FILE__))
       FileUtils.mkdir_p(modules_folder) unless Dir.exist?(modules_folder)
       # symlink the parent folder to the modules folder for puppet
-      File.symlink(File.dirname(__FILE__), File.expand_path('pwshlib', modules_folder))
+      symlink_path = File.expand_path('pwshlib', modules_folder)
+      File.symlink(File.dirname(__FILE__), symlink_path) unless Dir.exist?(symlink_path)
       # 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-3' },
+        { name: 'xpsdesiredstateconfiguration', version: '9.1.0-0-1' },
+        { name: 'xwebadministration', version: '3.2.0-0-2' },
+        { name: 'accesscontroldsc', version: '1.4.1-0-3' }
+      ]
+      puppetized_dsc_modules.each do |puppet_module|
         next if Dir.exist?(File.expand_path(puppet_module[:name], modules_folder))
 
-        install_command = [
-          'bundle exec puppet module install',
-          "dsc-#{puppet_module[:name]}",
-          "--version #{puppet_module[:version]}",
-          '--ignore-dependencies',
-          "--target-dir #{modules_folder}"
-        ].join(' ')
-        run_local_command(install_command)
+        vendor_dsc_module(puppet_module[:name], puppet_module[:version], modules_folder)
       end
     end
     RSpec::Core::RakeTask.new(:spec) do |t|

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_functions.ps1

@@ -115,7 +115,7 @@ Function ConvertTo-CanonicalResult {
       }
 
       if ($Property.Definition -match 'InstanceArray') {
-          If ($Value.GetType().Name -notmatch '\[\]') { $Value = @($Value) }
+          If ($null -eq $Value -or $Value.GetType().Name -notmatch '\[\]') { $Value = @($Value) }
       }
 
       $ResultObject.$PropertyName = $Value

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.2'
 end

data/lib/pwsh.rb

@@ -406,7 +406,7 @@ Invoke-PowerShellUserCode @params
     #
     # @return[String] Unique string representing the manager instance.
     def self.instance_key(cmd, args, options)
-      cmd + args.join(' ') + options[:debug].to_s
+      cmd + args.join(' ') + options.to_s
     end
 
     # Return whether or not a particular stream is valid and readable

data/lib/templates/init.ps1

@@ -35,8 +35,18 @@ $global:ourFunctions = @'
 function Reset-ProcessEnvironmentVariables {
   param($CachedEnvironmentVariables)
 
+  # When Protected Event Logging and PowerShell Script Block logging are enabled together
+  # the SystemRoot environment variable is a requirement. If it is removed as part of this purge
+  # it causes the PowerShell process to crash, therefore breaking the pipe between Ruby and the
+  # remote PowerShell session.
+  # The least descructive way to avoid this is to filter out SystemRoot when pulling our current list
+  # of environment variables. Then we can continue safely with the removal.
+  $CurrentEnvironmentVariables = Get-ChildItem -Path Env:\* |
+    Where-Object {$_.Name -ne "SystemRoot"}
+
   # Delete existing environment variables
-  Remove-Item -Path Env:\* -ErrorAction SilentlyContinue -WarningAction SilentlyContinue -Recurse
+  $CurrentEnvironmentVariables |
+    ForEach-Object -Process { Remove-Item -Path "ENV:\$($_.Name)" -ErrorAction SilentlyContinue -WarningAction SilentlyContinue -Recurse }
 
   # Re-add the cached environment variables
   $CachedEnvironmentVariables |

data/metadata.json

@@ -1,6 +1,6 @@
 {
   "name": "puppetlabs-pwshlib",
-  "version": "0.9.0",
+  "version": "0.10.2",
   "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.2
 platform: ruby
 authors:
 - Puppet, Inc.
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-06-28 00:00:00.000000000 Z
+date: 2022-06-24 00:00:00.000000000 Z
 dependencies: []
 description: PowerShell code manager for ruby.
 email:
@@ -54,7 +54,7 @@ metadata:
   homepage_uri: https://github.com/puppetlabs/ruby-pwsh
   source_code_uri: https://github.com/puppetlabs/ruby-pwsh
   changelog_uri: https://github.com/puppetlabs/ruby-pwsh
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -69,8 +69,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.17
-signing_key:
+rubygems_version: 3.0.3.1
+signing_key: 
 specification_version: 4
 summary: PowerShell code manager for ruby.
 test_files: []