puppet-resource_api 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1470bc0d22d986fc0eccd0580a072ea54f6482b3c830f994b2d83f230ba95b22
-  data.tar.gz: 1346ed773c82d9478dbbcd243f5fe4b1260c487b7b17f971268801bd772c7f83
+  metadata.gz: fd035e8b155f1bf4307be10cd13021a16f91aae8d8ef3bfd652f5a77a67a3556
+  data.tar.gz: 43d002ab24ab5e320357684b297c8e01f6f79f661f7ed062410619ed37146a94
 SHA512:
-  metadata.gz: 1f521be6aa211b933e12f712be3af9226af5d5d9df4a8bec2ca075e0faedd5898c7a9d1150024784c8e71c27bcbd996c34b010ecd656e15cf314e40014bb86ed
-  data.tar.gz: 6a473b6d9eb96158008dfc4622da547026f01c3fbe492689fb9478179f645338b8b264b693fdfd6451491fd432d025b05026a5c245db374078222e668241f0cc
+  metadata.gz: c316e50d658c0c65501defdf61392f7d2ee586e0ebf4b1b78f9a1da98b3a289d65b6265f2ba68a8fdf3d23f2ab612591c280a7ca25846d1db66d6e530228ab9f
+  data.tar.gz: e4f60efe74b30a0770e07acb9e98024f0bcbaf6ea3d5bc5214b59835510c8c0edd757c3da50e88ab7bf65947c63a9fb9f0ea97315ae3051fb063af6ecf18f44f

data/.travis.yml

@@ -12,10 +12,18 @@ matrix:
   include:
     - rvm: 2.4.3
       env: PUPPET_GEM_VERSION='~> 5' # 5.5
-    - rvm: jruby-1.7.26
-      env: PUPPET_GEM_VERSION='~> 5' JRUBY_OPTS="--debug"
-    - rvm: jruby-9.1.9.0
-      env: PUPPET_GEM_VERSION='~> 5' JRUBY_OPTS="--debug"
+    - env: RVM="jruby-1.7.26" 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:
+        bundler: true
+        directories: ~/.rvm
+      before_install: rvm use jruby-1.7.26 --install --binary --fuzzy
+    - 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:
+        bundler: true
+        directories: ~/.rvm
+      before_install: rvm use jruby-9.1.9.0 --install --binary --fuzzy
     - rvm: 2.4.3
       env: CHECK=rubocop
     - rvm: 2.4.3

data/CHANGELOG.md

@@ -3,6 +3,28 @@
 All significant changes to this repo will be summarized in this file.
 
 
