node.py

import collections
import os
import uuid
import re
import copy
import math

import exceptions
import json_templates
from connections import Link
from helper import Point, Line, Size


INTERFACE_NAME_RE = re.compile(r'(?P<base_name>[a-zA-Z]+)(?P<adapter_number>\d+)/(?P<port_number>\d+)')


class Node(object):
    """
    TODO
    @DynamicAttrs
    """
    L2_IOL_LABEL_COORDINATES = Point(-4, 46)
    L3_IOL_LABEL_COORDINATES = Point(15, 46)
    DEFAULT_LABEL_COORDINATES = Point(5, -25)
    SWITCH_SYMBOL_SIZE = Size(51, 48)
    ROUTER_SYMBOL_SIZE = Size(66, 45)

    def __init__(self, interfaces_dict=None, **kwargs):
        self.uuid = uuid.uuid4()

        for attr_name, attr_value in kwargs.items():
            setattr(self, attr_name, attr_value)

        # self.eve_node_id = eve_node_id
        # self.name = name
        # self.node_type = node_type
        # self.image_path = image_path
        # self.eve_icon = eve_icon
        # self.eve_coordinates = eve_coordinates
        #
        # self.serial_adapters_number = serial_adapters_number
        # self.ethernet_adapters_number = ethernet_adapters_number

        self.config = None
        self.interfaces = []
        self.id_to_interface = {}

        # self.topology = topology
        self.topology.id_to_node[self.eve_node_id] = self

        if interfaces_dict is not None:
            self.parse_interfaces(interfaces_dict)

    @classmethod
    def from_dict(cls, node_dict, topology=None):
        """
        TODO
        Creates a Node object if it does exist based on the node_dict

        Args:
            node_dict: dictionary, obtained from xmltodict representing the node
            id_to_network: dictionary, containing mapping from Network id to Network object
            id_to_node: dictionary, containing mapping from Node id to Node object

        Returns:
            instance of the class Node

        Examples:
            node_dict = {'@name': 'R1', '@eve_node_id': '123'}
            node = Node.from_dict(node_dict, {}, {})
        """
        params = cls.parse_node_dict(
            node_dict,
            topology.GNS_DEFAULT_SCENE_SIZE
        )
        node = topology.id_to_node.get(params['eve_node_id'])
        params['topology'] = topology
        interfaces_dict = node_dict.get('interface', [])

        if node is None:
            params['interfaces_dict'] = interfaces_dict
            # if the node does not yet exist, create a new one using class constructor
            return cls(**params)
        else:
            # if node already exists go through each attribute and set it for the existing object
            for attr_name, attr_value in params.items():
                setattr(node, attr_name, attr_value)
            node.parse_interfaces(interfaces_dict)
            return node

    @staticmethod
    def parse_node_dict(node_dict, gns_default_scene_size):
        """
        Parses dictionary from xmltodict and returns a new dictionary with different variable names

        Args:
            node_dict: dictionary obtained from xmltodict and containing information about nodes

        Returns:
            dictionary containing class Node attribute names with their values
        """
        params = dict()
        params['name'] = node_dict['@name']
        params['eve_node_id'] = node_dict['@id']
        params['node_type'] = node_dict['@type']  # iol, qemu
        params['template'] = node_dict['@template']  # vios, viosl2, iol
        params['image_path'] = node_dict['@image']
        params['eve_icon'] = node_dict['@icon']

        eve_x = node_dict['@left']
        if '%' in eve_x:
            eve_x = gns_default_scene_size.width * int(eve_x.strip('%')) * 0.01
        else:
            eve_x = int(eve_x)

        eve_y = node_dict['@top']
        if '%' in eve_y:
            eve_y = gns_default_scene_size.height * int(eve_y.strip('%')) * 0.01
        else:
            eve_y = int(eve_y)

        params['eve_coordinates'] = Point(eve_x, eve_y)
        if params['node_type'] == 'iol':
            params['ethernet_adapters_number'] = int(node_dict['@ethernet'])
            params['serial_adapters_number'] = int(node_dict['@serial'])
        elif params['node_type'] == 'qemu':
            params['console_type'] = node_dict['@console']
            params['cpus'] = int(node_dict['@cpu'])
            params['ram'] = int(node_dict['@ram'])
            params['adapters'] = int(node_dict['@ethernet'])
        else:
            raise NotImplementedError(f'Parser for the node type {params["node_type"]} is not implemented')

        return params

    @property
    def role(self):
        if 'router' in self.eve_icon.lower():
            return 'router'
        elif 'switch' in self.eve_icon.lower():
            return 'switch'
        else:
            return None

    def __repr__(self):
        return f'Node(eve_node_id={self.eve_node_id}, name={self.name})'

    def parse_interfaces(self, interfaces_dict):
        """
        TODO
        Goes through each interface in the dictionary and creates Interface objects for them

        Args:
            interfaces_dict: dictionary retrieved from xmltodict containing information about interfaces
            id_to_network: dictionary containing Network id to Network object mapping
            id_to_node: dictionary containing Node id to Node object mapping

        Modifies:
            self.interfaces - adds a new Interface to the list
            id_to_node - adds an id to Node object mapping to the dictionary
            May create a remote Node object and Interface if needed
        """
        def parse_interface_dict(int_dict):
            link_type = int_dict['@type']
            eve_interface_id = int(int_dict['@id'])
            eve_interface_name = int_dict['@name']
            try:
                interface = self.get_interface(eve_interface_id)
                interface.eve_name = eve_interface_name
            except exceptions.MissingInterface:
                if link_type == 'ethernet':
                    eve_network_id = int_dict['@network_id']
                    eve_network = self.topology.id_to_network.get(eve_network_id)
                    self.create_interface(eve_interface_id=eve_interface_id,
                                          eve_interface_name=eve_interface_name,
                                          eve_network=eve_network)

                elif link_type == 'serial':
                    eve_remote_node_id = int_dict['@remote_id']
                    eve_remote_interface_id = int(int_dict['@remote_if'])
                    remote_node = self.topology.id_to_node.get(eve_remote_node_id)

                    if remote_node is None:
                        # remote node does not exist yet
                        remote_node = Node(eve_node_id=eve_remote_node_id, topology=self.topology)
                    try:
                        remote_interface = remote_node.get_interface(eve_remote_interface_id)
                    except exceptions.MissingInterface:
                        remote_interface = remote_node.create_interface(
                            eve_interface_id=eve_remote_interface_id,
                            remote_node=self
                        )
                        # I do not update interface details later!

                    local_interface = self.create_interface(
                        eve_interface_id=eve_interface_id,
                        eve_interface_name=eve_interface_name,
                        remote_node=remote_node
                    )

                    remote_interface.remote_node = self

                    # link interfaces between each other
                    local_interface.remote_interface = remote_interface
                    remote_interface.remote_interface = local_interface

                    # create Link object if the link is point to point
                    link = Link(interfaces=(local_interface, remote_interface))
                    local_interface.link = link
                    remote_interface.link = link
                    self.topology.links.append(link)

        for interface_dict in interfaces_dict:
            parse_interface_dict(interface_dict)

    def get_interface(self, interface_id):
        """
        Gets an Interface object based on interface_id

        Args:
            interface_id: string, id of the interface in source xml file

        Returns:
            Interface object having this interface_id if exists

        Raises:
            errors.MissingInterface if interface was not found
        """
        try:
            return self.id_to_interface[interface_id]
        except KeyError:
            raise exceptions.MissingInterface(
                f'Interface with id {interface_id} does not exist on node with id {self.eve_node_id}'
            )

    def create_interface(self, eve_interface_id, eve_interface_name=None,
                         eve_network=None, remote_node=None,
                         remote_interface=None):
        """
        Creates an Interfaces object and stored it in self.interfaces list

        Args:
            eve_interface_id: string, interface id in source XML file
            eve_interface_name: string, interface name in source XML file
            eve_network: Network object to which an interface is connected
            remote_node: Node object, a Node to which an interface is connected if the link is serial
            remote_interface: Interface object, which belongs to
                a Node to which an interface is connected if the link is serial

        Returns:
            Interface object

        Modifies:
            self.interfaces - adds an Interface object to this list
            self.id_to_interface - adds id to Interface object mapping for quick access
        """
        interface = Interface(eve_id=eve_interface_id,
                              eve_name=eve_interface_name,
                              eve_network=eve_network,
                              node=self,
                              remote_node=remote_node,
                              remote_interface=remote_interface)
        self.id_to_interface[eve_interface_id] = interface
        self.interfaces.append(interface)
        return interface

    @property
    def gns_coordinates(self):
        return self.topology.get_gns_coordinates(self.eve_coordinates)

    @property
    def gns_image(self):
        if self.node_type == 'iol' and self.role == 'switch' and self.topology.args.l2_iol_image:
            return self.topology.args.l2_iol_image
        elif self.node_type == 'iol' and self.role == 'router' and self.topology.args.l3_iol_image:
            return self.topology.args.l3_iol_image
        else:
            return self.image_path

    @property
    def gns_label_coordinates(self):
        if self.node_type == 'iol' and self.role == 'switch':
            return self.L2_IOL_LABEL_COORDINATES
        elif self.node_type == 'iol' and self.role == 'router':
            return self.L3_IOL_LABEL_COORDINATES
        else:
            return self.DEFAULT_LABEL_COORDINATES

    @property
    def gns_icon(self):
        if self.role == 'switch':
            return ':/symbols/multilayer_switch.svg'
        elif self.role == 'router':
            return ':/symbols/router.svg'

    @property
    def gns_icon_size(self):
        if self.role == 'switch':
            return self.SWITCH_SYMBOL_SIZE
        elif self.role == 'router':
            return self.ROUTER_SYMBOL_SIZE

    @property
    def gns_icon_center_coordinates(self):
        return self.gns_coordinates + self.gns_icon_size / 2

    def write_config_to_dir(self, dst_dir):
        """
        Creates a config file for the node in the specified directory on disk

        Args:
            dst_dir: string, destination directory where the file should be written

        Returns:
            None
        """
        if self.config:
            filename = f'{self.name}_startup-config.cfg'
            path = os.path.join(dst_dir, filename)
            with open(path, 'wb') as f:
                f.write(self.config)

    def build_gns_topology_json(self):
        if self.node_type == 'iol':
            node_json = copy.deepcopy(json_templates.IOL_JSON_TEMPLATE)
            node_json['properties']['ethernet_adapters'] = self.ethernet_adapters_number
            node_json['properties']['serial_adapters'] = self.serial_adapters_number
            node_json['properties']['path'] = self.gns_image
        elif self.node_type == 'qemu':
            node_json = copy.deepcopy(json_templates.QEMU_JSON_TEMPLATE)
            node_json['properties']['adapters'] = self.adapters
            node_json['properties']['cpus'] = self.cpus
            node_json['properties']['ram'] = self.ram
            node_json['properties']['hda_disk_image'] = self.gns_image
            if self.template == 'vios':
                node_json['port_name_format'] = 'Gi0/{0}'
                node_json['properties']['hdb_disk_image'] = 'IOSv_startup_config.img'
                node_json['properties']['hdb_disk_interface'] = 'virtio'
            elif self.template == 'viosl2':
                node_json['port_name_format'] = 'Gi{1}/{0}'
                node_json['properties']['port_segment_size'] = 4
            else:
                node_json['port_name_format'] = 'Gi0/{0}'
        else:
            raise NotImplementedError("There is no template for the node type {self.node_type}")

        node_json['console'] = self.topology.console_start_port + int(self.eve_node_id)
        node_json['label']['text'] = self.name
        node_json['name'] = self.name
        node_json['node_id'] = str(self.uuid)

        node_json['symbol'] = self.gns_icon

        gns_coordinates = self.gns_coordinates
        node_json['x'] = gns_coordinates.x
        node_json['y'] = gns_coordinates.y
        node_json['width'] = self.gns_icon_size.x
        node_json['height'] = self.gns_icon_size.y

        gns_label_coordinates = self.gns_label_coordinates
        node_json['label']['x'] = gns_label_coordinates.x
        node_json['label']['y'] = gns_label_coordinates.y

        return node_json


class Interface(object):
    def __init__(self, eve_id, eve_name, eve_network=None, node=None,
                 remote_node=None, remote_interface=None):
        self.eve_id = eve_id
        self.eve_name = eve_name
        self.eve_network = eve_network
        self.node = node
        if self.eve_network is not None:
            self.eve_network.interfaces.append(self)
        self.link = None
        self.remote_node = remote_node
        self.remote_interface = remote_interface

    def __repr__(self):
        return f'Interface(eve_id={self.eve_id}, eve_name={self.eve_name}, node={self.node})'

    def get_adapter_port_number(self):
        if self.node.node_type == 'iol':
            parsed_values = INTERFACE_NAME_RE.match(self.eve_name).groupdict()
            return int(parsed_values['adapter_number']), int(parsed_values['port_number'])
        else:
            raise NotImplementedError('This method is valid only for IOL devices')