Add api_paste type/provider for magnum

Add magnum_api_paste_ini type/provider for magnum.
Also add ability to custom options to api_paste.ini in config.pp.
Add and update related unit tests.
Closes-Bug:1483371

Change-Id: I02ca8e8486b68009660c98ace943e6c0bf3dd9ea

lib/puppet/provider/magnum_api_paste_ini/ini_setting.rb

@@ -0,0 +1,27 @@
+Puppet::Type.type(:magnum_api_paste_ini).provide(
+  :ini_setting,
+  :parent => Puppet::Type.type(:ini_setting).provider(:ruby)
+) do
+
+  def section
+    resource[:name].split('/', 2).first
+  end
+
+  def setting
+    resource[:name].split('/', 2).last
+  end
+
+  def separator
+    '='
+  end
+
+  def self.file_path
+    '/etc/magnum/api-paste.ini'
+  end
+
+  # added for backwards compatibility with older versions of inifile
+  def file_path
+    self.class.file_path
+  end
+
+end

lib/puppet/type/magnum_api_paste_ini.rb

@@ -0,0 +1,52 @@
+Puppet::Type.newtype(:magnum_api_paste_ini) do
+
+  ensurable
+
+  newparam(:name, :namevar => true) do
+    desc 'Section/setting name to manage from /etc/magnum/api-paste.ini'
+    newvalues(/\S+\/\S+/)
+  end
+
+  newproperty(:value) do
+    desc 'The value of the setting to be defined.'
+    munge do |value|
+      value = value.to_s.strip
+      value.capitalize! if value =~ /^(true|false)$/i
+      value
+    end
+
+    def is_to_s( currentvalue )
+      if resource.secret?
+        return '[old secret redacted]'
+      else
+        return currentvalue
+      end
+    end
+
+    def should_to_s( newvalue )
+      if resource.secret?
+        return '[new secret redacted]'
+      else
+        return newvalue
+      end
+    end
+  end
+
+  newparam(:secret, :boolean => true) do
+    desc 'Whether to hide the value from Puppet logs. Defaults to `false`.'
+
+    newvalues(:true, :false)
+
+    defaultto false
+  end
+
+  newparam(:ensure_absent_val) do
+    desc 'A value that is specified as the value property will behave as if ensure => absent was specified'
+    defaultto('<SERVICE DEFAULT>')
+  end
+
+  autorequire(:package) do
+    'magnum-common'
+  end
+
+end

manifests/config.pp

@@ -17,14 +17,20 @@
 #     DEFAULT/bar:
 #       value: barValue
 #
+# [*magnum_api_paste_ini*]
+#   (optional) Allow configuration of /etc/magnum/api-paste.ini options.
+#
 #   NOTE: The configuration MUST NOT be already handled by this module
 #   or Puppet catalog compilation will fail with duplicate resources.
 #
 class magnum::config (
-  $magnum_config = {},
+  $magnum_config        = {},
+  $magnum_api_paste_ini = {},
 ) {
 
   validate_hash($magnum_config)
+  validate_hash($magnum_api_paste_ini)
 
   create_resources('magnum_config', $magnum_config)
+  create_resources('magnum_api_paste_ini', $magnum_api_paste_ini)
 }

spec/classes/magnum_config_spec.rb

@@ -21,6 +21,18 @@ describe 'magnum::config' do
     end
   end
 
+  shared_examples_for 'magnum_api_paste_ini' do
+    let :params do
+      { :magnum_api_paste_ini => config_hash }
+    end
+
+    it 'configures arbitrary magnum-config configurations' do
+      is_expected.to contain_magnum_api_paste_ini('DEFAULT/foo').with_value('fooValue')
+      is_expected.to contain_magnum_api_paste_ini('DEFAULT/bar').with_value('barValue')
+      is_expected.to contain_magnum_api_paste_ini('DEFAULT/baz').with_ensure('absent')
+    end
+  end
+
   on_supported_os({
     :supported_os   => OSDefaults.get_supported_os
   }).each do |os,facts|
@@ -30,6 +42,7 @@ describe 'magnum::config' do
       end
 
       it_configures 'magnum_config'
+      it_configures 'magnum_api_paste_ini'
     end
   end
 end

spec/unit/provider/magnum_api_paste_ini/ini_setting_spec.rb

@@ -0,0 +1,29 @@
+#
+# these tests are a little concerning b/c they are hacking around the
+# modulepath, so these tests will not catch issues that may eventually arise
+# related to loading these plugins.
+# I could not, for the life of me, figure out how to programatcally set the modulepath
+$LOAD_PATH.push(
+  File.join(
+    File.dirname(__FILE__),
+    '..',
+    '..',
+    '..',
+    'fixtures',
+    'modules',
+    'inifile',
+    'lib')
+)
+require 'spec_helper'
+provider_class = Puppet::Type.type(:magnum_api_paste_ini).provider(:ini_setting)
+describe provider_class do
+
+  it 'should allow setting to be set explicitly' do
+    resource = Puppet::Type::Magnum_api_paste_ini.new(
+      {:name => 'dude/foo', :value => 'bar'}
+    )
+    provider = provider_class.new(resource)
+    expect(provider.section).to eq('dude')
+    expect(provider.setting).to eq('foo')
+  end
+end

spec/unit/type/magnum_api_paste_ini_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+# this hack is required for now to ensure that the path is set up correctly
+# to retrive the parent provider
+$LOAD_PATH.push(
+  File.join(
+    File.dirname(__FILE__),
+    '..',
+    '..',
+    'fixtures',
+    'modules',
+    'inifile',
+    'lib')
+)
+require 'puppet/type/magnum_api_paste_ini'
+describe 'Puppet::Type.type(:magnum_api_paste_ini)' do
+  before :each do
+    @magnum_api_paste_ini = Puppet::Type.type(:magnum_api_paste_ini).new(:name => 'DEFAULT/foo', :value => 'bar')
+  end
+  it 'should accept a valid value' do
+    @magnum_api_paste_ini[:value] = 'bar'
+    expect(@magnum_api_paste_ini[:value]).to eq('bar')
+  end
+
+  it 'should autorequire the package that install the file' do
+    catalog = Puppet::Resource::Catalog.new
+    package = Puppet::Type.type(:package).new(:name => 'magnum-common')
+    catalog.add_resource package, @magnum_api_paste_ini
+    dependency = @magnum_api_paste_ini.autorequire
+    expect(dependency.size).to eq(1)
+    expect(dependency[0].target).to eq(@magnum_api_paste_ini)
+    expect(dependency[0].source).to eq(package)
+  end
+
+end