Puppet Function: validate_array

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

Summary

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

Overview

validate_array() ⇒ Any

Examples:

*Usage*

The following values will pass:

    $my_array = [ 'one', 'two' ]
    validate_array($my_array)

The following values will fail, causing compilation to abort:

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

Returns:

  • (Any) —

    validate array



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
34
35
36
37
38
39
40
41
 
# File 'vendor_modules/stdlib/lib/puppet/parser/functions/validate_array.rb', line 7

newfunction(:validate_array, doc: <<-DOC) do |args|
  @summary
    Validate that all passed values are array data structures. Abort catalog
    compilation if any value fails this check.

  @return
    validate array

  @example **Usage**
    The following values will pass:

        $my_array = [ 'one', 'two' ]
        validate_array($my_array)

    The following values will fail, causing compilation to abort:

        validate_array(true)
        validate_array('some_string')
        $undefined = undef
        validate_array($undefined)
    DOC

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

  if args.empty?
    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