3rdparty/modules/stdlib/lib/puppet/parser/functions/validate_re.rb

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