Puppet Function: enclose_ipv6

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

Summary

Takes an array of ip addresses and encloses the ipv6 addresses with square brackets.

Overview

enclose_ipv6() ⇒ Any

Returns:

  • (Any) —

    encloses the ipv6 addresses with square brackets.



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
40
41
42
43
44
45
46
 
# File 'vendor_modules/stdlib/lib/puppet/parser/functions/enclose_ipv6.rb', line 7

newfunction(:enclose_ipv6, type: :rvalue, doc: <<-DOC
  @summary
    Takes an array of ip addresses and encloses the ipv6 addresses with square brackets.

  @return
    encloses the ipv6 addresses with square brackets.

DOC
) do |arguments|
  require 'ipaddr'

  rescuable_exceptions = [ArgumentError]
  if defined?(IPAddr::InvalidAddressError)
    rescuable_exceptions << IPAddr::InvalidAddressError
  end

  if arguments.size != 1
    raise(Puppet::ParseError, "enclose_ipv6(): Wrong number of arguments given #{arguments.size} for 1")
  end
  unless arguments[0].is_a?(String) || arguments[0].is_a?(Array)
    raise(Puppet::ParseError, "enclose_ipv6(): Wrong argument type given #{arguments[0].class} expected String or Array")
  end

  input = [arguments[0]].flatten.compact
  result = []

  input.each do |val|
    unless val == '*'
      begin
        ip = IPAddr.new(val)
      rescue *rescuable_exceptions
        raise(Puppet::ParseError, "enclose_ipv6(): Wrong argument given #{val} is not an ip address.")
      end
      val = "[#{ip}]" if ip.ipv6?
    end
    result << val
  end

  return result.uniq
end