diff options
| -rw-r--r-- | CHANGELOG | 9 | ||||
| -rw-r--r-- | Modulefile | 2 | ||||
| -rw-r--r-- | README.markdown | 18 | ||||
| -rw-r--r-- | RELEASE_PROCESS.markdown | 3 | ||||
| -rw-r--r-- | lib/puppet/parser/functions/has_key.rb | 27 | ||||
| -rw-r--r-- | lib/puppet/parser/functions/merge.rb | 30 | ||||
| -rw-r--r-- | lib/puppet/parser/functions/validate_array.rb | 35 | ||||
| -rw-r--r-- | lib/puppet/parser/functions/validate_string.rb | 35 | ||||
| -rw-r--r-- | spec/unit/puppet/parser/functions/has_key_spec.rb | 46 | ||||
| -rw-r--r-- | spec/unit/puppet/parser/functions/merge_spec.rb | 54 | ||||
| -rw-r--r-- | spec/unit/puppet/parser/functions/validate_array_spec.rb | 63 | ||||
| -rw-r--r-- | spec/unit/puppet/parser/functions/validate_string_spec.rb | 83 |
12 files changed, 397 insertions, 8 deletions
@@ -1,3 +1,12 @@ +2011-08-04 Puppet Labs <support@puppetlabs.com> - 1.0.0 +* Initial stable release +* Add validate_array and validate_string functions +* Make merge() function work with Ruby 1.8.5 +* Add hash merging function +* Add has_key function +* Add loadyaml() function +* Add append_line native + 2011-06-21 Jeff McCune <jeff@puppetlabs.com> - 0.1.7 * Add validate_hash() and getvar() functions @@ -1,5 +1,5 @@ name 'puppetlabs-stdlib' -version '0.1.7' +version '1.0.0' source 'git://github.com/puppetlabs/puppetlabs-stdlib' author 'puppetlabs' license 'Apache 2.0' diff --git a/README.markdown b/README.markdown index 1e93c6f..68186c2 100644 --- a/README.markdown +++ b/README.markdown @@ -20,15 +20,21 @@ This module is designed to work with Puppet version 2.6 and later. It may be forked if Puppet 2.7 specific features are added. There are currently no plans for a Puppet 0.25 standard library module. -# Overview # - -TBA +# Functions # -# Contact Information # + Please see `puppet doc -r function` for documentation on each function. The + current list of functions is: - Jeff McCune <jeff@puppetlabs.com> + * getvar + * has\_key + * loadyaml + * merge.rb + * validate\_array + * validate\_bool + * validate\_hash + * validate\_re + * validate\_string -# Functions # ## validate\_hash ## $somehash = { 'one' => 'two' } diff --git a/RELEASE_PROCESS.markdown b/RELEASE_PROCESS.markdown index df20730..ea40d5d 100644 --- a/RELEASE_PROCESS.markdown +++ b/RELEASE_PROCESS.markdown @@ -3,8 +3,9 @@ * Work in a topic branch * Submit a github pull request * Address any comments / feeback - * Merge into master using --no-fw + * Merge into master using --no-ff * Update the CHANGELOG + * Update the Modulefile * Create an annotated tag with git tag -a X.Y.Z -m 'version X.Y.Z' * Push the tag with git push origin --tags * Build a new package with puppet-module diff --git a/lib/puppet/parser/functions/has_key.rb b/lib/puppet/parser/functions/has_key.rb new file mode 100644 index 0000000..9c1c4c3 --- /dev/null +++ b/lib/puppet/parser/functions/has_key.rb @@ -0,0 +1,27 @@ +module Puppet::Parser::Functions + + newfunction(:has_key, :type => :rvalue, :doc => <<-'ENDHEREDOC') do |args| + determine if a hash has a certain key value. + + Example: + $my_hash = {'key_one' => 'value_one'} + if has_key($my_hash, 'key_two') { + notice('we will not reach here') + } + if has_key($my_hash, 'key_one') { + notice('this will be printed') + } + + ENDHEREDOC + + unless args.length == 2 + raise Puppet::ParseError, ("has_key(): wrong number of arguments (#{args.length}; must be 2)") + end + unless args[0].is_a?(Hash) + raise Puppet::ParseError, "has_key(): expects the first argument to be a hash, got #{args[0].inspect} which is of type #{args[0].class}" + end + args[0].has_key?(args[1]) + + end + +end diff --git a/lib/puppet/parser/functions/merge.rb b/lib/puppet/parser/functions/merge.rb new file mode 100644 index 0000000..d2dc0f9 --- /dev/null +++ b/lib/puppet/parser/functions/merge.rb @@ -0,0 +1,30 @@ +module Puppet::Parser::Functions + newfunction(:merge, :type => :rvalue, :doc => <<-'ENDHEREDOC') do |args| + Merges two or more hashes together and returns the resulting hash. + + For example: + + $hash1 = {'one' => 1, 'two', => 2} + $hash1 = {'two' => 2, 'three', => 2} + $merged_hash = merge($hash1, $hash2) + # merged_hash = {'one' => 1, 'two' => 2, 'three' => 2} + + ENDHEREDOC + + if args.length < 2 + raise Puppet::ParseError, ("merge(): wrong number of arguments (#{args.length}; must be at least 2)") + end + + # The hash we accumulate into + accumulator = Hash.new + # Merge into the accumulator hash + args.each do |arg| + unless arg.is_a?(Hash) + raise Puppet::ParseError, "merge: unexpected argument type #{arg.class}, only expects hash arguments" + end + accumulator.merge!(arg) + end + # Return the fully merged hash + accumulator + end +end diff --git a/lib/puppet/parser/functions/validate_array.rb b/lib/puppet/parser/functions/validate_array.rb new file mode 100644 index 0000000..a7a7165 --- /dev/null +++ b/lib/puppet/parser/functions/validate_array.rb @@ -0,0 +1,35 @@ +module Puppet::Parser::Functions + + newfunction(:validate_array, :doc => <<-'ENDHEREDOC') do |args| + Validate all passed values are a Array data structure + value does not pass the check. + + Example: + + These values validate + + $my_array = [ 'one', 'two' ] + validate_array($my_array) + + These values do NOT validate + + validate_array(true) + validate_array('some_string') + $undefined = undef + validate_array($undefined) + + ENDHEREDOC + + unless args.length > 0 then + raise Puppet::ParseError, ("validate_array(): wrong number of arguments (#{args.length}; must be > 0)") + end + + args.each do |arg| + unless arg.is_a?(Array) + raise Puppet::ParseError, ("#{arg.inspect} is not an Array. It looks to be a #{arg.class}") + end + end + + end + +end diff --git a/lib/puppet/parser/functions/validate_string.rb b/lib/puppet/parser/functions/validate_string.rb new file mode 100644 index 0000000..d0e1376 --- /dev/null +++ b/lib/puppet/parser/functions/validate_string.rb @@ -0,0 +1,35 @@ +module Puppet::Parser::Functions + + newfunction(:validate_string, :doc => <<-'ENDHEREDOC') do |args| + Validate all passed values are a string data structure + value does not pass the check. + + Example: + + These values validate + + $my_string = "one two" + validate_string($my_string) + + These values do NOT validate + + validate_string(true) + validate_string([ 'some', 'array' ]) + $undefined = undef + validate_string($undefined) + + ENDHEREDOC + + unless args.length > 0 then + raise Puppet::ParseError, ("validate_string(): wrong number of arguments (#{args.length}; must be > 0)") + end + + args.each do |arg| + unless arg.is_a?(String) + raise Puppet::ParseError, ("#{arg.inspect} is not a string. It looks to be a #{arg.class}") + end + end + + end + +end diff --git a/spec/unit/puppet/parser/functions/has_key_spec.rb b/spec/unit/puppet/parser/functions/has_key_spec.rb new file mode 100644 index 0000000..d1dcd15 --- /dev/null +++ b/spec/unit/puppet/parser/functions/has_key_spec.rb @@ -0,0 +1,46 @@ +require 'puppet' +require 'mocha' +describe Puppet::Parser::Functions.function(:has_key) do + + # Pulled from Dan's create_resources function + # TODO - this should be moved to spec_helper since the + # logic is likely to be applied to multiple rspec files. + let(:compiler) { + topscope = Puppet::Parser::Scope.new + # This is necessary so we don't try to use the compiler to discover our parent. + topscope.parent = nil + my_scope = Puppet::Parser::Scope.new + my_scope.compiler = Puppet::Parser::Compiler.new(Puppet::Node.new("floppy", :environment => 'production')) + my_scope.parent = topscope + compiler = my_scope.compiler + } + let(:scope) { + scope = Puppet::Parser::Scope.new + scope.stubs(:environment).returns(Puppet::Node::Environment.new('production')) + scope + } + + describe 'when calling has_key from puppet' do + it "should not compile when no arguments are passed" do + Puppet[:code] = 'has_key()' + expect { compiler.compile }.should raise_error(Puppet::ParseError, /wrong number of arguments/) + end + it "should not compile when 1 argument is passed" do + Puppet[:code] = "has_key('foo')" + expect { compiler.compile }.should raise_error(Puppet::ParseError, /wrong number of arguments/) + end + it "should require the first value to be a Hash" do + Puppet[:code] = "has_key('foo', 'bar')" + expect { compiler.compile }.should raise_error(Puppet::ParseError, /expects the first argument to be a hash/) + end + end + describe 'when calling the function has_key from a scope instance' do + it 'should detect existing keys' do + scope.function_has_key([{'one' => 1}, 'one']).should be_true + end + it 'should detect existing keys' do + scope.function_has_key([{'one' => 1}, 'two']).should be_false + end + end + +end diff --git a/spec/unit/puppet/parser/functions/merge_spec.rb b/spec/unit/puppet/parser/functions/merge_spec.rb new file mode 100644 index 0000000..71e1869 --- /dev/null +++ b/spec/unit/puppet/parser/functions/merge_spec.rb @@ -0,0 +1,54 @@ +require 'puppet' +require 'mocha' +describe Puppet::Parser::Functions.function(:merge) do + + # Pulled from Dan's create_resources function + # TODO - these let statements should be moved somewhere + # where they can be resued + let(:compiler) { + topscope = Puppet::Parser::Scope.new + # This is necessary so we don't try to use the compiler to discover our parent. + topscope.parent = nil + my_scope = Puppet::Parser::Scope.new + my_scope.compiler = Puppet::Parser::Compiler.new(Puppet::Node.new("floppy", :environment => 'production')) + my_scope.parent = topscope + compiler = my_scope.compiler + } + let(:scope) { + scope = Puppet::Parser::Scope.new + scope.stubs(:environment).returns(Puppet::Node::Environment.new('production')) + scope + } + + describe 'when calling merge from puppet' do + it "should not compile when no arguments are passed" do + Puppet[:code] = 'merge()' + expect { compiler.compile }.should raise_error(Puppet::ParseError, /wrong number of arguments/) + end + it "should not compile when 1 argument is passed" do + Puppet[:code] = "$my_hash={'one' => 1}\nmerge($my_hash)" + expect { compiler.compile }.should raise_error(Puppet::ParseError, /wrong number of arguments/) + end + end + describe 'when calling merge on the scope instance' do + it 'should require all parameters are hashes' do + expect { new_hash = scope.function_merge([{}, '2'])}.should raise_error(Puppet::ParseError, /unexpected argument type String/) + + end + it 'should be able to merge two hashes' do + new_hash = scope.function_merge([{'one' => '1', 'two' => '1'}, {'two' => '2', 'three' => '2'}]) + new_hash['one'].should == '1' + new_hash['two'].should == '2' + new_hash['three'].should == '2' + end + it 'should merge multiple hashes' do + hash = scope.function_merge([{'one' => 1}, {'one' => '2'}, {'one' => '3'}]) + hash['one'].should == '3' + end + it 'should accept empty hashes' do + scope.function_merge([{},{},{}]).should == {} + end + + end + +end diff --git a/spec/unit/puppet/parser/functions/validate_array_spec.rb b/spec/unit/puppet/parser/functions/validate_array_spec.rb new file mode 100644 index 0000000..37ae09d --- /dev/null +++ b/spec/unit/puppet/parser/functions/validate_array_spec.rb @@ -0,0 +1,63 @@ +require 'puppet' + +# We don't need this for the basic tests we're doing +# require 'spec_helper' + +# Dan mentioned that Nick recommended the function method call +# to return the string value for the test description. +# this will not even try the test if the function cannot be +# loaded. +describe Puppet::Parser::Functions.function(:validate_array) do + + # Pulled from Dan's create_resources function + def get_scope + @topscope = Puppet::Parser::Scope.new + # This is necessary so we don't try to use the compiler to discover our parent. + @topscope.parent = nil + @scope = Puppet::Parser::Scope.new + @scope.compiler = Puppet::Parser::Compiler.new(Puppet::Node.new("floppy", :environment => 'production')) + @scope.parent = @topscope + @compiler = @scope.compiler + end + + describe 'when calling validate_array from puppet' do + + %w{ true false }.each do |the_string| + + it "should not compile when #{the_string} is a string" do + Puppet[:code] = "validate_array('#{the_string}')" + get_scope + expect { @scope.compiler.compile }.should raise_error(Puppet::ParseError, /is not an Array/) + end + + it "should not compile when #{the_string} is a bare word" do + Puppet[:code] = "validate_array(#{the_string})" + get_scope + expect { @scope.compiler.compile }.should raise_error(Puppet::ParseError, /is not an Array/) + end + + end + + it "should compile when multiple array arguments are passed" do + Puppet[:code] = <<-'ENDofPUPPETcode' + $foo = [ ] + $bar = [ 'one', 'two' ] + validate_array($foo, $bar) + ENDofPUPPETcode + get_scope + @scope.compiler.compile + end + + it "should not compile when an undef variable is passed" do + Puppet[:code] = <<-'ENDofPUPPETcode' + $foo = undef + validate_array($foo) + ENDofPUPPETcode + get_scope + expect { @scope.compiler.compile }.should raise_error(Puppet::ParseError, /is not an Array/) + end + + end + +end + diff --git a/spec/unit/puppet/parser/functions/validate_string_spec.rb b/spec/unit/puppet/parser/functions/validate_string_spec.rb new file mode 100644 index 0000000..92392da --- /dev/null +++ b/spec/unit/puppet/parser/functions/validate_string_spec.rb @@ -0,0 +1,83 @@ +require 'puppet' + +# We don't need this for the basic tests we're doing +# require 'spec_helper' + +# Dan mentioned that Nick recommended the function method call +# to return the string value for the test description. +# this will not even try the test if the function cannot be +# loaded. +describe Puppet::Parser::Functions.function(:validate_string) do + + # Pulled from Dan's create_resources function + def get_scope + @topscope = Puppet::Parser::Scope.new + # This is necessary so we don't try to use the compiler to discover our parent. + @topscope.parent = nil + @scope = Puppet::Parser::Scope.new + @scope.compiler = Puppet::Parser::Compiler.new(Puppet::Node.new("floppy", :environment => 'production')) + @scope.parent = @topscope + @compiler = @scope.compiler + end + + describe 'when calling validate_string from puppet' do + + %w{ foo bar baz }.each do |the_string| + + it "should compile when #{the_string} is a string" do + Puppet[:code] = "validate_string('#{the_string}')" + get_scope + @scope.compiler.compile + end + + it "should compile when #{the_string} is a bare word" do + Puppet[:code] = "validate_string(#{the_string})" + get_scope + @scope.compiler.compile + end + + end + + %w{ true false }.each do |the_string| + it "should compile when #{the_string} is a string" do + Puppet[:code] = "validate_string('#{the_string}')" + get_scope + @scope.compiler.compile + end + + it "should not compile when #{the_string} is a bare word" do + Puppet[:code] = "validate_string(#{the_string})" + get_scope + expect { @scope.compiler.compile }.should raise_error(Puppet::ParseError, /is not a string/) + end + end + + it "should compile when multiple string arguments are passed" do + Puppet[:code] = <<-'ENDofPUPPETcode' + $foo = '' + $bar = 'two' + validate_string($foo, $bar) + ENDofPUPPETcode + get_scope + @scope.compiler.compile + end + + it "should compile when an explicitly undef variable is passed (NOTE THIS MAY NOT BE DESIRABLE)" do + Puppet[:code] = <<-'ENDofPUPPETcode' + $foo = undef + validate_string($foo) + ENDofPUPPETcode + get_scope + @scope.compiler.compile + end + + it "should compile when an undefined variable is passed (NOTE THIS MAY NOT BE DESIRABLE)" do + Puppet[:code] = <<-'ENDofPUPPETcode' + validate_string($foobarbazishouldnotexist) + ENDofPUPPETcode + get_scope + @scope.compiler.compile + end + end +end + |