Merge "apiserver: mock socket.gethostbyname"
[yardstick.git] / yardstick / benchmark / scenarios / networking / vnf_generic.py
index e6dca92..905f1f4 100644 (file)
 """ NSPerf specific scenario definition """
 
 from __future__ import absolute_import
-import logging
 
+import logging
 import errno
-import os
 
+import ipaddress
+import os
+import sys
 import re
 from itertools import chain
-from operator import itemgetter
+
+import six
 from collections import defaultdict
 
 from yardstick.benchmark.scenarios import base
@@ -31,8 +34,10 @@ from yardstick.network_services.collector.subscriber import Collector
 from yardstick.network_services.vnf_generic import vnfdgen
 from yardstick.network_services.vnf_generic.vnf.base import GenericVNF
 from yardstick.network_services.traffic_profile.base import TrafficProfile
+from yardstick.network_services.utils import get_nsb_option
 from yardstick import ssh
 
+
 LOG = logging.getLogger(__name__)
 
 
@@ -57,10 +62,11 @@ class IncorrectSetup(Exception):
 
 
 class SshManager(object):
-    def __init__(self, node):
+    def __init__(self, node, timeout=120):
         super(SshManager, self).__init__()
         self.node = node
         self.conn = None
+        self.timeout = timeout
 
     def __enter__(self):
         """
@@ -69,7 +75,7 @@ class SshManager(object):
         """
         try:
             self.conn = ssh.SSH.from_node(self.node)
-            self.conn.wait()
+            self.conn.wait(timeout=self.timeout)
         except SSHError as error:
             LOG.info("connect failed to %s, due to %s", self.node["ip"], error)
         # self.conn defaults to None
@@ -81,19 +87,22 @@ class SshManager(object):
 
 
 def find_relative_file(path, task_path):
+    """
+    Find file in one of places: in abs of path or
+    relative to TC scenario file. In this order.
+
+    :param path:
+    :param task_path:
+    :return str: full path to file
+    """
     # fixme: create schema to validate all fields have been provided
-    try:
-        with open(path):
+    for lookup in [os.path.abspath(path), os.path.join(task_path, path)]:
+        try:
+            with open(lookup):
+                return lookup
+        except IOError:
             pass
-        return path
-    except IOError as e:
-        if e.errno != errno.ENOENT:
-            raise
-        else:
-            rel_path = os.path.join(task_path, path)
-            with open(rel_path):
-                pass
-            return rel_path
+    raise IOError(errno.ENOENT, 'Unable to find {} file'.format(path))
 
 
 def open_relative_file(path, task_path):
@@ -125,20 +134,62 @@ class NetworkServiceTestCase(base.Scenario):
         self.vnfs = []
         self.collector = None
         self.traffic_profile = None
+        self.node_netdevs = {}
+
+    def _get_ip_flow_range(self, ip_start_range):
+
+        node_name, range_or_interface = next(iter(ip_start_range.items()), (None, '0.0.0.0'))
+        if node_name is not None:
+            node = self.context_cfg["nodes"].get(node_name, {})
+            try:
+                # the ip_range is the interface name
+                interface = node.get("interfaces", {})[range_or_interface]
+            except KeyError:
+                ip = "0.0.0.0"
+                mask = "255.255.255.0"
+            else:
+                ip = interface["local_ip"]
+                # we can't default these values, they must both exist to be valid
+                mask = interface["netmask"]
+
+            ipaddr = ipaddress.ip_network(six.text_type('{}/{}'.format(ip, mask)), strict=False)
+            hosts = list(ipaddr.hosts())
+            if len(hosts) > 2:
+                # skip the first host in case of gateway
+                ip_addr_range = "{}-{}".format(hosts[1], hosts[-1])
+            else:
+                LOG.warning("Only single IP in range %s", ipaddr)
+                # fall back to single IP range
+                ip_addr_range = ip
+        else:
+            # we are manually specifying the range
+            ip_addr_range = range_or_interface
+        return ip_addr_range
 
     def _get_traffic_flow(self):
+        flow = {}
         try:
-            with open(self.scenario_cfg["traffic_options"]["flow"]) as fflow:
-                flow = yaml_load(fflow)
-        except (KeyError, IOError, OSError):
+            # TODO: should be .0  or .1 so we can use list
+            # but this also roughly matches uplink_0, downlink_0
+            fflow = self.scenario_cfg["options"]["flow"]
+            for index, src in enumerate(fflow.get("src_ip", [])):
+                flow["src_ip_{}".format(index)] = self._get_ip_flow_range(src)
+
+            for index, dst in enumerate(fflow.get("dst_ip", [])):
+                flow["dst_ip_{}".format(index)] = self._get_ip_flow_range(dst)
+
+            for index, publicip in enumerate(fflow.get("public_ip", [])):
+                flow["public_ip_{}".format(index)] = publicip
+
+            flow["count"] = fflow["count"]
+        except KeyError:
             flow = {}
-        return flow
+        return {"flow": flow}
 
     def _get_traffic_imix(self):
         try:
