4 module Puppet::Parser::Functions
5 newfunction(:validate_re, :doc => <<-DOC
7 Perform simple validation of a string against one or more regular
10 The first argument of this function should be a string to
11 test, and the second argument should be a stringified regular expression
12 (without the // delimiters) or an array of regular expressions. If none
13 of the regular expressions match the string passed in, compilation will
14 abort with a parse error.
15 If a third argument is specified, this will be the error message raised and
19 validation of a string against one or more regular expressions.
22 The following strings will validate against the regular expressions:
24 validate_re('one', '^one$')
25 validate_re('one', [ '^one', '^two' ])
27 The following strings will fail to validate, causing compilation to abort:
29 validate_re('one', [ '^two', '^three' ])
31 A helpful error message can be returned like this:
33 validate_re($::puppetversion, '^2.7', 'The $puppetversion fact value does not match 2.7')
36 Compilation will also abort, if the first argument is not a String. Always use
37 quotes to force stringification:
38 validate_re("${::operatingsystemmajrelease}", '^[57]$')
41 function_deprecation([:validate_re, 'This method is deprecated, please use the stdlib validate_legacy function,
42 with Stdlib::Compat::Re. There is further documentation for validate_legacy function in the README.'])
44 if (args.length < 2) || (args.length > 3)
45 raise Puppet::ParseError, "validate_re(): wrong number of arguments (#{args.length}; must be 2 or 3)"
48 raise Puppet::ParseError, "validate_re(): input needs to be a String, not a #{args[0].class}" unless args[0].is_a? String
50 msg = args[2] || "validate_re(): #{args[0].inspect} does not match #{args[1].inspect}"
52 # We're using a flattened array here because we can't call String#any? in
53 # Ruby 1.9 like we can in Ruby 1.8
54 raise Puppet::ParseError, msg unless [args[1]].flatten.any? do |re_str|
55 args[0] =~ Regexp.compile(re_str)