openstack/puppet-trove
Code Issues Proposed changes

Reflect provider change in puppet-openstacklib

Browse Source 
With the creation of the new openstack_config provider, some processing
that was done in trove_config has been centralized in
openstack_config.

The same apply for trove_conductor_config, trove_guestagent_config and
trove_taskmanager_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 :

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

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

That means that all the current :

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

can be removed in favor of :

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

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

Change-Id: I44472b107c951d22932c533031f68aa67a5f2e18
Depends-On: I0eeebde3aac2662cc7e69bfad7f8d2481463a218
This commit is contained in:
Yanis Guenane
2015-08-06 13:06:40 +02:00
parent 27313c16bc
commit c8527beace
12 changed files with 183 additions and 90 deletions
Download Patch File Download Diff File Expand all files Collapse all files

114
README.md
View File

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

19
lib/puppet/provider/trove_api_paste_ini/ini_setting.rb
View File

@@ -1,27 +1,10 @@
Puppet::Type.type(:trove_api_paste_ini).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/trove/api-paste.ini'
end
# added for backwards compatibility with older versions of inifile
def file_path
self.class.file_path
end
end

19
lib/puppet/provider/trove_conductor_config/ini_setting.rb
View File

@@ -1,27 +1,10 @@
Puppet::Type.type(:trove_conductor_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/trove/trove-conductor.conf'
end
# added for backwards compatibility with older versions of inifile
def file_path
self.class.file_path
end
end

19
lib/puppet/provider/trove_config/ini_setting.rb
View File

@@ -1,27 +1,10 @@
Puppet::Type.type(:trove_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/trove/trove.conf'
end
# added for backwards compatibility with older versions of inifile
def file_path
self.class.file_path
end
end

19
lib/puppet/provider/trove_guestagent_config/ini_setting.rb
View File

@@ -1,27 +1,10 @@
Puppet::Type.type(:trove_guestagent_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/trove/trove-guestagent.conf'
end
# added for backwards compatibility with older versions of inifile
def file_path
self.class.file_path
end
end

19
lib/puppet/provider/trove_taskmanager_config/ini_setting.rb
View File

@@ -1,27 +1,10 @@
Puppet::Type.type(:trove_taskmanager_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/trove/trove-taskmanager.conf'
end
# added for backwards compatibility with older versions of inifile
def file_path
self.class.file_path
end
end

6
lib/puppet/type/trove_api_paste_ini.rb
View File

@@ -39,4 +39,10 @@ Puppet::Type.newtype(:trove_api_paste_ini) 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
end

7
lib/puppet/type/trove_conductor_config.rb
View File

@@ -14,6 +14,7 @@ Puppet::Type.newtype(:trove_conductor_config) do
value.capitalize! if value =~ /^(true|false)$/i
value
end
newvalues(/^[\S ]*$/)
def is_to_s( currentvalue )
if resource.secret?
@@ -39,4 +40,10 @@ Puppet::Type.newtype(:trove_conductor_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
end

7
lib/puppet/type/trove_config.rb
View File

@@ -14,6 +14,7 @@ Puppet::Type.newtype(:trove_config) do
value.capitalize! if value =~ /^(true|false)$/i
value
end
newvalues(/^[\S ]*$/)
def is_to_s( currentvalue )
if resource.secret?
@@ -39,4 +40,10 @@ Puppet::Type.newtype(:trove_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
end

7
lib/puppet/type/trove_guestagent_config.rb
View File

@@ -14,6 +14,7 @@ Puppet::Type.newtype(:trove_guestagent_config) do
value.capitalize! if value =~ /^(true|false)$/i
value
end
newvalues(/^[\S ]*$/)
def is_to_s( currentvalue )
if resource.secret?
@@ -39,4 +40,10 @@ Puppet::Type.newtype(:trove_guestagent_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
end

7
lib/puppet/type/trove_taskmanager_config.rb
View File

@@ -14,6 +14,7 @@ Puppet::Type.newtype(:trove_taskmanager_config) do
value.capitalize! if value =~ /^(true|false)$/i
value
end
newvalues(/^[\S ]*$/)
def is_to_s( currentvalue )
if resource.secret?
@@ -39,4 +40,10 @@ Puppet::Type.newtype(:trove_taskmanager_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
end

30
spec/unit/provider/trove_config/ini_setting_spec.rb
View File

@@ -13,6 +13,17 @@ $LOAD_PATH.push(
'inifile',
'lib')
)
$LOAD_PATH.push(
File.join(
File.dirname(__FILE__),
'..',
'..',
'..',
'fixtures',
'modules',
'openstacklib',
'lib')
)
require 'spec_helper'
provider_class = Puppet::Type.type(:trove_config).provider(:ini_setting)
describe provider_class do
@@ -34,4 +45,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::Trove_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::Trove_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