-            with open(self.scenario_cfg["traffic_options"]["imix"]) as fimix:
-                imix = yaml_load(fimix)
-        except (KeyError, IOError, OSError):
+            imix = {"imix": self.scenario_cfg['options']['framesize']}
+        except KeyError:
             imix = {}
         return imix
 
@@ -153,8 +204,8 @@ class NetworkServiceTestCase(base.Scenario):
         traffic_map_data = {
             'flow': self._get_traffic_flow(),
             'imix': self._get_traffic_imix(),
-            'private': {},
-            'public': {},
+            TrafficProfile.UPLINK: {},
+            TrafficProfile.DOWNLINK: {},
         }
 
         traffic_vnfd = vnfdgen.generate_vnfd(traffic_mapping, traffic_map_data)
@@ -168,7 +219,26 @@ class NetworkServiceTestCase(base.Scenario):
 
     @staticmethod
     def get_vld_networks(networks):
-        return {n['vld_id']: n for n in networks.values()}
+        # network name is vld_id
+        vld_map = {}
+        for name, n in networks.items():
+            try:
+                vld_map[n['vld_id']] = n
+            except KeyError:
+                vld_map[name] = n
+        return vld_map
+
+    @staticmethod
+    def find_node_if(nodes, name, if_name, vld_id):
+        try:
+            # check for xe0, xe1
+            intf = nodes[name]["interfaces"][if_name]
+        except KeyError:
+            # if not xe0, then maybe vld_id,  uplink_0, downlink_0
+            # pop it and re-insert with the correct name from topology
+            intf = nodes[name]["interfaces"].pop(vld_id)
+            nodes[name]["interfaces"][if_name] = intf
+        return intf
 
     def _resolve_topology(self):
         for vld in self.topology["vld"]:
@@ -186,8 +256,8 @@ class NetworkServiceTestCase(base.Scenario):
 
             try:
                 nodes = self.context_cfg["nodes"]
-                node0_if = nodes[node0_name]["interfaces"][node0_if_name]
-                node1_if = nodes[node1_name]["interfaces"][node1_if_name]
+                node0_if = self.find_node_if(nodes, node0_name, node0_if_name, vld["id"])
+                node1_if = self.find_node_if(nodes, node1_name, node1_if_name, vld["id"])
 
                 # names so we can do reverse lookups
                 node0_if["ifname"] = node0_if_name
@@ -196,7 +266,6 @@ class NetworkServiceTestCase(base.Scenario):
                 node0_if["node_name"] = node0_name
                 node1_if["node_name"] = node1_name
 
-                vld_networks = self.get_vld_networks(self.context_cfg["networks"])
                 node0_if["vld_id"] = vld["id"]
                 node1_if["vld_id"] = vld["id"]
 
@@ -209,6 +278,7 @@ class NetworkServiceTestCase(base.Scenario):
                 node1_if["peer_ifname"] = node0_if_name
 
                 # just load the network
+                vld_networks = self.get_vld_networks(self.context_cfg["networks"])
                 node0_if["network"] = vld_networks.get(vld["id"], {})
                 node1_if["network"] = vld_networks.get(vld["id"], {})
 
@@ -237,8 +307,8 @@ class NetworkServiceTestCase(base.Scenario):
             node1_if_name = node1_data["vnfd-connection-point-ref"]
 
             nodes = self.context_cfg["nodes"]
-            node0_if = nodes[node0_name]["interfaces"][node0_if_name]
-            node1_if = nodes[node1_name]["interfaces"][node1_if_name]
+            node0_if = self.find_node_if(nodes, node0_name, node0_if_name, vld["id"])
+            node1_if = self.find_node_if(nodes, node1_name, node1_if_name, vld["id"])
 
             # add peer interface dict, but remove circular link
             # TODO: don't waste memory
@@ -258,17 +328,16 @@ class NetworkServiceTestCase(base.Scenario):
             vnfd = self._find_vnfd_from_vnf_idx(vnf_idx)
             self.context_cfg["nodes"][vnf_name].update(vnfd)
 
-    @staticmethod
-    def _sort_dpdk_port_num(netdevs):
-        # dpdk_port_num is PCI BUS ID ordering, lowest first
-        s = sorted(netdevs.values(), key=itemgetter('pci_bus_id'))
-        for dpdk_port_num, netdev in enumerate(s):
-            netdev['dpdk_port_num'] = dpdk_port_num
+    def _probe_netdevs(self, node, node_dict, timeout=120):
+        try:
+            return self.node_netdevs[node]
+        except KeyError:
+            pass
 
-    def _probe_netdevs(self, node, node_dict):
-        cmd = "PATH=$PATH:/sbin:/usr/sbin ip addr show"
         netdevs = {}
-        with SshManager(node_dict) as conn:
+        cmd = "PATH=$PATH:/sbin:/usr/sbin ip addr show"
+
+        with SshManager(node_dict, timeout=timeout) as conn:
             if conn:
                 exit_status = conn.execute(cmd)[0]
                 if exit_status != 0:
