puppet-resource_api 1.8.13 → 1.8.18

data/lib/puppet/resource_api/type_definition.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Provides accessor methods for the type being provided
 module Puppet::ResourceApi
   # pre-declare class
@@ -15,7 +17,7 @@ module Puppet::ResourceApi
 
     # rubocop complains when this is named has_feature?
     def feature?(feature)
-      (definition[:features] && definition[:features].include?(feature))
+      definition[:features]&.include?(feature)
     end
 
     def title_patterns
@@ -34,10 +36,56 @@ module Puppet::ResourceApi
       Puppet::ResourceApi::DataTypeHandling.validate_ensure(definition)
 
       definition[:features] ||= []
-      supported_features = %w[supports_noop canonicalize remote_resource simple_get_filter].freeze
+      supported_features = %w[supports_noop canonicalize custom_insync remote_resource simple_get_filter].freeze
       unknown_features = definition[:features] - supported_features
       Puppet.warning("Unknown feature detected: #{unknown_features.inspect}") unless unknown_features.empty?
     end
+
+    # This call creates a new parameter or property with all work-arounds or
+    # customizations required by the Resource API applied. Under the hood,
+    # this maps to the relevant DSL methods in Puppet::Type. See
+    # https://puppet.com/docs/puppet/6.0/custom_types.html#reference-5883
+    # for details.
+    #
+    # type: the Resource API Type the attribute is being created in
+    # attribute_name: the name of the attribute being created
+    # param_or_property: Whether to call the :newparam or :newproperty method
+    # parent: The type of attribute to create: Property, ReadOnly, or Parameter
+    # options: The hash of attribute options, including type, desc, default, and behaviour
+    def create_attribute_in(type, attribute_name, param_or_property, parent, options)
+      type.send(param_or_property, attribute_name.to_sym, parent: parent) do
+        if options[:desc]
+          desc "#{options[:desc]} (a #{options[:type]})"
+        end
+
+        # The initialize method is called when puppet core starts building up
+        # type objects. The core passes in a hash of shape { resource:
+        # #<Puppet::Type::TypeName> }. We use this to pass through the
+        # required configuration data to the parent (see
+        # Puppet::ResourceApi::Property, Puppet::ResourceApi::Parameter and
+        # Puppet::ResourceApi::ReadOnlyParameter).
+        define_method(:initialize) do |resource_hash|
+          super(type.name, self.class.data_type, attribute_name, resource_hash, type)
+        end
+
+        # get pops data type object for this parameter or property
+        define_singleton_method(:data_type) do
+          @rsapi_data_type ||= Puppet::ResourceApi::DataTypeHandling.parse_puppet_type(
+            attribute_name,
+            options[:type],
+          )
+        end
+
+        # from ValueCreator call create_values which makes alias values and
+        # default values for properties and params
+        Puppet::ResourceApi::ValueCreator.create_values(
+          self,
+          data_type,
+          param_or_property,
+          options,
+        )
+      end
+    end
   end
 
   # RSAPI Transport schema
@@ -88,6 +136,13 @@ module Puppet::ResourceApi
       }.keys
     end
 
+    def insyncable_attributes
+      @insyncable_attributes ||= attributes.reject { |_name, options|
+        # Only attributes without any behavior are normal Puppet Properties and get insynced
+        options.key?(:behaviour)
+      }.keys
+    end
+
     def validate_schema(definition, attr_key)
       raise Puppet::DevError, '%{type_class} must be a Hash, not `%{other_type}`' % { type_class: self.class.name, other_type: definition.class } unless definition.is_a?(Hash)
       @attributes = definition[attr_key]
@@ -110,6 +165,7 @@ module Puppet::ResourceApi
       Puppet.warning('`%{name}` has no documentation, add it using a `desc` key' % { name: definition[:name] }) unless definition.key? :desc
 
       attributes.each do |key, attr|
+        raise Puppet::DevError, '`rsapi_custom_insync_trigger` cannot be specified as an attribute; it is reserved for propertyless types with the custom_insync feature' if key == :rsapi_custom_insync_trigger # rubocop:disable Metrics/LineLength
         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('`%{name}.%{key}` has no documentation, add it using a `desc` key' % { name: definition[:name], key: key }) unless attr.key? :desc
@@ -194,7 +250,7 @@ module Puppet::ResourceApi
         if is_sensitive
           bad_vals[key] = '<< redacted value >> ' + error_message unless error_message.nil?
         else
