(MODULES-7197) Remove unused ensurable values #55
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
ThoughtCrhyme
previously approved these changes
Jun 12, 2018
|
Note: This doesn't change the name of the ensurable property default value, but it does remove extraneous ones and document why there's only one/advise folks not to specify it in their manifest. Future work to change the name will have to come (if at all) after we figure out how to make the reporting better (since by default puppet declares a resource which is in the desired state as |
glennsarti
reviewed
Jun 13, 2018
README.md
Outdated
| @@ -287,6 +287,11 @@ The `dsc` type allows specifying any DSC Resource declaration as a minimal Puppe | |||
|
|
|||
| The name of the declaration. This has no affect on the DSC Resource declaration and is not used by the DSC Resource. | |||
|
|
|||
| #### ensure | |||
|
|
|||
| A necessary property to cause puppet to invoke the dsc resource if required. | |||
There was a problem hiding this comment.
Not keen on this. Perhaps
An optional property that specifies that the DSC resource should be invoked. This property has only one value of `present`. This property does not need be be set in manifests.
lib/puppet/type/dsc.rb
Outdated
| @@ -5,9 +5,17 @@ | |||
| require Pathname.new(__FILE__).dirname + '../../puppet_x/puppetlabs/dsc_lite/dsc_type_helpers' | |||
|
|
|||
| ensurable do | |||
| newvalue(:exists?) { provider.exists? } | |||
| desc <<-HERE | |||
| A necessary property to cause puppet to invoke the dsc resource if required. | |||
There was a problem hiding this comment.
As per comment in README
Prior to this commit the ensure property included an option for users to specify `absent` on the resource which may not actually match up with the DSC properties and which follows the same code path as `present` in any case. The ensure property also included `exists?` as a valid value, even though setting it provided no functionality for users. This commit removes the code to support the `absent` and `exists?` values in the type and the `absent` value in the provider. The `exists?` codepath is still called before puppet runs the `create` code path, and only runs `create` if the returned value from `exists?` is `false`. Further, this commit removes the ensure tests from the acceptance test suite. These tests verified functionality when the dsc and puppet `ensure` properties were in conflict. As of this commit there is only one valid value for `ensure` on the puppet resource so these tests are no longer needed. Finally, this commit adds documentation to the `ensure` property and some comments to clarify why we did not change the name of the ensurable value (reporting). A future commit which addresses the reporting problems may also allow us to update the ensurable value from 'present' to something like 'invoke' which is more semantically accurate.
glennsarti
approved these changes
Jun 13, 2018
|
|
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 commit the ensure property included an
option for users to specify
absenton the resourcewhich may not actually match up with the DSC properties
and which follows the same code path as
presentinany case. The ensure property also included
exists?as a valid value, even though setting it provided no
functionality for users.
This commit removes the code to support the
absentand
exists?values in the type and theabsentvalue in the provider. The
exists?codepath is stillcalled before puppet runs the
createcode path, andonly runs
createif the returned value fromexists?is
false.Further, this commit removes the ensure tests from the
acceptance test suite. These tests verified functionality
when the dsc and puppet
ensureproperties were inconflict. As of this commit there is only one valid value
for
ensureon the puppet resource so these tests are nolonger needed.
Finally, this commit adds documentation to the
ensureproperty and some comments to clarify why we did not
change the name of the ensurable value (reporting).
A future commit which addresses the reporting problems
may also allow us to update the ensurable value from
'present' to something like 'invoke' which is more
semantically accurate.