@@ -279,6 +348,8 @@ class NetworkServiceTestCase(base.Scenario):
                     raise IncorrectSetup(
                         "Cannot find netdev info in sysfs" % node)
                 netdevs = node_dict['netdevs'] = self.parse_netdev_info(stdout)
+
+        self.node_netdevs[node] = netdevs
         return netdevs
 
     @classmethod
@@ -303,6 +374,10 @@ class NetworkServiceTestCase(base.Scenario):
 
         :return: None. Side effect: context_cfg is updated
         """
+        num_nodes = len(self.context_cfg["nodes"])
+        # OpenStack instance creation time is probably proportional to the number
+        # of instances
+        timeout = 120 * num_nodes
         for node, node_dict in self.context_cfg["nodes"].items():
 
             for network in node_dict["interfaces"].values():
@@ -312,16 +387,16 @@ class NetworkServiceTestCase(base.Scenario):
 
                 # only ssh probe if there are missing values
                 # ssh probe won't work on Ixia, so we had better define all our values
-
                 try:
-                    netdevs = self._probe_netdevs(node, node_dict)
-                    self._probe_missing_values(netdevs, network)
-                except KeyError:
-                    pass
+                    netdevs = self._probe_netdevs(node, node_dict, timeout=timeout)
                 except (SSHError, SSHTimeout):
                     raise IncorrectConfig(
                         "Unable to probe missing interface fields '%s', on node %s "
                         "SSH Error" % (', '.join(missing), node))
+                try:
+                    self._probe_missing_values(netdevs, network)
+                except KeyError:
+                    pass
                 else:
                     missing = self.TOPOLOGY_REQUIRED_KEYS.difference(
                         network)
@@ -391,10 +466,22 @@ printf "%s/driver:" $1 ; basename $(readlink -s $1/device/driver); } \
                               (expected_name, classes_found))
 
     @staticmethod
-    def update_interfaces_from_node(vnfd, node):
-        for intf in vnfd["vdu"][0]["external-interface"]:
-            node_intf = node['interfaces'][intf['name']]
-            intf['virtual-interface'].update(node_intf)
+    def create_interfaces_from_node(vnfd, node):
+        ext_intfs = vnfd["vdu"][0]["external-interface"] = []
+        # have to sort so xe0 goes first
+        for intf_name, intf in sorted(node['interfaces'].items()):
+            if intf.get('vld_id'):
+                # force dpkd_port_num to int so we can do reverse lookup
+                try:
+                    intf['dpdk_port_num'] = int(intf['dpdk_port_num'])
+                except KeyError:
+                    pass
+                ext_intf = {
+                    "name": intf_name,
+                    "virtual-interface": intf,
+                    "vnfd-connection-point-ref": intf_name,
+                }
+                ext_intfs.append(ext_intf)
 
     def load_vnf_models(self, scenario_cfg=None, context_cfg=None):
         """ Create VNF objects based on YAML descriptors
@@ -404,6 +491,9 @@ printf "%s/driver:" $1 ; basename $(readlink -s $1/device/driver); } \
         :param context_cfg:
         :return:
         """
+        trex_lib_path = get_nsb_option('trex_client_lib')
+        sys.path[:] = list(chain([trex_lib_path], (x for x in sys.path if x != trex_lib_path)))
+
         if scenario_cfg is None:
             scenario_cfg = self.scenario_cfg
 
@@ -421,7 +511,7 @@ printf "%s/driver:" $1 ; basename $(readlink -s $1/device/driver); } \
             vnfd = vnfdgen.generate_vnfd(vnf_model, node)
             # TODO: here add extra context_cfg["nodes"] regardless of template
             vnfd = vnfd["vnfd:vnfd-catalog"]["vnfd"][0]
-            self.update_interfaces_from_node(vnfd, node)
+            self.create_interfaces_from_node(vnfd, node)
             vnf_impl = self.get_vnf_impl(vnfd['id'])
             vnf_instance = vnf_impl(node_name, vnfd)
             vnfs.append(vnf_instance)
@@ -451,7 +541,6 @@ printf "%s/driver:" $1 ; basename $(readlink -s $1/device/driver); } \
             for vnf in chain(traffic_runners, non_traffic_runners):
                 LOG.info("Instantiating %s", vnf.name)
                 vnf.instantiate(self.scenario_cfg, self.context_cfg)
-            for vnf in chain(traffic_runners, non_traffic_runners):
                 LOG.info("Waiting for %s to instantiate", vnf.name)
                 vnf.wait_for_instantiate()
         except RuntimeError:
@@ -484,7 +573,7 @@ printf "%s/driver:" $1 ; basename $(readlink -s $1/device/driver); } \
         for vnf in self.vnfs:
             # Result example:
             # {"VNF1: { "tput" : [1000, 999] }, "VNF2": { "latency": 100 }}
-            LOG.debug("vnf")
+            LOG.debug("collect KPI for %s", vnf.name)
             result.update(self.collector.get_kpi(vnf))
 
     def teardown(self):