puppet-resource_api 1.6.4 → 1.6.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cf451ef613e1041859eb390fe112577c9ac7cda85b5e68f3f2ca8cc26b88faa2
-  data.tar.gz: 1627bf1b0fe98460eb6e627cab47fd5b0184ecc2fabaa8a81b2a4f04ac55615f
+  metadata.gz: 160e4e687bacbb19cddb0b34398c6caa72ba308707a3718487c2fd4c86040804
+  data.tar.gz: ece23bfd962d5f97f34690bcdb02dbbaeb64d8109b65e5044396bfebb13328fb
 SHA512:
-  metadata.gz: 38306bd46fdc4e19c1d6e094b44009aa7014f4f107eca7919b785618d261d75053812618a6b840d028ad650afca5170298e243258e2a4649a05a41cea4af140e
-  data.tar.gz: 3bbe35aebff424e7277fe0f94f701782d008e991165c2847ebff7d0ad9d8cff7fd92dc39a3da7c6e537833ef1ed88ecb924968e925fb03d3c218ef54caaf2bd1
+  metadata.gz: '0888ca950e55d91f308274aab1d97ee46e6f5f924fad3b6abb150721012516f71afc740e6d4a297b188938f63416812d429e4e236908109d254ff9daf0a19a13'
+  data.tar.gz: 94df73da789c0808562408becc35d38ee55d8a5447db00b91999475362819508531b3e59dca2d96d7928bfff61e40447c568168c859beb9b2fe7ccf79d93ac4d

data/.rspec

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

data/.travis.yml

@@ -14,13 +14,13 @@ branches:
 matrix:
   include:
     - rvm: 2.4.3
-      env: PUPPET_GEM_VERSION='~> 5' COVERAGE=yes # 5.5
-    - env: RVM="jruby-1.7.26" PUPPET_GEM_VERSION='~> 5' JRUBY_OPTS="--debug" COVERAGE=yes
+      env: PUPPET_GEM_VERSION='~> 5' SIMPLECOV=yes # 5.5
+    - env: RVM="jruby-1.7.26" PUPPET_GEM_VERSION='~> 5' JRUBY_OPTS="--debug" SIMPLECOV=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
+      before_install: rvm use jruby-1.7.26 --install --binary --fuzzy && gem install bundler -v '~> 1.7.0'
     # 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
@@ -45,7 +45,7 @@ matrix:
     - rvm: 2.4.1
       env: PUPPET_GEM_VERSION='~> 5.0.0'
     - rvm: 2.1.9
-      env: PUPPET_GEM_VERSION='~> 4' COVERAGE=yes # 4.10
+      env: PUPPET_GEM_VERSION='~> 4' SIMPLECOV=yes # 4.10
     - rvm: 2.1.9
       env: PUPPET_GEM_VERSION='~> 4.9.0'
     - rvm: 2.1.9

data/Gemfile

@@ -7,16 +7,14 @@ 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'
   # 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 any rubocop version that works on java for the Rakefile
-    gem 'rubocop'
+    # 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
@@ -27,6 +25,9 @@ group :tests do
     # 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')
   end
   gem 'simplecov-console'
   # the test gems required for module testing

data/Rakefile

@@ -14,22 +14,30 @@ 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['COVERAGE'] = 'yes'
+    ENV['SIMPLECOV'] = '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

@@ -37,6 +37,16 @@ module Puppet::ResourceApi
     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]
@@ -56,7 +66,7 @@ module Puppet::ResourceApi
     end
 
     Puppet::Type.newtype(definition[:name].to_sym) do
-      @docs = definition[:docs]
+      @docs = definition[:desc]
 
       # Keeps a copy of the provider around. Weird naming to avoid clashes with puppet's own `provider` member
       define_singleton_method(:my_provider) do
@@ -81,7 +91,7 @@ module Puppet::ResourceApi
         apply_to_device
       end
 
-      define_method(:initialize) do |attributes|
+      def initialize(attributes)
         # $stderr.puts "A: #{attributes.inspect}"
         if attributes.is_a? Puppet::Resource
           @title = attributes.title
@@ -109,7 +119,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 definition[:attributes][:name].nil? && attributes[:title].nil?
+        if type_definition.attributes[:name].nil? && attributes[:title].nil?
           attributes[:title] = attributes.delete(:name)
           if attributes[:title].nil? && !type_definition.namevars.empty?
             attributes[:title] = @title
@@ -123,11 +133,25 @@ 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
 
-      define_method(:to_resource_shim) do |resource|
+      def to_resource_shim(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)
@@ -234,7 +258,7 @@ module Puppet::ResourceApi
         end
       end
 
-      define_singleton_method(:instances) do
+      def self.instances
         # puts 'instances'
         # force autoloading of the provider
         provider(type_definition.name)
@@ -251,16 +275,16 @@ module Puppet::ResourceApi
           result = if resource_hash.key? :title
                      new(title: resource_hash[:title])
                    else
-                     new(title: resource_hash[type_definition.namevars.first])
+                     new(title: build_title(type_definition, resource_hash))
                    end
           result.cache_current_state(resource_hash)
           result
         end
       end
 