-          bad_vals[key] = value unless error_message.nil?
+          bad_vals[key] = "#{value} (#{error_message})" unless error_message.nil?
         end
       end
       bad_vals

data/lib/puppet/resource_api/value_creator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Puppet; module ResourceApi; end; end # predeclare the main module # rubocop:disable Style/Documentation,Style/ClassAndModuleChildren
 
 # This module is responsible for setting default and alias values for the

data/lib/puppet/resource_api/version.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module Puppet
   module ResourceApi
-    VERSION = '1.8.13'.freeze
+    VERSION = '1.8.18'
   end
 end

data/lib/puppet/resource_api.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'pathname'
 require 'puppet/resource_api/data_type_handling'
 require 'puppet/resource_api/glue'
@@ -123,6 +125,22 @@ module Puppet::ResourceApi
         @rsapi_title
       end
 
+      def rsapi_canonicalized_target_state
+        @rsapi_canonicalized_target_state ||= begin
+          # skip puppet's injected metaparams
+          actual_params = @parameters.select { |k, _v| type_definition.attributes.key? k }
+          target_state = Hash[actual_params.map { |k, v| [k, v.rs_value] }]
+          target_state = my_provider.canonicalize(context, [target_state]).first if type_definition.feature?('canonicalize')
+          target_state
+        end
+        @rsapi_canonicalized_target_state
+      end
+
+      def rsapi_current_state
+        refresh_current_state unless @rsapi_current_state
+        @rsapi_current_state
+      end
+
       def to_resource
         to_resource_shim(super)
       end
@@ -166,6 +184,21 @@ module Puppet::ResourceApi
         raise_missing_params if @missing_params.any?
       end
 
+      # If the custom_insync feature is specified but no insyncable attributes are included
+      # in the definition, add the hidden rsapi_custom_insync_trigger property.
+      # This property exists *only* to allow a resource without properties to still execute an
+      # insync check; there's no point in specifying it in a manifest as it can only have one
+      # value; it cannot be specified in a type definition as it should only exist in this case.
+      if type_definition.feature?('custom_insync') && type_definition.insyncable_attributes.empty?
+        custom_insync_trigger_options = {
+          type: 'Enum[do_not_specify_in_manifest]',
+          desc: 'A hidden property which enables a type with custom insync to perform an insync check without specifying any insyncable properties',
+          default: 'do_not_specify_in_manifest',
+        }
+
+        type_definition.create_attribute_in(self, :rsapi_custom_insync_trigger, :newproperty, Puppet::ResourceApi::Property, custom_insync_trigger_options)
+      end
+
       definition[:attributes].each do |name, options|
         # puts "#{name}: #{options.inspect}"
 
@@ -189,43 +222,7 @@ module Puppet::ResourceApi
           parent = Puppet::ResourceApi::Property
         end
 
-        # This call creates a new parameter or property with all work-arounds or
-        # customizations required by the Resource API applied. Under the hood,
-        # this maps to the relevant DSL methods in Puppet::Type. See
-        # https://puppet.com/docs/puppet/6.0/custom_types.html#reference-5883
-        # for details.
-        send(param_or_property, name.to_sym, parent: parent) do
-          if options[:desc]
-            desc "#{options[:desc]} (a #{options[:type]})"
-          end
-
-          # The initialize method is called when puppet core starts building up
-          # type objects. The core passes in a hash of shape { resource:
-          # #<Puppet::Type::TypeName> }. We use this to pass through the
-          # required configuration data to the parent (see
-          # Puppet::ResourceApi::Property, Puppet::ResourceApi::Parameter and
-          # Puppet::ResourceApi::ReadOnlyParameter).
-          define_method(:initialize) do |resource_hash|
-            super(definition[:name], self.class.data_type, name, resource_hash)
-          end
-
-          # get pops data type object for this parameter or property
-          define_singleton_method(:data_type) do
-            @rsapi_data_type ||= Puppet::ResourceApi::DataTypeHandling.parse_puppet_type(
-              name,
-              options[:type],
-            )
-          end
-
-          # from ValueCreator call create_values which makes alias values and
-          # default values for properties and params
-          Puppet::ResourceApi::ValueCreator.create_values(
-            self,
-            data_type,
-            param_or_property,
-            options,
-          )
-        end
+        type_definition.create_attribute_in(self, name, param_or_property, parent, options)
       end
 
       def self.instances
@@ -279,11 +276,9 @@ module Puppet::ResourceApi
       end
 
       def retrieve
