VPP-1508: Use scapy.compat to manage packet level library differences.
[vpp.git] / test / hook.py
index 64fc076..555fc2e 100644 (file)
@@ -5,11 +5,10 @@ import traceback
 from log import RED, single_line_delim, double_line_delim
 import ipaddress
 from subprocess import check_output, CalledProcessError
+
+import scapy.compat
+
 from util import check_core_path, get_core_path
-try:
-    text_type = unicode
-except NameError:
-    text_type = str
 
 
 class Hook(object):
@@ -17,8 +16,9 @@ class Hook(object):
     Generic hooks before/after API/CLI calls
     """
 
-    def __init__(self, logger):
-        self.logger = logger
+    def __init__(self, test):
+        self.test = test
+        self.logger = test.logger
 
     def before_api(self, api_name, api_args):
         """
@@ -34,7 +34,7 @@ class Hook(object):
                 return val
             if len(val) == 6:
                 return '{!s} ({!s})'.format(val, ':'.join(['{:02x}'.format(
-                    ord(x)) for x in val]))
+                    scapy.compat.orb(x)) for x in val]))
             try:
                 # we don't call test_type(val) because it is a packed value.
                 return '{!s} ({!s})'.format(val, str(
@@ -79,49 +79,59 @@ class VppDiedError(Exception):
 class PollHook(Hook):
     """ Hook which checks if the vpp subprocess is alive """
 
-    def __init__(self, testcase):
-        super(PollHook, self).__init__(testcase.logger)
-        self.testcase = testcase
+    def __init__(self, test):
+        super(PollHook, self).__init__(test)
 
     def on_crash(self, core_path):
-        self.logger.error("Core file present, debug with: gdb %s %s" %
-                          (self.testcase.vpp_bin, core_path))
+        self.logger.error("Core file present, debug with: gdb %s %s",
+                          self.test.vpp_bin, core_path)
         check_core_path(self.logger, core_path)
-        self.logger.error("Running `file %s':" % core_path)
+        self.logger.error("Running `file %s':", core_path)
         try:
             info = check_output(["file", core_path])
             self.logger.error(info)
         except CalledProcessError as e:
             self.logger.error(
-                "Could not run `file' utility on core-file, "
-                "rc=%s" % e.returncode)
+                "Subprocess returned with error running `file' utility on "
+                "core-file, "
+                "rc=%s",  e.returncode)
+        except OSError as e:
+            self.logger.error(
+                "Subprocess returned OS error running `file' utility on "
+                "core-file, "
+                "oserror=(%s) %s", e.errno, e.strerror)
+        except Exception as e:
+            self.logger.error(
+                "Subprocess returned unanticipated error running `file' "
+                "utility on core-file, "
+                "%s", e)
 
     def poll_vpp(self):
         """
         Poll the vpp status and throw an exception if it's not running
         :raises VppDiedError: exception if VPP is not running anymore
         """
-        if self.testcase.vpp_dead:
+        if self.test.vpp_dead:
             # already dead, nothing to do
             return
 
-        self.testcase.vpp.poll()
-        if self.testcase.vpp.returncode is not None:
+        self.test.vpp.poll()
+        if self.test.vpp.returncode is not None:
             signaldict = dict(
                 (k, v) for v, k in reversed(sorted(signal.__dict__.items()))
                 if v.startswith('SIG') and not v.startswith('SIG_'))
 
-            if self.testcase.vpp.returncode in signaldict:
-                s = signaldict[abs(self.testcase.vpp.returncode)]
+            if self.test.vpp.returncode in signaldict:
+                s = signaldict[abs(self.test.vpp.returncode)]
             else:
                 s = "unknown"
             msg = "VPP subprocess died unexpectedly with returncode %d [%s]." \
-                  % (self.testcase.vpp.returncode, s)
+                  % (self.test.vpp.returncode, s)
             self.logger.critical(msg)
-            core_path = get_core_path(self.testcase.tempdir)
+            core_path = get_core_path(self.test.tempdir)
             if os.path.isfile(core_path):
                 self.on_crash(core_path)
-            self.testcase.vpp_dead = True
+            self.test.vpp_dead = True
             raise VppDiedError(msg)
 
     def before_api(self, api_name, api_args):
@@ -151,11 +161,11 @@ class PollHook(Hook):
 class StepHook(PollHook):
     """ Hook which requires user to press ENTER before doing any API/CLI """
 
-    def __init__(self, testcase):
+    def __init__(self, test):
         self.skip_stack = None
         self.skip_num = None
         self.skip_count = 0
-        super(StepHook, self).__init__(testcase)
+        super(StepHook, self).__init__(test)
 
     def skip(self):
         if self.skip_stack is None: