puppet-resource_api 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 48ed58d882063171b3d9cd9b0711403cf6d8bc0c213aa98d0583d2b0bf8746a7
-  data.tar.gz: c6acb1edb2ee5b1cefe1cb0449090ee3072e380632952d82948b6eb2455a49b4
+  metadata.gz: e87d10235bb663c8a935d0ff8e1c50dc468e953255d96dd075df6c47e169a171
+  data.tar.gz: 91560d8c900e70924b4f9ca4c527a8100d3ad5604a0403227440a4e82f1eb00a
 SHA512:
-  metadata.gz: 4fc8c73ce49206569836f00aa1c52380b1571055ccc3f6842577a6c890c657b19280ad9b6c09e376db8acc3b63daa700cebe6d64c47571d464df797ba1b0e482
-  data.tar.gz: 9e64c5cc2d4474014ed8f45d66b44ad0416874f29b6b2f6c5b0a0da01e93179525d3eee33029f3e28eaa29acb5f5ea2d537935265f608d23610e63d51e5b3ec3
+  metadata.gz: ef62b7f3ac5119b64136f54200818d5753bf4612636560135724e2621d200c4067e07e700507613d54461a2c5eaf13be02aa0892fc8b2ed230fa66f163566ad2
+  data.tar.gz: fd919bff975e27af3807cd0c1818ee50c4166e26ba55b136bb5a432b11ee4a1228478525ade80aa954579389d59ef2114eb247abdb16b062509d800e149a82b9

data/.rspec

@@ -1,2 +1,3 @@
 --format documentation
 --color
+--order rand:123

data/.rubocop.yml

@@ -154,3 +154,7 @@ Naming/UncommunicativeMethodParamName:
   - id
   - is
   ForbiddenNames: []
+
+# This cop breaks syntax highlighting in VSCode
+Layout/ClosingHeredocIndentation:
+  Enabled: false

data/.travis.yml

@@ -6,7 +6,7 @@ script:
   - cat Gemfile.lock
   - bundle list
   - echo travis_fold:end:DEBUG
-  - COVERAGE=yes bundle exec rake $CHECK
+  - bundle exec rake $CHECK
 cache: bundler
 branches:
   except:
@@ -14,13 +14,14 @@ branches:
 matrix:
   include:
     - rvm: 2.4.3
-      env: PUPPET_GEM_VERSION='~> 5' # 5.5
-    - env: RVM="jruby-1.7.26" PUPPET_GEM_VERSION='~> 5' JRUBY_OPTS="--debug"
+      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
+    # 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
       cache:
@@ -44,7 +45,7 @@ matrix:
     - rvm: 2.4.1
       env: PUPPET_GEM_VERSION='~> 5.0.0'
     - rvm: 2.1.9
-      env: PUPPET_GEM_VERSION='~> 4' # 4.10
+      env: PUPPET_GEM_VERSION='~> 4' COVERAGE=yes # 4.10
     - rvm: 2.1.9
       env: PUPPET_GEM_VERSION='~> 4.9.0'
     - rvm: 2.1.9

data/CHANGELOG.md

@@ -3,6 +3,33 @@
 All significant changes to this repo will be summarized in this file.
 
 
