From cdf3b05f35f78971203dfd9fadd2552ad5a41bd4 Mon Sep 17 00:00:00 2001 From: Matthaus Owens Date: Tue, 23 Oct 2012 14:13:11 -0700 Subject: Add PE facts to stdlib As many PE modules have PE specific functionality, but are deployed to all nodes, including FOSS nodes, it is valuable to be able to selectively enable those PE specific functions. These facts allow modules to use the is_pe fact to determine whether the module should be used or not. The facts include is_pe, pe_version, pe_major_version, pe_minor_version, and pe_patch_version. For PE 2.6.0 those facts would have values true, 2.6.0, 2, 6, and 0, respectively. --- lib/facter/pe_version.rb | 47 +++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 47 insertions(+) create mode 100644 lib/facter/pe_version.rb diff --git a/lib/facter/pe_version.rb b/lib/facter/pe_version.rb new file mode 100644 index 0000000..7c31e84 --- /dev/null +++ b/lib/facter/pe_version.rb @@ -0,0 +1,47 @@ +# Fact: is_pe, pe_version, pe_major_version, pe_minor_version, pe_patch_version +# +# Purpose: Return various facts about the PE state of the system +# +# Resolution: Uses a regex match against puppetversion to determine whether the +# machine has Puppet Enterprise installed, and what version (overall, major, +# minor, patch) is installed. +# +# Caveats: +# +Facter.add("pe_version") do + setcode do + pe_ver = Facter.value("puppetversion").match(/Puppet Enterprise (\d+\.\d+\.\d+)/) + pe_ver[1] if pe_ver + end +end + +Facter.add("is_pe") do + setcode do + if Facter.value(:pe_version).to_s.empty? then + false + else + true + end + end +end + +Facter.add("pe_major_version") do + confine :is_pe => true + setcode do + Facter.value(:pe_version).split('.')[0] + end +end + +Facter.add("pe_minor_version") do + confine :is_pe => true + setcode do + Facter.value(:pe_version).split('.')[1] + end +end + +Facter.add("pe_patch_version") do + confine :is_pe => true + setcode do + Facter.value(:pe_version).split('.')[2] + end +end -- cgit v1.2.3 From 4442f1edb5c3566e832b3b10ac6181793d7502e5 Mon Sep 17 00:00:00 2001 From: Matthaus Owens Date: Tue, 23 Oct 2012 14:14:06 -0700 Subject: Add spec tests for pe_version facts This commit adds some basic spec tests for the pe_version facts. There are basic postitive and negative cases. --- spec/unit/facter/pe_version_spec.rb | 68 +++++++++++++++++++++++++++++++++++++ 1 file changed, 68 insertions(+) create mode 100644 spec/unit/facter/pe_version_spec.rb diff --git a/spec/unit/facter/pe_version_spec.rb b/spec/unit/facter/pe_version_spec.rb new file mode 100644 index 0000000..202a0e5 --- /dev/null +++ b/spec/unit/facter/pe_version_spec.rb @@ -0,0 +1,68 @@ +#!/usr/bin/env rspec + +require 'spec_helper' + +describe "PE Version specs" do + before :each do + Facter.collection.loader.load(:pe_version) + end + + context "If PE is installed" do + %w{ 2.6.1 2.10.300 }.each do |version| + puppetversion = "2.7.19 (Puppet Enterprise #{version})" + context "puppetversion => #{puppetversion}" do + before :each do + Facter.fact(:puppetversion).stubs(:value).returns(puppetversion) + end + + (major,minor,patch) = version.split(".") + + it "Should return true" do + Facter.fact(:is_pe).value.should == true + end + + it "Should have a version of #{version}" do + Facter.fact(:pe_version).value.should == version + end + + it "Should have a major version of #{major}" do + Facter.fact(:pe_major_version).value.should == major + end + + it "Should have a minor version of #{minor}" do + Facter.fact(:pe_minor_version).value.should == minor + end + + it "Should have a patch version of #{patch}" do + Facter.fact(:pe_patch_version).value.should == patch + end + end + end + end + + context "When PE is not installed" do + before :each do + Facter.fact(:puppetversion).stubs(:value).returns("2.7.19") + end + + it "is_pe is false" do + Facter.fact(:is_pe).value.should == false + end + + it "pe_version is nil" do + Facter.fact(:pe_version).value.should be_nil + end + + it "pe_major_version is nil" do + Facter.fact(:pe_major_version).value.should be_nil + end + + it "pe_minor_version is nil" do + Facter.fact(:pe_minor_version).value.should be_nil + end + + it "Should have a patch version" do + Facter.fact(:pe_patch_version).value.should be_nil + end + end +end -- cgit v1.2.3 From ba70a3885af452aea72d408f447c5bc7fd8bf0c0 Mon Sep 17 00:00:00 2001 From: Jeff McCune Date: Wed, 24 Oct 2012 16:59:43 -0700 Subject: (maint) Clear all facts before each example Without this patch example groups must explicitly call `Facter.clear` to clear any cached values between examples. This is a problem because this behavior is not the concern of the example groups, the behavior is the concern of the spec_helper or whatever facility we have in place to initialize the system for testing. This patch fixes the problem by duplicating the logic in the Facter spec_helper to ensure facts are cleared out before each example. This patch requires the example groups to explicitly load the facts they require if the fact name does not match the filename. --- spec/spec_helper.rb | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/spec/spec_helper.rb b/spec/spec_helper.rb index 8ae9ad3..931d35c 100644 --- a/spec/spec_helper.rb +++ b/spec/spec_helper.rb @@ -12,3 +12,17 @@ require 'rspec/expectations' require 'puppetlabs_spec_helper/module_spec_helper' +RSpec.configure do |config| + # FIXME REVISIT - We may want to delegate to Facter like we do in + # Puppet::PuppetSpecInitializer.initialize_via_testhelper(config) because + # this behavior is a duplication of the spec_helper in Facter. + config.before :each do + # Ensure that we don't accidentally cache facts and environment between + # test cases. This requires each example group to explicitly load the + # facts being exercised with something like + # Facter.collection.loader.load(:ipaddress) + Facter::Util::Loader.any_instance.stubs(:load_all) + Facter.clear + Facter.clear_messages + end +end -- cgit v1.2.3 From e68677976b671eb8b7f81393dc6dac6c6d86410c Mon Sep 17 00:00:00 2001 From: Jeff McCune Date: Thu, 25 Oct 2012 10:00:42 -0700 Subject: Prevent undefined method `split' for nil:NilClass with pe_foo_version facts Without this patch the pe_major_version, pe_minor_version, and pe_patch_version facts directly depend on the pe_version fact in a manner that calls split directly on the return value. This is a problem because Fact values are not always guaranteed to return strings, or objects that respond to split. This patch is a defensive measure to ensure we're always calling the split method on a string object. If the Fact returns nil, this will be converted to an empty string responding to split. --- lib/facter/pe_version.rb | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/lib/facter/pe_version.rb b/lib/facter/pe_version.rb index 7c31e84..0cc0f64 100644 --- a/lib/facter/pe_version.rb +++ b/lib/facter/pe_version.rb @@ -28,20 +28,26 @@ end Facter.add("pe_major_version") do confine :is_pe => true setcode do - Facter.value(:pe_version).split('.')[0] + if pe_version = Facter.value(:pe_version) + pe_version.to_s.split('.')[0] + end end end Facter.add("pe_minor_version") do confine :is_pe => true setcode do - Facter.value(:pe_version).split('.')[1] + if pe_version = Facter.value(:pe_version) + pe_version.to_s.split('.')[1] + end end end Facter.add("pe_patch_version") do confine :is_pe => true setcode do - Facter.value(:pe_version).split('.')[2] + if pe_version = Facter.value(:pe_version) + pe_version.to_s.split('.')[2] + end end end -- cgit v1.2.3 From d6d23b495cda0e154b4e73982acc43e586564c0e Mon Sep 17 00:00:00 2001 From: Jeff McCune Date: Thu, 25 Oct 2012 10:41:52 -0700 Subject: Revert "Merge branch 'haus-add_pe_facts_to_stdlib' into 2.4.x" This reverts commit 74e6411157b8df1af9a24c17971e3236f3096529, reversing changes made to 417d219aa6e42f2a16af42c98aa063fc1d9d2ecd. Here's why: Actually... I just screwed this up. I merged this new fact into 2.4.x but it's not fixing any bug. It's adding a new fact, so this should go into master and we should release 2.5 since this is new, backwards-compatible functionality. --- lib/facter/pe_version.rb | 53 ----------------------------- spec/spec_helper.rb | 14 -------- spec/unit/facter/pe_version_spec.rb | 68 ------------------------------------- 3 files changed, 135 deletions(-) delete mode 100644 lib/facter/pe_version.rb delete mode 100644 spec/unit/facter/pe_version_spec.rb diff --git a/lib/facter/pe_version.rb b/lib/facter/pe_version.rb deleted file mode 100644 index 0cc0f64..0000000 --- a/lib/facter/pe_version.rb +++ /dev/null @@ -1,53 +0,0 @@ -# Fact: is_pe, pe_version, pe_major_version, pe_minor_version, pe_patch_version -# -# Purpose: Return various facts about the PE state of the system -# -# Resolution: Uses a regex match against puppetversion to determine whether the -# machine has Puppet Enterprise installed, and what version (overall, major, -# minor, patch) is installed. -# -# Caveats: -# -Facter.add("pe_version") do - setcode do - pe_ver = Facter.value("puppetversion").match(/Puppet Enterprise (\d+\.\d+\.\d+)/) - pe_ver[1] if pe_ver - end -end - -Facter.add("is_pe") do - setcode do - if Facter.value(:pe_version).to_s.empty? then - false - else - true - end - end -end - -Facter.add("pe_major_version") do - confine :is_pe => true - setcode do - if pe_version = Facter.value(:pe_version) - pe_version.to_s.split('.')[0] - end - end -end - -Facter.add("pe_minor_version") do - confine :is_pe => true - setcode do - if pe_version = Facter.value(:pe_version) - pe_version.to_s.split('.')[1] - end - end -end - -Facter.add("pe_patch_version") do - confine :is_pe => true - setcode do - if pe_version = Facter.value(:pe_version) - pe_version.to_s.split('.')[2] - end - end -end diff --git a/spec/spec_helper.rb b/spec/spec_helper.rb index 931d35c..8ae9ad3 100644 --- a/spec/spec_helper.rb +++ b/spec/spec_helper.rb @@ -12,17 +12,3 @@ require 'rspec/expectations' require 'puppetlabs_spec_helper/module_spec_helper' -RSpec.configure do |config| - # FIXME REVISIT - We may want to delegate to Facter like we do in - # Puppet::PuppetSpecInitializer.initialize_via_testhelper(config) because - # this behavior is a duplication of the spec_helper in Facter. - config.before :each do - # Ensure that we don't accidentally cache facts and environment between - # test cases. This requires each example group to explicitly load the - # facts being exercised with something like - # Facter.collection.loader.load(:ipaddress) - Facter::Util::Loader.any_instance.stubs(:load_all) - Facter.clear - Facter.clear_messages - end -end diff --git a/spec/unit/facter/pe_version_spec.rb b/spec/unit/facter/pe_version_spec.rb deleted file mode 100644 index 202a0e5..0000000 --- a/spec/unit/facter/pe_version_spec.rb +++ /dev/null @@ -1,68 +0,0 @@ -#!/usr/bin/env rspec - -require 'spec_helper' - -describe "PE Version specs" do - before :each do - Facter.collection.loader.load(:pe_version) - end - - context "If PE is installed" do - %w{ 2.6.1 2.10.300 }.each do |version| - puppetversion = "2.7.19 (Puppet Enterprise #{version})" - context "puppetversion => #{puppetversion}" do - before :each do - Facter.fact(:puppetversion).stubs(:value).returns(puppetversion) - end - - (major,minor,patch) = version.split(".") - - it "Should return true" do - Facter.fact(:is_pe).value.should == true - end - - it "Should have a version of #{version}" do - Facter.fact(:pe_version).value.should == version - end - - it "Should have a major version of #{major}" do - Facter.fact(:pe_major_version).value.should == major - end - - it "Should have a minor version of #{minor}" do - Facter.fact(:pe_minor_version).value.should == minor - end - - it "Should have a patch version of #{patch}" do - Facter.fact(:pe_patch_version).value.should == patch - end - end - end - end - - context "When PE is not installed" do - before :each do - Facter.fact(:puppetversion).stubs(:value).returns("2.7.19") - end - - it "is_pe is false" do - Facter.fact(:is_pe).value.should == false - end - - it "pe_version is nil" do - Facter.fact(:pe_version).value.should be_nil - end - - it "pe_major_version is nil" do - Facter.fact(:pe_major_version).value.should be_nil - end - - it "pe_minor_version is nil" do - Facter.fact(:pe_minor_version).value.should be_nil - end - - it "Should have a patch version" do - Facter.fact(:pe_patch_version).value.should be_nil - end - end -end -- cgit v1.2.3 From 9693c04c9d877e0f877418bc41e16f01aaf784cd Mon Sep 17 00:00:00 2001 From: Jeff McCune Date: Thu, 25 Oct 2012 10:46:57 -0700 Subject: Revert "Revert "Merge branch 'haus-add_pe_facts_to_stdlib' into 2.4.x"" This reverts commit d6d23b495cda0e154b4e73982acc43e586564c0e. This backwards-compatible additional functionality is targeted at the next minor release. There are already backwards-incompatible changes in the master branch so we need to establish a new minor branch. --- lib/facter/pe_version.rb | 53 +++++++++++++++++++++++++++++ spec/spec_helper.rb | 14 ++++++++ spec/unit/facter/pe_version_spec.rb | 68 +++++++++++++++++++++++++++++++++++++ 3 files changed, 135 insertions(+) create mode 100644 lib/facter/pe_version.rb create mode 100644 spec/unit/facter/pe_version_spec.rb diff --git a/lib/facter/pe_version.rb b/lib/facter/pe_version.rb new file mode 100644 index 0000000..0cc0f64 --- /dev/null +++ b/lib/facter/pe_version.rb @@ -0,0 +1,53 @@ +# Fact: is_pe, pe_version, pe_major_version, pe_minor_version, pe_patch_version +# +# Purpose: Return various facts about the PE state of the system +# +# Resolution: Uses a regex match against puppetversion to determine whether the +# machine has Puppet Enterprise installed, and what version (overall, major, +# minor, patch) is installed. +# +# Caveats: +# +Facter.add("pe_version") do + setcode do + pe_ver = Facter.value("puppetversion").match(/Puppet Enterprise (\d+\.\d+\.\d+)/) + pe_ver[1] if pe_ver + end +end + +Facter.add("is_pe") do + setcode do + if Facter.value(:pe_version).to_s.empty? then + false + else + true + end + end +end + +Facter.add("pe_major_version") do + confine :is_pe => true + setcode do + if pe_version = Facter.value(:pe_version) + pe_version.to_s.split('.')[0] + end + end +end + +Facter.add("pe_minor_version") do + confine :is_pe => true + setcode do + if pe_version = Facter.value(:pe_version) + pe_version.to_s.split('.')[1] + end + end +end + +Facter.add("pe_patch_version") do + confine :is_pe => true + setcode do + if pe_version = Facter.value(:pe_version) + pe_version.to_s.split('.')[2] + end + end +end diff --git a/spec/spec_helper.rb b/spec/spec_helper.rb index 8ae9ad3..931d35c 100644 --- a/spec/spec_helper.rb +++ b/spec/spec_helper.rb @@ -12,3 +12,17 @@ require 'rspec/expectations' require 'puppetlabs_spec_helper/module_spec_helper' +RSpec.configure do |config| + # FIXME REVISIT - We may want to delegate to Facter like we do in + # Puppet::PuppetSpecInitializer.initialize_via_testhelper(config) because + # this behavior is a duplication of the spec_helper in Facter. + config.before :each do + # Ensure that we don't accidentally cache facts and environment between + # test cases. This requires each example group to explicitly load the + # facts being exercised with something like + # Facter.collection.loader.load(:ipaddress) + Facter::Util::Loader.any_instance.stubs(:load_all) + Facter.clear + Facter.clear_messages + end +end diff --git a/spec/unit/facter/pe_version_spec.rb b/spec/unit/facter/pe_version_spec.rb new file mode 100644 index 0000000..202a0e5 --- /dev/null +++ b/spec/unit/facter/pe_version_spec.rb @@ -0,0 +1,68 @@ +#!/usr/bin/env rspec + +require 'spec_helper' + +describe "PE Version specs" do + before :each do + Facter.collection.loader.load(:pe_version) + end + + context "If PE is installed" do + %w{ 2.6.1 2.10.300 }.each do |version| + puppetversion = "2.7.19 (Puppet Enterprise #{version})" + context "puppetversion => #{puppetversion}" do + before :each do + Facter.fact(:puppetversion).stubs(:value).returns(puppetversion) + end + + (major,minor,patch) = version.split(".") + + it "Should return true" do + Facter.fact(:is_pe).value.should == true + end + + it "Should have a version of #{version}" do + Facter.fact(:pe_version).value.should == version + end + + it "Should have a major version of #{major}" do + Facter.fact(:pe_major_version).value.should == major + end + + it "Should have a minor version of #{minor}" do + Facter.fact(:pe_minor_version).value.should == minor + end + + it "Should have a patch version of #{patch}" do + Facter.fact(:pe_patch_version).value.should == patch + end + end + end + end + + context "When PE is not installed" do + before :each do + Facter.fact(:puppetversion).stubs(:value).returns("2.7.19") + end + + it "is_pe is false" do + Facter.fact(:is_pe).value.should == false + end + + it "pe_version is nil" do + Facter.fact(:pe_version).value.should be_nil + end + + it "pe_major_version is nil" do + Facter.fact(:pe_major_version).value.should be_nil + end + + it "pe_minor_version is nil" do + Facter.fact(:pe_minor_version).value.should be_nil + end + + it "Should have a patch version" do + Facter.fact(:pe_patch_version).value.should be_nil + end + end +end -- cgit v1.2.3 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/defined_with_params.rb | 33 ++++++++++++++++++++ lib/puppet/parser/functions/ensure_resource.rb | 28 +++++++++++++++++ spec/functions/defined_with_params_spec.rb | 31 +++++++++++++++++++ spec/functions/ensure_resource_spec.rb | 35 ++++++++++++++++++++++ 4 files changed, 127 insertions(+) create mode 100644 lib/puppet/parser/functions/defined_with_params.rb create mode 100644 lib/puppet/parser/functions/ensure_resource.rb create mode 100644 spec/functions/defined_with_params_spec.rb create mode 100644 spec/functions/ensure_resource_spec.rb diff --git a/lib/puppet/parser/functions/defined_with_params.rb b/lib/puppet/parser/functions/defined_with_params.rb new file mode 100644 index 0000000..e09e41c --- /dev/null +++ b/lib/puppet/parser/functions/defined_with_params.rb @@ -0,0 +1,33 @@ +# Test whether a given class or definition is defined +require 'puppet/parser/functions' + +Puppet::Parser::Functions.newfunction(:defined_with_params, + :type => :rvalue, + :doc => <<-'ENDOFDOC' +Takes a resource reference and an optional hash of attributes. + +Returns true if a resource with the specified attributes has already been added +to the catalog, and false otherwise. + + user { 'dan': + ensure => present, + } + + if ! defined_with_params(User[dan], {'ensure' => 'present' }) { + user { 'dan': ensure => present, } + } +ENDOFDOC +) do |vals| + reference, params = vals + raise(ArgumentError, 'Must specify a reference') unless reference + params ||= {} + ret = false + if resource = findresource(reference.to_s) + matches = params.collect do |key, value| + resource[key] == value + end + ret = params.empty? || !matches.include?(false) + end + Puppet.debug("Resource #{reference} was not determined to be defined") + ret +end 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 diff --git a/spec/functions/defined_with_params_spec.rb b/spec/functions/defined_with_params_spec.rb new file mode 100644 index 0000000..21c08a0 --- /dev/null +++ b/spec/functions/defined_with_params_spec.rb @@ -0,0 +1,31 @@ +#! /usr/bin/env ruby -S rspec +require 'spec_helper' + +require 'rspec-puppet' +describe 'defined_with_params' do + describe 'when a resource is not specified' do + it { should run.with_params().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]', {}).and_return(true) + should run.with_params('User[bob]', {}).and_return(false) + should run.with_params('User[dan]', {'foo' => 'bar'}).and_return(false) + end + end + + describe 'when comparted against a resource with attributes' do + let :pre_condition do + 'user { "dan": ensure => present, shell => "/bin/csh", managehome => false}' + end + it do + should run.with_params('User[dan]', {}).and_return(true) + should run.with_params('User[dan]', {'ensure' => 'present'}).and_return(true) + should run.with_params('User[dan]', {'ensure' => 'present', 'managehome' => false}).and_return(true) + should run.with_params('User[dan]', {'ensure' => 'absent', 'managehome' => false}).and_return(false) + end + end +end diff --git a/spec/functions/ensure_resource_spec.rb b/spec/functions/ensure_resource_spec.rb new file mode 100644 index 0000000..e45a6d0 --- /dev/null +++ b/spec/functions/ensure_resource_spec.rb @@ -0,0 +1,35 @@ +#! /usr/bin/env ruby -S rspec +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 + 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', {}) + compiler.catalog.resource('User[dan]').to_s.should == 'User[dan]' + end + end + + describe 'when comparted against a resource with attributes' 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', {'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 + end +end -- cgit v1.2.3 From 4f8b133917255451b1f28128e26b36305c23d254 Mon Sep 17 00:00:00 2001 From: Dan Bode Date: Mon, 13 Aug 2012 18:52:00 -0700 Subject: Handle undef for parameter argument This commit adds better handling of the case where undef is passed as the parameter value. This works by converting '' into [] --- lib/puppet/parser/functions/defined_with_params.rb | 4 +++- spec/functions/defined_with_params_spec.rb | 1 + spec/functions/ensure_resource_spec.rb | 1 + 3 files changed, 5 insertions(+), 1 deletion(-) diff --git a/lib/puppet/parser/functions/defined_with_params.rb b/lib/puppet/parser/functions/defined_with_params.rb index e09e41c..d7df306 100644 --- a/lib/puppet/parser/functions/defined_with_params.rb +++ b/lib/puppet/parser/functions/defined_with_params.rb @@ -20,7 +20,9 @@ ENDOFDOC ) do |vals| reference, params = vals raise(ArgumentError, 'Must specify a reference') unless reference - params ||= {} + if (! params) || params == '' + params = {} + end ret = false if resource = findresource(reference.to_s) matches = params.collect do |key, value| diff --git a/spec/functions/defined_with_params_spec.rb b/spec/functions/defined_with_params_spec.rb index 21c08a0..f995b67 100644 --- a/spec/functions/defined_with_params_spec.rb +++ b/spec/functions/defined_with_params_spec.rb @@ -26,6 +26,7 @@ describe 'defined_with_params' do should run.with_params('User[dan]', {'ensure' => 'present'}).and_return(true) should run.with_params('User[dan]', {'ensure' => 'present', 'managehome' => false}).and_return(true) should run.with_params('User[dan]', {'ensure' => 'absent', 'managehome' => false}).and_return(false) + should run.with_params('User[dan]', '').and_return(true) end end end diff --git a/spec/functions/ensure_resource_spec.rb b/spec/functions/ensure_resource_spec.rb index e45a6d0..e03efda 100644 --- a/spec/functions/ensure_resource_spec.rb +++ b/spec/functions/ensure_resource_spec.rb @@ -26,6 +26,7 @@ describe 'ensure_resource' do 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 -- 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(+) 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 +- spec/functions/defined_with_params_spec.rb | 13 +++++++++---- spec/functions/ensure_resource_spec.rb | 10 +++++++--- 3 files changed, 17 insertions(+), 8 deletions(-) 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 diff --git a/spec/functions/defined_with_params_spec.rb b/spec/functions/defined_with_params_spec.rb index f995b67..28dbab3 100644 --- a/spec/functions/defined_with_params_spec.rb +++ b/spec/functions/defined_with_params_spec.rb @@ -17,16 +17,21 @@ describe 'defined_with_params' do end end - describe 'when comparted against a resource with attributes' do + describe 'when compared against a resource with attributes' do let :pre_condition do 'user { "dan": ensure => present, shell => "/bin/csh", managehome => false}' end it do should run.with_params('User[dan]', {}).and_return(true) - should run.with_params('User[dan]', {'ensure' => 'present'}).and_return(true) - should run.with_params('User[dan]', {'ensure' => 'present', 'managehome' => false}).and_return(true) - should run.with_params('User[dan]', {'ensure' => 'absent', 'managehome' => false}).and_return(false) should run.with_params('User[dan]', '').and_return(true) + should run.with_params('User[dan]', {'ensure' => 'present'} + ).and_return(true) + should run.with_params('User[dan]', + {'ensure' => 'present', 'managehome' => false} + ).and_return(true) + should run.with_params('User[dan]', + {'ensure' => 'absent', 'managehome' => false} + ).and_return(false) end end end diff --git a/spec/functions/ensure_resource_spec.rb b/spec/functions/ensure_resource_spec.rb index e03efda..611666e 100644 --- a/spec/functions/ensure_resource_spec.rb +++ b/spec/functions/ensure_resource_spec.rb @@ -19,7 +19,7 @@ describe 'ensure_resource' do end end - describe 'when comparted against a resource with attributes' do + describe 'when compared against a resource with attributes' do let :pre_condition do 'user { "dan": ensure => present, shell => "/bin/csh", managehome => false}' end @@ -28,9 +28,13 @@ describe 'ensure_resource' do 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}) + 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) + should run.with_params('User', 'dan', + {'ensure' => 'absent', 'managehome' => false} + ).and_raise_error(Puppet::Error) end end end -- cgit v1.2.3 From 9fc3063ea954bbd49cd2b8386bc69696a4af4114 Mon Sep 17 00:00:00 2001 From: Dan Bode Date: Wed, 15 Aug 2012 15:57:45 -0700 Subject: Explicitly load functions used by ensure_resource The ensure_resource function actually calls two other functions, create_resources and defined_with_param. When calling Puppet functions from Ruby, you sometimes have to load the functions manually if they have not been called before. This commit explicitly loads the functions that ensure_resource depends on from within the function. --- lib/puppet/parser/functions/ensure_resource.rb | 2 ++ 1 file changed, 2 insertions(+) diff --git a/lib/puppet/parser/functions/ensure_resource.rb b/lib/puppet/parser/functions/ensure_resource.rb index 6a9e2ed..fba2035 100644 --- a/lib/puppet/parser/functions/ensure_resource.rb +++ b/lib/puppet/parser/functions/ensure_resource.rb @@ -25,9 +25,11 @@ ENDOFDOC 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 }]) end end -- cgit v1.2.3 From 88af331b0e9b0e8c8a3c1e74e4c5598dc7b8e1c8 Mon Sep 17 00:00:00 2001 From: Jeff McCune Date: Thu, 25 Oct 2012 11:02:53 -0700 Subject: Update Modulefile, CHANGELOG for 2.5.0 --- CHANGELOG | 24 ++++++++++++++++++++++++ Modulefile | 2 +- 2 files changed, 25 insertions(+), 1 deletion(-) diff --git a/CHANGELOG b/CHANGELOG index aa56323..5792979 100644 --- a/CHANGELOG +++ b/CHANGELOG @@ -1,3 +1,27 @@ +2012-10-23 - Matthaus Owens - 2.5.0 + * Add PE facts to stdlib (cdf3b05) + +2012-08-15 - Dan Bode - 2.5.0 + * Explicitly load functions used by ensure_resource (9fc3063) + +2012-08-13 - Dan Bode - 2.5.0 + * Add better docs about duplicate resource failures (97d327a) + +2012-08-13 - Dan Bode - 2.5.0 + * Handle undef for parameter argument (4f8b133) + +2012-08-07 - Dan Bode - 2.5.0 + * Add function ensure_resource and defined_with_params (a0cb8cd) + +2012-08-20 - Jeff McCune - 2.5.0 + * Disable tests that fail on 2.6.x due to #15912 (c81496e) + +2012-08-20 - Jeff McCune - 2.5.0 + * (Maint) Fix mis-use of rvalue functions as statements (4492913) + +2012-08-20 - Jeff McCune - 2.5.0 + * Add .rspec file to repo root (88789e8) + 2012-06-07 - Chris Price - 2.4.0 * Add support for a 'match' parameter to file_line (a06c0d8) diff --git a/Modulefile b/Modulefile index 146dbb9..8f5bb0a 100644 --- a/Modulefile +++ b/Modulefile @@ -1,5 +1,5 @@ name 'puppetlabs-stdlib' -version '2.4.0' +version '2.5.0' source 'git://github.com/puppetlabs/puppetlabs-stdlib' author 'puppetlabs' license 'Apache 2.0' -- cgit v1.2.3