-      define_method(:refresh_current_state) do
+      def refresh_current_state
         @rsapi_current_state = if type_definition.feature?('simple_get_filter')
-                                 my_provider.get(context, [title]).find { |h| namevar_match?(h) }
+                                 my_provider.get(context, [rsapi_title]).find { |h| namevar_match?(h) }
                                else
                                  my_provider.get(context).find { |h| namevar_match?(h) }
                                end
@@ -269,7 +293,11 @@ module Puppet::ResourceApi
           type_definition.check_schema(@rsapi_current_state)
           strict_check(@rsapi_current_state) if type_definition.feature?('canonicalize')
         else
-          @rsapi_current_state = { title: title }
+          @rsapi_current_state = if rsapi_title.is_a? Hash
+                                   rsapi_title.dup
+                                 else
+                                   { title: rsapi_title }
+                                 end
           @rsapi_current_state[:ensure] = :absent if type_definition.ensurable?
         end
       end
@@ -280,7 +308,7 @@ module Puppet::ResourceApi
         strict_check(@rsapi_current_state) if type_definition.feature?('canonicalize')
       end
 
-      define_method(:retrieve) do
+      def retrieve
         refresh_current_state unless @rsapi_current_state
 
         Puppet.debug("Current State: #{@rsapi_current_state.inspect}")
@@ -294,13 +322,13 @@ module Puppet::ResourceApi
         result
       end
 
-      define_method(:namevar_match?) do |item|
+      def namevar_match?(item)
         context.type.namevars.all? do |namevar|
           item[namevar] == @parameters[namevar].value if @parameters[namevar].respond_to? :value
         end
       end
 
-      define_method(:flush) do
+      def flush
         raise_missing_attrs
 
         # puts 'flush'
@@ -318,7 +346,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 definition[:attributes][name][:behaviour] == :init_only && value != @rsapi_current_state[name]
+            next unless type_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
@@ -330,9 +358,9 @@ module Puppet::ResourceApi
         end
 
         if type_definition.feature?('supports_noop')
-          my_provider.set(context, { title => { is: @rsapi_current_state, should: target_state } }, noop: noop?)
+          my_provider.set(context, { rsapi_title => { is: @rsapi_current_state, should: target_state } }, noop: noop?)
         else
-          my_provider.set(context, title => { is: @rsapi_current_state, should: target_state }) unless noop?
+          my_provider.set(context, rsapi_title => { is: @rsapi_current_state, should: target_state }) unless noop?
         end
         raise 'Execution encountered an error' if context.failed?
 
@@ -340,17 +368,17 @@ module Puppet::ResourceApi
         @rsapi_current_state = target_state
       end
 
-      define_method(:raise_missing_attrs) do
+      def raise_missing_attrs
         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
+      def raise_missing_params
         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|
+      def strict_check(current_state)
         return if Puppet.settings[:strict] == :off
 
         # if strict checking is on we must notify if the values are changed by canonicalize
@@ -364,7 +392,7 @@ module Puppet::ResourceApi
         #:nocov:
         # codecov fails to register this multiline as covered, even though simplecov does.
         message = <<MESSAGE.strip
-#{definition[:name]}[#{@title}]#get has not provided canonicalized values.
+#{type_definition.name}[#{@title}]#get has not provided canonicalized values.
 Returned values:       #{current_state.inspect}
 Canonicalized values:  #{state_clone.inspect}
 MESSAGE
@@ -377,7 +405,7 @@ MESSAGE
           raise Puppet::DevError, message
         end
 
-        return nil
+        nil
       end
 
       define_singleton_method(:context) do
@@ -388,9 +416,9 @@ MESSAGE
         self.class.context
       end
 
-      define_singleton_method(:title_patterns) do
-        @title_patterns ||= if definition.key? :title_patterns
-                              parse_title_patterns(definition[:title_patterns])
+      def self.title_patterns
+        @title_patterns ||= if type_definition.definition.key? :title_patterns
+                              parse_title_patterns(type_definition.definition[:title_patterns])
                             else
                               [[%r{(.*)}m, [[type_definition.namevars.first]]]]
                             end

data/lib/puppet/resource_api/glue.rb

@@ -41,9 +41,35 @@ 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,4 +1,5 @@
 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,
@@ -19,12 +20,12 @@ module Puppet::ResourceApi
 
         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?
+        is = SimpleProvider.create_absent(:name, name) if is.nil?
+        should = SimpleProvider.create_absent(:name, name) if should.nil?
 
         name_hash = if context.type.namevars.length > 1
                       # pass a name_hash containing the values of all namevars
-                      name_hash = { title: name }
+                      name_hash = {}
                       context.type.namevars.each do |namevar|
                         name_hash[namevar] = change[:should][namevar]
                       end
@@ -60,5 +61,16 @@ 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

@@ -27,13 +27,7 @@ class Puppet::ResourceApi::TypeDefinition
 
   # 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
+    (definition[:features] && definition[:features].include?(feature))
   end
 
   # validates a resource hash against its type schema

data/lib/puppet/resource_api/version.rb

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

metadata

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