puppet-resource_api 1.8.3 → 1.8.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 42a8295bef7527d8b9a309e22c9b650bf2f0e62213be3bba7cca506ecd5b745b
-  data.tar.gz: b1630d97f5a1c13f5377f67e30818dbcd41cc31c6f1c0cbc5e8dd75acff51cb2
+  metadata.gz: 2f6caa565c4c74ffa60028baa93976517fe6a6677e1265e29b164b91c1b8ddf7
+  data.tar.gz: 0d88b19fa67188d50658428a3a1a22fd3012831b2e7552fbf2d9dd5a546b2b52
 SHA512:
-  metadata.gz: 8d3741e8c50ecaa89ccc3e7dd6f8e0a926602427731d1a4755377e45ab8aab1de46ed2c2c020d455516825509cf9e4159e9890c86d4b11ddbe8236b734a41486
-  data.tar.gz: 4c55d2a4b01c0dd1675c49c42752643c037b68eb5fd0c66ce65a152d1d93129a09cb33bdb967ad81eef36d7622c5a7a66d9642d86753d6e807135895af17e07c
+  metadata.gz: 12df0d25e70620dbc247bd26b4705c39d5b0d4341606d828f1aed79a152bd67934b2704b20dd29805955240e3dd972bce8f7586bf3719bdd509afe7fd1a6a219
+  data.tar.gz: fc3e433a2a5a2c218a64dbcb2dab12af8aa96d36ed458b9607bf997cb470afce3352d0ed966e69ee03d0c7037bc738e713aab9ad8940560c9b7a6a59f8df5c2f

data/.travis.yml

@@ -20,7 +20,7 @@ matrix:
       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

data/Gemfile

@@ -7,15 +7,13 @@ 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 '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'
@@ -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/README.md

