Puppet Function: simplib::validate_bool

Defined in:
lib/puppet/functions/simplib/validate_bool.rb
Function type:
Ruby 4.x API

Overview

simplib::validate_bool(Variant[String,Boolean] *$values_to_validate) ⇒ Nil

Validate that all passed values are either ‘true`, ’true’, ‘false` or ’false’.

Terminates catalog compilation if validation fails.

Examples:

Passing validation


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

Failing validation

$some_array = [ true ]
validate_bool($some_array)
validate_bool('True')
validate_bool('TRUE')

Parameters:

  • *values_to_validate (Variant[String,Boolean]) —

    One or more values to validate

Returns:

  • (Nil)

Raises:

  • (RuntimeError) —

    if validation fails



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

Puppet::Functions.create_function(:'simplib::validate_bool') do

  # @param values_to_validate One or more values to validate
  # @return [Nil]
  # @raise [RuntimeError] if validation fails
  # @example Passing validation
  #
  #     $iamtrue = true
  #     validate_bool(true)
  #     validate_bool("false")
  #     validate_bool("true")
  #     validate_bool(true, 'true', false, $iamtrue)
  #
  # @example Failing validation
  #     $some_array = [ true ]
  #     validate_bool($some_array)
  #     validate_bool('True')
  #     validate_bool('TRUE')
  #
  dispatch :validate_bool do
    required_repeated_param 'Variant[String,Boolean]', :values_to_validate
  end

  def validate_bool(*values_to_validate)
    valid_entries = [true, false, 'true', 'false']
    values_to_validate.each do |value|
      unless valid_entries.include?(value) then
        fail("simplib::validate_bool: '#{value}' is not a boolean.")
      end
    end
  end
end