puppet-resource_api 1.5.0 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9e2e55069c15f749148ae6c4a9fc626e77191f0ebba51123893f5d82c6d22a9d
-  data.tar.gz: 7add3eb881e226501009caf3150001ee7d83891e301a5d41081fffe3dd77d4cf
+  metadata.gz: 1aa62aa45972c81860d638d83bc416d5e2f8c459f2c05ca95d60e5df470bed21
+  data.tar.gz: 6c5783f8b8fb63b9502166ce696a923191b3a20e77bcfb4f2c61e3331fa713fc
 SHA512:
-  metadata.gz: d34e5647c07817985e6ec9029e2e7635dc94f0873943af524ae737d27166fe5da76a7bbc8649785d46f7aa0a99097c97e70478a6d797b0cb28562734d1d478d7
-  data.tar.gz: 1341a7774319c44650747f1ccba7178e70db1dff676c019d7614ae1ee8fa94af5f33ecaff8eb51ad2942b6a97252e25c8c381f12088b7fd33f8bf07ebdce91d2
+  metadata.gz: 997ab672ae396571471897d1041a86ed86f70f38cc11816fb4df0128268a189b461a492738a674a207dbb0df544fcddb868b13c8c1d6d9b6930b195a012b3fa5
+  data.tar.gz: 3a4a058a1def23f378f0ca5cd1fa9cce0d0b3fa5f15e9c034a85ed5edd24486cca67e94a45a219ce7cfae51e88f6abda0728d4a661c1601d674d62e021cff413

data/.travis.yml

@@ -54,6 +54,8 @@ matrix:
       env: PUPPET_GEM_VERSION='~> 4.7.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'
 notifications:
   hipchat:
     rooms:

data/CHANGELOG.md

@@ -3,6 +3,25 @@
 All significant changes to this repo will be summarized in this file.
 
 
+## [v1.6.0](https://github.com/puppetlabs/puppet-resource_api/tree/v1.6.0) (2018-09-25)
+[Full Changelog](https://github.com/puppetlabs/puppet-resource_api/compare/v1.5.0...v1.6.0)
+
+**Implemented enhancements:**
+
+- \(PDK-1185\) Implement allowances for device-specific providers [\#126](https://github.com/puppetlabs/puppet-resource_api/pull/126) ([DavidS](https://github.com/DavidS))
+- \(PDK-1143\) Allow SimpleProvider to handle multiple namevars [\#125](https://github.com/puppetlabs/puppet-resource_api/pull/125) ([da-ar](https://github.com/da-ar))
+
+**Fixed bugs:**
+
+- Update README walkthrough [\#122](https://github.com/puppetlabs/puppet-resource_api/pull/122) ([AlmogCohen](https://github.com/AlmogCohen))
+
+**Merged pull requests:**
+
+- Update README [\#124](https://github.com/puppetlabs/puppet-resource_api/pull/124) ([clairecadman](https://github.com/clairecadman))
+- Update README [\#123](https://github.com/puppetlabs/puppet-resource_api/pull/123) ([DavidS](https://github.com/DavidS))
+- \(maint\) Add Travis job for Puppet 6.0.x branch [\#120](https://github.com/puppetlabs/puppet-resource_api/pull/120) ([da-ar](https://github.com/da-ar))
+- Release prep for v1.5.0 [\#119](https://github.com/puppetlabs/puppet-resource_api/pull/119) ([DavidS](https://github.com/DavidS))
+
 ## [v1.5.0](https://github.com/puppetlabs/puppet-resource_api/tree/v1.5.0) (2018-09-12)
 [Full Changelog](https://github.com/puppetlabs/puppet-resource_api/compare/v1.4.2...v1.5.0)
 

data/Gemfile

@@ -24,6 +24,8 @@ group :tests do
   # the test gems required for module testing
   gem 'puppetlabs_spec_helper', '~> 2.7'
   gem 'rspec-puppet'
+
+  gem 'CFPropertyList'
 end
 
 group :development do

data/README.md

@@ -1,6 +1,10 @@
 # Puppet::ResourceApi [![TravisCI Build Status](https://travis-ci.org/puppetlabs/puppet-resource_api.svg?branch=master)](https://travis-ci.org/puppetlabs/puppet-resource_api) [![Appveyor Build status](https://ci.appveyor.com/api/projects/status/8o9s1ax0hs8lm5fd/branch/master?svg=true)](https://ci.appveyor.com/project/puppetlabs/puppet-resource-api/branch/master) [![codecov](https://codecov.io/gh/puppetlabs/puppet-resource_api/branch/master/graph/badge.svg)](https://codecov.io/gh/puppetlabs/puppet-resource_api)
 
-This is an implementation of the [Resource API](https://github.com/puppetlabs/puppet-specifications/blob/master/language/resource-api/README.md) proposal. Find a working example of a new-style provider in the [experimental puppetlabs-apt branch](https://github.com/DavidS/puppetlabs-apt/blob/resource-api-experiments/lib/puppet/provider/apt_key2/apt_key2.rb). There is also the corresponding [type](https://github.com/DavidS/puppetlabs-apt/blob/resource-api-experiments/lib/puppet/type/apt_key2.rb), [provider](https://github.com/DavidS/puppetlabs-apt/blob/resource-api-experiments/lib/puppet/provider/apt_key2/apt_key2.rb), and [new unit tests](https://github.com/DavidS/puppetlabs-apt/blob/resource-api-experiments/spec/unit/puppet/provider/apt_key2/apt_key2_spec.rb) for 100% coverage.
+This is an implementation of the [Resource API](https://github.com/puppetlabs/puppet-specifications/blob/master/language/resource-api/README.md) specification. Find a working example of a new-style providers in the [Palo Alto Firewall module](https://github.com/puppetlabs/puppetlabs-panos/): [base provider](https://github.com/puppetlabs/puppetlabs-panos/blob/master/lib/puppet/provider/panos_provider.rb), [type](https://github.com/puppetlabs/puppetlabs-panos/blob/master/lib/puppet/type/panos_address.rb), [actual provider with validation and xml processing](https://github.com/puppetlabs/puppetlabs-panos/blob/master/lib/puppet/provider/panos_address/panos_address.rb), and [new unit tests](https://github.com/puppetlabs/puppetlabs-panos/blob/master/spec/unit/puppet/provider/panos_provider_spec.rb) for 100% coverage.
+
+## Deployment
+
+The `puppet-resource_api` gem is part of the [Puppet 6 Platform](https://puppet.com/blog/introducing-puppet-6). With older versions of Puppet, you can use the [puppetlabs-resource_api module](https://forge.puppet.com/puppetlabs/resource_api) to install the gem on your servers and agents.
 
 ## Getting Started
 
@@ -8,7 +12,7 @@ This is an implementation of the [Resource API](https://github.com/puppetlabs/pu
 
 2. Create a [new module](https://puppet.com/docs/pdk/latest/pdk_generating_modules.html) with the PDK, or work with an existing PDK-enabled module. To create a new module, run `pdk new module <MODULE_NAME>` from the command line, specifying the name of the module. Respond to the dialog questions.
 
-3. To add the `puppet-resource_api` gem and enable "modern" rspec-style mocking, open the `sync.yml` file in your editor, and add the following content:
+3. To add the `puppet-resource_api` gem and enable "modern" rspec-style mocking, open the `.sync.yml` file in your editor, and add the following content:
 
 ```
 # .sync.yml
@@ -55,16 +59,17 @@ $ pdk new provider foo
 pdk (INFO): Creating '.../example/lib/puppet/type/foo.rb' from template.
 pdk (INFO): Creating '.../example/lib/puppet/provider/foo/foo.rb' from template.
 pdk (INFO): Creating '.../example/spec/unit/puppet/provider/foo/foo_spec.rb' from template.
+pdk (INFO): Creating '.../example/spec/unit/puppet/type/foo_spec.rb' from template.
 $
 ```
 
-The three generated files are the type, the implementation, and the unit tests. The default template contains an example that demonstrates the basic workings of the Resource API. This allows the unit tests to run immediately after creating the provider, which will look like this:
+The four generated files are the type, the implementation, and the unit tests. The default template contains an example that demonstrates the basic workings of the Resource API. This allows the unit tests to run immediately after creating the provider, which will look like this:
 
 ```
 $ pdk test unit
 [✔] Preparing to run the unit tests.
 [✔] Running unit tests.
-  Evaluated 4 tests in 0.012065973 seconds: 0 failures, 0 pending.
+  Evaluated 5 tests in 0.012065973 seconds: 0 failures, 0 pending.
 [✔] Cleaning up after running unit tests.
 $
 ```
@@ -175,6 +180,10 @@ The provider needs to specify the `remote_resource` feature to enable the second
 
 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).
 
+#### Device-specific providers
+
+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`.
+
 ### 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.

data/lib/puppet/resource_api.rb

@@ -4,6 +4,7 @@ require 'puppet/resource_api/puppet_context' unless RUBY_PLATFORM == 'java'
 require 'puppet/resource_api/type_definition'
 require 'puppet/resource_api/version'
 require 'puppet/type'
+require 'puppet/util/network_device'
 
 module Puppet::ResourceApi
   @warning_count = 0
@@ -54,7 +55,8 @@ module Puppet::ResourceApi
 
       # Keeps a copy of the provider around. Weird naming to avoid clashes with puppet's own `provider` member
       define_singleton_method(:my_provider) do
-        @my_provider ||= Puppet::ResourceApi.load_provider(definition[:name]).new
+        @my_provider ||= Hash.new { |hash, key| hash[key] = Puppet::ResourceApi.load_provider(definition[:name]).new }
+        @my_provider[Puppet::Util::NetworkDevice.current.class]
       end
 
       # make the provider available in the instance's namespace
@@ -514,14 +516,48 @@ MESSAGE
   def load_provider(type_name)
     class_name = class_name_from_type_name(type_name)
     type_name_sym = type_name.to_sym
+    device_name = if Puppet::Util::NetworkDevice.current.nil?
+                    nil
+                  else
+                    # extract the device type from the currently loaded device's class
+                    Puppet::Util::NetworkDevice.current.class.name.split('::')[-2].downcase
+                  end
+    device_class_name = class_name_from_type_name(device_name)
+
+    if device_name
+      device_name_sym = device_name.to_sym if device_name
+      load_device_provider(class_name, type_name_sym, device_class_name, device_name_sym)
+    else
+      load_default_provider(class_name, type_name_sym)
+    end
+  rescue NameError
+    if device_name # line too long # rubocop:disable Style/GuardClause
+      raise Puppet::DevError, "Found neither the device-specific provider class Puppet::Provider::#{class_name}::#{device_class_name} in puppet/provider/#{type_name}/#{device_name}"\
+      " nor the generic provider class Puppet::Provider::#{class_name}::#{class_name} in puppet/provider/#{type_name}/#{type_name}"
+    else
+      raise Puppet::DevError, "provider class Puppet::Provider::#{class_name}::#{class_name} not found in puppet/provider/#{type_name}/#{type_name}"
+    end
+  end
+  module_function :load_provider # rubocop:disable Style/AccessModifierDeclarations
 
+  def load_default_provider(class_name, type_name_sym)
     # loads the "puppet/provider/#{type_name}/#{type_name}" file through puppet
     Puppet::Type.type(type_name_sym).provider(type_name_sym)
     Puppet::Provider.const_get(class_name).const_get(class_name)
-  rescue NameError
-    raise Puppet::DevError, "class #{class_name} not found in puppet/provider/#{type_name}/#{type_name}"
   end
-  module_function :load_provider # rubocop:disable Style/AccessModifierDeclarations
+  module_function :load_default_provider # rubocop:disable Style/AccessModifierDeclarations
+
+  def load_device_provider(class_name, type_name_sym, device_class_name, device_name_sym)
+    # loads the "puppet/provider/#{type_name}/#{device_name}" file through puppet
+    Puppet::Type.type(type_name_sym).provider(device_name_sym)
+    provider_module = Puppet::Provider.const_get(class_name)
+    if provider_module.const_defined?(device_class_name)
+      provider_module.const_get(device_class_name)
+    else
+      load_default_provider(class_name, type_name_sym)
+    end
+  end
+  module_function :load_device_provider # rubocop:disable Style/AccessModifierDeclarations
 
   def self.class_name_from_type_name(type_name)
     type_name.to_s.split('_').map(&:capitalize).join

data/lib/puppet/resource_api/simple_provider.rb

@@ -22,17 +22,28 @@ module Puppet::ResourceApi
         is = { name: name, ensure: 'absent' } if is.nil?
         should = { name: name, ensure: 'absent' } 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 }
+                      context.type.namevars.each do |namevar|
+                        name_hash[namevar] = change[:should][namevar]
+                      end
+                      name_hash
+                    else
+                      name
+                    end
+
         if is[:ensure].to_s == 'absent' && should[:ensure].to_s == 'present'
           context.creating(name) do
-            create(context, name, should)
+            create(context, name_hash, should)
           end
         elsif is[:ensure].to_s == 'present' && should[:ensure].to_s == 'present'
           context.updating(name) do
-            update(context, name, should)
+            update(context, name_hash, should)
           end
         elsif is[:ensure].to_s == 'present' && should[:ensure].to_s == 'absent'
           context.deleting(name) do
-            delete(context, name)
+            delete(context, name_hash)
           end
         end
       end

data/lib/puppet/resource_api/version.rb

@@ -1,5 +1,5 @@
 module Puppet
   module ResourceApi
-    VERSION = '1.5.0'.freeze
+    VERSION = '1.6.0'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puppet-resource_api
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.6.0
 platform: ruby
 authors:
 - David Schmitt
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-09-12 00:00:00.000000000 Z
+date: 2018-09-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hocon
@@ -82,7 +82,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
 summary: This library provides a simple way to write new native resources for puppet.