-        refresh_current_state unless @rsapi_current_state
-
-        Puppet.debug("Current State: #{@rsapi_current_state.inspect}")
+        Puppet.debug("Current State: #{rsapi_current_state.inspect}")
 
-        result = Puppet::Resource.new(self.class, title, parameters: @rsapi_current_state)
+        result = Puppet::Resource.new(self.class, title, parameters: rsapi_current_state)
         # puppet needs ensure to be a symbol
         result[:ensure] = result[:ensure].to_sym if type_definition.ensurable? && result[:ensure].is_a?(String)
 
@@ -302,10 +297,7 @@ module Puppet::ResourceApi
         raise_missing_attrs
 
         # puts 'flush'
-        # skip puppet's injected metaparams
-        actual_params = @parameters.select { |k, _v| type_definition.attributes.key? k }
-        target_state = Hash[actual_params.map { |k, v| [k, v.rs_value] }]
-        target_state = my_provider.canonicalize(context, [target_state]).first if type_definition.feature?('canonicalize')
+        target_state = rsapi_canonicalized_target_state
 
         retrieve unless @rsapi_current_state
 
@@ -464,7 +456,7 @@ MESSAGE
         definition[auto].each do |type, values|
           Puppet.debug("Registering #{auto} for #{type}: #{values.inspect}")
           send(auto, type.downcase.to_sym) do
-            [values].flatten.map do |v|
+            resolved = [values].flatten.map do |v|
               match = %r{\A\$(.*)\Z}.match(v) if v.is_a? String
               if match.nil?
                 v
@@ -472,6 +464,9 @@ MESSAGE
                 self[match[1].to_sym]
               end
             end
+            # Flatten to handle any resolved array properties and filter any nil
+            # values resulting from unspecified optional parameters:
+            resolved.flatten.reject { |v| v.nil? }
           end
         end
       end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'hocon'
 require 'hocon/config_syntax'
 

data/puppet-resource_api.gemspec

@@ -12,14 +12,13 @@ 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, 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('**/*')
-                       end.reject do |f|
-                         f.match(%r{^(test|spec|features)/})
-                       end
+  base = "#{__dir__}#{File::SEPARATOR}"
+  dirs =
+    Dir[File.join(__dir__, 'lib/**/*')] +
+    Dir[File.join(__dir__, 'docs/**/*')]
+  spec.files =
+    dirs.select { |path| File.file?(path) }.map { |path| path.sub(base, '') } +
+    %w[CHANGELOG.md CONTRIBUTING.md README.md LICENSE NOTICE puppet-resource_api.gemspec]
 
   spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puppet-resource_api
 version: !ruby/object:Gem::Version
-  version: 1.8.13
+  version: 1.8.18
 platform: ruby
 authors:
 - David Schmitt
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-04-21 00:00:00.000000000 Z
+date: 2023-07-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hocon
@@ -31,27 +31,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".dependency_decisions.yml"
-- ".fixtures.yml"
-- ".gitignore"
-- ".rspec"
-- ".rubocop.yml"
-- ".travis.yml"
 - CHANGELOG.md
-- CODEOWNERS
 - CONTRIBUTING.md
-- Gemfile
-- HISTORY.md
 - LICENSE
 - NOTICE
 - README.md
-- Rakefile
-- appveyor.yml
-- bin/console
-- bin/setup
-- codecov.yml
-- contrib/README.md
-- contrib/pre-commit
 - docs/README.md
 - docs/hands-on-lab/01-installing-prereqs.md
 - docs/hands-on-lab/02-connecting-to-the-lightbulbs-emulator.png
@@ -99,7 +83,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.0
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: This library provides a simple way to write new native resources for puppet.

data/.dependency_decisions.yml

