From b554d30aaf7b08d928183d5fab9fe4e8319d492f Mon Sep 17 00:00:00 2001 From: Yanis Guenane <yguenane@redhat.com> Date: Thu, 6 Aug 2015 13:05:28 +0200 Subject: [PATCH] Reflect provider change in puppet-openstacklib With the creation of the new openstack_config provider, some processing that was done in cinder_config has been centralized in openstack_config. Impacted methods are : * section * setting * separator Also, this commit adds the fact that, when passing a specific string (ensure_absent_val) the provider will behave as if ensure => absent was specified. '<SERVICE DEFAULT>' is the default value for ensure_absent_val. The use case is the following : cinder_config { 'DEFAULT/foo' : value => 'bar' } # will work as usual cinder_config { 'DEFAULT/foo' : value => '<SERVICE DEFAULT>' } # will mean absent That means that all the current : if $myvar { cinder_config { 'DEFAULT/foo' : value => $myvar } } else { cinder_config { 'DEFAULT/foo' : ensure => absent } } can be removed in favor of : cinder_config { 'DEFAULT/foo' : value => $myvar } If for any reason '<SERVICE DEFAULT>' turns out to be a valid value for a specific parameter. One could by pass that doing the following : cinder_config { 'DEFAULT/foo' : value => '<SERVICE DEFAULT>', ensure_absent_val => 'foo' } Change-Id: I10931ea201b567ff6576fd3f87d05f2fd0816166 Depends-On: I0eeebde3aac2662cc7e69bfad7f8d2481463a218 --- README.md | 30 +++++++++++++++++++ .../provider/cinder_config/ini_setting.rb | 19 +----------- lib/puppet/type/cinder_config.rb | 8 ++++- .../cinder_config/ini_setting_spec.rb | 30 +++++++++++++++++++ 4 files changed, 68 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index d96970ea..559bebbc 100644 --- a/README.md +++ b/README.md @@ -157,6 +157,36 @@ Implementation cinder is a combination of Puppet manifest and ruby code to delivery configuration and extra functionality through types and providers. +### Types + +#### cinder_config + +The `cinder_config` provider is a children of the ini_setting provider. It allows one to write an entry in the `/etc/cinder/cinder.conf` file. + +```puppet +cinder_config { 'DEFAULT/verbose' : + value => true, +} +``` + +This will write `verbose=true` in the `[DEFAULT]` section. + +##### name + +Section/setting name to manage from `cinder.conf` + +##### value + +The value of the setting to be defined. + +##### secret + +Whether to hide the value from Puppet logs. Defaults to `false`. + +##### ensure_absent_val + +If value is equal to ensure_absent_val then the resource will behave as if `ensure => absent` was specified. Defaults to `<SERVICE DEFAULT>` + Limitations ------------ diff --git a/lib/puppet/provider/cinder_config/ini_setting.rb b/lib/puppet/provider/cinder_config/ini_setting.rb index 6dcd9559..749fb16e 100644 --- a/lib/puppet/provider/cinder_config/ini_setting.rb +++ b/lib/puppet/provider/cinder_config/ini_setting.rb @@ -1,27 +1,10 @@ Puppet::Type.type(:cinder_config).provide( :ini_setting, - :parent => Puppet::Type.type(:ini_setting).provider(:ruby) + :parent => Puppet::Type.type(:openstack_config).provider(:ini_setting) ) 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/cinder/cinder.conf' end - # added for backwards compatibility with older versions of inifile - def file_path - self.class.file_path - end - end diff --git a/lib/puppet/type/cinder_config.rb b/lib/puppet/type/cinder_config.rb index 6da9baf9..3eb3a1f9 100644 --- a/lib/puppet/type/cinder_config.rb +++ b/lib/puppet/type/cinder_config.rb @@ -3,7 +3,7 @@ Puppet::Type.newtype(:cinder_config) do ensurable newparam(:name, :namevar => true) do - desc 'Section/setting name to manage from /etc/cinder/cinder.conf' + desc 'Section/setting name to manage from cinder.conf' newvalues(/\S+\/\S+/) end @@ -14,6 +14,7 @@ Puppet::Type.newtype(:cinder_config) do value.capitalize! if value =~ /^(true|false)$/i value end + newvalues(/^[\S ]*$/) def is_to_s( currentvalue ) if resource.secret? @@ -40,6 +41,11 @@ Puppet::Type.newtype(:cinder_config) do 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 'cinder' end diff --git a/spec/unit/provider/cinder_config/ini_setting_spec.rb b/spec/unit/provider/cinder_config/ini_setting_spec.rb index 6aad3845..b4ebf99d 100644 --- a/spec/unit/provider/cinder_config/ini_setting_spec.rb +++ b/spec/unit/provider/cinder_config/ini_setting_spec.rb @@ -9,6 +9,17 @@ $LOAD_PATH.push( 'inifile', 'lib') ) +$LOAD_PATH.push( + File.join( + File.dirname(__FILE__), + '..', + '..', + '..', + 'fixtures', + 'modules', + 'openstacklib', + 'lib') +) require 'spec_helper' @@ -39,4 +50,23 @@ describe provider_class do expect(provider.section).to eq('dude') expect(provider.setting).to eq('foo') end + + it 'should ensure absent when <SERVICE DEFAULT> is specified as a value' do + resource = Puppet::Type::Cinder_config.new( + {:name => 'dude/foo', :value => '<SERVICE DEFAULT>'} + ) + provider = provider_class.new(resource) + provider.exists? + expect(resource[:ensure]).to eq :absent + end + + it 'should ensure absent when value matches ensure_absent_val' do + resource = Puppet::Type::Cinder_config.new( + {:name => 'dude/foo', :value => 'foo', :ensure_absent_val => 'foo' } + ) + provider = provider_class.new(resource) + provider.exists? + expect(resource[:ensure]).to eq :absent + end + end