Merge "Doc: Release notes for Fraser"

[vswitchperf.git] / tools / teststepstools.py

diff --git a/tools/teststepstools.py b/tools/teststepstools.py
index d39f7f4..db2d53e 100644 (file)
--- a/tools/teststepstools.py
+++ b/tools/teststepstools.py
@@ -1,4 +1,4 @@
-# Copyright 2016 Intel Corporation.
+# Copyright 2016-2017 Intel Corporation.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -15,10 +15,13 @@
 """Various helper functions for step driven testcases
 """
 
-import re
 import logging
 import subprocess
 import locale
+from tools.functions import filter_output
+from tools.tasks import run_background_task
+
+_LOGGER = logging.getLogger(__name__)
 
 class TestStepsTools(object):
     """ Various tools and functions used by step driven testcases
@@ -26,25 +29,21 @@ class TestStepsTools(object):
     # Functions use nonstandard names to avoid conflicts with
     # standard python keywords.
     # pylint: disable=invalid-name
-    def __init__(self):
-        """ TestStepsTools initialization
-        """
-        self._logger = logging.getLogger(__name__)
-
-    def Assert(self, condition):
+    @staticmethod
+    def Assert(condition):
         """ Evaluate given `condition' and raise AssertionError
             in case, that evaluation fails
         """
         try:
-            assert self.Eval(condition)
+            assert TestStepsTools.Eval(condition)
         except AssertionError:
-            self._logger.error('Condition %s is not True', condition)
+            _LOGGER.error('Condition %s is not True', condition)
             raise
 
         return True
 
     @staticmethod
-    def validate_Assert(result, dummy_condition):
+    def validate_Assert(result, _dummy_condition):
         """ Validate evaluation of given `condition'
         """
         return result
@@ -57,13 +56,33 @@ class TestStepsTools(object):
         return eval(expression)
 
     @staticmethod
-    def validate_Eval(result, dummy_expression):
+    def validate_Eval(result, _dummy_expression):
         """ Validate result of python `expression' evaluation
         """
         return result is not None
 
     @staticmethod
-    def Exec(command, regex=None):
+    def Exec_Python(code):
+        """ Execute a python `code' and return True on success
+        """
+        # pylint: disable=exec-used
+        try:
+            exec(code, globals())
+        # pylint: disable=broad-except
+        # pylint: disable=bare-except
+        except:
+            _LOGGER.error('Execution of following code has failed %s', code)
+            return False
+        return True
+
+    @staticmethod
+    def validate_Exec_Python(result, _dummy_code):
+        """ Validate result of python `code' execution
+        """
+        return result
+
+    @staticmethod
+    def Exec_Shell(command, regex=None):
         """ Execute a shell `command' and return its output filtered
             out by optional `regex' expression.
         """
@@ -75,16 +94,28 @@ class TestStepsTools(object):
         output = output.decode(locale.getdefaultlocale()[1])
 
         if regex:
-            for line in output.split('\n'):
-                result = re.findall(regex, line)
-                if result:
-                    return result
-            return []
+            return filter_output(output, regex)
 
         return output
 
     @staticmethod
-    def validate_Exec(result, dummy_command, dummy_regex=None):
+    def validate_Exec_Shell(result, _dummy_command, _dummy_regex=None):
         """ validate result of shell `command' execution
         """
         return result is not None
+
+    @staticmethod
+    def Exec_Shell_Background(command):
+        """ Execute a shell `command' at the background and return its PID id
+        """
+        try:
+            pid = run_background_task(command.split(), _LOGGER, "Background task: {}".format(command))
+            return pid
+        except OSError:
+            return None
+
+    @staticmethod
+    def validate_Exec_Shell_Background(result, _dummy_command, _dummy_regex=None):
+        """ validate result of shell `command' execution on the background
+        """
+        return result is not None