puppet-resource_api 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8adaec9101c4bdf2bfaabfbb4ef87147d37c7360dd5008a8da7d0d653bd4071c
-  data.tar.gz: a81e2f4b6e643587b74e7ae4313e9b011f76aeec10b09abc292d9bb65083df2a
+  metadata.gz: 3c0802c277632a57802c1b44466a56470474357dea596c39472c7e23a592aab9
+  data.tar.gz: 66b3de030a9a2b91a2abac411d46e803152e973a10235eaf09c1b3381b41a184
 SHA512:
-  metadata.gz: f910f226a69685dcdadd6391b5ad4f2b5064f1861fdc06c8a7ed36d84f4da49d850983550809eb7053959d94799946c8c6109e0c3c848dbe9649d2bbc23f4f20
-  data.tar.gz: 47ba949ac49e663add1eed1d9648d5b4642346ac4ecbf944447670352e9aa8f75813d5964cab7fd9f2793e1ae49b41153b24d54b0e9bb5884484284d101bb0ca
+  metadata.gz: c16aea1e79a69f0c6112812c1f5e89884899064ffdcf31c7c2a9567e776435244646a3d0111c3c29acf64cfee8ce061f3684ef012edb7af574615aef910b2cb2
+  data.tar.gz: 7e719c49452ddea14cabddaf3702eac1e15da5717138ce732be25c0f57b6c649df1f2702869adf3265b002fb83ca78f6df7b5671350119ea8b6fdc62f9eb2415

data/CHANGELOG.md

@@ -3,6 +3,25 @@
 All significant changes to this repo will be summarized in this file.
 
 
