From a7185157223159a2275b854df61c101a45f85d9d Mon Sep 17 00:00:00 2001 From: Dmitry Ilyin Date: Fri, 22 Apr 2016 00:33:57 +0300 Subject: [PATCH] Add types, providers and unit tests Change-Id: I77a785667d99cfb841bf9b48d946278a530b47b5 --- .../ec2api_api_paste_ini/ini_setting.rb | 15 ++++ .../provider/ec2api_config/ini_setting.rb | 9 +- lib/puppet/type/ec2api_api_paste_ini.rb | 56 ++++++++++++ .../ec2api_api_paste_ini/ini_setting_spec.rb | 69 ++++++++++++++ .../ec2api_config/ini_setting_spec.rb | 1 + spec/unit/type/ec2api_api_paste_ini_spec.rb | 90 +++++++++++++++++++ spec/unit/type/ec2api_config_spec.rb | 32 ++++++- 7 files changed, 267 insertions(+), 5 deletions(-) create mode 100644 lib/puppet/provider/ec2api_api_paste_ini/ini_setting.rb create mode 100644 lib/puppet/type/ec2api_api_paste_ini.rb create mode 100644 spec/unit/provider/ec2api_api_paste_ini/ini_setting_spec.rb create mode 100644 spec/unit/type/ec2api_api_paste_ini_spec.rb diff --git a/lib/puppet/provider/ec2api_api_paste_ini/ini_setting.rb b/lib/puppet/provider/ec2api_api_paste_ini/ini_setting.rb new file mode 100644 index 0000000..a281729 --- /dev/null +++ b/lib/puppet/provider/ec2api_api_paste_ini/ini_setting.rb @@ -0,0 +1,15 @@ +Puppet::Type.type(:ec2api_api_paste_ini).provide( + :ini_setting, + :parent => Puppet::Type.type(:openstack_config).provider(:ini_setting) +) do + + def self.file_path + '/etc/ec2api/api-paste.ini' + end + + # added for backwards compatibility with older versions of inifile + def file_path + self.class.file_path + end + +end diff --git a/lib/puppet/provider/ec2api_config/ini_setting.rb b/lib/puppet/provider/ec2api_config/ini_setting.rb index f86aa2e..ce72c39 100644 --- a/lib/puppet/provider/ec2api_config/ini_setting.rb +++ b/lib/puppet/provider/ec2api_config/ini_setting.rb @@ -1,10 +1,15 @@ Puppet::Type.type(:ec2api_config).provide( - :ini_setting, - :parent => Puppet::Type.type(:openstack_config).provider(:ini_setting) + :ini_setting, + :parent => Puppet::Type.type(:openstack_config).provider(:ini_setting) ) do def self.file_path '/etc/ec2api/ec2api.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/ec2api_api_paste_ini.rb b/lib/puppet/type/ec2api_api_paste_ini.rb new file mode 100644 index 0000000..039005f --- /dev/null +++ b/lib/puppet/type/ec2api_api_paste_ini.rb @@ -0,0 +1,56 @@ +Puppet::Type.newtype(:ec2api_api_paste_ini) do + + ensurable do + defaultvalues + defaultto :present + end + + newparam(:name, :namevar => true) do + desc 'Section/setting name to manage from /etc/ec2api/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 + newvalues(/^[\S ]*$/) + + 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('') + end + + autorequire(:package) do + 'ec2api' + end + +end diff --git a/spec/unit/provider/ec2api_api_paste_ini/ini_setting_spec.rb b/spec/unit/provider/ec2api_api_paste_ini/ini_setting_spec.rb new file mode 100644 index 0000000..b858d57 --- /dev/null +++ b/spec/unit/provider/ec2api_api_paste_ini/ini_setting_spec.rb @@ -0,0 +1,69 @@ +# +# 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') +) +$LOAD_PATH.push( + File.join( + File.dirname(__FILE__), + '..', + '..', + '..', + 'fixtures', + 'modules', + 'openstacklib', + 'lib') +) + +require 'spec_helper' +provider_class = Puppet::Type.type(:ec2api_api_paste_ini).provider(:ini_setting) +describe provider_class do + + it 'should default to the default setting when no other one is specified' do + resource = Puppet::Type::Ec2api_api_paste_ini.new( + {:name => 'DEFAULT/foo', :value => 'bar'} + ) + provider = provider_class.new(resource) + expect(provider.section).to eq('DEFAULT') + expect(provider.setting).to eq('foo') + end + + it 'should allow setting to be set explicitly' do + resource = Puppet::Type::Ec2api_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 + + it 'should ensure absent when is specified as a value' do + resource = Puppet::Type::Ec2api_api_paste_ini.new( + {:name => 'dude/foo', :value => ''} + ) + 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::Ec2api_api_paste_ini.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 diff --git a/spec/unit/provider/ec2api_config/ini_setting_spec.rb b/spec/unit/provider/ec2api_config/ini_setting_spec.rb index b3b455f..ebec326 100644 --- a/spec/unit/provider/ec2api_config/ini_setting_spec.rb +++ b/spec/unit/provider/ec2api_config/ini_setting_spec.rb @@ -25,6 +25,7 @@ $LOAD_PATH.push( 'openstacklib', 'lib') ) + require 'spec_helper' provider_class = Puppet::Type.type(:ec2api_config).provider(:ini_setting) describe provider_class do diff --git a/spec/unit/type/ec2api_api_paste_ini_spec.rb b/spec/unit/type/ec2api_api_paste_ini_spec.rb new file mode 100644 index 0000000..12a2f99 --- /dev/null +++ b/spec/unit/type/ec2api_api_paste_ini_spec.rb @@ -0,0 +1,90 @@ +# +# 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') +) +$LOAD_PATH.push( + File.join( + File.dirname(__FILE__), + '..', + '..', + 'fixtures', + 'modules', + 'openstacklib', + 'lib') +) + +require 'spec_helper' +require 'puppet' + +describe Puppet::Type.type(:ec2api_api_paste_ini) do + before :each do + @ec2api_api_paste_ini = Puppet::Type.type(:ec2api_api_paste_ini).new(:name => 'DEFAULT/foo', :value => 'bar') + end + + it 'should require a name' do + expect { + Puppet::Type.type(:ec2api_api_paste_ini).new({}) + }.to raise_error(Puppet::Error, 'Title or name must be provided') + end + + it 'should not expect a name with whitespace' do + expect { + Puppet::Type.type(:ec2api_api_paste_ini).new(:name => 'f oo') + }.to raise_error(Puppet::Error, /Parameter name failed/) + end + + it 'should fail when there is no section' do + expect { + Puppet::Type.type(:ec2api_api_paste_ini).new(:name => 'foo') + }.to raise_error(Puppet::Error, /Parameter name failed/) + end + + it 'should not require a value when ensure is absent' do + Puppet::Type.type(:ec2api_api_paste_ini).new(:name => 'DEFAULT/foo', :ensure => :absent) + end + + it 'should accept a valid value' do + @ec2api_api_paste_ini[:value] = 'bar' + expect(@ec2api_api_paste_ini[:value]).to eq('bar') + end + + it 'should not accept a value with whitespace' do + @ec2api_api_paste_ini[:value] = 'b ar' + expect(@ec2api_api_paste_ini[:value]).to eq('b ar') + end + + it 'should accept valid ensure values' do + @ec2api_api_paste_ini[:ensure] = :present + expect(@ec2api_api_paste_ini[:ensure]).to eq(:present) + @ec2api_api_paste_ini[:ensure] = :absent + expect(@ec2api_api_paste_ini[:ensure]).to eq(:absent) + end + + it 'should not accept invalid ensure values' do + expect { + @ec2api_api_paste_ini[:ensure] = :latest + }.to raise_error(Puppet::Error, /Invalid value/) + end + + it 'should autorequire the package that install the file' do + catalog = Puppet::Resource::Catalog.new + package = Puppet::Type.type(:package).new(:name => 'ec2api') + catalog.add_resource package, @ec2api_api_paste_ini + dependency = @ec2api_api_paste_ini.autorequire + expect(dependency.size).to eq(1) + expect(dependency[0].target).to eq(@ec2api_api_paste_ini) + expect(dependency[0].source).to eq(package) + end + +end diff --git a/spec/unit/type/ec2api_config_spec.rb b/spec/unit/type/ec2api_config_spec.rb index fb83655..48eb7a4 100644 --- a/spec/unit/type/ec2api_config_spec.rb +++ b/spec/unit/type/ec2api_config_spec.rb @@ -1,6 +1,34 @@ require 'puppet' require 'puppet/type/ec2api_config' -describe 'Puppet::Type.type(:ec2api_config)' do +require 'spec_helper' + +# +# 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') +) +$LOAD_PATH.push( + File.join( + File.dirname(__FILE__), + '..', + '..', + 'fixtures', + 'modules', + 'openstacklib', + 'lib') +) + +describe Puppet::Type.type(:ec2api_config) do before :each do @ec2api_config = Puppet::Type.type(:ec2api_config).new(:name => 'DEFAULT/foo', :value => 'bar') end @@ -59,6 +87,4 @@ describe 'Puppet::Type.type(:ec2api_config)' do expect(dependency[0].target).to eq(@ec2api_config) expect(dependency[0].source).to eq(package) end - - end