put_address_in_context.py

# -*- coding: utf-8 -*-
#
# Copyright 2019 Radosław Piliszek (yoctozepto)
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

from ipaddress import ip_address
from kolla_ansible.exception import FilterError


def put_address_in_context(address, context):
    """puts address in context

    :param address: the address to contextify
    :param context: describes context in which the address appears,
                    either 'url' or 'memcache',
                    affects only IPv6 addresses format
    :returns: string with address in proper context
    """

    if context not in ['url', 'memcache', 'rabbitmq']:
        raise FilterError("Unknown context '{context}'"
                          .format(context=context))

    if ':' not in address and context != 'rabbitmq':
        return address

    # must be IPv6 raw address

    if context == 'url':
        return '[{address}]'.format(address=address)
    if context == 'memcache':
        return 'inet6:[{address}]'.format(address=address)

    # rabbitmq/erlang has special syntax for ip addresses in IPv4 and IPv6
    # see: https://www.erlang.org/doc/man/inet.html
    # replacing dots and colons with decimal points
    # and converting IPv6 as described here:
    # https://www.erlang.org/doc/man/inet.html#type-ip6_address

    if context == 'rabbitmq':
        if ip_address(address).version == 6:
            return (",".join(['16#%x' % int(x, 16)
                    for x in
                    ip_address(address).exploded.split(':')]))

        return address.replace('.', ',')

    return address