+## [v1.0.3](https://github.com/puppetlabs/puppet-resource_api/tree/v1.0.3) (2018-04-06)
+[Full Changelog](https://github.com/puppetlabs/puppet-resource_api/compare/v1.0.2...v1.0.3)
+
+**Implemented enhancements:**
+
+- \(PDK-887\) Add checks for read\_only values being set or modified [\#54](https://github.com/puppetlabs/puppet-resource_api/pull/54) ([da-ar](https://github.com/da-ar))
+- \(PDK-885\) Add support for init\_only attributes [\#52](https://github.com/puppetlabs/puppet-resource_api/pull/52) ([da-ar](https://github.com/da-ar))
+
+**Fixed bugs:**
+
+- \(PDK-911\) Fix handling of `ensure` values from symbols to strings [\#55](https://github.com/puppetlabs/puppet-resource_api/pull/55) ([DavidS](https://github.com/DavidS))
+
+**Merged pull requests:**
+
+- Misc fixes [\#56](https://github.com/puppetlabs/puppet-resource_api/pull/56) ([DavidS](https://github.com/DavidS))
+- \(PDK-890\) document current constraints on possible data types  [\#53](https://github.com/puppetlabs/puppet-resource_api/pull/53) ([DavidS](https://github.com/DavidS))
+- Update release prep notes [\#51](https://github.com/puppetlabs/puppet-resource_api/pull/51) ([DavidS](https://github.com/DavidS))
+- Release prep for v1.0.2 [\#50](https://github.com/puppetlabs/puppet-resource_api/pull/50) ([DavidS](https://github.com/DavidS))
+
 ## [v1.0.2](https://github.com/puppetlabs/puppet-resource_api/tree/v1.0.2) (2018-03-26)
 [Full Changelog](https://github.com/puppetlabs/puppet-resource_api/compare/v1.0.1...v1.0.2)
 

data/README.md

@@ -55,6 +55,8 @@ pdk (INFO): Creating '.../example/spec/unit/puppet/provider/foo/foo_spec.rb' fro
 $
 ```
 
+Note that the templates released with PDK 1.4 suffer from the fallout of [PDK-911](https://tickets.puppetlabs.com/browse/PDK-911), and need all occurrences of `:present` changed to `'present'`. This will be fixed in PDK 1.5.
+
 The three generated files are the type, the implementation, and the unit tests. The default template contains an example that demonstrates the basic workings of the Resource API. This allows the unit tests to run immediately after creating the provider:
 
 ```
@@ -118,11 +120,11 @@ class Puppet::Provider::Foo::Foo < Puppet::ResourceApi::SimpleProvider
     [
       {
         name: 'foo',
-        ensure: :present,
+        ensure: 'present',
       },
       {
         name: 'bar',
-        ensure: :present,
+        ensure: 'present',
       },
     ]
   end
@@ -188,6 +190,12 @@ This gem is still under heavy development. This section is a living document of
 
 Currently working:
 * Basic type and provider definition, using `name`, `desc`, and `attributes`.
+* Scalar puppet 4 [data types](https://puppet.com/docs/puppet/5.3/lang_data_type.html#core-data-types):
+  * String
+  * Integer, Float, Numeric
+  * Boolean
+  * Enum[absent, present]
+  * simple Optionals
 * The `canonicalize`, `simple_get_filter`, and `remote_resource` features.
 * All the logging facilities.
 * Executing the new provider under the following commands:
@@ -197,8 +205,8 @@ Currently working:
   * `puppet device` (if applicable)
 
 There are still a few notable gaps between the implementation and the specification:
+* Complex data types, like Array, Hash, Tuple or Struct are not yet implemented.
 * Only a single runtime environment (the Puppet commands) is currently implemented.
-* The `:init_only` behaviour is not yet implemented ([PDK-885](https://tickets.puppetlabs.com/browse/PDK-885))
 
 Restrictions of running under puppet:
 * `supports_noop` is not effective, as puppet doesn't call into the type under noop.
@@ -222,6 +230,7 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/puppet
 
 To cut a new release, from a current `master` checkout:
 
+* Start the release branch with `git checkout -b release-prep`
 * Update `lib/puppet/resource_api/version.rb` to the new version
 * Update the CHANGELOG
   * Have a [CHANGELOG_GITHUB_TOKEN](https://github.com/skywinder/github-changelog-generator#github-token) set in your environment
@@ -229,7 +238,9 @@ To cut a new release, from a current `master` checkout:
   * double check the PRs to make sure they're all tagged correctly (using the new CHANGELOG for cross-checking)
 * Check README and other materials for up-to-date-ness
 * Commit changes with title "Release prep for v<VERSION>"
-* Upload and PR the release prep to github as normal
+* Upload and PR the release prep to github through the main repo starting with `git push upstream`
+  * make sure to use the name of your git remote pointing to main repo instead of "upstream"
 * Check that CI is green and merge the PR
 * Run `rake release[upstream]` to release from your checkout
   * make sure to use the name of your git remote pointing to main repo instead of "upstream"
+* Remove the release-prep branch

data/lib/puppet/resource_api.rb

@@ -85,7 +85,7 @@ module Puppet::ResourceApi
 
           # skip properties if the resource is being deleted
           next if definition[:attributes][:ensure] &&
-                  value(:ensure) == :absent &&
+                  value(:ensure) == 'absent' &&
                   options[:behaviour].nil?
 
           if value(name).nil? && !(type.instance_of? Puppet::Pops::Types::POptionalType)
@@ -96,7 +96,7 @@ module Puppet::ResourceApi
         missing_attrs -= [:ensure] if @called_from_resource
 
         if missing_attrs.any?
-          error_msg = "The following mandatory attributes where not provided:\n    *  " + missing_attrs.join(", \n    *  ")
+          error_msg = "The following mandatory attributes were not provided:\n    *  " + missing_attrs.join(", \n    *  ")
           raise Puppet::ResourceError, error_msg
         end
       end
@@ -105,7 +105,7 @@ module Puppet::ResourceApi
         # puts "#{name}: #{options.inspect}"
 
         if options[:behaviour]
-          unless [:read_only, :namevar, :parameter].include? options[:behaviour]
+          unless [:read_only, :namevar, :parameter, :init_only].include? options[:behaviour]
             raise Puppet::ResourceError, "`#{options[:behaviour]}` is not a valid behaviour value"
           end
         end
@@ -142,72 +142,80 @@ module Puppet::ResourceApi
             if options.key? :default
               defaultto options[:default]
             end
+          end
 
-            type = Puppet::Pops::Types::TypeParser.singleton.parse(options[:type])
-            validate do |value|
-              return true if type.instance?(value)
+          type = Puppet::Pops::Types::TypeParser.singleton.parse(options[:type])
+          validate do |value|
+            if options[:behaviour] == :read_only
+              raise Puppet::ResourceError, "Attempting to set `#{name}` read_only attribute value to `#{value}`"
+            end
+
+            return true if type.instance?(value)
 
-              if value.is_a? String
-                # when running under `puppet resource`, we need to try to coerce from strings to the real type
-                case value
-                when %r{^-?\d+$}, Puppet::Pops::Patterns::NUMERIC
-                  value = Puppet::Pops::Utils.to_n(value)
-                when %r{\Atrue|false\Z}
-                  value = value == 'true'
-                end
-                return true if type.instance?(value)
-
-                inferred_type = Puppet::Pops::Types::TypeCalculator.infer_set(value)
-                error_msg = Puppet::Pops::Types::TypeMismatchDescriber.new.describe_mismatch("#{definition[:name]}.#{name}", type, inferred_type)
-                raise Puppet::ResourceError, error_msg
+            if value.is_a? String
+              # when running under `puppet resource`, we need to try to coerce from strings to the real type
+              case value
+              when %r{^-?\d+$}, Puppet::Pops::Patterns::NUMERIC
+                value = Puppet::Pops::Utils.to_n(value)
+              when %r{\Atrue|false\Z}
+                value = value == 'true'
               end
-            end
+              return true if type.instance?(value)
 
-            if type.instance_of? Puppet::Pops::Types::POptionalType
-              type = type.type
+              inferred_type = Puppet::Pops::Types::TypeCalculator.infer_set(value)
+              error_msg = Puppet::Pops::Types::TypeMismatchDescriber.new.describe_mismatch("#{definition[:name]}.#{name}", type, inferred_type)
+              raise Puppet::ResourceError, error_msg
             end
+          end
 
-            # provide better handling of the standard types
-            case type
-            when Puppet::Pops::Types::PStringType
-              # require any string value
-              Puppet::ResourceApi.def_newvalues(self, param_or_property, %r{})
-            # rubocop:disable Lint/BooleanSymbol
-            when Puppet::Pops::Types::PBooleanType
-              Puppet::ResourceApi.def_newvalues(self, param_or_property, 'true', 'false')
-              aliasvalue true, 'true'
-              aliasvalue false, 'false'
-              aliasvalue :true, 'true'
-              aliasvalue :false, 'false'
-
-              munge do |v|
-                case v
-                when 'true', :true
-                  true
-                when 'false', :false
-                  false
-                else
-                  v
-                end
-              end
-            # rubocop:enable Lint/BooleanSymbol
-            when Puppet::Pops::Types::PIntegerType
-              Puppet::ResourceApi.def_newvalues(self, param_or_property, %r{^-?\d+$})
-              munge do |v|
-                Puppet::Pops::Utils.to_n(v)
-              end
-            when Puppet::Pops::Types::PFloatType, Puppet::Pops::Types::PNumericType
-              Puppet::ResourceApi.def_newvalues(self, param_or_property, Puppet::Pops::Patterns::NUMERIC)
-              munge do |v|
-                Puppet::Pops::Utils.to_n(v)
+          if type.instance_of? Puppet::Pops::Types::POptionalType
+            type = type.type
+          end
+
+          # provide better handling of the standard types
+          case type
+          when Puppet::Pops::Types::PStringType
+            # require any string value
+            Puppet::ResourceApi.def_newvalues(self, param_or_property, %r{})
+          # rubocop:disable Lint/BooleanSymbol
+          when Puppet::Pops::Types::PBooleanType
+            Puppet::ResourceApi.def_newvalues(self, param_or_property, 'true', 'false')
+            aliasvalue true, 'true'
+            aliasvalue false, 'false'
+            aliasvalue :true, 'true'
+            aliasvalue :false, 'false'
+
+            munge do |v|
+              case v
+              when 'true', :true
+                true
+              when 'false', :false
+                false
+              else
+                v
               end
             end
-
-            case options[:type]
-            when 'Enum[present, absent]'
-              Puppet::ResourceApi.def_newvalues(self, param_or_property, :absent, :present)
+          # rubocop:enable Lint/BooleanSymbol
+          when Puppet::Pops::Types::PIntegerType
+            Puppet::ResourceApi.def_newvalues(self, param_or_property, %r{^-?\d+$})
+            munge do |v|
+              Puppet::Pops::Utils.to_n(v)
+            end
+          when Puppet::Pops::Types::PFloatType, Puppet::Pops::Types::PNumericType
+            Puppet::ResourceApi.def_newvalues(self, param_or_property, Puppet::Pops::Patterns::NUMERIC)
+            munge do |v|
+              Puppet::Pops::Utils.to_n(v)
             end
           end
+
+          case options[:type]
+          when 'Enum[present, absent]'
+            Puppet::ResourceApi.def_newvalues(self, param_or_property, 'absent', 'present')
+            # puppet symbolizes these values through puppet/paramter/value.rb (see .convert()), but Enums are strings
+            # specifying a munge block here skips the value_collection fallback in puppet/parameter.rb's
+            # default .unsafe_munge() implementation
+            munge { |v| v }
+          end
         end
       end
 
@@ -248,7 +256,7 @@ module Puppet::ResourceApi
           end
         else
           result[namevar_name] = title
-          result[:ensure] = :absent
+          result[:ensure] = 'absent'
         end
 
         @rapi_current_state = current_state
@@ -270,6 +278,20 @@ module Puppet::ResourceApi
 
         Puppet.debug("Target State: #{target_state.inspect}")
 
+        # enforce init_only attributes
+        if Puppet.settings[:strict] != :off && @rapi_current_state && (@rapi_current_state[:ensure] == 'present' && target_state[:ensure] == 'present')
+          target_state.each do |name, value|
+            next unless definition[:attributes][name][:behaviour] == :init_only && value != @rapi_current_state[name]
+            message = "Attempting to change `#{name}` init_only attribute value from `#{@rapi_current_state[name]}` to `#{value}`"
+            case Puppet.settings[:strict]
+            when :warning
+              Puppet.warning(message)
+            when :error
+              raise Puppet::ResourceError, message
+            end
+          end
+        end
+
         if feature_support?('supports_noop')
           my_provider.set(context, { title => { is: @rapi_current_state, should: target_state } }, noop: noop?)
         else
@@ -302,7 +324,7 @@ MESSAGE
         when :warning
           Puppet.warning(message)
         when :error
-          raise Puppet::Error, message
+          raise Puppet::DevError, message
         end
 
         return nil

data/lib/puppet/resource_api/version.rb

@@ -1,5 +1,5 @@
 module Puppet
   module ResourceApi
-    VERSION = '1.0.2'.freeze
+    VERSION = '1.0.3'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puppet-resource_api
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors:
 - David Schmitt
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-03-26 00:00:00.000000000 Z
+date: 2018-04-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hocon