+## [v1.2.0](https://github.com/puppetlabs/puppet-resource_api/tree/v1.2.0) (2018-05-08)
+[Full Changelog](https://github.com/puppetlabs/puppet-resource_api/compare/v1.1.0...v1.2.0)
+
+**Implemented enhancements:**
+
+- \(PDK-924\) Throw when SimpleProvider is used with unensurable type [\#73](https://github.com/puppetlabs/puppet-resource_api/pull/73) ([da-ar](https://github.com/da-ar))
+- \(PDK-955\) Provide access to the type definition from the provider [\#72](https://github.com/puppetlabs/puppet-resource_api/pull/72) ([da-ar](https://github.com/da-ar))
+
+**Fixed bugs:**
+
+- \(PDK-946\) Passes ensure values to puppet as symbols. [\#74](https://github.com/puppetlabs/puppet-resource_api/pull/74) ([da-ar](https://github.com/da-ar))
+- \(PDK-929\) Ignore validation for absent resources [\#69](https://github.com/puppetlabs/puppet-resource_api/pull/69) ([da-ar](https://github.com/da-ar))
+- Make ruby files individually loadable without puppet [\#65](https://github.com/puppetlabs/puppet-resource_api/pull/65) ([DavidS](https://github.com/DavidS))
+- \(PDK-526\) fix test for git [\#63](https://github.com/puppetlabs/puppet-resource_api/pull/63) ([DavidS](https://github.com/DavidS))
+
+**Merged pull requests:**
+
+- Add pre-commit hook for rubocop [\#70](https://github.com/puppetlabs/puppet-resource_api/pull/70) ([da-ar](https://github.com/da-ar))
+- Add a template for release announcements [\#67](https://github.com/puppetlabs/puppet-resource_api/pull/67) ([DavidS](https://github.com/DavidS))
+- Cache ~/.rvm for jruby jobs [\#66](https://github.com/puppetlabs/puppet-resource_api/pull/66) ([cotsog](https://github.com/cotsog))
+- Release prep for v1.1.0 [\#64](https://github.com/puppetlabs/puppet-resource_api/pull/64) ([DavidS](https://github.com/DavidS))
+
 ## [v1.1.0](https://github.com/puppetlabs/puppet-resource_api/tree/v1.1.0) (2018-04-12)
 [Full Changelog](https://github.com/puppetlabs/puppet-resource_api/compare/v1.0.3...v1.1.0)
 

data/contrib/README.md

@@ -0,0 +1,7 @@
+# Git pre-commit hook
+This directory contains the file `pre-commit`. When enabled the hook is called when you attempt to commit changes locally. The hook will run the bundled `rubocop` with auto correct function on files that you have changed.
+
+* If rubocop is successful in correcting errors detected in the changed files it will stage the changes and proceed with the commit.
+* If rubocop is unsuccessful in correcting errors detected in the changed files the commit will fail and the rubocop output will be displayed. Manual changes will need to be made before proceeding.
+
+To enable the pre-commit hook, either create a symlink to this file or copy the file to `.git/hooks`

data/contrib/pre-commit

@@ -0,0 +1,23 @@
+#!/usr/bin/env ruby
+# 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 = changed_files.select { |file_name|
+  File.extname(file_name) == '.rb'
+}.join(' ')
+
+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.rb

@@ -1,6 +1,7 @@
 require 'pathname'
 require 'puppet/resource_api/glue'
 require 'puppet/resource_api/puppet_context' unless RUBY_PLATFORM == 'java'
+require 'puppet/resource_api/type_definition'
 require 'puppet/resource_api/version'
 require 'puppet/type'
 
@@ -9,6 +10,7 @@ module Puppet::ResourceApi
     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
+    validate_ensure(definition)
 
     definition[:features] ||= []
     supported_features = %w[supports_noop canonicalize remote_resource simple_get_filter].freeze
@@ -48,15 +50,15 @@ module Puppet::ResourceApi
         self.class.my_provider
       end
 
-      define_singleton_method(:feature_support?) do |feature|
-        definition[:features] && definition[:features].include?(feature)
+      define_singleton_method(:type_definition) do
+        @type_definition ||= TypeDefinition.new(definition)
       end
 
-      def feature_support?(feature)
-        self.class.feature_support?(feature)
+      def type_definition
+        self.class.type_definition
       end
 
-      if feature_support?('remote_resource')
+      if type_definition.feature?('remote_resource')
         apply_to_device
       end
 
@@ -68,7 +70,7 @@ module Puppet::ResourceApi
           @called_from_resource = true
         end
         # $stderr.puts "B: #{attributes.inspect}"
-        if feature_support?('canonicalize')
+        if type_definition.feature?('canonicalize')
           attributes = my_provider.canonicalize(context, [attributes])[0]
         end
         # $stderr.puts "C: #{attributes.inspect}"
@@ -77,9 +79,11 @@ module Puppet::ResourceApi
 
       validate do
         # enforce mandatory attributes
-        missing_attrs = []
+        @missing_attrs = []
+        @missing_params = []
         definition[:attributes].each do |name, options|
           type = Puppet::Pops::Types::TypeParser.singleton.parse(options[:type])
+
           # skip read only vars and the namevar
           next if [:read_only, :namevar].include? options[:behaviour]
 
@@ -89,16 +93,14 @@ module Puppet::ResourceApi
                   options[:behaviour].nil?
 
           if value(name).nil? && !(type.instance_of? Puppet::Pops::Types::POptionalType)
-            missing_attrs << name
+            @missing_attrs << name
+            @missing_params << name if options[:behaviour] == :parameter
           end
         end
 
-        missing_attrs -= [:ensure] if @called_from_resource
+        @missing_attrs -= [:ensure] if @called_from_resource
 
-        if missing_attrs.any?
-          error_msg = "The following mandatory attributes were not provided:\n    *  " + missing_attrs.join(", \n    *  ")
-          raise Puppet::ResourceError, error_msg
-        end
+        raise_missing_params if @missing_params.any?
       end
 
       definition[:attributes].each do |name, options|
@@ -118,6 +120,7 @@ module Puppet::ResourceApi
                             else
                               :newproperty
                             end
+
         send(param_or_property, name.to_sym) do
           unless options[:type]
             raise Puppet::DevError, "#{definition[:name]}.#{name} has no type"
@@ -144,12 +147,20 @@ module Puppet::ResourceApi
             end
           end
 
+          if name == :ensure
+            def insync?(is)
+              rs_value.to_s == is.to_s
+            end
+          end
+
           type = Puppet::Pops::Types::TypeParser.singleton.parse(options[:type])
           if param_or_property == :newproperty
             define_method(:should) do
               if type.is_a? Puppet::Pops::Types::PBooleanType
                 # work around https://tickets.puppetlabs.com/browse/PUP-2368
                 rs_value ? :true : :false # rubocop:disable Lint/BooleanSymbol
+              elsif name == :ensure && rs_value.is_a?(String)
+                rs_value.to_sym
               else
                 rs_value
               end
@@ -204,12 +215,11 @@ module Puppet::ResourceApi
             Puppet::ResourceApi.def_newvalues(self, param_or_property, %r{})
           when Puppet::Pops::Types::PBooleanType
             Puppet::ResourceApi.def_newvalues(self, param_or_property, 'true', 'false')
-            # rubocop:disable Lint/BooleanSymbol
             aliasvalue true, 'true'
             aliasvalue false, 'false'
-            aliasvalue :true, 'true'
-            aliasvalue :false, 'false'
-            # rubocop:enable Lint/BooleanSymbol
+            aliasvalue :true, 'true' # rubocop:disable Lint/BooleanSymbol
+            aliasvalue :false, 'false' # rubocop:disable Lint/BooleanSymbol
+
           when Puppet::Pops::Types::PIntegerType
             Puppet::ResourceApi.def_newvalues(self, param_or_property, %r{^-?\d+$})
           when Puppet::Pops::Types::PFloatType, Puppet::Pops::Types::PNumericType
@@ -251,15 +261,13 @@ module Puppet::ResourceApi
         # puts "retrieve(#{title.inspect})"
         result = Puppet::Resource.new(self.class, title)
 
-        current_state = if feature_support?('simple_get_filter')
+        current_state = if type_definition.feature?('simple_get_filter')
                           my_provider.get(context, [title]).first
                         else
                           my_provider.get(context).find { |h| h[namevar_name] == title }
                         end
 
-        strict_check(current_state) if current_state && feature_support?('canonicalize')
-
-        # require 'pry'; binding.pry
+        strict_check(current_state) if current_state && type_definition.feature?('canonicalize')
 
         if current_state
           current_state.each do |k, v|
@@ -267,23 +275,29 @@ module Puppet::ResourceApi
           end
         else
           result[namevar_name] = title
-          result[:ensure] = 'absent'
+          result[:ensure] = :absent if type_definition.ensurable?
         end
 
+        # 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
 
       define_method(:flush) do
+        raise_missing_attrs
+
         # puts 'flush'
         # skip puppet's injected metaparams
         target_state = Hash[@parameters.reject { |k, _v| [:loglevel, :noop].include? k }.map { |k, v| [k, v.rs_value] }]
-        target_state = my_provider.canonicalize(context, [target_state]).first if feature_support?('canonicalize')
+        target_state = my_provider.canonicalize(context, [target_state]).first if type_definition.feature?('canonicalize')
 
         retrieve unless @rapi_current_state
 
-        # require 'pry'; binding.pry
         return if @rapi_current_state == target_state
 
         Puppet.debug("Target State: #{target_state.inspect}")
@@ -302,7 +316,7 @@ module Puppet::ResourceApi
           end
         end
 
-        if feature_support?('supports_noop')
+        if type_definition.feature?('supports_noop')
           my_provider.set(context, { title => { is: @rapi_current_state, should: target_state } }, noop: noop?)
         else
           my_provider.set(context, title => { is: @rapi_current_state, should: target_state }) unless noop?
@@ -310,6 +324,16 @@ module Puppet::ResourceApi
         raise 'Execution encountered an error' if context.failed?
       end
 
+      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
+
+      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
+
       define_method(:strict_check) do |current_state|
         return if Puppet.settings[:strict] == :off
 
@@ -341,7 +365,7 @@ MESSAGE
       end
 
       define_singleton_method(:context) do
-        @context ||= PuppetContext.new(definition[:name])
+        @context ||= PuppetContext.new(definition)
       end
 
       def context
@@ -476,6 +500,15 @@ MESSAGE
     # an error :-(
     inferred_type = Puppet::Pops::Types::TypeCalculator.infer_set(value)
     error_msg = Puppet::Pops::Types::TypeMismatchDescriber.new.describe_mismatch(error_msg_prefix, type, inferred_type)
-    return [nil, error_msg] # the entire function is using returns for clarity # rubocop:disable Style/RedundantReturn
+    [nil, error_msg]
+  end
+
+  def self.validate_ensure(definition)
+    return unless definition[:attributes].key? :ensure
+    options = definition[:attributes][:ensure]
+    type = Puppet::Pops::Types::TypeParser.singleton.parse(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
 end

data/lib/puppet/resource_api/base_context.rb

@@ -1,9 +1,16 @@
 require 'puppet/util'
 require 'puppet/util/network_device'
+require 'puppet/resource_api/type_definition'
 
+module Puppet; end
+module Puppet::ResourceApi; end
 class Puppet::ResourceApi::BaseContext
-  def initialize(typename)
-    @typename = typename
+  attr_reader :type
+
+  def initialize(definition)
+    raise Puppet::DevError, 'BaseContext requires definition to be a Hash' unless definition.is_a?(Hash)
+    @typename = definition[:name]
+    @type = Puppet::ResourceApi::TypeDefinition.new(definition)
   end
 
   def device
@@ -17,13 +24,8 @@ class Puppet::ResourceApi::BaseContext
   end
 
   def feature_support?(feature)
-    supported = Puppet::Type.type(@typename).feature_support?(feature)
-    if supported
-      Puppet.debug("#{@typename} supports `#{feature}`")
-    else
-      Puppet.debug("#{@typename} does not support `#{feature}`")
-    end
-    supported
+    Puppet.deprecation_warning('context.feature_support? is deprecated. Please use context.type.feature? instead.')
+    type.feature?(feature)
   end
 
   [:debug, :info, :notice, :warning, :err].each do |level|

data/lib/puppet/resource_api/glue.rb

@@ -1,4 +1,4 @@
-
+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

data/lib/puppet/resource_api/io_context.rb

@@ -1,8 +1,8 @@
 require 'puppet/resource_api/base_context'
 
 class Puppet::ResourceApi::IOContext < Puppet::ResourceApi::BaseContext
-  def initialize(typename, target = $stderr)
-    super(typename)
+  def initialize(definition, target = $stderr)
+    super(definition)
     @target = target
   end
 

data/lib/puppet/resource_api/simple_provider.rb

@@ -1,3 +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,
@@ -7,7 +8,7 @@ module Puppet::ResourceApi
   class SimpleProvider
     def set(context, changes)
       changes.each do |name, change|
-        is = if context.feature_support?('simple_get_filter')
+        is = if context.type.feature?('simple_get_filter')
                change.key?(:is) ? change[:is] : (get(context, [name]) || []).find { |r| r[:name] == name }
              else
                change.key?(:is) ? change[:is] : (get(context) || []).find { |r| r[:name] == name }
@@ -15,6 +16,8 @@ module Puppet::ResourceApi
 
         should = change[:should]
 
+        raise 'SimpleProvider cannot be used with a Type that is not ensurable' unless context.type.ensurable?
+
         is = { name: name, ensure: 'absent' } if is.nil?
         should = { name: name, ensure: 'absent' } if should.nil?
 

data/lib/puppet/resource_api/type_definition.rb

@@ -0,0 +1,28 @@
+# Provides accessor methods for the type being provided
+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
+  end
+
+  def attributes
+    @definition[:attributes]
+  end
+
+  def ensurable?
+    @definition[:attributes].key?(:ensure)
+  end
+
+  # rubocop complains when this is named has_feature?
+  def feature?(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
+end

data/lib/puppet/resource_api/version.rb

@@ -1,5 +1,5 @@
 module Puppet
   module ResourceApi
-    VERSION = '1.1.0'.freeze
+    VERSION = '1.2.0'.freeze
   end
 end

data/misc/ANNOUNCEMENT_TEMPLATE.md

@@ -0,0 +1,41 @@
+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.
+
+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.
+
+The github rendering of the markdown seems to copy&paste acceptably into Google Inbox.
+
+The [CHANGELOG](https://github.com/puppetlabs/puppet-resource_api/blob/master/CHANGELOG.md) is a good starting point for finding enhancements and bug-fixes.
+
+See [this post](https://groups.google.com/d/msg/puppet-dev/1R9gwkEIxHU/adWXJ0NfCAAJ) for an example.
+
+---
+
+Subject: [ANN] Resource API vX.Y.Z Release
+
+Hi all,
+
+We're pleased to announce that version X.Y.Z of the Resource API is being released today.
+
+The Resource API provides a simple way to create new native resources in the form of types and providers for Puppet. It is provided as a Ruby gem to be referenced within modules. Support for it has been included as an experimental feature in version 1.4 of the Puppet Development Kit (`pdk new provider`). Use the [resource_api module](https://forge.puppet.com/puppetlabs/resource_api) to deploy it in your infrastructure.
+
+The new release of the Resource API provides the following enhancements:
+
+* A
+* B
+* C
+
+The new release also contains the following notable bugfixes:
+
+* D
+* E
+* F
+
+See the [CHANGELOG](https://github.com/puppetlabs/puppet-resource_api/blob/master/CHANGELOG.md) for a full list of changes
+
+We encourage all module developers to review the Resource API and use it when creating types and providers. For reference, there is an example of its usage in a [branch](https://github.com/DavidS/puppetlabs-apt/blob/resource-api-experiments/lib/puppet/provider/apt_key2/apt_key2.rb) of the apt module.
+
+Please let us know of your experiences with the Resource API, either here, on [Slack](https://slack.puppet.com/) (#forge-modules), or on the [github repo](https://github.com/puppetlabs/puppet-resource_api).
+
+
+Thanks,
+YOUR NAME

data/puppet-resource_api.gemspec

@@ -11,8 +11,8 @@ Gem::Specification.new do |spec|
   spec.summary       = 'This library provides a simple way to write new native resources for puppet.'
   spec.homepage      = 'https://github.com/puppetlabs/puppet-resource_api'
 
-  # on out internal jenkins, there is no `.git` directory, but since it is a clean machine, we don't need to worry about anything else
-  spec.files         = if Dir.exist?('.git')
+  # on out internal jenkins, there is no git, but since it is a clean machine, we don't need to worry about anything else
+  spec.files         = if system('git --help > /dev/null')
                          `git ls-files -z`.split("\x0")
                        else
                          Dir.glob('**/*')

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puppet-resource_api
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - David Schmitt
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-04-12 00:00:00.000000000 Z
+date: 2018-05-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hocon
@@ -49,14 +49,18 @@ files:
 - bin/console
 - bin/setup
 - codecov.yml
+- contrib/README.md
+- contrib/pre-commit
 - lib/puppet/resource_api.rb
 - lib/puppet/resource_api/base_context.rb
 - lib/puppet/resource_api/glue.rb
 - lib/puppet/resource_api/io_context.rb
 - lib/puppet/resource_api/puppet_context.rb
 - lib/puppet/resource_api/simple_provider.rb
+- lib/puppet/resource_api/type_definition.rb
 - lib/puppet/resource_api/version.rb
 - lib/puppet/util/network_device/simple/device.rb
+- misc/ANNOUNCEMENT_TEMPLATE.md
 - puppet-resource_api.gemspec
 homepage: https://github.com/puppetlabs/puppet-resource_api
 licenses: []