ruby-pwsh 0.6.0 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 164dc89d750a5544dd4c100bd2166c0fe9d26447d5636bb18b0eec7d8dfc142f
-  data.tar.gz: bdf317f119bd2e5a7261a711a2a5c4721feda199a955feb5265af07c6f94d8d8
+  metadata.gz: b70b1a0989c8bc3458422b67e0c328084f819067d60455b9504031106a6c78e6
+  data.tar.gz: 44c5f49c82db4a56e76d521e1b90a5434d3bfacd6a5fa242e4e6c5c90878d875
 SHA512:
-  metadata.gz: 8430d204e301ce7577148a95d37a8581b3e0d37da1c3e97fcb5dce3c3a2b66601b651dd48ef3a2810d802d09cf28579dfc986712bf407e54ecb3ca8f23ab9283
-  data.tar.gz: ed31dd3ec848dc4c7fd108ee040c5b39e532ea50fe406ba8f98dfb6bb2cf5c804b0d758c393ead8b560785d34717a629380e346f24baae6963e34094889c6fdc
+  metadata.gz: 80207ddfde5794a3e461c769fdb20983bbc0f601cc18c99a57bd6e2f37ee3158ca27efa1a176d1bb600090860f107b059816f6ec5c263bbbd3d6b21bf7cb11df
+  data.tar.gz: 41d7a31a3703e24e5e64944776eeb889ac01f7acd685e867211898e37a0478606e3728747779e1073cc1138619d51f7e9b2c872047a3754ffc38d061d14916d6

data/CHANGELOG.md