@@ -1,98 +0,0 @@
----
-- - :permit
-  - MIT
-  - :who: DavidS
-    :why: standard license
-    :versions: []
-    :when: 2017-07-28 11:11:09.971500380 Z
-- - :permit
-  - Apache 2.0
-  - :who: DavidS
-    :why: standard license
-    :versions: []
-    :when: 2017-07-28 11:12:21.086779416 Z
-- - :permit
-  - ruby
-  - :who: DavidS
-    :why: standard license
-    :versions: []
-    :when: 2017-07-28 11:12:28.578927478 Z
-- - :permit
-  - Simplified BSD
-  - :who: DavidS
-    :why: standard license
-    :versions: []
-    :when: 2017-07-28 11:12:36.924605442 Z
-- - :permit
-  - New BSD
-  - :who: DavidS
-    :why: standard license
-    :versions: []
-    :when: 2017-07-28 11:14:00.252514982 Z
-- - :permit
-  - Apache License, v2
-  - :who: DavidS
-    :why: standard license
-    :versions: []
-    :when: 2017-07-28 11:14:07.999759997 Z
-- - :permit
-  - Ruby or LGPLv3+
-  - :who: DavidS
-    :why: standard license
-    :versions: []
-    :when: 2017-07-28 11:18:47.915684798 Z
-- - :license
-  - bundler
-  - MIT
-  - :who: DavidS
-    :why: See https://rubygems.org/gems/bundler
-    :versions: []
-    :when: 2017-07-28 11:22:12.975947786 Z
-- - :license
-  - minitar
-  - ruby
-  - :who: DavidS
-    :why: https://rubygems.org/gems/minitar
-    :versions: []
-    :when: 2017-07-28 11:22:50.609762862 Z
-- - :license
-  - colored
-  - MIT
-  - :who: DavidS
-    :why: https://github.com/defunkt/colored/blob/829bde0f8832406be1cacc5c99c49d976e05ccfc/LICENSE
-    :versions: []
-    :when: 2017-07-28 11:23:25.554994001 Z
-- - :permit
-  - ISC
-  - :who: scotje
-    :why: MIT equivalent
-    :versions: []
-    :when: 2017-08-11 01:30:32.594531000 Z
-- - :license
-  - facter
-  - Apache 2.0
-  - :who: DavidS
-    :why: https://github.com/puppetlabs/facter/blob/d6e1d4bcb087683239ff5ee6bd72978d262b9c39/LICENSE
-    :versions: []
-    :when: 2017-08-31 13:26:57.197893553 Z
-- - :license
-  - codecov
-  - MIT
-  - :who: DavidS
-    :why: https://github.com/codecov/codecov-ruby/blob/d5f85a0ece83845a577e26f8ce735ae10de767c0/LICENSE.txt
-    :versions: []
-    :when: 2017-10-11 12:15:00.000000000 Z
-- - :license
-  - blankslate
-  - MIT
-  - :who: DavidS
-    :why: https://github.com/masover/blankslate/blob/f0a73b80c34bc3ad94dc3195d12a227a8fe30019/MIT-LICENSE
-    :versions: []
-    :when: 2017-11-17 14:05:09.534340925 Z
-- - :license
-  - puppetlabs_spec_helper
-  - Apache 2.0
-  - :who: DavidS
-    :why:
-    :versions: []
-    :when: 2018-03-09 18:04:29.175843919 Z

data/.fixtures.yml

@@ -1,8 +0,0 @@
-# This file can be used to install module depdencies for unit testing
-# See https://github.com/puppetlabs/puppetlabs_spec_helper#using-fixtures for details
----
-fixtures:
-  forge_modules:
-#     stdlib: "puppetlabs/stdlib"
-  symlinks:
-    test_module: "#{source_dir}/spec/fixtures/test_module"

data/.gitignore

@@ -1,15 +0,0 @@
-/.bundle/
-/.yardoc
-/Gemfile.lock
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-
-# rspec failure tracking
-.rspec_status
-
-# puppetlabs_spec_helper automatic fixtures
-spec/fixtures/modules/test_module

data/.rspec

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

data/.rubocop.yml

