ruby-pwsh 1.1.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eb7a2c9a103865f74de54ae3a977a70382a2b18ff2e1f8f830b25ef50f4ba1d2
-  data.tar.gz: 7ca9acbd7478367673a8f761a0b51ddf5f0359246b3ca72f7fe9b8e4c3da34a6
+  metadata.gz: 1ac282abeea132104fda1b3fc2f4743f4b99603cdd6b73a42b7063641c9e65d9
+  data.tar.gz: 410bc1d7a7b08366a89019324b172219102197f8aa6891bcfaa1729e3bd76925
 SHA512:
-  metadata.gz: 830c6e92076e50675f1ce02445f9fd9952545987af24e152bb164b11223d35d47d3619c997bf51b9b09293b22d69d2c832e689f59cfbad1118663203af374046
-  data.tar.gz: 5e107bcb95cc294f2c421d565c3376b21a7272b4bd4e4c32684f4481577398e2fa54c5005f8e6d990a7d9ffebf2db5eca5dbdb7eba2b2c7ddb2660ca65315f04
+  metadata.gz: 0fd8c7af3f87ce61121a7404b66cfae5cf78fea8bdb885dc7715467bb5092bd974a9fd4d7f94824fe10675d56b4e4dc7b439826f95bc5d9672f14fcb74692501
+  data.tar.gz: 198328e45920aa2794cab2984e090c14c81ce56b4b038e4ae0b7f22ad66d327d0bbd34b5726709108c14609324dba1687a83a2f67026a2d8abf12d749067ca27

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

@@ -44,6 +44,7 @@ class Puppet::Provider::DscBaseProvider # rubocop:disable Metrics/ClassLength
   # @param context [Object] the Puppet runtime context to operate in and send feedback to
   # @param resources [Hash] the hash of the resource to canonicalize from either manifest or invocation
   # @return [Hash] returns a hash representing the current state of the object, if it exists
+  # rubocop:disable Metrics/BlockLength, Metrics/MethodLength
   def canonicalize(context, resources)
     canonicalized_resources = []
     resources.collect do |r|
@@ -83,9 +84,18 @@ class Puppet::Provider::DscBaseProvider # rubocop:disable Metrics/ClassLength
             downcased_result.each do |key, value|
               # Canonicalize to the manifest value unless the downcased strings match and the attribute is not an enum:
               # - When the values don't match at all, the manifest value is desired;
-              # - When the values match case insensitively but the attribute is an enum, prefer the casing of the manifest enum.
-              # - When the values match case insensitively and the attribute is not an enum, prefer the casing from invoke_get_method
-              canonicalized[key] = r[key] unless same?(value, downcased_resource[key]) && !enum_attributes(context).include?(key)
+              # - When the values match case insensitively but the attribute is an enum, and the casing from invoke_get_method
+              #   is not int the enum, prefer the casing of the manifest enum.
+              # - When the values match case insensitively and the attribute is not an enum, or is an enum and invoke_get_method casing
+              #   is in the enum, prefer the casing from invoke_get_method
+              is_enum = enum_attributes(context).include?(key)
+              canonicalized_value_in_enum = if is_enum
+                                              enum_values(context, key).include?(canonicalized[key])
+                                            else
+                                              false
+                                            end
+              match_insensitively = same?(value, downcased_resource[key])
+              canonicalized[key] = r[key] unless match_insensitively && (canonicalized_value_in_enum || !is_enum)
               canonicalized.delete(key) unless downcased_resource.key?(key)
             end
             # Cache the actually canonicalized resource separately
@@ -104,6 +114,7 @@ class Puppet::Provider::DscBaseProvider # rubocop:disable Metrics/ClassLength
     context.debug("Canonicalized Resources: #{canonicalized_resources}")
     canonicalized_resources
   end
+  # rubocop:enable Metrics/BlockLength, Metrics/MethodLength
 
   # Attempts to retrieve an instance of the DSC resource, invoking the `Get` method and passing any
   # namevars as the Properties to Invoke-DscResource. The result object, if any, is compared to the
@@ -299,24 +310,16 @@ class Puppet::Provider::DscBaseProvider # rubocop:disable Metrics/ClassLength
       # notify and retry
       context.notice("Retrying: attempt #{try} of #{max_retry_count}.")
       data = JSON.parse(yield)
-      # if no error, break
-      if data['errormessage'].nil?
-        break
-      # check if error matches error matcher supplied
-      elsif data['errormessage'].match?(error_matcher)
-        # if last attempt, return error
-        if try == max_retry_count
-          context.notice("Attempt #{try} of #{max_retry_count} failed. No more retries.")
-          # all attempts failed, raise error
-          return context.err(data['errormessage'])
-        end
-        # if not last attempt, notify, continue and retry
-        context.notice("Attempt #{try} of #{max_retry_count} failed.")
-        next
-      else
-        # if we get an unexpected error, return
-        return context.err(data['errormessage'])
-      end
+      # if no error, assume successful invocation and break
+      break if data['errormessage'].nil?
+
+      # notify of failed retry
+      context.notice("Attempt #{try} of #{max_retry_count} failed.")
+      # return if error does not match expceted error, or all retries exhausted
+      return context.err(data['errormessage']) unless data['errormessage'].match?(error_matcher) && try < max_retry_count
+
+      # else, retry
+      next
     end
     data
   end
@@ -348,7 +351,7 @@ class Puppet::Provider::DscBaseProvider # rubocop:disable Metrics/ClassLength
   # @param context [Object] the Puppet runtime context to operate in and send feedback to
   # @param name_hash [Hash] the hash of namevars to be passed as properties to `Invoke-DscResource`
   # @return [Hash] returns a hash representing the DSC resource munged to the representation the Puppet Type expects
