Reflect provider change in puppet-openstacklib

With the creation of the new openstack_config provider, some processing
that was done in designate_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 :

designate_config { 'DEFAULT/foo' : value => 'bar' } # will work as usual

designate_config { 'DEFAULT/foo' : value => '<SERVICE DEFAULT>' } # will mean absent

That means that all the current :

if $myvar {
  designate_config { 'DEFAULT/foo' : value => $myvar }
} else {
  designate_config { 'DEFAULT/foo' : ensure => absent }
}

can be removed in favor of :

designate_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 :

designate_config { 'DEFAULT/foo' : value => '<SERVICE DEFAULT>',
ensure_absent_val => 'foo' }

Change-Id: I16873c60bfce5b2f432f034755b7bfa3f1383dc5
Depends-On: I0eeebde3aac2662cc7e69bfad7f8d2481463a218
This commit is contained in:
Yanis Guenane 2015-08-06 13:05:36 +02:00
parent 4f7c34a6a4
commit aa4184a043
7 changed files with 128 additions and 27 deletions

View File

@ -36,6 +36,36 @@ Implementation
designate is a combination of Puppet manifest and ruby code to delivery configuration and extra functionality through types and providers. designate is a combination of Puppet manifest and ruby code to delivery configuration and extra functionality through types and providers.
### Types
#### designate_config
The `designate_config` provider is a children of the ini_setting provider. It allows one to write an entry in the `/etc/designate/designate.conf` file.
```puppet
designate_config { 'DEFAULT/verbose' :
value => true,
}
```
This will write `verbose=true` in the `[DEFAULT]` section.
##### name
Section/setting name to manage from `designate.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 Limitations
----------- -----------

View File

@ -1,20 +1,8 @@
Puppet::Type.type(:designate_api_paste_ini).provide( Puppet::Type.type(:designate_api_paste_ini).provide(
:ini_setting, :ini_setting,
:parent => Puppet::Type.type(:ini_setting).provider(:ruby) :parent => Puppet::Type.type(:openstack_config).provider(:ini_setting)
) do ) do
def section
resource[:name].split('/', 2).first
end
def setting
resource[:name].split('/', 2).last
end
def separator
'='
end
def self.file_path def self.file_path
'/etc/designate/api-paste.ini' '/etc/designate/api-paste.ini'
end end

View File

@ -1,21 +1,9 @@
Puppet::Type.type(:designate_config).provide( Puppet::Type.type(:designate_config).provide(
:ini_setting, :ini_setting,
:parent => Puppet::Type.type(:ini_setting).provider(:ruby) :parent => Puppet::Type.type(:openstack_config).provider(:ini_setting)
) do ) do
def section def self.file_path
resource[:name].split('/', 2).first
end
def setting
resource[:name].split('/', 2).last
end
def separator
'='
end
def file_path
'/etc/designate/designate.conf' '/etc/designate/designate.conf'
end end

View File

@ -40,6 +40,12 @@ Puppet::Type.newtype(:designate_api_paste_ini) do
defaultto false defaultto false
end 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 autorequire(:package) do
'designate-common' 'designate-common'
end end

View File

@ -41,6 +41,11 @@ Puppet::Type.newtype(:designate_config) do
defaultto false defaultto false
end 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 autorequire(:package) do
'designate-common' 'designate-common'
end end

View File

@ -0,0 +1,55 @@
require 'spec_helper_acceptance'
describe 'basic designate_config resource' do
context 'default parameters' do
it 'should work with no errors' do
pp= <<-EOS
Exec { logoutput => 'on_failure' }
File <||> -> Designate_config <||>
file { '/etc/designate' :
ensure => directory,
}
file { '/etc/designate/designate.conf' :
ensure => file,
}
designate_config { 'DEFAULT/thisshouldexist' :
value => 'foo',
}
designate_config { 'DEFAULT/thisshouldnotexist' :
value => '<SERVICE DEFAULT>',
}
designate_config { 'DEFAULT/thisshouldexist2' :
value => '<SERVICE DEFAULT>',
ensure_absent_val => 'toto',
}
designate_config { 'DEFAULT/thisshouldnotexist2' :
value => 'toto',
ensure_absent_val => 'toto',
}
EOS
# Run it twice and test for idempotency
apply_manifest(pp, :catch_failures => true)
apply_manifest(pp, :catch_changes => true)
end
describe file('/etc/designate/designate.conf') do
it { should exist }
it { should contain('thisshouldexist=foo') }
it { should contain('thisshouldexist2=<SERVICE DEFAULT>') }
its(:content) { should_not match /thisshouldnotexist/ }
end
end
end

View File

@ -14,6 +14,17 @@ $LOAD_PATH.push(
'inifile', 'inifile',
'lib') 'lib')
) )
$LOAD_PATH.push(
File.join(
File.dirname(__FILE__),
'..',
'..',
'..',
'fixtures',
'modules',
'openstacklib',
'lib')
)
require 'spec_helper' require 'spec_helper'
provider_class = Puppet::Type.type(:designate_config).provider(:ini_setting) provider_class = Puppet::Type.type(:designate_config).provider(:ini_setting)
describe provider_class do describe provider_class do
@ -35,4 +46,22 @@ describe provider_class do
expect(provider.section).to eq('boo') expect(provider.section).to eq('boo')
expect(provider.setting).to eq('zoo') expect(provider.setting).to eq('zoo')
end end
it 'should ensure absent when <SERVICE DEFAULT> is specified as a value' do
resource = Puppet::Type::Designate_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::Designate_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 end