puppet-resource_api 1.8.0 → 1.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '066920a9f1eca6ad946f2c8f39239482a2d00b756a9ac26db2441c4015a6aa37'
-  data.tar.gz: b9f87949cc263e98ead6d3fc5dcc480787a8122078e548bb135a2f1c21373f30
+  metadata.gz: e1490074420a43833ba41869aa9ccfe401126dd773292d8ab1998d4769c72104
+  data.tar.gz: 54c027ce51ab65c46b30522ff1d92a7292a1e3288ab81307c410e1edefbf3d30
 SHA512:
-  metadata.gz: c61a6bc59301a6214c53470b213d59493a31056f20b02ab6f6688ee9809f3f0a05494b66e8c2c0daa28fb222af85f132867a4b1164121ac1aa4f184d60a2acda
-  data.tar.gz: 393f017b70985894eb1f5abe4ecd0ec41d6640bd5d57fa288fb2a66acfc202dcb42b1c11fda89ec1e4c694a688442555015465a8e4ffd6354150da59f245faae
+  metadata.gz: e1cabe1b8a956dcfc9e4193ee5d28ef90046972b8b503e647e1a0e96fa99371092fbd13c7d3e4caf2fe78415cbc8e568b2aebc2ae5e7e1b488bc5056227c522c
+  data.tar.gz: 6ddb5982af07a32271a4198b29d12c1f25492f6bb45c3f431dfdf548513a4c7be11f552c7c8f8ebc660af8296b437fe60f928629a992103117b920b04387192a

data/.travis.yml

@@ -28,9 +28,9 @@ matrix:
         bundler: false
         directories: ~/.rvm
       before_install: rvm use jruby-9.1.9.0 --install --binary --fuzzy
-    - rvm: 2.4.3
+    - rvm: 2.5.1
       env: CHECK=rubocop
-    - rvm: 2.4.3
+    - rvm: 2.5.1
       env: CHECK=license_finder
       bundler_args: ""
 
@@ -60,10 +60,18 @@ matrix:
       env: PUPPET_GEM_VERSION='~> 4.7.0'
       before_install:
         - gem install bundler -v '< 2'
+    - rvm: 2.5.1
+      env: PUPPET_GEM_VERSION='~> 6' # 6.0, soon 6.1
+    - rvm: 2.5.1
+      env: PUPPET_GEM_VERSION='~> 6.0'
     - rvm: 2.5.1
       env: PUPPET_GEM_VERSION='https://github.com/puppetlabs/puppet.git#master'
     - rvm: 2.5.1
       env: PUPPET_GEM_VERSION='https://github.com/puppetlabs/puppet.git#6.0.x'
+    - rvm: 2.4.3
+      env: PUPPET_GEM_VERSION='https://github.com/puppetlabs/puppet.git#5.5.x'
+    - rvm: 2.1.9
+      env: PUPPET_GEM_VERSION='https://github.com/puppetlabs/puppet.git#4.10.x'
 notifications:
   slack:
     secure: aPXZYNow8LsmmlS8PQU3FjL0bc7FqUUA95d++wZfIu7YAjGboIUiekxYouQ0XnY+Aig8InvbTOIgBHgGNheyr/YFbFS90/jtulbF8oW7BitW+imgjeAHDCwlQZTCc4FFYde/2pI7QTT8H5NpLR9mKxlTU77Sqr8gFAIybuPdHcKMYQZdEZS07ma2pUp7+GyKS6PDQpzW2+mDCz/wfi3/JdsUvc0mclCZ8vxySc66j5P1E6nFDMzuakBOjwJHpgeDpreapbmSUQLAX0a3ZsFP+N+SNduLotlV2BWnJK2gcO6rGFP4Fz1D0bGXuBnYYdIiB+9OgI3wtXg9y1SifNHUG3IrOBAA8CGNyrebTGKtH0TS2O+HZLbaNX2g6udD5e3156vys9wScmJuQ/rSkVtQfXf1qUm5eijvlXI+DIbssbZHqm6QQGyM4p3NoULmNmF1C85bQoZ4GF7b1P/8mstsVE/HUfnzRPNbwD0r6j1aE/ck3PKMi7ZAhIi0Ja9RnAgP3wi0t62uERYcJGGYEycWohMWnrf2w6GFwGeuoiwAkASdHOLX0/AOMPc4mBOjlc621o8uYMrrZqfF5CrOAvJ151USSsWn2AhXaibIvnHo6X91paNvvNpU/GYu3CUAl6q8OhYovvjtRVPVnhs2DrpgoRB+6NWHnzjRG/wr6Z9U+vA=