+## [v1.4.0](https://github.com/puppetlabs/puppet-resource_api/tree/v1.4.0) (2018-06-19)
+[Full Changelog](https://github.com/puppetlabs/puppet-resource_api/compare/v1.3.0...v1.4.0)
+
+**Implemented enhancements:**
+
+- Allow `SimpleDevice` to be initialized with a config hash [\#96](https://github.com/puppetlabs/puppet-resource_api/pull/96) ([DavidS](https://github.com/DavidS))
+- \(PDK-1007\) implement enough to support purge=\>true  [\#95](https://github.com/puppetlabs/puppet-resource_api/pull/95) ([DavidS](https://github.com/DavidS))
+- \(PDK-917\) Validates provider.get values against Type schema [\#88](https://github.com/puppetlabs/puppet-resource_api/pull/88) ([da-ar](https://github.com/da-ar))
+
+**Fixed bugs:**
+
+- \(PDK-1004\) log exceptions as they are processed [\#101](https://github.com/puppetlabs/puppet-resource_api/pull/101) ([DavidS](https://github.com/DavidS))
+- \(PDK-1000\) do not print nil valued attributes [\#100](https://github.com/puppetlabs/puppet-resource_api/pull/100) ([DavidS](https://github.com/DavidS))
+- \(PDK-1007\) Handle setting `ensure` to a Symbol through code [\#94](https://github.com/puppetlabs/puppet-resource_api/pull/94) ([DavidS](https://github.com/DavidS))
+- \(PDK-1007\) the namevar is a param [\#91](https://github.com/puppetlabs/puppet-resource_api/pull/91) ([DavidS](https://github.com/DavidS))
+- \(PDK-996\) Provide better messaging when type cannot be resolved [\#87](https://github.com/puppetlabs/puppet-resource_api/pull/87) ([da-ar](https://github.com/da-ar))
+
+**Merged pull requests:**
+
+- Whitespace cleanup with new rubocop version [\#98](https://github.com/puppetlabs/puppet-resource_api/pull/98) ([DavidS](https://github.com/DavidS))
+- \(PDK-1007\) add tests for `to\_resource` [\#93](https://github.com/puppetlabs/puppet-resource_api/pull/93) ([DavidS](https://github.com/DavidS))
+- Enable randomised rspec testing [\#92](https://github.com/puppetlabs/puppet-resource_api/pull/92) ([da-ar](https://github.com/da-ar))
+- appease rubocop 0.57.0 [\#90](https://github.com/puppetlabs/puppet-resource_api/pull/90) ([da-ar](https://github.com/da-ar))
+- Improve unit tests of parameter and property results after register\_type [\#89](https://github.com/puppetlabs/puppet-resource_api/pull/89) ([DavidS](https://github.com/DavidS))
+- Update release docs and announcement template [\#86](https://github.com/puppetlabs/puppet-resource_api/pull/86) ([DavidS](https://github.com/DavidS))
+- Release prep for v1.3.0 [\#85](https://github.com/puppetlabs/puppet-resource_api/pull/85) ([da-ar](https://github.com/da-ar))
+
 ## [v1.3.0](https://github.com/puppetlabs/puppet-resource_api/tree/v1.3.0) (2018-05-24)
 [Full Changelog](https://github.com/puppetlabs/puppet-resource_api/compare/v1.2.0...v1.3.0)
 

data/CONTRIBUTING.md

@@ -1,11 +1 @@
-# Contributing
-
-We welcome error reports and patches to the puppet-resource\_api repository. Post questions to [puppet-users@groups.google.com](https://groups.google.com/forum/#!forum/puppet-users). Post bug reports and pull requests on GitHub at https://github.com/puppetlabs/puppet-resource_api/issues.
-
-# Running tests
-
-puppet-resource\_api has the following testing Rake tasks.
-
-## spec
-
-Runs unit tests.
+Please see [the Contributing section in the README](https://github.com/puppetlabs/puppet-resource_api#contributing) for contributing guidelines.

data/README.md

@@ -1,7 +1,7 @@
 # Puppet::ResourceApi [![TravisCI Build Status](https://travis-ci.org/puppetlabs/puppet-resource_api.svg?branch=master)](https://travis-ci.org/puppetlabs/puppet-resource_api) [![Appveyor Build status](https://ci.appveyor.com/api/projects/status/8o9s1ax0hs8lm5fd/branch/master?svg=true)](https://ci.appveyor.com/project/puppetlabs/puppet-resource-api/branch/master)
  [![codecov](https://codecov.io/gh/puppetlabs/puppet-resource_api/branch/master/graph/badge.svg)](https://codecov.io/gh/puppetlabs/puppet-resource_api)
 
-This is an implementation of the [Resource API](https://github.com/DavidS/puppet-specifications/blob/resourceapi/language/resource-api/README.md) proposal. Find a working example of a new-style provider in the [experimental puppetlabs-apt branch](https://github.com/DavidS/puppetlabs-apt/blob/resource-api-experiments/lib/puppet/provider/apt_key2/apt_key2.rb). There is also the corresponding [type](https://github.com/DavidS/puppetlabs-apt/blob/resource-api-experiments/lib/puppet/type/apt_key2.rb), [provider](https://github.com/DavidS/puppetlabs-apt/blob/resource-api-experiments/lib/puppet/provider/apt_key2/apt_key2.rb), and [new unit tests](https://github.com/DavidS/puppetlabs-apt/blob/resource-api-experiments/spec/unit/puppet/provider/apt_key2/apt_key2_spec.rb) for 100% coverage.
+This is an implementation of the [Resource API](https://github.com/puppetlabs/puppet-specifications/blob/master/language/resource-api/README.md) proposal. Find a working example of a new-style provider in the [experimental puppetlabs-apt branch](https://github.com/DavidS/puppetlabs-apt/blob/resource-api-experiments/lib/puppet/provider/apt_key2/apt_key2.rb). There is also the corresponding [type](https://github.com/DavidS/puppetlabs-apt/blob/resource-api-experiments/lib/puppet/type/apt_key2.rb), [provider](https://github.com/DavidS/puppetlabs-apt/blob/resource-api-experiments/lib/puppet/provider/apt_key2/apt_key2.rb), and [new unit tests](https://github.com/DavidS/puppetlabs-apt/blob/resource-api-experiments/spec/unit/puppet/provider/apt_key2/apt_key2_spec.rb) for 100% coverage.
 
 ## Getting started
 
@@ -176,7 +176,7 @@ After this, `puppet device` will be able to use the new provider, and supply it
 
 ### Further Reading
 
-The [Resource API](https://github.com/DavidS/puppet-specifications/blob/resourceapi/language/resource-api/README.md) describes details of all the capabilities of this gem.
+The [Resource API](https://github.com/puppetlabs/puppet-specifications/blob/master/language/resource-api/README.md) describes details of all the capabilities of this gem.
 
 This [Introduction to Testing Puppet Modules](https://www.netways.de/index.php?id=3445#c44135) talk describes rspec usage in more detail.
 
@@ -239,9 +239,10 @@ To cut a new release, from a current `master` checkout:
   * run `rake changelog`
   * 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>"
+* Commit changes with title "Release prep for v\<VERSION>"
 * Upload and PR the release-prep branch to the puppetlabs GitHub repo
 * 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 the puppetlabs GitHub repo
 * Remove the release-prep branch
+* Send the release announcements using the template in [misc/ANNOUNCEMENT_TEMPLATE.md](misc/ANNOUNCEMENT_TEMPLATE.md)

data/contrib/pre-commit

@@ -2,15 +2,7 @@
 # Code modified from: https://gist.github.com/hanloong/9849098
 require 'English'
 
-ADDED = %r{A|AM}
-
-changed_files = `git status --porcelain`.split(%r{\n})
-changed_files = changed_files.select do |file_name_with_status|
-  file_name_with_status =~ ADDED
-end
-changed_files = changed_files.map do |file_name_with_status|
-  file_name_with_status.split(' ')[1]
-end
+changed_files = `git diff --name-only --cached --diff-filter=ACM`.split(%r{\n})
 changed_files = changed_files.select { |file_name|
   File.extname(file_name) == '.rb'
 }.join(' ')
@@ -20,4 +12,5 @@ system("bundle exec rubocop -a #{changed_files}") unless changed_files.empty?
 if $CHILD_STATUS.to_s[-1].to_i.zero? && !changed_files.empty?
   system("git add #{changed_files}")
 end
+
 exit $CHILD_STATUS.to_s[-1].to_i

data/lib/puppet/resource_api/base_context.rb

@@ -51,7 +51,7 @@ class Puppet::ResourceApi::BaseContext
         block.call
         notice("Finished in #{format_seconds(Time.now - start_time)} seconds")
       rescue StandardError => e
-        err("Failed after #{format_seconds(Time.now - start_time)} seconds: #{e}")
+        log_exception(e, message: "Failed after #{format_seconds(Time.now - start_time)} seconds")
         @failed = true
       ensure
         @context = nil
@@ -67,7 +67,7 @@ class Puppet::ResourceApi::BaseContext
       yield
       warning("Finished failing in #{format_seconds(Time.now - start_time)} seconds")
     rescue StandardError => e
-      err("Failed after #{format_seconds(Time.now - start_time)} seconds: #{e}")
+      log_exception(e, message: "Failed after #{format_seconds(Time.now - start_time)} seconds")
       @failed = true
     ensure
       @context = nil
@@ -83,7 +83,7 @@ class Puppet::ResourceApi::BaseContext
       yield
       notice("Finished processing #{title} in #{format_seconds(Time.now - start_time)} seconds: #{should}")
     rescue StandardError => e
-      err("Failed processing #{title} after #{format_seconds(Time.now - start_time)} seconds: #{e}")
+      log_exception(e, message: "Failed processing #{title} after #{format_seconds(Time.now - start_time)} seconds")
       @failed = true
     ensure
       @context = nil
@@ -124,6 +124,15 @@ class Puppet::ResourceApi::BaseContext
     end
   end
 
+  def log_exception(exception, message: 'Error encountered', trace: false)
+    message = "#{message}: #{exception}"
+    if trace
+      message += "\n"
+      message += exception.backtrace.join("\n")
+    end
+    err(message)
+  end
+
   def send_log(_level, _message)
     raise 'Received send_log() on an unprepared BaseContext. Use IOContext, or PuppetContext instead.'
   end

data/lib/puppet/resource_api/glue.rb

@@ -2,29 +2,6 @@ require 'yaml'
 
 module Puppet; end # rubocop:disable Style/Documentation
 module Puppet::ResourceApi
-  # A trivial class to provide the functionality required to push data through the existing type/provider parts of puppet
-  class TypeShim
-    attr_reader :values, :typename, :namevars, :attr_def
-
-    def initialize(resource_hash, typename, namevars, attr_def)
-      # internalize and protect - needs to go deeper
-      @values = resource_hash.dup.freeze
-
-      @typename = typename
-      @namevars = namevars
-      @attr_def = attr_def
-      @resource = ResourceShim.new(@values, @typename, @namevars, @attr_def)
-    end
-
-    def to_resource
-      @resource
-    end
-
-    def name
-      @resource.title
-    end
-  end
-
   # A trivial class to provide the functionality required to push data through the existing type/provider parts of puppet
   class ResourceShim
     attr_reader :values, :typename, :namevars, :attr_def
@@ -37,7 +14,7 @@ module Puppet::ResourceApi
     end
 
     def title
-      values[@namevars.first]
+      values[:title] || values[@namevars.first]
     end
 
     def prune_parameters(*_args)
@@ -49,12 +26,12 @@ module Puppet::ResourceApi
       (["#{@typename} { #{Puppet::Parameter.format_value_for_display(title)}: "] + filtered_keys.map do |k|
         cs = ' '
         ce = ''
-        if attr_def[k][:behaviour] && attr_def[k][:behaviour] == :read_only
+        if attr_def[k] && attr_def[k][:behaviour] && attr_def[k][:behaviour] == :read_only
           cs = '#'
           ce = ' # Read Only'
         end
-        "#{cs} #{k} => #{Puppet::Parameter.format_value_for_display(values[k])},#{ce}"
-      end + ['}']).join("\n")
+        "#{cs} #{k} => #{Puppet::Parameter.format_value_for_display(values[k])},#{ce}" unless values[k].nil?
+      end + ['}']).compact.join("\n")
     end
 
     # Convert our resource to yaml for Hiera purposes.
@@ -65,7 +42,7 @@ module Puppet::ResourceApi
 
     # attribute names that are not title or namevars
     def filtered_keys
-      values.keys.reject { |k| k == :title || attr_def[k][:behaviour] == :namevar && @namevars.size == 1 }
+      values.keys.reject { |k| k == :title || !attr_def[k] || (attr_def[k][:behaviour] == :namevar && @namevars.size == 1) }
     end
   end
 end

data/lib/puppet/resource_api/puppet_context.rb

@@ -2,9 +2,24 @@ require 'puppet/resource_api/base_context'
 require 'puppet/util/logging'
 
 class Puppet::ResourceApi::PuppetContext < Puppet::ResourceApi::BaseContext
+  def log_exception(exception, message: 'Error encountered', trace: false)
+    self.class.logging_proxy.log_exception(exception, message, trace: trace)
+  end
+
   protected
 
   def send_log(level, message)
     Puppet::Util::Log.create(level: level, message: message)
   end
+
+  # Avoid including Puppet::Util::Logging into the main class to avoid the namespace clashes
+  class LoggingProxy
+    include Puppet::Util::Logging
+  end
+
+  class << self
+    def logging_proxy
+      @logging_proxy ||= LoggingProxy.new
+    end
+  end
 end

data/lib/puppet/resource_api/simple_provider.rb

@@ -13,6 +13,7 @@ module Puppet::ResourceApi
              else
                change.key?(:is) ? change[:is] : (get(context) || []).find { |r| r[:name] == name }
              end
+        context.type.check_schema(is) unless change.key?(:is)
 
         should = change[:should]
 

data/lib/puppet/resource_api/type_definition.rb

@@ -7,6 +7,10 @@ class Puppet::ResourceApi::TypeDefinition
     @definition = definition
   end
 
+  def name
+    @definition[:name]
+  end
+
   def attributes
     @definition[:attributes]
   end
@@ -31,4 +35,59 @@ class Puppet::ResourceApi::TypeDefinition
     end
     supported
   end
+
+  # validates a resource hash against its type schema
+  def check_schema(resource)
+    namevars.each do |namevar|
+      if resource[namevar].nil?
+        raise Puppet::ResourceError, "`#{name}.get` did not return a value for the `#{namevar}` namevar attribute"
+      end
+    end
+
+    message = "Provider returned data that does not match the Type Schema for `#{name}[#{resource[namevars.first]}]`"
+
+    rejected_keys = check_schema_keys(resource) # removes bad keys
+    bad_values = check_schema_values(resource)
+
+    unless rejected_keys.empty?
+      message += "\n Unknown attribute:\n"
+      rejected_keys.each { |key, _value| message += "    * #{key}\n" }
+    end
+    unless bad_values.empty?
+      message += "\n Value type mismatch:\n"
+      bad_values.each { |key, value| message += "    * #{key}: #{value}\n" }
+    end
+
+    return if rejected_keys.empty? && bad_values.empty?
+
+    if Puppet.settings[:strict] == :off
+      Puppet.debug(message)
+    elsif Puppet.settings[:strict] == :warning
+      Puppet::ResourceApi.warning_count += 1
+      Puppet.warning(message) if Puppet::ResourceApi.warning_count <= 100 # maximum number of schema warnings to display in a run
+    elsif Puppet.settings[:strict] == :error
+      raise Puppet::DevError, message
+    end
+  end
+
+  # Returns an array of keys that where not found in the type schema
+  # Modifies the resource passed in, leaving only valid attributes
+  def check_schema_keys(resource)
+    rejected = []
+    resource.reject! { |key| rejected << key unless attributes.key? key }
+    rejected
+  end
+
+  # Returns a hash of keys and values that are not valid
+  # does not modify the resource passed in
+  def check_schema_values(resource)
+    bad_vals = {}
+    resource.each do |key, value|
+      next unless attributes[key]
+      type = Puppet::ResourceApi.parse_puppet_type(key, attributes[key][:type])
+      error_message = Puppet::ResourceApi.try_validate(type, value, '')
+      bad_vals[key] = value unless error_message.nil?
+    end
+    bad_vals
+  end
 end

data/lib/puppet/resource_api/version.rb

@@ -1,5 +1,5 @@
 module Puppet
   module ResourceApi
-    VERSION = '1.3.0'.freeze
+    VERSION = '1.4.0'.freeze
   end
 end

data/lib/puppet/resource_api.rb

@@ -6,6 +6,12 @@ require 'puppet/resource_api/version'
 require 'puppet/type'
 
 module Puppet::ResourceApi
+  @warning_count = 0
+
+  class << self
+    attr_accessor :warning_count
+  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
@@ -94,6 +100,20 @@ module Puppet::ResourceApi
         super(attributes)
       end
 
+      def name
+        title
+      end
+
+      def to_resource
+        to_resource_shim(super)
+      end
+
+      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)
+      end
+
       validate do
         # enforce mandatory attributes
         @missing_attrs = []
@@ -103,7 +123,7 @@ module Puppet::ResourceApi
         return if @ral_find_absent
 
         definition[:attributes].each do |name, options|
-          type = Puppet::Pops::Types::TypeParser.singleton.parse(options[:type])
+          type = Puppet::ResourceApi.parse_puppet_type(:name, options[:type])
 
           # skip read only vars and the namevar
           next if [:read_only, :namevar].include? options[:behaviour]
@@ -136,7 +156,7 @@ module Puppet::ResourceApi
         # TODO: using newparam everywhere would suppress change reporting
         #       that would allow more fine-grained reporting through context,
         #       but require more invest in hooking up the infrastructure to emulate existing data
-        param_or_property = if [:read_only, :parameter].include? options[:behaviour]
+        param_or_property = if [:read_only, :parameter, :namevar].include? options[:behaviour]
                               :newparam
                             else
                               :newproperty
@@ -170,7 +190,8 @@ module Puppet::ResourceApi
             end
           end
 
-          type = Puppet::Pops::Types::TypeParser.singleton.parse(options[:type])
+          type = Puppet::ResourceApi.parse_puppet_type(name, options[:type])
+
           if param_or_property == :newproperty
             define_method(:should) do
               if type.is_a? Puppet::Pops::Types::PBooleanType
@@ -185,6 +206,11 @@ module Puppet::ResourceApi
 
             define_method(:should=) do |value|
               @shouldorig = value
+
+              if name == :ensure
+                value = value.to_s
+              end
+
               # Puppet requires the @should value to always be stored as an array. We do not use this
               # for anything else
               # @see Puppet::Property.should=(value)
@@ -260,50 +286,49 @@ module Puppet::ResourceApi
       define_singleton_method(:instances) do
         # puts 'instances'
         # force autoloading of the provider
-        provider(name)
-        attr_def = {}
+        provider(type_definition.name)
+
         my_provider.get(context).map do |resource_hash|
-          resource_hash.each do |key|
-            property = definition[:attributes][key.first]
-            attr_def[key.first] = property
-          end
-          context.type.namevars.each do |namevar|
-            if resource_hash[namevar].nil?
-              raise Puppet::ResourceError, "`#{name}.get` did not return a value for the `#{namevar}` namevar attribute"
-            end
-          end
-          Puppet::ResourceApi::TypeShim.new(resource_hash, name, context.type.namevars, attr_def)
+          type_definition.check_schema(resource_hash)
+          result = new(title: resource_hash[type_definition.namevars.first])
+          result.cache_current_state(resource_hash)
+          result
         end
       end
 
-      define_method(:retrieve) do
-        # puts "retrieve(#{title.inspect})"
-        result = Puppet::Resource.new(self.class, title)
-
-        current_state = if type_definition.feature?('simple_get_filter')
-                          my_provider.get(context, [title]).first
-                        else
-                          my_provider.get(context).find { |h| namevar_match?(h) }
-                        end
-
-        strict_check(current_state) if current_state && type_definition.feature?('canonicalize')
+      define_method(:refresh_current_state) do
+        @rapi_current_state = if type_definition.feature?('simple_get_filter')
+                                my_provider.get(context, [title]).first
+                              else
+                                my_provider.get(context).find { |h| namevar_match?(h) }
+                              end
 
-        if current_state
-          current_state.each do |k, v|
-            result[k] = v
-          end
+        if @rapi_current_state
+          type_definition.check_schema(@rapi_current_state)
+          strict_check(@rapi_current_state) if type_definition.feature?('canonicalize')
         else
-          result[:title] = title
-          result[:ensure] = :absent if type_definition.ensurable?
+          @rapi_current_state = { title: title }
+          @rapi_current_state[:ensure] = :absent if type_definition.ensurable?
         end
+      end
+
+      # Use this to set the current state from the `instances` method
+      def cache_current_state(resource_hash)
+        @rapi_current_state = resource_hash
+        strict_check(@rapi_current_state) if type_definition.feature?('canonicalize')
+      end
 
+      define_method(:retrieve) do
+        refresh_current_state unless @rapi_current_state
+
+        Puppet.debug("Current State: #{@rapi_current_state.inspect}")
+
+        result = Puppet::Resource.new(self.class, title, parameters: @rapi_current_state)
         # puppet needs ensure to be a symbol
         result[:ensure] = result[:ensure].to_sym if type_definition.ensurable? && result[:ensure].is_a?(String)
 
         raise_missing_attrs
 
-        @rapi_current_state = current_state
-        Puppet.debug("Current State: #{@rapi_current_state.inspect}")
         result
       end
 
@@ -347,6 +372,9 @@ module Puppet::ResourceApi
           my_provider.set(context, title => { is: @rapi_current_state, should: target_state }) unless noop?
         end
         raise 'Execution encountered an error' if context.failed?
+
+        # remember that we have successfully reached our desired state
+        @rapi_current_state = target_state
       end
 
       define_method(:raise_missing_attrs) do
@@ -441,7 +469,7 @@ MESSAGE
       end
     end
   end
-  module_function :register_type
+  module_function :register_type # rubocop:disable Style/AccessModifierDeclarations
 
   def load_provider(type_name)
     class_name = class_name_from_type_name(type_name)
@@ -453,7 +481,7 @@ MESSAGE
   rescue NameError
     raise Puppet::DevError, "class #{class_name} not found in puppet/provider/#{type_name}/#{type_name}"
   end
-  module_function :load_provider
+  module_function :load_provider # rubocop:disable Style/AccessModifierDeclarations
 
   def self.class_name_from_type_name(type_name)
     type_name.to_s.split('_').map(&:capitalize).join
@@ -598,9 +626,17 @@ MESSAGE
   def self.validate_ensure(definition)
     return unless definition[:attributes].key? :ensure
     options = definition[:attributes][:ensure]
-    type = Puppet::Pops::Types::TypeParser.singleton.parse(options[:type])
+    type = Puppet::ResourceApi.parse_puppet_type(:ensure, options[:type])
 
     return if type.is_a?(Puppet::Pops::Types::PEnumType) && type.values.sort == %w[absent present].sort
     raise Puppet::DevError, '`:ensure` attribute must have a type of: `Enum[present, absent]`'
   end
+
+  def self.parse_puppet_type(attr_name, type)
+    Puppet::Pops::Types::TypeParser.singleton.parse(type)
+  rescue Puppet::ParseErrorWithIssue => e
+    raise Puppet::DevError, "The type of the `#{attr_name}` attribute `#{type}` could not be parsed: #{e.message}"
+  rescue Puppet::ParseError => e
+    raise Puppet::DevError, "The type of the `#{attr_name}` attribute `#{type}` is not recognised: #{e.message}"
+  end
 end

data/lib/puppet/util/network_device/simple/device.rb

@@ -6,9 +6,13 @@ module Puppet::Util::NetworkDevice::Simple
   # A basic device class, that reads its configuration from the provided URL.
   # The URL has to be a local file URL.
   class Device
-    def initialize(url, _options = {})
-      @url = URI.parse(url)
-      raise "Unexpected url '#{url}' found. Only file:/// URLs for configuration supported at the moment." unless @url.scheme == 'file'
+    def initialize(url_or_config, _options = {})
+      if url_or_config.is_a? String
+        @url = URI.parse(url_or_config)
+        raise "Unexpected url '#{url_or_config}' found. Only file:/// URLs for configuration supported at the moment." unless @url.scheme == 'file'
+      else
+        @config = url_or_config
+      end
     end
 
     def facts
@@ -16,7 +20,7 @@ module Puppet::Util::NetworkDevice::Simple
     end
 
     def config
-      raise "Trying to load config from '#{@url.path}, but file does not exist." unless File.exist? @url.path
+      raise "Trying to load config from '#{@url.path}, but file does not exist." if @url && !File.exist?(@url.path)
       @config ||= Hocon.load(@url.path, syntax: Hocon::ConfigSyntax::HOCON)
     end
   end

data/misc/ANNOUNCEMENT_TEMPLATE.md

@@ -1,4 +1,4 @@
-Send out announcements for major new feature releases, and high-impact bugfixes to puppet-dev@googlegroups.com, puppet-users@googlegroups.com, voxpupuli@groups.io, and the puppet internal mailing lists.
+Send out announcements for major new feature releases, and high-impact bugfixes to <puppet-announce@googlegroups.com>, <puppet-dev@googlegroups.com>, <puppet-users@googlegroups.com>, <voxpupuli@groups.io>, and the puppet internal mailing lists <dev@puppet.com> and <tech-discuss@puppet.com>.
 
 Before sending, do check that all links are still valid. Feel free to adjust the text to match better with the circumstances of the release, or add other news that are relevant at the time. If you make changes, consider committing them here, for the benefit of future-you.
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puppet-resource_api
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - David Schmitt
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-05-24 00:00:00.000000000 Z
+date: 2018-06-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hocon
@@ -81,7 +81,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.3
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: This library provides a simple way to write new native resources for puppet.