vxlan: vxlan/vxlan.api API cleanup

[vpp.git] / test / hook.py

diff --git a/test/hook.py b/test/hook.py
index 7287aaa..97b05d0 100644 (file)
--- a/test/hook.py
+++ b/test/hook.py
@@ -1,11 +1,13 @@
-import signal
 import os
 import sys
 import traceback
-from log import RED, single_line_delim, double_line_delim
-from debug import spawn_gdb
+import ipaddress
 from subprocess import check_output, CalledProcessError
-from util import check_core_path
+
+import scapy.compat
+import framework
+from log import RED, single_line_delim, double_line_delim
+from util import check_core_path, get_core_path
 
 
 class Hook(object):
@@ -13,8 +15,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):
         """
@@ -24,8 +27,24 @@ class Hook(object):
         @param api_name: name of the API
         @param api_args: tuple containing the API arguments
         """
+
+        def _friendly_format(val):
+            if not isinstance(val, str):
+                return val
+            if len(val) == 6:
+                return '{!s} ({!s})'.format(val, ':'.join(['{:02x}'.format(
+                    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(
+                    ipaddress.ip_address(val)))
+            except ValueError:
+                return val
+
+        _args = ', '.join("{!s}={!r}".format(key, _friendly_format(val)) for
+                          (key, val) in api_args.items())
         self.logger.debug("API: %s (%s)" %
-                          (api_name, api_args), extra={'color': RED})
+                          (api_name, _args), extra={'color': RED})
 
     def after_api(self, api_name, api_args):
         """
@@ -52,63 +71,52 @@ class Hook(object):
         pass
 
 
-class VppDiedError(Exception):
-    pass
-
-
 class PollHook(Hook):
     """ Hook which checks if the vpp subprocess is alive """
 
-    def __init__(self, testcase):
-        self.testcase = testcase
-        self.logger = testcase.logger
+    def __init__(self, test):
+        super(PollHook, self).__init__(test)
 
     def on_crash(self, core_path):
-        if self.testcase.debug_core:
-            # notify parent process that we're handling a core file
-            open('%s/_core_handled' % self.testcase.tempdir, 'a').close()
-            spawn_gdb(self.testcase.vpp_bin, core_path, self.logger)
-        else:
-            self.logger.error("Core file present, debug with: gdb %s %s" %
-                              (self.testcase.vpp_bin, core_path))
-            check_core_path(self.logger, 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)
-                pass
+        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)
+        try:
+            info = check_output(["file", core_path])
+            self.logger.error(info)
+        except CalledProcessError as e:
+            self.logger.error(
+                "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:
-            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)]
-            else:
-                s = "unknown"
-            msg = "VPP subprocess died unexpectedly with returncode %d [%s]" %\
-                (self.testcase.vpp.returncode, s)
-            self.logger.critical(msg)
-            core_path = self.testcase.tempdir + '/core'
+        self.test.vpp.poll()
+        if self.test.vpp.returncode is not None:
+            self.test.vpp_dead = True
+            raise framework.VppDiedError(rv=self.test.vpp.returncode)
+            core_path = get_core_path(self.test.tempdir)
             if os.path.isfile(core_path):
                 self.on_crash(core_path)
-            self.testcase.vpp_dead = True
-            raise VppDiedError(msg)
 
     def before_api(self, api_name, api_args):
         """
@@ -137,11 +145,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: