puppet-resource_api 1.6.5 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 160e4e687bacbb19cddb0b34398c6caa72ba308707a3718487c2fd4c86040804
-  data.tar.gz: ece23bfd962d5f97f34690bcdb02dbbaeb64d8109b65e5044396bfebb13328fb
+  metadata.gz: c26bda3effbce092aa8b8defb8904fdb41a02231fba2830593bfc85413b66906
+  data.tar.gz: 89b49840bd21ea57227db05021e0b9ddb7ab7539b9b130a888e3fea99b7da87e
 SHA512:
-  metadata.gz: '0888ca950e55d91f308274aab1d97ee46e6f5f924fad3b6abb150721012516f71afc740e6d4a297b188938f63416812d429e4e236908109d254ff9daf0a19a13'
-  data.tar.gz: 94df73da789c0808562408becc35d38ee55d8a5447db00b91999475362819508531b3e59dca2d96d7928bfff61e40447c568168c859beb9b2fe7ccf79d93ac4d
+  metadata.gz: 971775219d3ae76f94a18ebef57b0a1be470a0c222b31a4a1cf0d1d4b8f4ecc71516fb6b004674a4878c619d97f4b6f3e644edcc43e3cba419070afd5ad53bd3
+  data.tar.gz: dfb2823ce573240977587f9a7431b1956a62a0367a740d4e0c9fc412436542d41065be88e7ed8348057fd42b1cf039c4ac69c8e4b7bad7f4771d73c2f6927454

data/.rspec

@@ -1,3 +1,3 @@
 --format documentation
 --color
---order rand
+--order rand

data/.travis.yml

@@ -14,13 +14,13 @@ branches:
 matrix:
   include:
     - rvm: 2.4.3
-      env: PUPPET_GEM_VERSION='~> 5' SIMPLECOV=yes # 5.5
-    - env: RVM="jruby-1.7.26" PUPPET_GEM_VERSION='~> 5' JRUBY_OPTS="--debug" SIMPLECOV=yes
+      env: PUPPET_GEM_VERSION='~> 5' COVERAGE=yes # 5.5
+    - env: RVM="jruby-1.7.26" PUPPET_GEM_VERSION='~> 5' JRUBY_OPTS="--debug" COVERAGE=yes
       before_cache: pushd ~/.rvm && rm -rf archives rubies/ruby-2.2.7 rubies/ruby-2.3.4 && popd
       cache:
         bundler: true
         directories: ~/.rvm
-      before_install: rvm use jruby-1.7.26 --install --binary --fuzzy && gem install bundler -v '~> 1.7.0'
+      before_install: rvm use jruby-1.7.26 --install --binary --fuzzy
     # disable coverage on jruby9k as this confuses codecov
     - env: RVM="jruby-9.1.9.0" PUPPET_GEM_VERSION='~> 5' JRUBY_OPTS="--debug"
       before_cache: pushd ~/.rvm && rm -rf archives rubies/ruby-2.2.7 rubies/ruby-2.3.4 && popd
@@ -28,9 +28,9 @@ matrix:
         bundler: true
         directories: ~/.rvm
       before_install: rvm use jruby-9.1.9.0 --install --binary --fuzzy
-    - rvm: 2.5.1
+    - rvm: 2.4.3
       env: CHECK=rubocop
-    - rvm: 2.5.1
+    - rvm: 2.4.3
       env: CHECK=license_finder
       bundler_args: ""
 
@@ -45,25 +45,25 @@ matrix:
     - rvm: 2.4.1
       env: PUPPET_GEM_VERSION='~> 5.0.0'
     - rvm: 2.1.9
-      env: PUPPET_GEM_VERSION='~> 4' SIMPLECOV=yes # 4.10
+      env: PUPPET_GEM_VERSION='~> 4'  COVERAGE=yes # 4.10
+      before_install:
+        - gem install bundler -v '< 2'
     - rvm: 2.1.9
       env: PUPPET_GEM_VERSION='~> 4.9.0'
