(#8010) Add validate_hash function

This function validates all passed variables are hashes.  This is
similar to the validate_bool function and is copied from it.

1 files changed, 37 insertions, 0 deletions

diff --git a/lib/puppet/parser/functions/validate_hash.rb b/lib/puppet/parser/functions/validate_hash.rb
new file mode 100644
index 0000000..1443318
--- /dev/null
+++ b/lib/puppet/parser/functions/validate_hash.rb
@@ -0,0 +1,37 @@
+module Puppet::Parser::Functions
+
+  newfunction(:validate_hash, :doc => <<-'ENDHEREDOC') do |args|
+    Validate all passed values are a Hash data structure
+    value does not pass the check.
+
+    Example:
+
+    These values validate
+
+        $my_hash = { 'one' => 'two' }
+        validate_hash($my_hash)
+
+    These values do NOT validate
+
+        validate_hash(true)
+        validate_hash('some_string')
+        $undefined = undef
+        validate_hash($undefined)
+
+    * Jeff McCune <jeff@puppetlabs.com>
+
+    ENDHEREDOC
+
+    unless args.length > 0 then
+      raise Puppet::ParseError, ("validate_hash(): 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 a Hash.  It looks to be a #{arg.class}")
+      end
+    end
+
+  end
+
+end