Puppet Function: validate_hash

Defined in:
puppet/modules/stdlib/lib/puppet/parser/functions/validate_hash.rb
Function type:
Ruby 3.x API

Overview

validate_hash() ⇒ Any

Validate that all passed values are hash data structures. Abort catalog compilation if any value fails this check.

The following values will pass:

$my_hash = { 'one' => 'two' }
validate_hash($my_hash)

The following values will fail, causing compilation to abort:

validate_hash(true)
validate_hash('some_string')
$undefined = undef
validate_hash($undefined)

Returns:

  • (Any) 


3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
 
# File 'puppet/modules/stdlib/lib/puppet/parser/functions/validate_hash.rb', line 3

newfunction(:validate_hash, :doc => <<-'ENDHEREDOC') do |args|
  Validate that all passed values are hash data structures. Abort catalog
  compilation if any value fails this check.

  The following values will pass:

      $my_hash = { 'one' => 'two' }
      validate_hash($my_hash)

  The following values will fail, causing compilation to abort:

      validate_hash(true)
      validate_hash('some_string')
      $undefined = undef
      validate_hash($undefined)

  ENDHEREDOC

  function_deprecation([:validate_hash, 'This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::Hash. There is further documentation for validate_legacy function in the README.'])

  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