+#
+# validate_domain_name.rb
+#
module Puppet::Parser::Functions
- newfunction(:validate_domain_name, :doc => <<-ENDHEREDOC
- Validate that all values passed are syntactically correct domain names.
- Fail compilation if any value fails this check.
+ newfunction(:validate_domain_name, :doc => <<-DOC
+ @summary
+ Validate that all values passed are syntactically correct domain names.
+ Fail compilation if any value fails this check.
- The following values will pass:
+ @return
+ passes when the given values are syntactically correct domain names or raise an error when they are not and fails compilation
- $my_domain_name = 'server.domain.tld'
- validate_domain_name($my_domain_name)
- validate_domain_name('domain.tld', 'puppet.com', $my_domain_name)
+ @example **Usage**
- The following values will fail, causing compilation to abort:
+ The following values will pass:
- validate_domain_name(1)
- validate_domain_name(true)
- validate_domain_name('invalid domain')
- validate_domain_name('-foo.example.com')
- validate_domain_name('www.example.2com')
+ $my_domain_name = 'server.domain.tld'
+ validate_domain_name($my_domain_name)
+ validate_domain_name('domain.tld', 'puppet.com', $my_domain_name)
- ENDHEREDOC
- ) do |args|
+ The following values will fail, causing compilation to abort:
+
+ validate_domain_name(1)
+ validate_domain_name(true)
+ validate_domain_name('invalid domain')
+ validate_domain_name('-foo.example.com')
+ validate_domain_name('www.example.2com')
+ DOC
+ ) do |args|
rescuable_exceptions = [ArgumentError]