(GH-154) Fix return data from Invoke-DscResource for empty strings and single item arrays in DSC Base Provider
#159
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
michaeltlombardi
changed the title
Invoke-DscResource for empty strings and single item arrays in DSC Base Provider
Prior to this commit, the ConvertTo-CanonicalResult function used to turn output from Invoke-DscResource with the Get method into something Puppet can use would return empty strings for unset values. Puppet distinguishes between nil and an empty string when deciding if a value has been defined - in these cases, nil is treated as undef whereas an empty string is treated as a set value. This causes canonicalization (and the run) to fail when the value for an unset enum is returned as an empty string. This commit modifies the logic in ConvertTo-CanonicalResult to munge an empty string to nil to prevent invalid enum errors.
Prior to this commit, the logic for determining if a CIM Instance value should be munged to an array value failed against hashes; the logic checked to see if the count was less than 2 and, if so, wrapped the value in an array. This failed against hashes because the count property represents the number of key-value pairs in a hash; this means that to the original logic, a single hash with multiple keys would never be wrapped in an array. When passing back a single item for a value to Puppet which Puppet expects to be an array, an error gets raised. This commit corrects the logic by validating the typename of the value includes the [] suffix and thereby ensures that values returned for CIM instances which are single hashes and should be treated as single-member arrays of hashes can be canonicalized.
jpogran
approved these changes
Jun 21, 2021
jpogran
approved these changes
Jun 21, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Prior to this PR, the
ConvertTo-CanonicalResourcefunction used to munge the valuesInvoke-DscResourceemits for theGetmethod into a usable hash for Puppet/Ruby to consume had minor bugs which:nilasundef)ConvertTo-CanonicalResultmishandled turning single hashes into an array of hashes with a single item).This PR corrects both issues.