@@ -239,31 +239,26 @@ Puppet::ResourceAPI.register_transport(
 
 ### Transport Schema keywords
 
-Please note that within the transport schema, the following keywords are reserved words:
-
-#### Usable within the schema
-
-The following keywords are encouraged within the Transport schema:
-
-* `uri` - Use when you need to specify a specific URL to connect to. All of the following keys will be computed from the `uri` if possible. In the future more url parts may be computed from the URI as well.
-* `host` - Use to specify and IP or address to connect to.
-* `protocol` - Use to specify which protocol the transport should use for example `http`, `https`, `ssh` or `tcp`
-* `user` - The user the transport should connect as.
-* `port` - The port the transport should connect to.
-
-#### Non-Usable within the schema
-
-The following keywords are keywords that must not be used by the transport schema:
-
-* `name` - transports should use `uri` instead of name.
-* `path` - reserved as a uri part
-* `query` - reserved as a uri part
-* `run-on` - This is used by bolt to determine which target to proxy to. Transports should not rely on this key.
-* `remote-transport` - This is used to determine which transport to load. It should always be the transport class name "declassified".
-* `remote-*` Any key starting with `remote-` is reserved for future use.
-* `implementations`: reserved by bolt
-
-Note: Currently bolt inventory requires that a name be set for every target and always uses that name as the URI. This means there is no way to specify `host` separately from the host section of the `name` when parsed as a URI.
+To align with [Bolt's inventory file](https://puppet.com/docs/bolt/latest/inventory_file.html), a transport schema prefers the following keywords (when relevant):
+
+* `uri`: use when you need to specify a specific URL to connect to. Bolt will compute the following keys from the `uri` when possible. In the future more url parts may be computed from the URI.
+* `protocol`: use to specify which protocol the transport should use for example `http`, `https`, `ssh` or `tcp`.
+* `host`: use to specify an IP or address to connect to.
+* `port`: the port the transport should connect to.
+* `user`: the user the transport should connect as.
+* `password`: the password for the specified user.
+
+Do not use the following keywords when writing a schema:
+
+* `implementations`: reserved by Bolt.
+* `name`: transports should use `uri` instead of name.
+* `path`: reserved as a uri part.
+* `query`: reserved as a uri part.
+* `remote-*`: any key starting with `remote-` is reserved for future use.
+* `remote-transport`: determines which transport to load. It is always the transport class named "declassified".
+* `run-on`: Bolt uses this keyword to determine which target to proxy to. Transports should not rely on this key.
+
+> Note: Bolt inventory requires you to set a name for every target and always use it for the URI. This means that there is no way to specify `host` separately from the host section of the `name` when parsed as a URI.
 
 After the device class, transport class and transport schema have been implemented, `puppet device` will be able to use the new provider, and supply it (through the device class) with the URL specified in the [`device.conf`](https://puppet.com/docs/puppet/5.3/config_file_device.html).
 

data/lib/puppet/resource_api/glue.rb

@@ -41,6 +41,17 @@ module Puppet::ResourceApi
       YAML.dump('type' => { title => attributes }).split("\n").drop(2).join("\n") + "\n"
     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
+
+    def to_hash
+      values
+    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) }

data/lib/puppet/resource_api/transport.rb

@@ -9,21 +9,19 @@ module Puppet::ResourceApi::Transport
     raise Puppet::DevError, 'requires `:connection_info`' unless schema.key? :connection_info
     raise Puppet::DevError, '`:connection_info` must be a hash, not `%{other_type}`' % { other_type: schema[:connection_info].class } unless schema[:connection_info].is_a?(Hash)
 
-    init_transports
-    unless @transports[@environment][schema[:name]].nil?
+    unless transports[schema[:name]].nil?
       raise Puppet::DevError, 'Transport `%{name}` is already registered for `%{environment}`' % {
         name: schema[:name],
-        environment: @environment,
+        environment: current_environment,
       }
     end
-    @transports[@environment][schema[:name]] = Puppet::ResourceApi::TransportSchemaDef.new(schema)
+    transports[schema[:name]] = Puppet::ResourceApi::TransportSchemaDef.new(schema)
   end
   module_function :register # rubocop:disable Style/AccessModifierDeclarations
 
   # retrieve a Hash of transport schemas, keyed by their name.
   def list
-    init_transports
-    Marshal.load(Marshal.dump(@transports[@environment]))
+    Marshal.load(Marshal.dump(transports))
   end
   module_function :list # rubocop:disable Style/AccessModifierDeclarations
 
@@ -47,15 +45,19 @@ module Puppet::ResourceApi::Transport
   module_function :inject_device # rubocop:disable Style/AccessModifierDeclarations
 
   def self.validate(name, connection_info)
-    init_transports
-    require "puppet/transport/schema/#{name}" unless @transports[@environment].key? name
-    transport_schema = @transports[@environment][name]
+    require "puppet/transport/schema/#{name}" unless transports.key? name
+    transport_schema = transports[name]
     if transport_schema.nil?
       raise Puppet::DevError, 'Transport for `%{target}` not registered with `%{environment}`' % {
         target: name,
-        environment: @environment,
+        environment: current_environment,
       }
     end
+
+    if connection_info.key?(:"remote-transport")
+      clean_bolt_attributes(transport_schema, connection_info)
+    end
+
     message_prefix = 'The connection info provided does not match the Transport Schema'
     transport_schema.check_schema(connection_info, message_prefix)
     transport_schema.validate(connection_info)
@@ -64,24 +66,12 @@ module Puppet::ResourceApi::Transport
 
   def self.get_context(name)
     require 'puppet/resource_api/puppet_context'
-    Puppet::ResourceApi::PuppetContext.new(@transports[@environment][name])
+    Puppet::ResourceApi::PuppetContext.new(transports[name])
   end
   private_class_method :get_context
 
-  def self.init_transports
-    lookup = Puppet.lookup(:current_environment) if Puppet.respond_to? :lookup
-    @environment =  if lookup.nil?
-                      :transports_default
-                    else
-                      lookup.name
-                    end
-    @transports ||= {}
-    @transports[@environment] ||= {}
-  end
-  private_class_method :init_transports
-
   def self.wrap_sensitive(name, connection_info)
-    transport_schema = @transports[@environment][name]
+    transport_schema = transports[name]
     if transport_schema
       transport_schema.definition[:connection_info].each do |attr_name, options|
         if options.key?(:sensitive) && (options[:sensitive] == true) && connection_info.key?(attr_name)
@@ -92,4 +82,52 @@ module Puppet::ResourceApi::Transport
     connection_info
   end
   private_class_method :wrap_sensitive
+
+  def self.transports
+    @transports ||= {}
+    @transports[current_environment] ||= {}
+  end
+  private_class_method :transports
+
+  def self.current_environment
+    if Puppet.respond_to? :lookup
+      env = Puppet.lookup(:current_environment)
+      env.nil? ? :transports_default : env.name
+    else
+      :transports_default
+    end
+  end
+  private_class_method :current_environment
+
+  def self.clean_bolt_attributes(transport_schema, connection_info)
+    context = get_context(transport_schema.name)
+
+    # Attributes we expect from bolt, but want to ignore if the transport does not expect them
+    [:uri, :host, :protocol, :user, :port, :password].each do |attribute_name|
+      if connection_info.key?(attribute_name) && !transport_schema.attributes.key?(attribute_name)
+        context.info('Discarding superfluous bolt attribute: %{attribute_name}' % { attribute_name: attribute_name })
+        connection_info.delete(attribute_name)
+      end
+    end
+
+    # Attributes that bolt emits, but we want to ignore if the transport does not expect them
+    ([:name, :path, :query, :"run-on", :"remote-transport", :implementations] + connection_info.keys.select { |k| k.to_s.start_with? 'remote-' }).each do |attribute_name|
+      if connection_info.key?(attribute_name) && !transport_schema.attributes.key?(attribute_name)
+        context.debug('Discarding bolt metaparameter: %{attribute_name}' % { attribute_name: attribute_name })
+        connection_info.delete(attribute_name)
+      end
+    end
+
+    # remove any other attributes the transport is not prepared to handle
+    connection_info.keys.each do |attribute_name|
+      if connection_info.key?(attribute_name) && !transport_schema.attributes.key?(attribute_name)
+        context.warning('Discarding unknown attribute: %{attribute_name}' % { attribute_name: attribute_name })
+        connection_info.delete(attribute_name)
+      end
+    end
+
+    # don't return a value as we've already modified the hash
+    nil
+  end
+  private_class_method :clean_bolt_attributes
 end

data/lib/puppet/resource_api/version.rb

@@ -1,5 +1,5 @@
 module Puppet
   module ResourceApi
-    VERSION = '1.8.3'.freeze
+    VERSION = '1.8.4'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puppet-resource_api
 version: !ruby/object:Gem::Version
-  version: 1.8.3
+  version: 1.8.4
 platform: ruby
 authors:
 - David Schmitt
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-06-10 00:00:00.000000000 Z
+date: 2019-06-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hocon