From 4c00cfc610cc132080dc5baa1ac8f231c4b76368 Mon Sep 17 00:00:00 2001
From: Jeff McCune <jeff@puppetlabs.com>
Date: Tue, 21 Jun 2011 17:01:33 -0700
Subject: (#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.
---
 lib/puppet/parser/functions/validate_hash.rb | 37 ++++++++++++++++++++++++++++
 1 file changed, 37 insertions(+)
 create mode 100644 lib/puppet/parser/functions/validate_hash.rb

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
-- 
cgit v1.2.3


From 08882ccd3b84eda124b56679e2885881a009ba12 Mon Sep 17 00:00:00 2001
From: Jeff McCune <jeff@puppetlabs.com>
Date: Tue, 21 Jun 2011 17:02:22 -0700
Subject: (#8010) Add validate_hash spec tests

These tests run through a number of example cases and exercise the
behavior of the validate_hash function.

To run, simple execute rspec validate_hash_spec.rb
---
 .../puppet/parser/functions/validate_hash_spec.rb  | 63 ++++++++++++++++++++++
 1 file changed, 63 insertions(+)
 create mode 100644 spec/unit/puppet/parser/functions/validate_hash_spec.rb

diff --git a/spec/unit/puppet/parser/functions/validate_hash_spec.rb b/spec/unit/puppet/parser/functions/validate_hash_spec.rb
new file mode 100644
index 0000000..8cc0b3d
--- /dev/null
+++ b/spec/unit/puppet/parser/functions/validate_hash_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_hash) 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_hash from puppet' do
+
+    %w{ true false }.each do |the_string|
+
+      it "should not compile when #{the_string} is a string" do
+        Puppet[:code] = "validate_hash('#{the_string}')"
+        get_scope
+        expect { @scope.compiler.compile }.should raise_error(Puppet::ParseError, /is not a Hash/)
+      end
+
+      it "should not compile when #{the_string} is a bare word" do
+        Puppet[:code] = "validate_hash(#{the_string})"
+        get_scope
+        expect { @scope.compiler.compile }.should raise_error(Puppet::ParseError, /is not a Hash/)
+      end
+
+    end
+
+    it "should compile when multiple hash arguments are passed" do
+      Puppet[:code] = <<-'ENDofPUPPETcode'
+        $foo = {}
+        $bar = { 'one' => 'two' }
+        validate_hash($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_hash($foo)
+      ENDofPUPPETcode
+      get_scope
+      expect { @scope.compiler.compile }.should raise_error(Puppet::ParseError, /is not a Hash/)
+    end
+
+  end
+
+end
+
-- 
cgit v1.2.3