framework: Add reworked framework to repo

This commit adds the vSwitch Integration Test Framework whose
design, based off TOIT, is outlined in the HLD previously made
availiable to the community for review.

The design of this framework allows developers to add different
implementations of components, specifically vSwitches, Traffic
Generators, Metrics Collectors and VNFs, easily.

The goal of this design is that all testcases should run regardless of
what is "under the hood".

This commit adds support for running the framework for a phy to phy
RFC2544 testcase only. More testcases will be added by the community.

vSwitches supported at this time:
* Intel DPDK (r) accelerated OpenvSwitch

Traffic Generators supported at this time:
* IxNet - IxNetwork Implementation
* Ixia - IxExplorer Implementation
* Dummy - Manual Implementation

Metrics Collectors supported at this time:
* Linux Metrics

No VNFs are supported at this time but the framework outlines how they
should be integrated and provides APIs for them to adhere to.

JIRA: VSPERF-27
Change-Id: I312e1a1199487ffee8f824be06cd97d4f793eee0
Signed-off-by: Stephen Finucane <Stephen.Finucane@intel.com>
Signed-off-by: Meghan Halton <Meghan.Halton@intel.com>
Signed-off-by: Christopher Nolan <Christopher.Nolan@intel.com>
Signed-off-by: Maryam Tahhan <Maryam.Tahhan@intel.com>
Signed-off-by: Ciara Loftus <Ciara.Loftus@intel.com>
Signed-off-by: Mark Kavanagh <Mark.B.Kavanagh@intel.com>
Signed-off-by: Cian Ferriter <Cian.Ferriter@intel.com>
Signed-off-by: Timo Puha <TimoX.Puha@intel.com>
Signed-off-by: Billy O'Mahony <billy.o.mahony@intel.com>
Signed-off-by: Michal Weglicki <MichalX.Weglicki@intel.com>
Signed-off-by: Rory Sexton <Rory.Sexton@intel.com>
Signed-off-by: Ian Stokes <Ian.Stokes@intel.com>
Signed-off-by: Kevin Traynor <Kevin.Traynor@intel.com>
Signed-off-by: Dino Simeon Madarang <dino.simeonx.madarang@intel.com>
Reviewed-by: Eugene Snider <Eugene.Snider@huawei.com>
Reviewed-by: Aihua Li <aihua.li@huawei.com>

3 files changed, 483 insertions, 0 deletions