+      before_install:
+        - gem install bundler -v '< 2'
     - rvm: 2.1.9
       env: PUPPET_GEM_VERSION='~> 4.8.0'
+      before_install:
+        - gem install bundler -v '< 2'
     - rvm: 2.1.9
       env: PUPPET_GEM_VERSION='~> 4.7.0'
-    - rvm: 2.5.1
-      env: PUPPET_GEM_VERSION='~> 6' # 6.0, soon 6.1
-    - rvm: 2.5.1
-      env: PUPPET_GEM_VERSION='~> 6.0'
+      before_install:
+        - gem install bundler -v '< 2'
     - rvm: 2.5.1
       env: PUPPET_GEM_VERSION='https://github.com/puppetlabs/puppet.git#master'
     - rvm: 2.5.1
       env: PUPPET_GEM_VERSION='https://github.com/puppetlabs/puppet.git#6.0.x'
-    - rvm: 2.4.3
-      env: PUPPET_GEM_VERSION='https://github.com/puppetlabs/puppet.git#5.5.x'
-    - rvm: 2.1.9
-      env: PUPPET_GEM_VERSION='https://github.com/puppetlabs/puppet.git#4.10.x'
 notifications:
   hipchat:
     rooms:

data/Gemfile

@@ -7,27 +7,18 @@ gemspec
 
 group :tests do
   gem 'codecov'
+  # license_finder does not install on windows using older versions of rubygems.
+  # ruby 2.4 is confirmed working on appveyor.
+  gem 'license_finder' if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('2.4.0')
   gem 'rake', '~> 10.0'
   gem 'rspec', '~> 3.0'
+  gem 'rubocop-rspec'
   # rubocop 0.58 throws when testing against ruby 2.1, so pin to the latest,
   # unless we're dealing with jruby...
   if RUBY_PLATFORM == 'java'
-    # load a rubocop version that works on java for the Rakefile
-    gem 'parser', '2.3.3.1'
-    gem 'rubocop', '0.41.2'
-  elsif Gem::Version.new(RUBY_VERSION) < Gem::Version.new('2.2.0')
-    gem 'rubocop', '0.57.2'
-    # the last version of parallel to support ruby 2.1
-    gem 'parallel', '1.13.0'
-    gem 'rubocop-rspec'
+    gem 'rubocop'
   else
-    # 2.1-compatible analysis was dropped after version 0.58
-    # This needs to be removed once we drop puppet4 support.
-    gem 'rubocop', '~> 0.57.0'
-    gem 'rubocop-rspec'
-    # license_finder does not install on windows using older versions of rubygems.
-    # ruby 2.4 is confirmed working on appveyor.
-    gem 'license_finder' if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('2.4.0')
+    gem 'rubocop', '0.57.2'
   end
   gem 'simplecov-console'
   # the test gems required for module testing

data/README.md