@@ -1,159 +0,0 @@
----
-require: rubocop-rspec
-AllCops:
-  TargetRubyVersion: '2.1'
-  Include:
-  - "**/*.rb"
-  Exclude:
-  - bin/*
-  - ".vendor/**/*"
-  - Gemfile
-  - Rakefile
-  - pkg/**/*
-  - spec/fixtures/**/*
-  - vendor/**/*
-Metrics/LineLength:
-  Description: People have wide screens, use them.
-  Max: 200
-RSpec/BeforeAfterAll:
-  Description: Beware of using after(:all) as it may cause state to leak between tests.
-    A necessary evil in acceptance testing.
-  Exclude:
-  - spec/acceptance/**/*.rb
-RSpec/HookArgument:
-  Description: Prefer explicit :each argument, matching existing module's style
-  EnforcedStyle: each
-RSpec/SubjectStub:
-  Exclude:
-    - 'spec/puppet/resource_api/base_context_spec.rb'
-Style/BlockDelimiters:
-  Description: Prefer braces for chaining. Mostly an aesthetical choice. Better to
-    be consistent then.
-  EnforcedStyle: braces_for_chaining
-Style/ClassAndModuleChildren:
-  Description: Compact style reduces the required amount of indentation.
-  EnforcedStyle: compact
-# this needs to be easily usable in the gemspec
-  Exclude:
-    - 'lib/puppet/resource_api/version.rb'
-Style/EmptyElse:
-  Description: Enforce against empty else clauses, but allow `nil` for clarity.
-  EnforcedStyle: empty
-Style/FormatString:
-  Description: Following the main puppet project's style, prefer the % format format.
-  EnforcedStyle: percent
-Style/FormatStringToken:
-  Description: Following the main puppet project's style, prefer the simpler template
-    tokens over annotated ones.
-  EnforcedStyle: template
-Style/Lambda:
-  Description: Prefer the keyword for easier discoverability.
-  EnforcedStyle: literal
-Style/RegexpLiteral:
-  Description: Community preference. See https://github.com/voxpupuli/modulesync_config/issues/168
-  EnforcedStyle: percent_r
-Style/TernaryParentheses:
-  Description: Checks for use of parentheses around ternary conditions. Enforce parentheses
-    on complex expressions for better readability, but seriously consider breaking
-    it up.
-  EnforcedStyle: require_parentheses_when_complex
-Style/TrailingCommaInArguments:
-  Description: Prefer always trailing comma on multiline argument lists. This makes
-    diffs, and re-ordering nicer.
-  EnforcedStyleForMultiline: comma
-Style/SymbolArray:
-  Description: Using percent style obscures symbolic intent of array's contents.
-  EnforcedStyle: brackets
-Layout/EndOfLine:
-  Enabled: false
-Style/CollectionMethods:
-  Enabled: true
-Style/MethodCalledOnDoEndBlock:
-  Enabled: true
-Style/StringMethods:
-  Enabled: true
-Metrics/AbcSize:
-  Enabled: false
-Metrics/BlockLength:
-  Enabled: false
-Metrics/ClassLength:
-  Enabled: false
-Metrics/CyclomaticComplexity:
-  Enabled: false
-Metrics/MethodLength:
-  Enabled: false
-Metrics/ModuleLength:
-  Enabled: false
-Metrics/ParameterLists:
-  Enabled: false
-Metrics/PerceivedComplexity:
-  Enabled: false
-RSpec/DescribeClass:
-  Enabled: false
-RSpec/ExampleLength:
-  Enabled: false
-RSpec/MessageExpectation:
-  Enabled: false
-RSpec/MultipleExpectations:
-  Enabled: false
-RSpec/NestedGroups:
-  Enabled: false
-Style/AsciiComments:
-  Enabled: false
-Style/IfUnlessModifier:
-  Enabled: false
-Style/SymbolProc:
-  Enabled: false
-
-# local overrides
-
-# overridden for local conventions
-Naming/FileName:
-  Exclude:
-    - 'puppet-resource_api.gemspec'
-
-# metaprogramming makes everything "fun"
-Lint/NestedMethodDefinition:
-  Exclude:
-    - 'lib/puppet/resource_api.rb'
-
-# Interacting with external API makes message spies pretty useless
-RSpec/MessageSpies:
-  Enabled: false
-
-# If neighbouring parameters are both hashes, it helps to have braces round both.
-Style/BracesAroundHashParameters:
-  Exclude:
-    - 'spec/puppet/resource_api/base_context_spec.rb'
-
-# requires 2.3's squiggly HEREDOC support, which we can't use, yet
-# see http://www.virtuouscode.com/2016/01/06/about-the-ruby-squiggly-heredoc-syntax/
-Layout/IndentHeredoc:
-  Enabled: false
-
-# Updated in 0.53 (or thereabouts)
-Style/TrailingCommaInArrayLiteral:
-  Description: Prefer always trailing comma on multiline literals. This makes diffs,
-    and re-ordering nicer.
-  EnforcedStyleForMultiline: comma
-Style/TrailingCommaInHashLiteral:
-  Description: Prefer always trailing comma on multiline literals. This makes diffs,
-    and re-ordering nicer.
-  EnforcedStyleForMultiline: comma
-
-# Add allowing "is", as it is a technical term in puppet
-Naming/UncommunicativeMethodParamName:
-  Description: Checks for method parameter names that contain capital letters, end in
-    numbers, or do not meet a minimal length.
-  Enabled: true
-  MinNameLength: 3
-  AllowNamesEndingInNumbers: true
-  AllowedNames:
-  - io
-  - id
-  - is
-  ForbiddenNames: []
-
-# This cop breaks syntax highlighting in VSCode
-Layout/ClosingHeredocIndentation:
-  Enabled: false