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>

1 files changed, 180 insertions, 0 deletions

diff --git a/core/loader/loader_servant.py b/core/loader/loader_servant.py
new file mode 100644
index 00000000..7966532c
--- /dev/null
+++ b/core/loader/loader_servant.py
@@ -0,0 +1,180 @@
+# 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.
+
+"""Loader servant module used by Loader.
+
+Module is inteded to be private to serve only Loader itself, nevertheless
+some methods are exposed outside and can be used by any other clients:
+- load_modules(self, path, interface)
+- load_module(self, path, interface, class_name)
+Those method are stateless static members.
+
+"""
+import os
+from os import sys
+import imp
+import fnmatch
+import logging
+
+
+class LoaderServant(object):
+    """Class implements basic dynamic import operations.
+    """
+    _class_name = None
+    _path = None
+    _interface = None
+
+    def __init__(self, path, class_name, interface):
+        """LoaderServant constructor
+
+        Intializes all data needed for import operations.
+
+        Attributes:
+            path: path to directory which contains implementations derived from
+                    interface.
+            class_name: Class name which will be returned in get_class
+                        method, if such definition exists in directory
+                        represented by path,
+            interface: interface type. Every object which doesn't
+                        implement this particular interface will be
+                        filtered out.
+        """
+        self._class_name = class_name
+        self._path = path
+        self._interface = interface
+
+    def get_class(self):
+        """Returns class type based on parameters passed in __init__.
+
+        :return: Type of the found class.
+            None if class hasn't been found
+        """
+
+        return self.load_module(path=self._path,
+                                interface=self._interface,
+                                class_name=self._class_name)
+
+    def get_classes(self):
+        """Returns all classes in path derived from interface
+
+        :return: Dictionary with following data:
+            - key: String representing class name,
+            - value: Class type.
+        """
+        return self.load_modules(path=self._path,
+                                 interface=self._interface)
+
+    def get_classes_printable(self):
+        """Returns all classes derived from _interface found in path
+
+        :return: String - list of classes in printable format.
+        """
+
+        out = self.load_modules(path=self._path,
+                                interface=self._interface)
+        results = []
+
+        for (name, mod) in list(out.items()):
+            desc = (mod.__doc__ or 'No description').strip().split('\n')[0]
+            results.append((name, desc))
+
+        output = [
+            'Classes derived from: ' + self._interface.__name__ + '\n======\n']
+
+        for (name, desc) in results:
+            output.append('* %-18s%s' % ('%s:' % name, desc))
+
+            output.append('')
+
+        output.append('')
+
+        return '\n'.join(output)
+
+    @staticmethod
+    def load_module(path, interface, class_name):
+        """Imports everything from given path and returns class type
+
+        This is based on following conditions:
+            - Class is derived from interface,
+            - Class type name matches class_name.
+
+        :return: Type of the found class.
+            None if class hasn't been found
+        """
+
+        results = LoaderServant.load_modules(
+            path=path, interface=interface)
+
+        if class_name in results:
+            logging.info(
+                "Class found: " + class_name + ".")
+            return results.get(class_name)
+
+        return None
+
+    @staticmethod
+    def load_modules(path, interface):
+        """Returns dictionary of class name/class type found in path
+
+        This is based on following conditions:
+            - classes found under path are derived from interface.
+            - class is not interface itself.
+
+        :return: Dictionary with following data:
+            - key: String representing class name,
+            - value: Class type.
+        """
+        result = {}
+
+        for _, mod in LoaderServant._load_all_modules(path):
+            # find all system metric loggers defined in the module
+            gens = dict((k, v) for (k, v) in list(mod.__dict__.items())
+                        if type(v) == type and
+                        issubclass(v, interface) and k != interface.__name__)
+            if gens:
+                for (genname, gen) in list(gens.items()):
+                    result[genname] = gen
+        return result
+
+    @staticmethod
+    def _load_all_modules(path):
+        """Load all modules from ``path`` directory.
+
+        This is based on the design used by OFTest:
+            https://github.com/floodlight/oftest/blob/master/oft
+
+        :param path: Path to a folder of modules.
+
+        :return: List of modules in a folder.
+        """
+        mods = []
+
+        for root, _, filenames in os.walk(path):
+            # Iterate over each python file
+            for filename in fnmatch.filter(filenames, '[!.]*.py'):
+                modname = os.path.splitext(os.path.basename(filename))[0]
+
+                try:
+                    if modname in sys.modules:
+                        mod = sys.modules[modname]
+                    else:
+                        mod = imp.load_module(
+                            modname, *imp.find_module(modname, [root]))
+                except ImportError:
+                    logging.error('Could not import file ' + filename)
+                    raise
+
+                mods.append((modname, mod))
+
+        return mods