@@ -231,6 +231,12 @@ Future possibilities:
 * [Multiple Providers](https://tickets.puppetlabs.com/browse/PDK-530)
 * [Commands API](https://tickets.puppetlabs.com/browse/PDK-847)
 
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/puppetlabs/puppet-resource_api.

data/Rakefile

@@ -14,30 +14,22 @@ end
 require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec) do |t|
+  Rake::Task[:spec_prep].invoke
   # thanks to the fixtures/modules/ symlinks this needs to exclude fixture modules explicitely
   excludes = ['fixtures/**/*.rb,fixtures/modules/*/**/*.rb']
   if RUBY_PLATFORM == 'java'
     excludes += ['acceptance/**/*.rb', 'integration/**/*.rb', 'puppet/resource_api/*_context_spec.rb', 'puppet/util/network_device/simple/device_spec.rb']
     t.rspec_opts = '--tag ~agent_test'
-    t.rspec_opts << ' --tag ~j17_exclude' if Gem::Version.new(RUBY_VERSION) < Gem::Version.new('2.0.0')
   end
   t.exclude_pattern = "spec/{#{excludes.join ','}}"
 end
 
-task :spec => :spec_prep
-
 namespace :spec do
   desc 'Run RSpec code examples with coverage collection'
   task :coverage do
-    ENV['SIMPLECOV'] = 'yes'
+    ENV['COVERAGE'] = 'yes'
     Rake::Task['spec'].execute
   end
-
-  RSpec::Core::RakeTask.new(:unit) do |t|
-    t.pattern = "spec/puppet/**/*_spec.rb,spec/integration/**/*_spec.rb"
-  end
-
-  task :unit => :spec_prep
 end
 
 #### LICENSE_FINDER ####

data/lib/puppet/resource_api.rb

@@ -19,43 +19,9 @@ module Puppet::ResourceApi
   end
 
   def register_type(definition)
-    raise Puppet::DevError, 'requires a hash as definition, not `%{other_type}`' % { other_type: definition.class } unless definition.is_a? Hash
-    raise Puppet::DevError, 'requires a `:name`' unless definition.key? :name
-    raise Puppet::DevError, 'requires `:attributes`' unless definition.key? :attributes
-    raise Puppet::DevError, '`:attributes` must be a hash, not `%{other_type}`' % { other_type: definition[:attributes].class } unless definition[:attributes].is_a?(Hash)
-    [:title, :provider, :alias, :audit, :before, :consume, :export, :loglevel, :noop, :notify, :require, :schedule, :stage, :subscribe, :tag].each do |name|
-      raise Puppet::DevError, 'must not define an attribute called `%{name}`' % { name: name.inspect } if definition[:attributes].key? name
-    end
-    if definition.key?(:title_patterns) && !definition[:title_patterns].is_a?(Array)
-      raise Puppet::DevError, '`:title_patterns` must be an array, not `%{other_type}`' % { other_type: definition[:title_patterns].class }
-    end
-
-    Puppet::ResourceApi::DataTypeHandling.validate_ensure(definition)
-
-    definition[:features] ||= []
-    supported_features = %w[supports_noop canonicalize remote_resource simple_get_filter].freeze
-    unknown_features = definition[:features] - supported_features
-    Puppet.warning("Unknown feature detected: #{unknown_features.inspect}") unless unknown_features.empty?
-
-    # fixup desc/docs backwards compatibility
-    if definition.key? :docs
-      if definition[:desc]
-        raise Puppet::DevError, '`%{name}` has both `desc` and `docs`, prefer using `desc`' % { name: definition[:name] }
-      end
-      definition[:desc] = definition[:docs]
-      definition.delete(:docs)
-    end
-    Puppet.warning('`%{name}` has no documentation, add it using a `desc` key' % { name: definition[:name] }) unless definition.key? :desc
-
-    # fixup any weird behavior  ;-)
-    definition[:attributes].each do |name, attr|
-      next unless attr[:behavior]
-      if attr[:behaviour]
-        raise Puppet::DevError, "the '#{name}' attribute has both a `behavior` and a `behaviour`, only use one"
-      end
-      attr[:behaviour] = attr[:behavior]
-      attr.delete(:behavior)
-    end
+    # Attempt to create a TypeDefinition from the input hash
+    # This will validate and throw if its not right
+    type_def = TypeDefinition.new(definition)
 
     # prepare the ruby module for the provider
     # this has to happen before Puppet::Type.newtype starts autoloading providers
@@ -66,7 +32,8 @@ module Puppet::ResourceApi
     end
 
     Puppet::Type.newtype(definition[:name].to_sym) do
-      @docs = definition[:desc]
+      @docs = definition[:docs]
+      @type_definition = type_def
 
       # Keeps a copy of the provider around. Weird naming to avoid clashes with puppet's own `provider` member
       define_singleton_method(:my_provider) do
@@ -80,7 +47,7 @@ module Puppet::ResourceApi
       end
 
       define_singleton_method(:type_definition) do
-        @type_definition ||= TypeDefinition.new(definition)
+        @type_definition
       end
 
       def type_definition
@@ -91,7 +58,7 @@ module Puppet::ResourceApi
         apply_to_device
       end
 
-      def initialize(attributes)
+      define_method(:initialize) do |attributes|
         # $stderr.puts "A: #{attributes.inspect}"
         if attributes.is_a? Puppet::Resource
           @title = attributes.title
@@ -119,7 +86,7 @@ module Puppet::ResourceApi
         # the `Puppet::Resource::Ral.find` method, when `instances` does not return a match, uses a Hash with a `:name` key to create
         # an "absent" resource. This is often hit by `puppet resource`. This needs to work, even if the namevar is not called `name`.
         # This bit here relies on the default `title_patterns` (see below) to match the title back to the first (and often only) namevar
-        if type_definition.attributes[:name].nil? && attributes[:title].nil?
+        if definition[:attributes][:name].nil? && attributes[:title].nil?
           attributes[:title] = attributes.delete(:name)
           if attributes[:title].nil? && !type_definition.namevars.empty?
             attributes[:title] = @title
@@ -133,25 +100,11 @@ module Puppet::ResourceApi
         title
       end
 
-      def self.build_title(type_definition, resource_hash)
-        if type_definition.namevars.size > 1
-          # use a MonkeyHash to allow searching in Puppet's RAL
-          Puppet::ResourceApi::MonkeyHash[type_definition.namevars.map { |attr| [attr, resource_hash[attr]] }]
-        else
-          resource_hash[type_definition.namevars[0]]
-        end
-      end
-
-      def rsapi_title
-        @rsapi_title ||= self.class.build_title(type_definition, self)
-        @rsapi_title
-      end
-
       def to_resource
         to_resource_shim(super)
       end
 
-      def to_resource_shim(resource)
+      define_method(:to_resource_shim) do |resource|
         resource_hash = Hash[resource.keys.map { |k| [k, resource[k]] }]
         resource_hash[:title] = resource.title
         ResourceShim.new(resource_hash, type_definition.name, type_definition.namevars, type_definition.attributes, catalog)
@@ -219,14 +172,8 @@ module Puppet::ResourceApi
         # https://puppet.com/docs/puppet/6.0/custom_types.html#reference-5883
         # for details.
         send(param_or_property, name.to_sym, parent: parent) do
-          unless options[:type]
-            raise Puppet::DevError, "#{definition[:name]}.#{name} has no type"
-          end
-
           if options[:desc]
             desc "#{options[:desc]} (a #{options[:type]})"
-          else
-            warn("#{definition[:name]}.#{name} has no docs")
           end
 
           # The initialize method is called when puppet core starts building up
@@ -258,7 +205,7 @@ module Puppet::ResourceApi
         end
       end
 
-      def self.instances
+      define_singleton_method(:instances) do
         # puts 'instances'
         # force autoloading of the provider
         provider(type_definition.name)
@@ -275,16 +222,16 @@ module Puppet::ResourceApi
           result = if resource_hash.key? :title
                      new(title: resource_hash[:title])
                    else
-                     new(title: build_title(type_definition, resource_hash))
+                     new(title: resource_hash[type_definition.namevars.first])
                    end
           result.cache_current_state(resource_hash)
           result
         end
       end
 
-      def refresh_current_state
+      define_method(:refresh_current_state) do
         @rsapi_current_state = if type_definition.feature?('simple_get_filter')
-                                 my_provider.get(context, [rsapi_title]).find { |h| namevar_match?(h) }
+                                 my_provider.get(context, [title]).find { |h| namevar_match?(h) }
                                else
                                  my_provider.get(context).find { |h| namevar_match?(h) }
                                end
@@ -293,11 +240,7 @@ module Puppet::ResourceApi
           type_definition.check_schema(@rsapi_current_state)
           strict_check(@rsapi_current_state) if type_definition.feature?('canonicalize')
         else
-          @rsapi_current_state = if rsapi_title.is_a? Hash
-                                   rsapi_title.dup
-                                 else
-                                   { title: rsapi_title }
-                                 end
+          @rsapi_current_state = { title: title }
           @rsapi_current_state[:ensure] = :absent if type_definition.ensurable?
         end
       end
@@ -308,7 +251,7 @@ module Puppet::ResourceApi
         strict_check(@rsapi_current_state) if type_definition.feature?('canonicalize')
       end
 
-      def retrieve
+      define_method(:retrieve) do
         refresh_current_state unless @rsapi_current_state
 
         Puppet.debug("Current State: #{@rsapi_current_state.inspect}")
@@ -322,13 +265,13 @@ module Puppet::ResourceApi
         result
       end
 
-      def namevar_match?(item)
+      define_method(:namevar_match?) do |item|
         context.type.namevars.all? do |namevar|
           item[namevar] == @parameters[namevar].value if @parameters[namevar].respond_to? :value
         end
       end
 
-      def flush
+      define_method(:flush) do
         raise_missing_attrs
 
         # puts 'flush'
@@ -346,7 +289,7 @@ module Puppet::ResourceApi
         # enforce init_only attributes
         if Puppet.settings[:strict] != :off && @rsapi_current_state && (@rsapi_current_state[:ensure] == 'present' && target_state[:ensure] == 'present')
           target_state.each do |name, value|
-            next unless type_definition.attributes[name][:behaviour] == :init_only && value != @rsapi_current_state[name]
+            next unless definition[:attributes][name][:behaviour] == :init_only && value != @rsapi_current_state[name]
             message = "Attempting to change `#{name}` init_only attribute value from `#{@rsapi_current_state[name]}` to `#{value}`"
             case Puppet.settings[:strict]
             when :warning
@@ -358,9 +301,9 @@ module Puppet::ResourceApi
         end
 
         if type_definition.feature?('supports_noop')
-          my_provider.set(context, { rsapi_title => { is: @rsapi_current_state, should: target_state } }, noop: noop?)
+          my_provider.set(context, { title => { is: @rsapi_current_state, should: target_state } }, noop: noop?)
         else
-          my_provider.set(context, rsapi_title => { is: @rsapi_current_state, should: target_state }) unless noop?
+          my_provider.set(context, title => { is: @rsapi_current_state, should: target_state }) unless noop?
         end
         raise 'Execution encountered an error' if context.failed?
 
@@ -368,17 +311,17 @@ module Puppet::ResourceApi
         @rsapi_current_state = target_state
       end
 
-      def raise_missing_attrs
+      define_method(:raise_missing_attrs) do
         error_msg = "The following mandatory attributes were not provided:\n    *  " + @missing_attrs.join(", \n    *  ")
         raise Puppet::ResourceError, error_msg if @missing_attrs.any? && (value(:ensure) != :absent && !value(:ensure).nil?)
       end
 
-      def raise_missing_params
+      define_method(:raise_missing_params) do
         error_msg = "The following mandatory parameters were not provided:\n    *  " + @missing_params.join(", \n    *  ")
         raise Puppet::ResourceError, error_msg
       end
 
-      def strict_check(current_state)
+      define_method(:strict_check) do |current_state|
         return if Puppet.settings[:strict] == :off
 
         # if strict checking is on we must notify if the values are changed by canonicalize
@@ -392,7 +335,7 @@ module Puppet::ResourceApi
         #:nocov:
         # codecov fails to register this multiline as covered, even though simplecov does.
         message = <<MESSAGE.strip
-#{type_definition.name}[#{@title}]#get has not provided canonicalized values.
+#{definition[:name]}[#{@title}]#get has not provided canonicalized values.
 Returned values:       #{current_state.inspect}
 Canonicalized values:  #{state_clone.inspect}
 MESSAGE
@@ -405,7 +348,7 @@ MESSAGE
           raise Puppet::DevError, message
         end
 
-        nil
+        return nil
       end
 
       define_singleton_method(:context) do
@@ -416,9 +359,9 @@ MESSAGE
         self.class.context
       end
 
-      def self.title_patterns
-        @title_patterns ||= if type_definition.definition.key? :title_patterns
-                              parse_title_patterns(type_definition.definition[:title_patterns])
+      define_singleton_method(:title_patterns) do
+        @title_patterns ||= if definition.key? :title_patterns
+                              parse_title_patterns(definition[:title_patterns])
                             else
                               [[%r{(.*)}m, [[type_definition.namevars.first]]]]
                             end

data/lib/puppet/resource_api/glue.rb

@@ -41,35 +41,9 @@ module Puppet::ResourceApi
       YAML.dump('type' => { title => attributes }).split("\n").drop(2).join("\n") + "\n"
     end
 
-    def to_hash
-      values
-    end
-
-    def to_json(*)
-      attrs = filtered_keys.map { |k| [k.to_s, values[k]] unless values[k].nil? }
-      attributes = Hash[*attrs.compact.flatten]
-      resource = { title => attributes }
-      resource.to_json
-    end
-
     # attribute names that are not title or namevars
     def filtered_keys
       values.keys.reject { |k| k == :title || !attr_def[k] || (attr_def[k][:behaviour] == :namevar && @namevars.size == 1) }
     end
   end
-
-  # this hash allows key-value based ordering comparisons between instances of this and instances of this and other classes
-  # this is required for `lib/puppet/indirector/resource/ral.rb`'s `search` method which expects all titles to be comparable
-  class MonkeyHash < Hash
-    def <=>(other)
-      result = self.class.name <=> other.class.name
-      if result.zero?
-        result = keys.sort <=> other.keys.sort
-      end
-      if result.zero?
-        result = keys.sort.map { |k| self[k] } <=> other.keys.sort.map { |k| other[k] }
-      end
-      result
-    end
-  end
 end

data/lib/puppet/resource_api/simple_provider.rb

@@ -1,5 +1,4 @@
 module Puppet; end # rubocop:disable Style/Documentation
-
 module Puppet::ResourceApi
   # This class provides a default implementation for set(), when your resource does not benefit from batching.
   # Instead of processing changes yourself, the `create`, `update`, and `delete` functions, are called for you,
@@ -20,12 +19,12 @@ module Puppet::ResourceApi
 
         raise 'SimpleProvider cannot be used with a Type that is not ensurable' unless context.type.ensurable?
 
-        is = SimpleProvider.create_absent(:name, name) if is.nil?
-        should = SimpleProvider.create_absent(:name, name) if should.nil?
+        is = { name: name, ensure: 'absent' } if is.nil?
+        should = { name: name, ensure: 'absent' } if should.nil?
 
         name_hash = if context.type.namevars.length > 1
                       # pass a name_hash containing the values of all namevars
-                      name_hash = {}
+                      name_hash = { title: name }
                       context.type.namevars.each do |namevar|
                         name_hash[namevar] = change[:should][namevar]
                       end
@@ -61,16 +60,5 @@ module Puppet::ResourceApi
     def delete(_context, _name)
       raise "#{self.class} has not implemented `delete`"
     end
-
-    # @api private
-    def self.create_absent(namevar, title)
-      result = if title.is_a? Hash
-                 title.dup
-               else
-                 { namevar => title }
-               end
-      result[:ensure] = 'absent'
-      result
-    end
   end
 end

data/lib/puppet/resource_api/type_definition.rb

@@ -3,8 +3,8 @@ class Puppet::ResourceApi::TypeDefinition
   attr_reader :definition
 
   def initialize(definition)
-    raise Puppet::DevError, 'TypeDefinition requires definition to be a Hash' unless definition.is_a?(Hash)
-    @definition = definition
+    @data_type_cache = {}
+    validate_schema(definition)
   end
 
   def name
@@ -27,7 +27,60 @@ class Puppet::ResourceApi::TypeDefinition
 
   # rubocop complains when this is named has_feature?
   def feature?(feature)
-    (definition[:features] && definition[:features].include?(feature))
+    supported = (definition[:features] && definition[:features].include?(feature))
+    if supported
+      Puppet.debug("#{definition[:name]} supports `#{feature}`")
+    else
+      Puppet.debug("#{definition[:name]} does not support `#{feature}`")
+    end
+    supported
+  end
+
+  def validate_schema(definition)
+    raise Puppet::DevError, 'Type definition must be a Hash, not `%{other_type}`' % { other_type: definition.class } unless definition.is_a?(Hash)
+    raise Puppet::DevError, 'Type definition must have a name' unless definition.key? :name
+    raise Puppet::DevError, 'Type definition must have `:attributes`' unless definition.key? :attributes
+    unless definition[:attributes].is_a?(Hash)
+      raise Puppet::DevError, '`%{name}.attributes` must be a hash, not `%{other_type}`' % {
+        name: definition[:name], other_type: definition[:attributes].class
+      }
+    end
+    [:title, :provider, :alias, :audit, :before, :consume, :export, :loglevel, :noop, :notify, :require, :schedule, :stage, :subscribe, :tag].each do |name|
+      raise Puppet::DevError, 'must not define an attribute called `%{name}`' % { name: name.inspect } if definition[:attributes].key? name
+    end
+    if definition.key?(:title_patterns) && !definition[:title_patterns].is_a?(Array)
+      raise Puppet::DevError, '`:title_patterns` must be an array, not `%{other_type}`' % { other_type: definition[:title_patterns].class }
+    end
+
+    Puppet::ResourceApi::DataTypeHandling.validate_ensure(definition)
+
+    definition[:features] ||= []
+    supported_features = %w[supports_noop canonicalize remote_resource simple_get_filter].freeze
+    unknown_features = definition[:features] - supported_features
+    Puppet.warning("Unknown feature detected: #{unknown_features.inspect}") unless unknown_features.empty?
+
+    definition[:attributes].each do |key, attr|
+      raise Puppet::DevError, "`#{definition[:name]}.#{key}` must be a Hash, not a #{attr.class}" unless attr.is_a? Hash
+      raise Puppet::DevError, "`#{definition[:name]}.#{key}` has no type" unless attr.key? :type
+      Puppet.warning("`#{definition[:name]}.#{key}` has no docs") unless attr.key? :desc
+
+      # validate the type by attempting to parse into a puppet type
+      @data_type_cache[definition[:attributes][key][:type]] ||=
+        Puppet::ResourceApi::DataTypeHandling.parse_puppet_type(
+          key,
+          definition[:attributes][key][:type],
+        )
+
+      # fixup any weird behavior  ;-)
+      next unless attr[:behavior]
+      if attr[:behaviour]
+        raise Puppet::DevError, "the '#{key}' attribute has both a `behavior` and a `behaviour`, only use one"
+      end
+      attr[:behaviour] = attr[:behavior]
+      attr.delete(:behavior)
+    end
+    # store the validated definition
+    @definition = definition
   end
 
   # validates a resource hash against its type schema
@@ -78,10 +131,7 @@ class Puppet::ResourceApi::TypeDefinition
     bad_vals = {}
     resource.each do |key, value|
       next unless attributes[key]
-      type = Puppet::ResourceApi::DataTypeHandling.parse_puppet_type(
-        key,
-        attributes[key][:type],
-      )
+      type = @data_type_cache[attributes[key][:type]]
       error_message = Puppet::ResourceApi::DataTypeHandling.try_validate(
         type,
         value,

data/lib/puppet/resource_api/version.rb

@@ -1,5 +1,5 @@
 module Puppet
   module ResourceApi
-    VERSION = '1.6.5'.freeze
+    VERSION = '1.7.0'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puppet-resource_api
 version: !ruby/object:Gem::Version
-  version: 1.6.5
+  version: 1.7.0
 platform: ruby
 authors:
 - David Schmitt
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-07-24 00:00:00.000000000 Z
+date: 2019-04-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hocon