python-oca/oca/vn.py

# -*- coding: UTF-8 -*-
from .pool import XMLElement, Pool, PoolElement, Template, extractString


class Lease(XMLElement):
    XML_TYPES = {
        'ip': str,
        'mac': str,
    }

    def __init__(self, xml):
        super(Lease, self).__init__(xml)
        self._convert_types()


class LeasesList(list):
    def __init__(self, xml):
        if xml is None:
            return
        self.xml = xml
        for element in self.xml:
            self.append(self._factory(element))

    def _factory(self, xml):
        v = Lease(xml)
        v._convert_types()
        return v


class AddressRange(XMLElement):
    XML_TYPES = {
        'id': ["AR_ID", lambda xml: int(xml.text)],
        'size': int,
        'leases': ['LEASES', LeasesList],
        # 'template' : ['TEMPLATE', Template],
    }

    def __init__(self, xml):
        super(AddressRange, self).__init__(xml)
        self._convert_types()
        self.id = self['AR_ID'] if self['AR_ID'] else None


class AddressRangeList(list):
    def __init__(self, xml):
        self.xml = xml
        for element in self.xml:
            self.append(self._factory(element))

    def _factory(self, xml):
        v = AddressRange(xml)
        v._convert_types()
        return v


class VirtualNetwork(PoolElement):
    METHODS = {
        'info': 'vn.info',
        'allocate': 'vn.allocate',
        'delete': 'vn.delete',
        'publish': 'vn.publish',
        'chown': 'vn.chown',
        'hold': 'vn.hold',
        'release': 'vn.release',
    }

    XML_TYPES = {
        'id': int,
        'uid': int,
        'gid': int,
        'uname': str,
        'gname': str,
        'name': str,
        # 'type'     : int,
        'bridge': str,
        # 'public'   : bool,
        'used_leases': int,
        'template': ['TEMPLATE', Template],
        'address_ranges': ['AR_POOL', AddressRangeList],
    }

    ELEMENT_NAME = 'VNET'

    @staticmethod
    def allocate(client, template):
        """
        allocates a new virtual network in OpenNebula

        Arguments

        ``template``
           a string containing the template of the virtual network
        """
        vn_id = client.call(VirtualNetwork.METHODS['allocate'], template)
        return vn_id

    def __init__(self, xml, client):
        # add 'vn_mad' attribute in OpenNebula >= 5
        xml_types = VirtualNetwork.XML_TYPES
        if client.one_version is None:
            client.version()
        if client.one_version >= '5' and 'vn_mad' not in xml_types:
            xml_types['vn_mad'] = extractString

        super(VirtualNetwork, self).__init__(xml, client)
        self.id = self['ID'] if self['ID'] else None

    def publish(self):
        """
        Publishes a virtual network.
        """
        self.client.call(self.METHODS['publish'], self.id, True)

    def unpublish(self):
        """
        Unpublishes a virtual network.
        """
        self.client.call(self.METHODS['publish'], self.id, False)

    def chown(self, uid, gid):
        """
        Changes the owner/group

        Arguments

        ``uid``
        New owner id. Set to -1 to leave current value
        ``gid``
        New group id. Set to -1 to leave current value
        """
        self.client.call(self.METHODS['chown'], self.id, uid, gid)

    def release(self, ip):
        """
        Releases given IP

        Arguments

        ``ip``
        IP to realse
        """
        self.client.call(self.METHODS['release'], self.id, 'LEASES=[IP={}]'.format(ip))

    def hold(self, ip):
        """
        Holds given IP

        Arguments

        ``ip``
        IP to hold
        """
        self.client.call(self.METHODS['hold'], self.id, 'LEASES=[IP={}]'.format(ip))

    def __repr__(self):
        return '<oca.VirtualNetwork("%s")>' % self.name


class VirtualNetworkPool(Pool):
    METHODS = {
        'info': 'vnpool.info',
    }

    def __init__(self, client, preload_info=False):
        self.preload_info = preload_info
        super(VirtualNetworkPool, self).__init__('VNET_POOL', 'VNET', client)

    def _factory(self, xml):
        v = VirtualNetwork(xml, self.client)
        v._convert_types()
        if self.preload_info:
            v.info()
        return v