Puppet Function: validate_string

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

Overview

validate_string() ⇒ Any

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

The following values will pass:

$my_string = "one two"
validate_string($my_string, 'three')

The following values will fail, causing compilation to abort:

validate_string(true)
validate_string([ 'some', 'array' ])

Note: validate_string(undef) will not fail in this version of the functions API (incl. current and future parser). Instead, use:

if $var == undef {
  fail('...')
}

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
36
37
38
39
 
# File 'puppet/modules/stdlib/lib/puppet/parser/functions/validate_string.rb', line 3

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

  The following values will pass:

      $my_string = "one two"
      validate_string($my_string, 'three')

  The following values will fail, causing compilation to abort:

      validate_string(true)
      validate_string([ 'some', 'array' ])

  Note: validate_string(undef) will not fail in this version of the
  functions API (incl. current and future parser). Instead, use:

      if $var == undef {
        fail('...')
      }

  ENDHEREDOC

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

  unless args.length > 0 then
    raise Puppet::ParseError, ("validate_string(): wrong number of arguments (#{args.length}; must be > 0)")
  end

  args.each do |arg|
    # when called through the v4 API shim, undef gets translated to nil
    unless arg.is_a?(String) || arg.nil?
      raise Puppet::ParseError, ("#{arg.inspect} is not a string.  It looks to be a #{arg.class}")
    end
  end

end