diff options
| -rw-r--r-- | README.markdown | 35 | ||||
| -rw-r--r-- | lib/puppet/parser/functions/validate_nonemptyhash.rb | 36 | ||||
| -rw-r--r-- | lib/puppet/parser/functions/validate_nonemptyhash_msg.rb | 30 | ||||
| -rw-r--r-- | spec/unit/puppet/parser/functions/validate_nonemptyhash_msg_spec.rb | 45 | ||||
| -rw-r--r-- | spec/unit/puppet/parser/functions/validate_nonemptyhash_spec.rb | 55 |
5 files changed, 201 insertions, 0 deletions
diff --git a/README.markdown b/README.markdown index 03a7284..9eb3fcd 100644 --- a/README.markdown +++ b/README.markdown @@ -86,3 +86,38 @@ The following values will fail, causing compilation to abort with the given msg: validate_nonemptyarray_msg(true, 'Not a nonempty array') validate_nonemptyarray_msg([], 'Not a nonempty array') + +validate_nonemptyhash +--------------------- +Validate that all passed values are hash data structures. Abort catalog +compilation if any value fails this check. Also abort if any of the hashes +is empty. + +The following values will pass: + + $my_hash = { 'one' => 'two' } + validate_nonemptyhash($my_array) + +The following values will fail, causing compilation to abort: + + validate_nonemptyhash(true) + validate_nonemptyhash([]) + validate_nonemptyhash('some_string') + $undefined = undef + validate_nonemptyhash($undefined) + +validate_nonemptyhash_msg +------------------------- +Validate that the passed value is an hash data structure. Abort catalog +compilation if any value fails this check. Also abort if any of the hashs +is empty. On failure it prints the message given as the second argument. + +The following values will pass: + + $my_hash = { 'one', 'two' } + validate_nonemptyhash_msg($my_hash, 'foo') + +The following values will fail, causing compilation to abort with the given msg: + + validate_nonemptyhash_msg(true, 'Not a nonempty hash') + validate_nonemptyhash_msg([], 'Not a nonempty hash') diff --git a/lib/puppet/parser/functions/validate_nonemptyhash.rb b/lib/puppet/parser/functions/validate_nonemptyhash.rb new file mode 100644 index 0000000..9a7b1f6 --- /dev/null +++ b/lib/puppet/parser/functions/validate_nonemptyhash.rb @@ -0,0 +1,36 @@ +module Puppet::Parser::Functions + + newfunction(:validate_nonemptyhash, :doc => <<-'ENDHEREDOC') do |args| + Validate that all passed values are hash data structures. Abort catalog + compilation if any value fails this check. Also abort if any of the hashes + is empty. + + The following values will pass: + + $my_hash = { 'one' => 'two' } + validate_nonemptyhash($my_array) + + The following values will fail, causing compilation to abort: + + validate_nonemptyhash(true) + validate_nonemptyhash([]) + validate_nonemptyhash('some_string') + $undefined = undef + validate_nonemptyhash($undefined) + + ENDHEREDOC + + unless args.length > 0 then + raise Puppet::ParseError, ("validate_nonemptyhash(): wrong number of arguments (#{args.length}; must be > 0)") + end + + args.each do |arg| + unless arg.is_a?(Hash) + raise Puppet::ParseError, ("#{arg.inspect} is not an Hash. It looks to be a #{arg.class}") + end + unless arg.keys.length > 0 + raise Puppet::ParseError, ("#{arg.inspect} is an empty Hash.") + end + end + end +end diff --git a/lib/puppet/parser/functions/validate_nonemptyhash_msg.rb b/lib/puppet/parser/functions/validate_nonemptyhash_msg.rb new file mode 100644 index 0000000..f402b92 --- /dev/null +++ b/lib/puppet/parser/functions/validate_nonemptyhash_msg.rb @@ -0,0 +1,30 @@ +module Puppet::Parser::Functions + + newfunction(:validate_nonemptyhash_msg, :doc => <<-'ENDHEREDOC') do |args| + Validate that the passed value is an hash data structure. Abort catalog + compilation if any value fails this check. Also abort if any of the hashs + is empty. On failure it prints the message given as the second argument. + + The following values will pass: + + $my_hash = { 'one', 'two' } + validate_nonemptyhash_msg($my_hash, 'foo') + + The following values will fail, causing compilation to abort with the given msg: + + validate_nonemptyhash_msg(true, 'Not a nonempty hash') + validate_nonemptyhash_msg([], 'Not a nonempty hash') + + ENDHEREDOC + + unless args.length == 2 then + raise Puppet::ParseError, ("validate_nonemptyhash_msg(): wrong number of arguments (#{args.length}; must be == 2)") + end + + arg = args[0] + msg = args[1] + unless arg.is_a?(Hash) and arg.keys.length > 0 + raise Puppet::ParseError, (msg) + end + end +end diff --git a/spec/unit/puppet/parser/functions/validate_nonemptyhash_msg_spec.rb b/spec/unit/puppet/parser/functions/validate_nonemptyhash_msg_spec.rb new file mode 100644 index 0000000..329b546 --- /dev/null +++ b/spec/unit/puppet/parser/functions/validate_nonemptyhash_msg_spec.rb @@ -0,0 +1,45 @@ +#! /usr/bin/env ruby -S rspec + +require 'spec_helper' + +describe Puppet::Parser::Functions.function(:validate_nonemptyhash_msg) do + let(:scope) { PuppetlabsSpec::PuppetInternals.scope } + describe 'when calling validate_nonemptyhash_msg from puppet' do + + %w{ true false }.each do |the_string| + it "should not compile when #{the_string} is a string" do + Puppet[:code] = "validate_nonemptyhash_msg('#{the_string}', 'a msg')" + expect { scope.compiler.compile }.to raise_error(Puppet::ParseError, /a msg/) + end + + it "should not compile when #{the_string} is a bare word" do + Puppet[:code] = "validate_nonemptyhash_msg(#{the_string}, 'a msg')" + expect { scope.compiler.compile }.to raise_error(Puppet::ParseError, /a msg/) + end + end + + it "should compile when a hash argument is passed" do + Puppet[:code] = <<-'ENDofPUPPETcode' + $foo = { 'foo' => 'bar' } + validate_nonemptyhash_msg($foo, 'a msg') + ENDofPUPPETcode + scope.compiler.compile + end + + it "should not compile when an undef variable is passed" do + Puppet[:code] = <<-'ENDofPUPPETcode' + $foo = undef + validate_nonemptyhash_msg($foo, 'a msg') + ENDofPUPPETcode + expect { scope.compiler.compile }.to raise_error(Puppet::ParseError, /a msg/) + end + + it "should not compile when with an empty hash" do + Puppet[:code] = <<-'ENDofPUPPETcode' + $foo = [] + validate_nonemptyhash_msg($foo, 'a msg') + ENDofPUPPETcode + expect { scope.compiler.compile }.to raise_error(Puppet::ParseError, /a msg/) + end + end +end diff --git a/spec/unit/puppet/parser/functions/validate_nonemptyhash_spec.rb b/spec/unit/puppet/parser/functions/validate_nonemptyhash_spec.rb new file mode 100644 index 0000000..a788fb7 --- /dev/null +++ b/spec/unit/puppet/parser/functions/validate_nonemptyhash_spec.rb @@ -0,0 +1,55 @@ +#! /usr/bin/env ruby -S rspec + +require 'spec_helper' + +describe Puppet::Parser::Functions.function(:validate_nonemptyhash) do + let(:scope) { PuppetlabsSpec::PuppetInternals.scope } + describe 'when calling validate_nonemptyhash from puppet' do + + %w{ true false }.each do |the_string| + it "should not compile when #{the_string} is a string" do + Puppet[:code] = "validate_nonemptyhash('#{the_string}')" + expect { scope.compiler.compile }.to raise_error(Puppet::ParseError, /is not an Hash/) + end + + it "should not compile when #{the_string} is a bare word" do + Puppet[:code] = "validate_nonemptyhash(#{the_string})" + expect { scope.compiler.compile }.to raise_error(Puppet::ParseError, /is not an Hash/) + end + end + + it "should compile when multiple hash arguments are passed" do + Puppet[:code] = <<-'ENDofPUPPETcode' + $foo = { 'foo' => 'bar' } + $bar = { 'one' => 'two' } + validate_nonemptyhash($foo, $bar) + ENDofPUPPETcode + scope.compiler.compile + end + + it "should not compile when an undef variable is passed" do + Puppet[:code] = <<-'ENDofPUPPETcode' + $foo = undef + validate_nonemptyhash($foo) + ENDofPUPPETcode + expect { scope.compiler.compile }.to raise_error(Puppet::ParseError, /is not an Hash/) + end + + it "should not compile when with an empty hash" do + Puppet[:code] = <<-'ENDofPUPPETcode' + $foo = {} + validate_nonemptyhash($foo) + ENDofPUPPETcode + expect { scope.compiler.compile }.to raise_error(Puppet::ParseError, /is an empty Hash/) + end + + it "should not compile when multiple hashes are padded and one is empty" do + Puppet[:code] = <<-'ENDofPUPPETcode' + $foo = { 'foo' => 'bar' } + $bar = {} + validate_nonemptyhash($foo, $bar) + ENDofPUPPETcode + expect { scope.compiler.compile }.to raise_error(Puppet::ParseError, /is an empty Hash/) + end + end +end |