diff --git a/src/ovs/__init__.py b/src/ovs/__init__.py
new file mode 100644
index 00000000..1a31ea2e
--- /dev/null
+++ b/src/ovs/__init__.py
@@ -0,0 +1,25 @@
+# Copyright 2015 Intel Corporation.
+#
+# 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.
+
+"""
+A package for controlling Open vSwitch
+
+This package is intended to stay gneneric enough to support using any data
+path of OVS (linux kernel, DPDK userspace, etc.) by different parameterization
+and external setup of vswitchd-external process, kernel modules etc.
+
+"""
+
+from src.ovs.daemon import *
+from src.ovs.ofctl import *
diff --git a/src/ovs/daemon.py b/src/ovs/daemon.py
new file mode 100644
index 00000000..ee3446d5
--- /dev/null
+++ b/src/ovs/daemon.py
@@ -0,0 +1,142 @@
+# Copyright 2015 Intel Corporation.
+#
+# 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.
+
+"""Class wrapper for controlling an OVS instance.
+
+Wraps a pair of ``ovs-vswitchd`` and ``ovsdb-server`` processes.
+"""
+
+import os
+import logging
+import pexpect
+
+from conf import settings
+from tools import tasks
+
+_OVS_VSWITCHD_BIN = os.path.join(
+    settings.getValue('OVS_DIR'), 'vswitchd', 'ovs-vswitchd')
+_OVSDB_TOOL_BIN = os.path.join(
+    settings.getValue('OVS_DIR'), 'ovsdb', 'ovsdb-tool')
+_OVSDB_SERVER_BIN = os.path.join(
+    settings.getValue('OVS_DIR'), 'ovsdb', 'ovsdb-server')
+
+_OVS_VAR_DIR = '/usr/local/var/run/openvswitch/'
+_OVS_ETC_DIR = '/usr/local/etc/openvswitch/'
+
+_LOG_FILE_VSWITCHD = os.path.join(
+    settings.getValue('LOG_DIR'), settings.getValue('LOG_FILE_VSWITCHD'))
+
+class VSwitchd(tasks.Process):
+    """Class wrapper for controlling an OVS instance.
+
+    Wraps a pair of ``ovs-vswitchd`` and ``ovsdb-server`` processes.
+    """
+    _ovsdb_pid = None
+    _logfile = _LOG_FILE_VSWITCHD
+
+
+    _expect = r'EAL: Master l*core \d+ is ready'
+    _proc_name = 'ovs-vswitchd'
+
+    def __init__(self, timeout=30, vswitchd_args=None):
+        """Initialise the wrapper with a specific start timeout and extra
+        parameters.
+
+        :param timeout: Timeout to wait for application to start.
+        :param vswitchd_args: Command line parameters for vswitchd.
+
+        :returns: None
+        """
+        self._logger = logging.getLogger(__name__)
+        self._timeout = timeout
+        vswitchd_args = vswitchd_args or []
+
+        self._cmd = ['sudo', '-E', _OVS_VSWITCHD_BIN] + vswitchd_args
+
+    # startup/shutdown
+
+    def start(self):
+        """ Start ``ovsdb-server`` and ``ovs-vswitchd`` instance.
+
+        :returns: None
+        :raises: pexpect.EOF, pexpect.TIMEOUT
+        """
+        self._reset_ovsdb()
+        self._start_ovsdb()  # this has to be started first
+
+        try:
+            super(VSwitchd, self).start()
+            self.relinquish()
+        except (pexpect.EOF, pexpect.TIMEOUT) as exc:
+            self._kill_ovsdb()
+            raise exc
+
+    def kill(self):
+        """Kill ``ovs-vswitchd`` instance if it is alive.
+
+        :returns: None
+        """
+        self._logger.info('Killing ovs-vswitchd...')
+
+        self._kill_ovsdb()
+
+        super(VSwitchd, self).kill()
+
+    # helper functions
+
+    def _reset_ovsdb(self):
+        """Reset system for 'ovsdb'.
+
+        :returns: None
+        """
+        self._logger.info('Resetting system after last run...')
+
+        tasks.run_task(['sudo', 'rm', '-rf', _OVS_VAR_DIR], self._logger)
+        tasks.run_task(['sudo', 'mkdir', '-p', _OVS_VAR_DIR], self._logger)
+        tasks.run_task(['sudo', 'rm', '-rf', _OVS_ETC_DIR], self._logger)
+        tasks.run_task(['sudo', 'mkdir', '-p', _OVS_ETC_DIR], self._logger)
+
+        tasks.run_task(['sudo', 'rm', '-f',
+                        os.path.join(_OVS_ETC_DIR, 'conf.db')],
+                       self._logger)
+
+        self._logger.info('System reset after last run.')
+
+    def _start_ovsdb(self):
+        """Start ``ovsdb-server`` instance.
+
+        :returns: None
+        """
+        tasks.run_task(['sudo', _OVSDB_TOOL_BIN, 'create',
+                        os.path.join(_OVS_ETC_DIR, 'conf.db'),
+                        os.path.join(settings.getValue('OVS_DIR'), 'vswitchd',
+                                     'vswitch.ovsschema')],
+                       self._logger,
+                       'Creating ovsdb configuration database...')
+
+        self._ovsdb_pid = tasks.run_background_task(
+            ['sudo', _OVSDB_SERVER_BIN,
+             '--remote=punix:%s' % os.path.join(_OVS_VAR_DIR, 'db.sock'),
+             '--remote=db:Open_vSwitch,Open_vSwitch,manager_options'],
+            self._logger,
+            'Starting ovsdb-server...')
+
+    def _kill_ovsdb(self):
+        """Kill ``ovsdb-server`` instance.
+
+        :returns: None
+        """
+        if self._ovsdb_pid:
+            tasks.run_task(['sudo', 'kill', '-2', str(self._ovsdb_pid)],
+                           self._logger, 'Killing ovsdb-server...')
diff --git a/src/ovs/ofctl.py b/src/ovs/ofctl.py
new file mode 100644
index 00000000..c6aaddc9
--- /dev/null
+++ b/src/ovs/ofctl.py
@@ -0,0 +1,316 @@
+# Copyright 2015 Intel Corporation.
+#
+# 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.
+
+"""Wrapper for an OVS bridge for convenient use of ``ovs-vsctl`` and
+``ovs-ofctl`` on it.
+
+Much of this code is based on ``ovs-lib.py`` from Open Stack:
+
+https://github.com/openstack/neutron/blob/6eac1dc99124ca024d6a69b3abfa3bc69c735667/neutron/agent/linux/ovs_lib.py
+"""
+
+import os
+import logging
+import string
+
+from tools import tasks
+from conf import settings
+
+_OVS_VSCTL_BIN = os.path.join(settings.getValue('OVS_DIR'), 'utilities',
+                              'ovs-vsctl')
+_OVS_OFCTL_BIN = os.path.join(settings.getValue('OVS_DIR'), 'utilities',
+                              'ovs-ofctl')
+
+class OFBase(object):
+    """Add/remove/show datapaths using ``ovs-ofctl``.
+    """
+    def __init__(self, timeout=10):
+        """Initialise logger.
+
+        :param timeout: Timeout to be used for each command
+
+        :returns: None
+        """
+        self.logger = logging.getLogger(__name__)
+        self.timeout = timeout
+
+    # helpers
+
+    def run_vsctl(self, args, check_error=False):
+        """Run ``ovs-vsctl`` with supplied arguments.
+
+        :param args: Arguments to pass to ``ovs-vsctl``
+        :param check_error: Throw exception on error
+
+        :return: None
+        """
+        cmd = ['sudo', _OVS_VSCTL_BIN, '--timeout', str(self.timeout)] + args
+        return tasks.run_task(
+            cmd, self.logger, 'Running ovs-vsctl...', check_error)
+
+    # datapath management
+
+    def add_br(self, br_name='br0'):
+        """Add datapath.
+
+        :param br_name: Name of bridge
+
+        :return: Instance of :class OFBridge:
+        """
+        self.logger.debug('add bridge')
+        self.run_vsctl(['add-br', br_name])
+
+        return OFBridge(br_name, self.timeout)
+
+    def del_br(self, br_name='br0'):
+        """Delete datapath.
+
+        :param br_name: Name of bridge
+
+        :return: None
+        """
+        self.logger.debug('delete bridge')
+        self.run_vsctl(['del-br', br_name])
+
+
+class OFBridge(OFBase):
+    """Control a bridge instance using ``ovs-vsctl`` and ``ovs-ofctl``.
+    """
+    def __init__(self, br_name='br0', timeout=10):
+        """Initialise bridge.
+
+        :param br_name: Bridge name
+        :param timeout: Timeout to be used for each command
+
+        :returns: None
+        """
+        super(OFBridge, self).__init__(timeout)
+        self.br_name = br_name
+        self._ports = {}
+
+    # context manager
+
+    def __enter__(self):
+        """Create datapath
+
+        :returns: self
+        """
+        return self
+
+    def __exit__(self, type_, value, traceback):
+        """Remove datapath.
+        """
+        if not traceback:
+            self.destroy()
+
+    # helpers
+
+    def run_ofctl(self, args, check_error=False):
+        """Run ``ovs-ofctl`` with supplied arguments.
+
+        :param args: Arguments to pass to ``ovs-ofctl``
+        :param check_error: Throw exception on error
+
+        :return: None
+        """
+        cmd = ['sudo', _OVS_OFCTL_BIN, '--timeout', str(self.timeout)] + args
+        return tasks.run_task(
+            cmd, self.logger, 'Running ovs-ofctl...', check_error)
+
+    def create(self):
+        """Create bridge.
+        """
+        self.logger.debug('create bridge')
+        self.add_br(self.br_name)
+
+    def destroy(self):
+        """Destroy bridge.
+        """
+        self.logger.debug('destroy bridge')
+        self.del_br(self.br_name)
+
+    def reset(self):
+        """Reset bridge.
+        """
+        self.logger.debug('reset bridge')
+        self.destroy()
+        self.create()
+
+    # port management
+
+    def add_port(self, port_name, params):
+        """Add port to bridge.
+
+        :param port_name: Name of port
+        :param params: Additional list of parameters to add-port
+
+        :return: OpenFlow port number for the port
+        """
+        self.logger.debug('add port')
+        self.run_vsctl(['add-port', self.br_name, port_name]+params)
+
+        # This is how port number allocation works currently
+        # This possibly will not work correctly if there are port deletions
+        # in between
+        of_port = len(self._ports) + 1
+        self._ports[port_name] = (of_port, params)
+        return of_port
+
+    def del_port(self, port_name):
+        """Remove port from bridge.
+
+        :param port_name: Name of port
+
+        :return: None
+        """
+        self.logger.debug('delete port')
+        self.run_vsctl(['del-port', self.br_name, port_name])
+        self._ports.pop(port_name)
+
+    def set_db_attribute(self, table_name, record, column, value):
+        """Set database attribute.
+
+        :param table_name: Name of table
+        :param record: Name of record
+        :param column: Name of column
+        :param value: Value to set
+
+        :return: None
+        """
+        self.logger.debug('set attribute')
+        self.run_vsctl(['set', table_name, record, '%s=%s' % (column, value)])
+
+    def get_ports(self):
+        """Get the ports of this bridge
+
+        Structure of the returned ports dictionary is
+        'portname': (openflow_port_number, extra_parameters)
+
+        Example:
+        ports = {
+            'dpdkport0':
+                (1, ['--', 'set', 'Interface', 'dpdkport0', 'type=dpdk']),
+            'dpdkvhostport0':
+                (2, ['--', 'set', 'Interface', 'dpdkvhostport0',
+                     'type=dpdkvhost'])
+        }
+
+        :return: Dictionary of ports
+        """
+        return self._ports
+
+    def clear_db_attribute(self, table_name, record, column):
+        """Clear database attribute.
+
+        :param table_name: Name of table
+        :param record: Name of record
+        :param column: Name of column
+
+        :return: None
+        """
+        self.logger.debug('clear attribute')
+        self.run_vsctl(['clear', table_name, record, column])
+
+    # flow mangement
+
+    def add_flow(self, flow):
+        """Add flow to bridge.
+
+        :param flow: Flow description as a dictionary
+        For flow dictionary structure, see function flow_key
+
+        :return: None
+        """
+        if not flow.get('actions'):
+            self.logger.error('add flow requires actions')
+            return
+
+        self.logger.debug('add flow')
+        _flow_key = flow_key(flow)
+        self.logger.debug('key : %s', _flow_key)
+        self.run_ofctl(['add-flow', self.br_name, _flow_key])
+
+    def del_flow(self, flow):
+        """Delete flow from bridge.
+
+        :param flow: Flow description as a dictionary
+        For flow dictionary structure, see function flow_key
+        flow=None will delete all flows
+
+        :return: None
+        """
+        self.logger.debug('delete flow')
+        _flow_key = flow_key(flow)
+        self.logger.debug('key : %s', _flow_key)
+        self.run_ofctl(['del-flows', self.br_name, _flow_key])
+
+    def del_flows(self):
+        """Delete all flows from bridge.
+        """
+        self.logger.debug('delete flows')
+        self.run_ofctl(['del-flows', self.br_name])
+
+    def dump_flows(self):
+        """Dump all flows from bridge.
+        """
+        self.logger.debug('dump flows')
+        self.run_ofctl(['dump-flows', self.br_name])
+
+#
+# helper functions
+#
+
+def flow_key(flow):
+    """Model a flow key string for ``ovs-ofctl``.
+
+    Syntax taken from ``ovs-ofctl`` manpages:
+        http://openvswitch.org/cgi-bin/ovsman.cgi?page=utilities%2Fovs-ofctl.8
+
+    Example flow dictionary:
+    flow = {
+        'in_port': '1',
+        'idle_timeout': '0',
+        'actions': ['output:3']
+    }
+
+    :param flow: Flow description as a dictionary
+
+    :return: String
+    :rtype: str
+    """
+    _flow_add_key = string.Template('${fields},action=${actions}')
+    _flow_del_key = string.Template('${fields}')
+
+    field_params = []
+
+    user_params = (x for x in list(flow.items()) if x[0] != 'actions')
+    for (key, default) in user_params:
+        field_params.append('%(field)s=%(value)s' %
+                            {'field': key, 'value': default})
+
+    field_params = ','.join(field_params)
+
+    _flow_key_param = {
+        'fields': field_params,
+    }
+
+    # no actions == delete key
+    if 'actions' in flow:
+        _flow_key_param['actions'] = ','.join(flow['actions'])
+
+        flow_str = _flow_add_key.substitute(_flow_key_param)
+    else:
+        flow_str = _flow_del_key.substitute(_flow_key_param)
+
+    return flow_str