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, 119 insertions, 0 deletions

diff --git a/vnfs/vnf/vnf.py b/vnfs/vnf/vnf.py
new file mode 100644
index 00000000..c746aa83
--- /dev/null
+++ b/vnfs/vnf/vnf.py
@@ -0,0 +1,119 @@
+# 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.
+
+"""
+Interface for VNF.
+"""
+
+
+class IVnf(object):
+
+    """
+    Interface for VNF.
+    """
+
+    def __init__(self, memory, cpus,
+                 monitor_path, shared_path_host,
+                 shared_path_guest, guest_prompt):
+        """
+        Initialization method.
+
+        Purpose of this method is to initialize all
+        common Vnf data, no services should be started by
+        this call (use ``start`` method instead).
+
+        :param memory:   Virtual RAM size in megabytes.
+        :param cpus:     Number of Processors.
+        :param monitor_path: Configure monitor to given path.
+        :param shared_path_host: HOST path to shared location.
+        :param shared_path_guest: GUEST path to shared location.
+        :param guest_prompt: preconfigured command prompt which is used
+                           in execute_and_wait & wait methods
+                           to detect if particular call is finished.
+        """
+        raise NotImplementedError()
+
+    def start(self):
+        """
+        Starts VNF instance.
+        """
+        raise NotImplementedError()
+
+    def stop(self):
+        """
+        Stops VNF instance.
+        """
+        raise NotImplementedError()
+
+    def execute(self, command, delay=30):
+        """
+        execute ``command`` with given ``delay``.
+
+        This method makes asynchronous call to guest system
+        and waits given ``delay`` before returning. Can be
+        used with ``wait`` method to create synchronous call.
+
+        :param command: Command to execute on guest system.
+        :param delay: Delay (in seconds) to wait after sending
+                      command before returning. Please note that
+                      this value can be floating point which
+                      allows to pass milliseconds.
+
+        :returns: None.
+        """
+        raise NotImplementedError()
+
+    def wait(self, guest_prompt, timeout=30):
+        """
+        wait for ``guest_prompt`` on guest system for given ``timeout``.
+
+        This method ends based on two conditions:
+        * ``guest_prompt`` has been detected
+        * ``timeout`` has been reached.
+
+        :param guest_prompt: method end condition. If ``guest_prompt``
+                             won't be detected during given timeout,
+                             method will return False.
+        :param timeout: Time to wait for prompt (in seconds).
+                        Please note that this value can be floating
+                        point which allows to pass milliseconds.
+
+        :returns: True if result_cmd has been detected before
+                  timeout has been reached, False otherwise.
+        """
+        raise NotImplementedError()
+
+    def execute_and_wait(self, command, timeout=30, guest_prompt=None):
+        """
+        execute ``command`` with given ``timeout``.
+
+        This method makes synchronous call to guest system
+        and waits till ``command`` execution is finished
+        (based on ``guest_prompt value) or ''timeout'' has
+        been reached.
+
+        :param command: Command to execute on guest system.
+        :param timeout: Timeout till the end of execution is not
+                        detected.
+        :param guest_prompt: method end condition. If ``guest_prompt``
+                             won't be detected during given timeout,
+                             method will return False. If no argument
+                             or None value will be passed, default
+                             ``guest_prompt`` passed in __init__
+                             method will be used.
+
+        :returns: True if end of execution has been detected
+                  before timeout has been reached, False otherwise.
+        """
+        raise NotImplementedError()