Puppet Function: validate_bool

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

Summary

Validate that all passed values are either true or false. Abort catalog compilation if any value fails this check.

Overview

validate_bool() ⇒ Any

Examples:

Usage


The following values will pass:

    $iamtrue = true
    validate_bool(true)
    validate_bool(true, true, false, $iamtrue)

The following values will fail, causing compilation to abort:

    $some_array = [ true ]
    validate_bool("false")
    validate_bool("true")
    validate_bool($some_array)

Returns:

  • (Any) —

    validate boolean



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
 
# File 'lib/puppet/parser/functions/validate_bool.rb', line 7

newfunction(:validate_bool, doc: <<-DOC
  @summary
    Validate that all passed values are either true or false. Abort catalog
    compilation if any value fails this check.

  @return
    validate boolean

  @example **Usage**

    The following values will pass:

        $iamtrue = true
        validate_bool(true)
        validate_bool(true, true, false, $iamtrue)

    The following values will fail, causing compilation to abort:

        $some_array = [ true ]
        validate_bool("false")
        validate_bool("true")
        validate_bool($some_array)
    DOC
) do |args|
  if args.empty?
    raise Puppet::ParseError, "validate_bool(): wrong number of arguments (#{args.length}; must be > 0)"
  end

  args.each do |arg|
    unless function_is_bool([arg])
      raise Puppet::ParseError, "#{arg.inspect} is not a boolean.  It looks to be a #{arg.class}"
    end
  end
end