@@ -2,6 +2,54 @@
 
 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.7.1](https://github.com/puppetlabs/ruby-pwsh/tree/0.7.1) (2021-02-01)
+
+[Full Changelog](https://github.com/puppetlabs/ruby-pwsh/compare/0.7.0...0.7.1)
+
+### Fixed
+
+- \(MAINT\) Correctly canonicalize enumerable values in dsc [\#92](https://github.com/puppetlabs/ruby-pwsh/pull/92) ([michaeltlombardi](https://github.com/michaeltlombardi))
+- \(MAINT\) Ensure vendored path check works with mix of module builds [\#91](https://github.com/puppetlabs/ruby-pwsh/pull/91) ([michaeltlombardi](https://github.com/michaeltlombardi))
+- \(GH-84\) Fix empty array parameter check [\#90](https://github.com/puppetlabs/ruby-pwsh/pull/90) ([michaeltlombardi](https://github.com/michaeltlombardi))
+- \(MAINT\) Minor fixes to CIM instance handling [\#89](https://github.com/puppetlabs/ruby-pwsh/pull/89) ([michaeltlombardi](https://github.com/michaeltlombardi))
+
+## [0.7.0](https://github.com/puppetlabs/ruby-pwsh/tree/0.7.0) (2021-01-20)
+
+[Full Changelog](https://github.com/puppetlabs/ruby-pwsh/compare/0.6.3...0.7.0)
+
+### Added
+
+- \(GH-75\) Including module name in vendored module path [\#85](https://github.com/puppetlabs/ruby-pwsh/pull/85) ([pmcmaw](https://github.com/pmcmaw))
+
+### Fixed
+
+- Make root module path use puppetized module name [\#86](https://github.com/puppetlabs/ruby-pwsh/pull/86) ([michaeltlombardi](https://github.com/michaeltlombardi))
+
+## [0.6.3](https://github.com/puppetlabs/ruby-pwsh/tree/0.6.3) (2020-12-16)
+
+[Full Changelog](https://github.com/puppetlabs/ruby-pwsh/compare/0.6.2...0.6.3)
+
+### Fixed
+
+- \(MAINT\) Add handling for when dsc\_ensure is stripped [\#78](https://github.com/puppetlabs/ruby-pwsh/pull/78) ([michaeltlombardi](https://github.com/michaeltlombardi))
+
+## [0.6.2](https://github.com/puppetlabs/ruby-pwsh/tree/0.6.2) (2020-12-09)
+
+[Full Changelog](https://github.com/puppetlabs/ruby-pwsh/compare/0.6.1...0.6.2)
+
+### Fixed
+
+- \(MAINT\) Ensure parameters are canonicalized [\#75](https://github.com/puppetlabs/ruby-pwsh/pull/75) ([michaeltlombardi](https://github.com/michaeltlombardi))
+
+## [0.6.1](https://github.com/puppetlabs/ruby-pwsh/tree/0.6.1) (2020-11-25)
+
+[Full Changelog](https://github.com/puppetlabs/ruby-pwsh/compare/0.6.0...0.6.1)
+
+### Fixed
+
+- \(maint\) - Removal of inappropriate terminology [\#70](https://github.com/puppetlabs/ruby-pwsh/pull/70) ([pmcmaw](https://github.com/pmcmaw))
+- \(Maint\) Fix ensurability in the dsc base provider [\#69](https://github.com/puppetlabs/ruby-pwsh/pull/69) ([michaeltlombardi](https://github.com/michaeltlombardi))
+
 ## [0.6.0](https://github.com/puppetlabs/ruby-pwsh/tree/0.6.0) (2020-11-24)
 
 [Full Changelog](https://github.com/puppetlabs/ruby-pwsh/compare/0.5.1...0.6.0)

data/CONTRIBUTING.md

@@ -79,7 +79,7 @@ process as easy as possible.
 
 2.  Sending your patches
 
-    To submit your changes via a GitHub pull request, we _highly_ recommend that you have them on a topic branch, instead of directly on "master".
+    To submit your changes via a GitHub pull request, we _highly_ recommend that you have them on a topic branch, instead of directly on "main".
     It makes things much easier to keep track of, especially if you decide to work on another thing before your first change is merged in.
 
     GitHub has some pretty good [general documentation](http://help.github.com/) on using their site.

data/README.md

@@ -74,9 +74,9 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 Steps to release an update to the gem and module include:
 
-1. Ensure that the release branch is up to date with the master:
+1. Ensure that the release branch is up to date with the main:
    ```bash
-   git push upstream upstream/master:release --force
+   git push upstream upstream/main:release --force
    ```
 1. Checkout a new working branch for the release prep (where xyz is the appropriate version, sans periods):
    ```bash
@@ -96,7 +96,7 @@ Steps to release an update to the gem and module include:
    ```
 1. Push your changes and submit a pull request for review _against the **release** branch_:
    ```bash
-   git push -u origin maint/release-prep-xyz
+   git push -u origin maint/release/prep-xyz
    ```
 1. Ensure tests pass and the code is merged to `release`.
 1. Grab the commit hash from the merge commit on release, use that as the tag for the version (replacing `x.y.z` with the appropriate version and  `commithash` with the relevant one), then push the tags to upstream:
@@ -114,6 +114,6 @@ Steps to release an update to the gem and module include:
    bundle exec rake build_module
    ```
 1. Publish the updated module version (found in the `pkg` folder) to [the Forge](https://forge.puppet.com/puppetlabs/pwshlib).
-1. Submit the [mergeback PR from the release branch to master](https://github.com/puppetlabs/ruby-pwsh/compare/master...release).
+1. Submit the [mergeback PR from the release branch to main](https://github.com/puppetlabs/ruby-pwsh/compare/main...release).
 
 ## Known Issues

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

@@ -50,6 +50,8 @@ class Puppet::Provider::DscBaseProvider
           canonicalized = r.dup
           @@cached_canonicalized_resource << r.dup
         else
+          parameters = r.select { |name, _properties| parameter_attributes(context).include?(name) }
+          canonicalized.merge!(parameters)
           canonicalized[:name] = r[:name]
           if r[:dsc_psdscrunascredential].nil?
             canonicalized.delete(:dsc_psdscrunascredential)
@@ -59,7 +61,8 @@ class Puppet::Provider::DscBaseProvider
           downcased_result = recursively_downcase(canonicalized)
           downcased_resource = recursively_downcase(r)
           downcased_result.each do |key, value|
-            canonicalized[key] = r[key] unless downcased_resource[key] == value
+            is_same = value.is_a?(Enumerable) ? downcased_resource[key].sort == value.sort : downcased_resource[key] == value
+            canonicalized[key] = r[key] unless is_same
             canonicalized.delete(key) unless downcased_resource.keys.include?(key)
           end
           # Cache the actually canonicalized resource separately
@@ -134,14 +137,15 @@ class Puppet::Provider::DscBaseProvider
                   end
 
       # for compatibility sake, we use dsc_ensure instead of ensure, so context.type.ensurable? does not work
-      if !context.type.attributes.key?(:dsc_ensure)
+      if context.type.attributes.key?(:dsc_ensure)
         is = create_absent(:name, name) if is.nil?
         should = create_absent(:name, name) if should.nil?
 
         # HACK: If the DSC Resource is ensurable but doesn't report a default value
         # for ensure, we assume it to be `Present` - this is the most common pattern.
         should_ensure = should[:dsc_ensure].nil? ? 'Present' : should[:dsc_ensure].to_s
-        is_ensure = is[:dsc_ensure].to_s
+        # HACK: Sometimes dsc_ensure is removed???? If it's gone, pretend it's absent??
+        is_ensure = is[:dsc_ensure].nil? ? 'Absent' : is[:dsc_ensure].to_s
 
         if is_ensure == 'Absent' && should_ensure == 'Present'
           context.creating(name) do
@@ -280,6 +284,15 @@ class Puppet::Provider::DscBaseProvider
     # If a resource is found, it's present, so refill this Puppet-only key
     data.merge!({ name: name_hash[:name] })
 
+    # Have to check for this to avoid a weird canonicalization warning
+    # The Resource API calls canonicalize against the current state which
+    # will lead to dsc_ensure being set to absent in the name_hash even if
+    # it was set to present in the manifest
+    name_hash_has_nil_keys = name_hash.select { |_k, v| v.nil? }.count.positive?
+    # We want to throw away all of the empty keys if and only if the manifest
+    # declaration is for an absent resource and the resource is actually absent
+    data.reject! { |_k, v| v.nil? } if data[:dsc_ensure] == 'Absent' && name_hash[:dsc_ensure] == 'Absent' && !name_hash_has_nil_keys
+
     # Cache the query to prevent a second lookup
     @@cached_query_results << data.dup if fetch_cached_hashes(@@cached_query_results, [data]).empty?
     context.debug("Returned to Puppet as #{data}")
@@ -346,17 +359,49 @@ class Puppet::Provider::DscBaseProvider
     # Because Puppet adds all of the modules to the LOAD_PATH we can be sure that the appropriate module lives here during an apply;
     # PROBLEM: This currently uses the downcased name, we need to capture the module name in the metadata I think.
     # During a Puppet agent run, the code lives in the cache so we can use the file expansion to discover the correct folder.
-    root_module_path = $LOAD_PATH.select { |path| path.match?(%r{#{resource[:dscmeta_module_name].downcase}/lib}) }.first
+    # This handles setting the vendored_modules_path to include the puppet module name; we now add the puppet module name into the
+    # path to allow multiple modules to with shared dsc_resources to be installed side by side
+    # The old vendored_modules_path: puppet_x/dsc_resources
+    # The new vendored_modules_path: puppet_x/<module_name>/dsc_resources
+    root_module_path = $LOAD_PATH.select { |path| path.match?(%r{#{puppetize_name(resource[:dscmeta_module_name])}/lib}) }.first
     resource[:vendored_modules_path] = if root_module_path.nil?
-                                         File.expand_path(Pathname.new(__FILE__).dirname + '../../../' + 'puppet_x/dsc_resources') # rubocop:disable Style/StringConcatenation
+                                         File.expand_path(Pathname.new(__FILE__).dirname + '../../../' + "puppet_x/#{puppetize_name(resource[:dscmeta_module_name])}/dsc_resources") # rubocop:disable Style/StringConcatenation
                                        else
-                                         File.expand_path("#{root_module_path}/puppet_x/dsc_resources")
+                                         File.expand_path("#{root_module_path}/puppet_x/#{puppetize_name(resource[:dscmeta_module_name])}/dsc_resources")
                                        end
+
+    # Check for the old vendored_modules_path second - if there is a mix of modules with the old and new pathing,
+    # checking for this first will always work and so the more specific search will never run.
+    unless File.exist? resource[:vendored_modules_path]
+      resource[:vendored_modules_path] = if root_module_path.nil?
+                                           File.expand_path(Pathname.new(__FILE__).dirname + '../../../' + 'puppet_x/dsc_resources') # rubocop:disable Style/StringConcatenation
+                                         else
+                                           File.expand_path("#{root_module_path}/puppet_x/dsc_resources")
+                                         end
+    end
+
+    # A warning is thrown if the something went wrong and the file was not created
+    raise "Unable to find expected vendored DSC Resource #{resource[:vendored_modules_path]}" unless File.exist? resource[:vendored_modules_path]
+
     resource[:attributes] = nil
+
     context.debug("should_to_resource: #{resource.inspect}")
     resource
   end
 
+  # Return a String containing a puppetized name. A puppetized name is a string that only
+  # includes lowercase letters, digits, underscores and cannot start with a digit.
+  #
+  # @return [String] with a puppeized module name
+  def puppetize_name(name)
+    # Puppet module names must be lower case
+    name = name.downcase
+    # Puppet module names must only include lowercase letters, digits and underscores
+    name = name.gsub(/[^a-z0-9_]/, '_')
+    # Puppet module names must not start with a number so if it does, append the letter 'a' to the name. Eg: '7zip' becomes 'a7zip'
+    name = name.match?(/^\d/) ? "a#{name}" : name # rubocop:disable Lint/UselessAssignment
+  end
+
   # Return a UUID with the dashes turned into underscores to enable the specifying of guaranteed-unique
   # variables in the PowerShell script.
   #
@@ -452,6 +497,14 @@ class Puppet::Provider::DscBaseProvider
     context.type.attributes.select { |_attribute, properties| properties[:behaviour] == :namevar }.keys
   end
 
+  # Parses the DSC resource type definition to retrieve the names of any attributes which are specified as parameters
+  #
+  # @param context [Object] the Puppet runtime context to operate in and send feedback to
+  # @return [Array] returns an array of attribute names as symbols which are parameters
+  def parameter_attributes(context)
+    context.type.attributes.select { |_name, properties| properties[:behaviour] == :parameter }.keys
+  end
+
   # Look through a fully formatted string, replacing all instances where a value matches the formatted properties
   # of an instantiated variable with references to the variable instead. This allows us to pass complex and nested
   # CIM instances to the Invoke-DscResource parameter hash without constructing them *in* the hash.
@@ -485,8 +538,8 @@ class Puppet::Provider::DscBaseProvider
         'user' => property_hash[:value]['user'],
         'password' => escape_quotes(property_hash[:value]['password'].unwrap)
       }
-      instantiated_variables.merge!(variable_name => credential_hash)
       credentials_block << format_pscredential(variable_name, credential_hash)
+      instantiated_variables.merge!(variable_name => credential_hash)
     end
     credentials_block.join("\n")
     credentials_block == [] ? '' : credentials_block
@@ -513,6 +566,7 @@ class Puppet::Provider::DscBaseProvider
     cim_instances_block = []
     resource[:parameters].each do |_property_name, property_hash|
       next unless property_hash[:mof_is_embedded]
+      next if property_hash[:mof_type] == 'PSCredential' # Credentials are handled separately
 
       # strip dsc_ from the beginning of the property name declaration
       # name = property_name.to_s.gsub(/^dsc_/, '').to_sym
@@ -523,10 +577,10 @@ class Puppet::Provider::DscBaseProvider
       unless cim_instance_hashes.count.zero?
         cim_instance_hashes.each do |instance|
           variable_name = random_variable_name
-          instantiated_variables.merge!(variable_name => instance)
           class_name = instance['cim_instance_type']
           properties = instance.reject { |k, _v| k == 'cim_instance_type' }
           cim_instances_block << format_ciminstance(variable_name, class_name, properties)
+          instantiated_variables.merge!(variable_name => instance)
         end
       end
       # We have to handle arrays of CIM instances slightly differently
@@ -534,14 +588,14 @@ class Puppet::Provider::DscBaseProvider
         class_name = property_hash[:mof_type].gsub('[]', '')
         property_hash[:value].each do |hash|
           variable_name = random_variable_name
-          instantiated_variables.merge!(variable_name => hash)
           cim_instances_block << format_ciminstance(variable_name, class_name, hash)
+          instantiated_variables.merge!(variable_name => hash)
         end
       else
         variable_name = random_variable_name
-        instantiated_variables.merge!(variable_name => property_hash[:value])
         class_name = property_hash[:mof_type]
         cim_instances_block << format_ciminstance(variable_name, class_name, property_hash[:value])
+        instantiated_variables.merge!(variable_name => property_hash[:value])
       end
     end
     cim_instances_block == [] ? '' : cim_instances_block.join("\n")
@@ -624,7 +678,7 @@ class Puppet::Provider::DscBaseProvider
     params_block = params_block.gsub("'[DateTime]", "[DateTime]'")
     # HACK: Handle intentionally empty arrays - need to strongly type them because
     # CIM instances do not do a consistent job of casting an empty array properly.
-    empty_array_parameters = resource[:parameters].select { |_k, v| v[:value].empty? }
+    empty_array_parameters = resource[:parameters].select { |_k, v| v[:value].is_a?(Array) && v[:value].empty? }
     empty_array_parameters.each do |name, properties|
       param_block_name = name.to_s.gsub(/^dsc_/, '')
       params_block = params_block.gsub("#{param_block_name} = @()", "#{param_block_name} = [#{properties[:mof_type]}]@()")

data/lib/pwsh/version.rb

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

data/metadata.json

@@ -1,11 +1,11 @@
 {
   "name": "puppetlabs-pwshlib",
-  "version": "0.6.0",
+  "version": "0.7.1",
   "author": "puppetlabs",
   "summary": "Provide library code for interoperating with PowerShell.",
   "license": "MIT",
   "source": "https://github.com/puppetlabs/ruby-pwsh",
-  "project_page": "https://github.com/puppetlabs/ruby-pwsh/blob/master/pwshlib.md",
+  "project_page": "https://github.com/puppetlabs/ruby-pwsh/blob/main/pwshlib.md",
   "issues_url": "https://github.com/puppetlabs/ruby-pwsh/issues",
   "dependencies": [
 

metadata

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