From e08734af5a38cb9ad4bc2323104a1a8a76019bb8 Mon Sep 17 00:00:00 2001 From: Alex Cline Date: Fri, 3 May 2013 15:47:27 -0400 Subject: (#20548) Allow an array of resource titles to be passed into the ensure_resource function This patch allows an array of resource titles to be passed into the ensure_resource function. Each item in the array will be checked for existence and will be created if it doesn't already exist. --- README.markdown | 5 ++++ lib/puppet/parser/functions/ensure_resource.rb | 22 +++++++++++----- spec/functions/ensure_resource_spec.rb | 35 ++++++++++++++++++++++++++ 3 files changed, 56 insertions(+), 6 deletions(-) diff --git a/README.markdown b/README.markdown index 84cd08e..7b45b17 100644 --- a/README.markdown +++ b/README.markdown @@ -243,6 +243,11 @@ If the resource already exists but does not match the specified parameters, this function will attempt to recreate the resource leading to a duplicate resource definition error. +An array of resources can also be passed in and each will be created with +the type and parameters specified if it doesn't already exist. + + ensure_resource('user', ['dan','alex'], {'ensure' => 'present'}) + - *Type*: statement diff --git a/lib/puppet/parser/functions/ensure_resource.rb b/lib/puppet/parser/functions/ensure_resource.rb index fba2035..8ede967 100644 --- a/lib/puppet/parser/functions/ensure_resource.rb +++ b/lib/puppet/parser/functions/ensure_resource.rb @@ -19,17 +19,27 @@ If the resource already exists but does not match the specified parameters, this function will attempt to recreate the resource leading to a duplicate resource definition error. +An array of resources can also be passed in and each will be created with +the type and parameters specified if it doesn't already exist. + + ensure_resource('user', ['dan','alex'], {'ensure' => 'present'}) + ENDOFDOC ) do |vals| type, title, params = vals raise(ArgumentError, 'Must specify a type') unless type raise(ArgumentError, 'Must specify a title') unless title params ||= {} - Puppet::Parser::Functions.function(:defined_with_params) - if function_defined_with_params(["#{type}[#{title}]", params]) - Puppet.debug("Resource #{type}[#{title}] not created b/c it already exists") - else - Puppet::Parser::Functions.function(:create_resources) - function_create_resources([type.capitalize, { title => params }]) + + items = title.kind_of?(Array) ? title : [].push(title) + + items.each do |item| + Puppet::Parser::Functions.function(:defined_with_params) + if function_defined_with_params(["#{type}[#{item}]", params]) + Puppet.debug("Resource #{type}[#{item}] not created b/c it already exists") + else + Puppet::Parser::Functions.function(:create_resources) + function_create_resources([type.capitalize, { item => params }]) + end end end diff --git a/spec/functions/ensure_resource_spec.rb b/spec/functions/ensure_resource_spec.rb index 611666e..abd8719 100644 --- a/spec/functions/ensure_resource_spec.rb +++ b/spec/functions/ensure_resource_spec.rb @@ -37,4 +37,39 @@ describe 'ensure_resource' do ).and_raise_error(Puppet::Error) end end + + describe 'when an array of new resources are passed in' do + it do + should run.with_params('User', ['dan', 'alex'], {}) + compiler.catalog.resource('User[dan]').to_s.should == 'User[dan]' + compiler.catalog.resource('User[alex]').to_s.should == 'User[alex]' + end + end + + describe 'when an array of existing resources is compared against existing resources' do + let :pre_condition do + 'user { "dan": ensure => present; "alex": ensure => present }' + end + it do + should run.with_params('User', ['dan', 'alex'], {}) + compiler.catalog.resource('User[dan]').to_s.should == 'User[dan]' + compiler.catalog.resource('User[alex]').to_s.should == 'User[alex]' + end + end + + describe 'when compared against existing resources with attributes' do + let :pre_condition do + 'user { "dan": ensure => present; "alex": ensure => present }' + end + it do + # These should not fail + should run.with_params('User', ['dan', 'alex'], {}) + should run.with_params('User', ['dan', 'alex'], '') + should run.with_params('User', ['dan', 'alex'], {'ensure' => 'present'}) + # This should fail + should run.with_params('User', ['dan', 'alex'], + {'ensure' => 'absent'} + ).and_raise_error(Puppet::Error) + end + end end -- cgit v1.2.3 From de253db5648c0aa15e7fcead9755488e9d8642fc Mon Sep 17 00:00:00 2001 From: Alex Cline Date: Mon, 6 May 2013 13:52:57 -0400 Subject: Changed str-to-array conversion and removed abbreviation. --- lib/puppet/parser/functions/ensure_resource.rb | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/lib/puppet/parser/functions/ensure_resource.rb b/lib/puppet/parser/functions/ensure_resource.rb index 8ede967..36c423a 100644 --- a/lib/puppet/parser/functions/ensure_resource.rb +++ b/lib/puppet/parser/functions/ensure_resource.rb @@ -31,12 +31,12 @@ ENDOFDOC raise(ArgumentError, 'Must specify a title') unless title params ||= {} - items = title.kind_of?(Array) ? title : [].push(title) + items = title.kind_of?(Array) ? title : [title] items.each do |item| Puppet::Parser::Functions.function(:defined_with_params) if function_defined_with_params(["#{type}[#{item}]", params]) - Puppet.debug("Resource #{type}[#{item}] not created b/c it already exists") + Puppet.debug("Resource #{type}[#{item}] not created because it already exists") else Puppet::Parser::Functions.function(:create_resources) function_create_resources([type.capitalize, { item => params }]) -- cgit v1.2.3 From b33cc24a3ce4da19ae89c59985c809a5790de291 Mon Sep 17 00:00:00 2001 From: Alex Cline Date: Mon, 6 May 2013 15:30:35 -0400 Subject: Refactor ensure_resource expectations This splits out the ensure_resource expectations into separate blocks for clarity. Per adrienthebo's recommendation. --- spec/functions/ensure_resource_spec.rb | 55 ++++++++++++++-------------------- 1 file changed, 22 insertions(+), 33 deletions(-) diff --git a/spec/functions/ensure_resource_spec.rb b/spec/functions/ensure_resource_spec.rb index abd8719..2e8aefc 100644 --- a/spec/functions/ensure_resource_spec.rb +++ b/spec/functions/ensure_resource_spec.rb @@ -4,17 +4,16 @@ require 'spec_helper' require 'rspec-puppet' describe 'ensure_resource' do describe 'when a type or title is not specified' do - it do - should run.with_params().and_raise_error(ArgumentError) - should run.with_params(['type']).and_raise_error(ArgumentError) - end + it { should run.with_params().and_raise_error(ArgumentError) } + it { should run.with_params(['type']).and_raise_error(ArgumentError) } end + describe 'when compared against a resource with no attributes' do let :pre_condition do 'user { "dan": }' end - it do - should run.with_params('user', 'dan', {}) + it "should contain the the ensured resources" do + subject.should run.with_params('user', 'dan', {}) compiler.catalog.resource('User[dan]').to_s.should == 'User[dan]' end end @@ -23,24 +22,18 @@ describe 'ensure_resource' do let :pre_condition do 'user { "dan": ensure => present, shell => "/bin/csh", managehome => false}' end - it do - # these first three should not fail - should run.with_params('User', 'dan', {}) - should run.with_params('User', 'dan', '') - should run.with_params('User', 'dan', {'ensure' => 'present'}) - should run.with_params('User', 'dan', - {'ensure' => 'present', 'managehome' => false} - ) - # test that this fails - should run.with_params('User', 'dan', - {'ensure' => 'absent', 'managehome' => false} - ).and_raise_error(Puppet::Error) - end + # these first three should not fail + it { should run.with_params('User', 'dan', {}) } + it { should run.with_params('User', 'dan', '') } + it { should run.with_params('User', 'dan', {'ensure' => 'present'}) } + it { should run.with_params('User', 'dan', {'ensure' => 'present', 'managehome' => false}) } + # test that this fails + it { should run.with_params('User', 'dan', {'ensure' => 'absent', 'managehome' => false}).and_raise_error(Puppet::Error) } end describe 'when an array of new resources are passed in' do - it do - should run.with_params('User', ['dan', 'alex'], {}) + it "should contain the ensured resources" do + subject.should run.with_params('User', ['dan', 'alex'], {}) compiler.catalog.resource('User[dan]').to_s.should == 'User[dan]' compiler.catalog.resource('User[alex]').to_s.should == 'User[alex]' end @@ -50,8 +43,8 @@ describe 'ensure_resource' do let :pre_condition do 'user { "dan": ensure => present; "alex": ensure => present }' end - it do - should run.with_params('User', ['dan', 'alex'], {}) + it "should return the existing resources" do + subject.should run.with_params('User', ['dan', 'alex'], {}) compiler.catalog.resource('User[dan]').to_s.should == 'User[dan]' compiler.catalog.resource('User[alex]').to_s.should == 'User[alex]' end @@ -61,15 +54,11 @@ describe 'ensure_resource' do let :pre_condition do 'user { "dan": ensure => present; "alex": ensure => present }' end - it do - # These should not fail - should run.with_params('User', ['dan', 'alex'], {}) - should run.with_params('User', ['dan', 'alex'], '') - should run.with_params('User', ['dan', 'alex'], {'ensure' => 'present'}) - # This should fail - should run.with_params('User', ['dan', 'alex'], - {'ensure' => 'absent'} - ).and_raise_error(Puppet::Error) - end + # These should not fail + it { should run.with_params('User', ['dan', 'alex'], {}) } + it { should run.with_params('User', ['dan', 'alex'], '') } + it { should run.with_params('User', ['dan', 'alex'], {'ensure' => 'present'}) } + # This should fail + it { should run.with_params('User', ['dan', 'alex'], {'ensure' => 'absent'}).and_raise_error(Puppet::Error) } end end -- cgit v1.2.3 From d38bce0488dd70a6f8a8a2c9b91a98a231f28f02 Mon Sep 17 00:00:00 2001 From: Alex Cline Date: Mon, 6 May 2013 16:16:38 -0400 Subject: Terser method of string to array conversion courtesy of ethooz. --- lib/puppet/parser/functions/ensure_resource.rb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/puppet/parser/functions/ensure_resource.rb b/lib/puppet/parser/functions/ensure_resource.rb index 36c423a..a9a1733 100644 --- a/lib/puppet/parser/functions/ensure_resource.rb +++ b/lib/puppet/parser/functions/ensure_resource.rb @@ -31,7 +31,7 @@ ENDOFDOC raise(ArgumentError, 'Must specify a title') unless title params ||= {} - items = title.kind_of?(Array) ? title : [title] + items = [title].flatten items.each do |item| Puppet::Parser::Functions.function(:defined_with_params) -- cgit v1.2.3