-  def invoke_get_method(context, name_hash)
+  def invoke_get_method(context, name_hash) # rubocop:disable Metrics/AbcSize
     context.debug("retrieving #{name_hash.inspect}")
 
     query_props = name_hash.select { |k, v| mandatory_get_attributes(context).include?(k) || (k == :dsc_psdscrunascredential && !v.nil?) }
@@ -391,6 +394,8 @@ class Puppet::Provider::DscBaseProvider # rubocop:disable Metrics/ClassLength
     # If a resource is found, it's present, so refill this Puppet-only key
     data[:name] = name_hash[:name]
 
+    data = stringify_nil_attributes(context, data)
+
     # 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
@@ -660,6 +665,20 @@ class Puppet::Provider::DscBaseProvider # rubocop:disable Metrics/ClassLength
     context.type.attributes.select { |_attribute, properties| properties[:mandatory_for_set] }.keys
   end
 
+  # Parses the DSC resource type definition to retrieve the names of any attributes which are specifed as required strings
+  # This is used to ensure that any nil values are converted to empty strings to match puppets expecetd value
+  # @param context [Object] the Puppet runtime context to operate in and send feedback to
+  # @param data [Hash] the hash of properties returned from the DSC resource
+  # @return [Hash] returns a data hash with any nil values converted to empty strings
+  def stringify_nil_attributes(context, data)
+    nil_strings = data.select { |_name, value| value.nil? }.keys
+    string_attrs = context.type.attributes.select { |_name, properties| properties[:type] == 'String' }.keys
+    string_attrs.each do |attribute|
+      data[attribute] = '' if nil_strings.include?(attribute)
+    end
+    data
+  end
+
   # Parses the DSC resource type definition to retrieve the names of any attributes which are specified as namevars
   #
   # @param context [Object] the Puppet runtime context to operate in and send feedback to
@@ -686,6 +705,28 @@ class Puppet::Provider::DscBaseProvider # rubocop:disable Metrics/ClassLength
     context.type.attributes.select { |_name, properties| properties[:type].include?('Enum[') }.keys
   end
 
+  # Parses the DSC resource type definition to retrieve the values of any attributes which are specified as enums
+  #
+  # @param context [Object] the Puppet runtime context to operate in and send feedback to
+  # @param attribute [String] the enum attribute to retrieve the allowed values from
+  # @return [Array] returns an array of attribute names as symbols which are enums
+  def enum_values(context, attribute)
+    # Get the attribute's type string for the given key
+    type_string = context.type.attributes[attribute][:type]
+
+    # Return an empty array if the key doesn't have an Enum type or doesn't exist
+    return [] unless type_string&.include?('Enum[')
+
+    # Extract the enum values from the type string
+    enum_content = type_string.match(/Enum\[(.*?)\]/)&.[](1)
+
+    # Return an empty array if we couldn't find the enum values
+    return [] if enum_content.nil?
+
+    # Return an array of the enum values, stripped of extra whitespace and quote marks
+    enum_content.split(',').map { |val| val.strip.delete('\'') }
+  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.

data/lib/pwsh/version.rb

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

data/spec/unit/puppet/provider/dsc_base_provider/dsc_base_provider_spec.rb

@@ -179,6 +179,8 @@ RSpec.describe Puppet::Provider::DscBaseProvider do
             end
 
             it 'treats the manifest value as canonical' do
+              expect(context).to receive(:type).and_return(type)
+              expect(type).to receive(:attributes).and_return({ dsc_property: { type: "Enum['Dword']" } })
               expect(canonicalized_resource.first[:dsc_property]).to eq('Dword')
             end
           end
@@ -812,9 +814,9 @@ RSpec.describe Puppet::Provider::DscBaseProvider do
                                                .exactly(5).times
         expect(context).to receive(:notice).with(/Invoke-DscResource collision detected: Please stagger the timing of your Puppet runs as this can lead to unexpected behaviour./).once
         expect(context).to receive(:notice).with('Sleeping for 60 seconds.').exactly(5).times
-        expect(context).to receive(:notice).with(/Retrying: attempt [1-6] of 5/).exactly(5).times
+        expect(context).to receive(:notice).with(/Retrying: attempt [1-5] of 5/).exactly(5).times
         expect(ps_manager).to receive(:execute).and_return({ stdout: '{"errormessage": "The Invoke-DscResource cmdlet is in progress and must return before Invoke-DscResource can be invoked"}' })
-        expect(context).to receive(:notice).with(/Attempt [1-6] of 5 failed/).exactly(5).times
+        expect(context).to receive(:notice).with(/Attempt [1-5] of 5 failed/).exactly(5).times
         expect(context).to receive(:err).with(/The Invoke-DscResource cmdlet is in progress and must return before Invoke-DscResource can be invoked/)
         allow(provider).to receive(:sleep)
         expect(result).to be_nil
@@ -827,6 +829,7 @@ RSpec.describe Puppet::Provider::DscBaseProvider do
         expect(context).to receive(:notice).with(/Retrying: attempt 1 of 5/).once
         allow(provider).to receive(:sleep)
         expect(ps_manager).to receive(:execute).and_return({ stdout: '{"errormessage": "Some unexpected error"}' }).once
+        expect(context).to receive(:notice).with(/Attempt 1 of 5 failed/).once
         expect(context).to receive(:err).with(/Some unexpected error/)
         expect(result).to be_nil
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-pwsh
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.1
 platform: ruby
 authors:
 - Puppet, Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-01-31 00:00:00.000000000 Z
+date: 2024-02-21 00:00:00.000000000 Z
 dependencies: []
 description: PowerShell code manager for ruby.
 email: