(PDK-506) Resource API-based provider template

config_defaults.yml

@@ -405,6 +405,7 @@ Rakefile:
  RSpec/LetSetup:
  RSpec/MessageChain:
  RSpec/MessageSpies:
+ EnforcedStyle: receive
  RSpec/MultipleDescribes:
  RSpec/NamedSubject:
  RSpec/OverwritingSetup:

moduleroot/.rubocop.yml.erb

@@ -41,9 +41,13 @@ raise "no defaults for rubocop #{version} available" unless File.exist?(path)
 require 'yaml'
 default_enabled_cops = YAML.load(File.read(path))[:default_enabled_cops]
 
-enabled_cops = (profile['enabled_cops'] || {}).keys
+cop_configs = (profile['enabled_cops'] || {})
+
+enabled_cops = cop_configs.keys
 enabled_cops = default_enabled_cops if enabled_cops == 'all'
-(enabled_cops - default_enabled_cops).sort.each { |c| configs[c] ||= {}; configs[c]['Enabled'] = true }
-(default_enabled_cops - enabled_cops).sort.each { |c| configs[c] ||= {}; configs[c]['Enabled'] = false }
+
+(enabled_cops & default_enabled_cops).sort.each { |c| configs[c] ||= cop_configs[c] if cop_configs[c] }
+(enabled_cops - default_enabled_cops).sort.each { |c| configs[c] ||= cop_configs[c] || {}; configs[c]['Enabled'] = true }
+(default_enabled_cops - enabled_cops).sort.each { |c| configs[c] ||= cop_configs[c] || {}; configs[c]['Enabled'] = false }
 -%>
 <%= YAML.dump(configs) -%>

object_templates/provider.erb

@@ -0,0 +1,21 @@
+require 'puppet/resource_api'
+
+Puppet::ResourceApi.register_type(
+ name: '<%= name %>',
+ docs: <<-EOS,
+ This type provides Puppet with the capabilities to manage ...
+ EOS
+ features: [],
+ attributes: {
+ ensure: {
+ type: 'Enum[present, absent]',
+ desc: 'Whether this resource should be present or absent on the target system.',
+ default: 'present',
+ },
+ name: {
+ type: 'String',
+ desc: 'The name of the resource you want to manage.',
+ behaviour: :namevar,
+ },
+ },
+)

object_templates/provider_addon.erb

@@ -0,0 +1,35 @@
+require 'puppet/resource_api'
+require 'puppet/resource_api/command'
+require 'puppet/resource_api/simple_provider'
+
+# Implementation for the <%= name %> type using the Resource API.
+class Puppet::Provider::<%= provider_class %>::<%= provider_class %> < Puppet::ResourceApi::SimpleProvider
+ def initialize
+ @echo_cmd = Puppet::ResourceApi::Command.new 'echo'
+ end
+
+ def get(context)
+ # nonsensical resource emulation for this example
+ @echo_cmd.run(context).stdout.split('').each do |c|
+ {
+ name: c,
+ ensure: :present,
+ }
+ end || []
+ end
+
+ def create(context, name, should)
+ # nonsensical resource emulation for this example
+ @echo_cmd.run(context, "create: #{name}, #{should.inspect}")
+ end
+
+ def update(context, name, should)
+ # nonsensical resource emulation for this example
+ @echo_cmd.run(context, "update: #{name}, #{should.inspect}")
+ end
+
+ def delete(context, name)
+ # nonsensical resource emulation for this example
+ @echo_cmd.run(context, "delete: #{name}")
+ end
+end

object_templates/provider_spec.erb

@@ -0,0 +1,84 @@
+require 'spec_helper'
+
+# TODO: needs some cleanup/helper to avoid this misery
+module Puppet::Provider::<%= provider_class %>; end
+require 'puppet/provider/<%= name %>/<%= name %>'
+
+RSpec.describe Puppet::Provider::<%= provider_class %>::<%= provider_class %> do
+ subject(:provider) { described_class.new }
+
+ let(:context) { instance_double('Puppet::ResourceApi::BaseContext', 'context') }
+ let(:echo_cmd) { instance_double('Puppet::ResourceApi::Command', 'echo_cmd') }
+
+ before(:each) do
+ allow(context).to receive(:is_a?).with(Puppet::ResourceApi::BaseContext).and_return(true)
+ allow(Puppet::ResourceApi::Command).to receive(:new).with('echo').and_return(echo_cmd)
+
+ # the provider should never call into the system on its own
+ expect(provider).not_to receive(:`) # rubocop:disable RSpec/ExpectInHook
+ end
+
+ describe '#get' do
+ before(:each) do
+ # fake output for the tests
+ allow(echo_cmd).to receive(:run)
+ .with(context)
+ .and_return(OpenStruct.new(stdout: resources))
+ end
+
+ context 'with no resources on the system' do
+ let(:resources) { '' }
+
+ it 'returns an empty list' do
+ expect(provider.get(context)).to eq []
+ end
+ end
+
+ context 'with some resources on the system' do
+ let(:resources) { 'abc' }
+
+ it 'processes resources' do
+ expect(provider.get(context)).to eq %w[a b c]
+ end
+ end
+ end
+
+ describe 'create(context, name, should)' do
+ it 'creates the resource' do
+ allow(context).to receive(:creating).and_yield
+ expect(echo_cmd).to receive(:run)
+ .with(context, 'create: a, {:name=>"a", :ensure=>"present"}')
+
+ provider.set(context, a: {
+ is: { name: 'a', ensure: 'absent' },
+ should: { name: 'a', ensure: 'present' },
+ })
+ end
+ end
+
+ describe 'update(context, name, should)' do
+ it 'updates the resource' do
+ allow(context).to receive(:updating).and_yield
+ expect(echo_cmd).to receive(:run)
+ .with(context, 'update: a, {:name=>"a", :ensure=>"present"}')
+
+ provider.set(context, a: {
+ is: { name: 'a', ensure: 'present' },
+ should: { name: 'a', ensure: 'present' },
+ })
+ end
+ end
+
+ describe 'delete(context, name, should)' do
+ it 'deletes the resource' do
+ allow(context).to receive(:deleting).and_yield
+ expect(echo_cmd).to receive(:run)
+ .with(context, 'delete: a')
+
+ provider.set(context, a: {
+ is: { name: 'a', ensure: 'present' },
+ should: { name: 'a', ensure: 'absent' },
+ })
+ end
+ end
+end