data/CHANGELOG.md

@@ -3,6 +3,20 @@
 All significant changes to this repo will be summarized in this file.
 
 
+## [v1.8.1](https://github.com/puppetlabs/puppet-resource_api/tree/v1.8.1) (2019-03-13)
+[Full Changelog](https://github.com/puppetlabs/puppet-resource_api/compare/v1.8.0...v1.8.1)
+
+**Fixed bugs:**
+
+- \(maint\) Fixes sensitive transport values where absent keys are wrapped [\#161](https://github.com/puppetlabs/puppet-resource_api/pull/161) ([da-ar](https://github.com/da-ar))
+
+**Merged pull requests:**
+
+- 1.6.x mergeup [\#162](https://github.com/puppetlabs/puppet-resource_api/pull/162) ([DavidS](https://github.com/DavidS))
+- \(FM-7829\) Update README with transports examples [\#160](https://github.com/puppetlabs/puppet-resource_api/pull/160) ([willmeek](https://github.com/willmeek))
+- \(maint\) update release docs [\#159](https://github.com/puppetlabs/puppet-resource_api/pull/159) ([DavidS](https://github.com/DavidS))
+- Improve travis cells and testing [\#145](https://github.com/puppetlabs/puppet-resource_api/pull/145) ([DavidS](https://github.com/DavidS))
+
 ## [v1.8.0](https://github.com/puppetlabs/puppet-resource_api/tree/v1.8.0) (2019-02-26)
 [Full Changelog](https://github.com/puppetlabs/puppet-resource_api/compare/v1.7.0...v1.8.0)
 
@@ -22,6 +36,7 @@ All significant changes to this repo will be summarized in this file.
 
 **Merged pull requests:**
 
+- Release prep for v1.8.0 [\#158](https://github.com/puppetlabs/puppet-resource_api/pull/158) ([DavidS](https://github.com/DavidS))
 - \(FM-7726\) cleanups for the transport  [\#153](https://github.com/puppetlabs/puppet-resource_api/pull/153) ([DavidS](https://github.com/DavidS))
 - \(FM-7691,FM-7696\) refactoring definition handling in contexts [\#150](https://github.com/puppetlabs/puppet-resource_api/pull/150) ([DavidS](https://github.com/DavidS))
 

data/README.md

@@ -172,19 +172,128 @@ The `create`/`update`/`delete` methods get called by the `SimpleProvider` base-c
 
 The generated unit tests in `spec/unit/puppet/provider/foo_spec.rb` get automatically evaluated with `pdk test unit`.
 
-### `puppet device` support
+## Remote resources
 
-To support remote resources using `puppet device`, a few more steps are needed. First a `Puppet::Util::NetworkDevice::<device type>::Device` class needs to exist, which provides facts and connection management . That device class can inherit from `Puppet::Util::NetworkDevice::Simple::Device` to receive a simple default configuration parser using hocon.
+Support for remote resources is enabled through a `transport` class. A transport class contains the code for managing connections and processing information to and from the remote resource. For information on how to create a transport class, see the [Resource API specification](https://github.com/puppetlabs/puppet-specifications/tree/master/language/resource-api#transport).
 
-The provider needs to specify the `remote_resource` feature to enable the second part of the machinery.
+An example of a transport class:
 
-After this, `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).
+```ruby
+# lib/puppet/transport/device_type.rb
+module Puppet::Transport
+  # The main connection class to a PAN-OS API endpoint
+  class DeviceType
+    def initialize(context, connection_info)
+    # Initialization eg. validate connection_info
+    end
+
+    def verify(context)
+    # Test that transport can talk to the remote target
+    end
+
+    def facts(context)
+    # Access target, return a Facter facts hash
+    end
+
+    def close(context)
+    # Close connection, free up resources
+    end
+  end
+end
+```
+
+An example of a corresponding schema:
+
+```ruby
+# lib/puppet/transport/device_type.rb
+Puppet::ResourceAPI.register_transport(
+  name: 'device_type', # points at class Puppet::Transport::DeviceType
+  desc: 'Connects to a device_type',
+  # features: [], # future extension points
+  connection_info: {
+    host: {
+      type: 'String',
+      desc: 'The host to connect to.',
+    },
+    user: {
+      type: 'String',
+      desc: 'The user.',
+    },
+    password: {
+      type: 'String',
+      sensitive: true,
+      desc: 'The password to connect.',
+    },
+    enable_password: {
+      type: 'String',
+      sensitive: true,
+      desc: 'The password escalate to enable access.',
+    },
+    port: {
+      type: 'Integer',
+      desc: 'The port to connect to.',
+    },
+  },
+)
+```
+
+### 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:
 
-#### Device-specific providers
+* `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.
 
-To allow modules to deal with different backends independently of each other, the Resource API also implements a mechanism to use different API providers side-by-side. For a given device type (see above), the Resource API will first try to load a `Puppet::Provider::TypeName::DeviceType` class from `lib/puppet/provider/type_name/device_type.rb`, before falling back to the regular provider at `Puppet::Provider::TypeName::TypeName`.
+#### Non-Usable within the schema
 
-### Further Reading
+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.
+
+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.
+
+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).
+
+#### Transport/device specific providers
+
+To allow modules to deal with different backends independently, the Resource API implements a mechanism to use different API providers side by side. For a given transport/device class (see above), the Resource API will first try to load a `Puppet::Provider::TypeName::<DeviceType>` class from `lib/puppet/provider/type_name/device_type.rb`, before falling back to the regular provider at `Puppet::Provider::TypeName::TypeName`.
+
+### Puppet backwards compatibility
+
+To connect to a remote resource through `puppet device`, you must provide a device shim to maintain compatibility with Puppet. The device shim needs to interface the transport to puppet's config and runtime expectations.
+
+In the simplest case you can use the provided `Puppet::ResourceApi::Transport::Wrapper` like this:
+
+```ruby
+# lib/puppet/util/network_device/device_type/device.rb
+
+require 'puppet'
+require 'puppet/resource_api/transport/wrapper'
+# force registering the transport schema
+require 'puppet/transport/schema/device_type'
+
+module Puppet::Util::NetworkDevice::Device_type
+  class Device < Puppet::ResourceApi::Transport::Wrapper
+    def initialize(url_or_config, _options = {})
+      super('device_type', url_or_config)
+    end
+  end
+end
+```
+
+## Further reading
 
 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.
 
@@ -231,19 +340,16 @@ Future possibilities:
 * [Multiple Providers](https://tickets.puppetlabs.com/browse/PDK-530)
 * [Commands API](https://tickets.puppetlabs.com/browse/PDK-847)
 
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
-
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
-
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/puppetlabs/puppet-resource_api.
 
 ### Cutting a release
 
-To cut a new release, from a current `master` checkout:
+In some cases we need to manually cut a release outside of the regular puppet
+agent process.
+
+To do so, follow these instructions from a current `master` checkout:
 
 * Start the release branch with `git checkout -b release-prep`
 * Update `lib/puppet/resource_api/version.rb` to the new version

data/lib/puppet/resource_api/transport.rb

@@ -84,7 +84,7 @@ module Puppet::ResourceApi::Transport
     transport_schema = @transports[@environment][name]
     if transport_schema
       transport_schema.definition[:connection_info].each do |attr_name, options|
-        if options.key?(:sensitive) && (options[:sensitive] == true)
+        if options.key?(:sensitive) && (options[:sensitive] == true) && connection_info.key?(attr_name)
           connection_info[attr_name] = Puppet::Pops::Types::PSensitiveType::Sensitive.new(connection_info[attr_name])
         end
       end

data/lib/puppet/resource_api/version.rb

@@ -1,5 +1,5 @@
 module Puppet
   module ResourceApi
-    VERSION = '1.8.0'.freeze
+    VERSION = '1.8.1'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puppet-resource_api
 version: !ruby/object:Gem::Version
-  version: 1.8.0
+  version: 1.8.1
 platform: ruby
 authors:
 - David Schmitt
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-02-26 00:00:00.000000000 Z
+date: 2019-03-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hocon