Puppet Function: validate_bool

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

Overview

validate_bool() ⇒ Any

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

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) 


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

newfunction(:validate_bool, :doc => <<-'ENDHEREDOC') do |args|
  Validate that all passed values are either true or false. Abort catalog
  compilation if any value fails this check.

  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)

  ENDHEREDOC

  # The deprecation function was being called twice, as validate_bool calls is_bool. I have removed it from here so it only calls deprecation once within is_bool.
  # function_deprecation([:validate_bool, 'This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::Bool. There is further documentation for validate_legacy function in the README.'])

  unless args.length > 0 then
    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