From a0cb8cdee42125c7acd64f17af603a2fa9375863 Mon Sep 17 00:00:00 2001 From: Dan Bode Date: Tue, 7 Aug 2012 20:48:54 -0700 Subject: Add function ensure_resource and defined_with_params This commit adds 2 new functions with unit tests. defined_with_params works similarily to puppet's defined function, except it allows you to also specify a hash of params. defined_with_params will return true if a resource also exists that matches the specified type/title (just like with defined) as well as all of the specified params. ensure_resource is a function that basically combines defined_with_params with create_resources to conditionally create resources only if the specified resource (title, type, params) does not already exist. These functions are created to serve as an alternative to using defined as follows: if ! defined(Package['some_package']) { package { 'some_package': ensure => present, } The issue with this usage is that there is no guarentee about what parameters were set in the previous definition of the package that made its way into the catalog. ensure_resource could be used instead, as: ensure_resource('package', 'some_package', { 'ensure' => 'present' }) This will creat the package resources only if another resource does not exist with the specified parameters. --- lib/puppet/parser/functions/ensure_resource.rb | 28 ++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) create mode 100644 lib/puppet/parser/functions/ensure_resource.rb (limited to 'lib/puppet/parser/functions/ensure_resource.rb') diff --git a/lib/puppet/parser/functions/ensure_resource.rb b/lib/puppet/parser/functions/ensure_resource.rb new file mode 100644 index 0000000..8f9eadf --- /dev/null +++ b/lib/puppet/parser/functions/ensure_resource.rb @@ -0,0 +1,28 @@ +# Test whether a given class or definition is defined +require 'puppet/parser/functions' + +Puppet::Parser::Functions.newfunction(:ensure_resource, + :type => :statement, + :doc => <<-'ENDOFDOC' +Takes a resource type, title, and a list of attributes that describe a +resource. + + user { 'dan': + ensure => present, + } + +This example only creates the resource if it does not already exist: + + ensure_resource('user, 'dan', {'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 ||= {} + if function_defined_with_params(["#{type}[#{title}]", params]) + Puppet.debug("Resource #{type}[#{title}] does not need to be created b/c it already exists") + else + function_create_resources([type.capitalize, { title => params }]) + end +end -- cgit v1.2.3 From 97d327ae44820083ed8ad127930600422faf5031 Mon Sep 17 00:00:00 2001 From: Dan Bode Date: Mon, 13 Aug 2012 18:52:56 -0700 Subject: Add better docs about duplicate resource failures This commit adds better inline documentation explaining how replicate resource definitions can occur if the resource exists and does not have matching parameters. --- lib/puppet/parser/functions/ensure_resource.rb | 5 +++++ 1 file changed, 5 insertions(+) (limited to 'lib/puppet/parser/functions/ensure_resource.rb') diff --git a/lib/puppet/parser/functions/ensure_resource.rb b/lib/puppet/parser/functions/ensure_resource.rb index 8f9eadf..3205b9b 100644 --- a/lib/puppet/parser/functions/ensure_resource.rb +++ b/lib/puppet/parser/functions/ensure_resource.rb @@ -14,6 +14,11 @@ resource. This example only creates the resource if it does not already exist: ensure_resource('user, 'dan', {'ensure' => 'present' }) + +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. + ENDOFDOC ) do |vals| type, title, params = vals -- cgit v1.2.3 From 444393bf6b1e21da4e31f9037d17ea417b9b473b Mon Sep 17 00:00:00 2001 From: Dan Bode Date: Mon, 13 Aug 2012 18:53:47 -0700 Subject: re-formatting This commit refactors to ensure 80 character lines. --- lib/puppet/parser/functions/ensure_resource.rb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'lib/puppet/parser/functions/ensure_resource.rb') diff --git a/lib/puppet/parser/functions/ensure_resource.rb b/lib/puppet/parser/functions/ensure_resource.rb index 3205b9b..6a9e2ed 100644 --- a/lib/puppet/parser/functions/ensure_resource.rb +++ b/lib/puppet/parser/functions/ensure_resource.rb @@ -26,7 +26,7 @@ ENDOFDOC raise(ArgumentError, 'Must specify a title') unless title params ||= {} if function_defined_with_params(["#{type}[#{title}]", params]) - Puppet.debug("Resource #{type}[#{title}] does not need to be created b/c it already exists") + Puppet.debug("Resource #{type}[#{title}] not created b/c it already exists") else function_create_resources([type.capitalize, { title => params }]) end -- cgit v1.2.3