1 files changed, 146 insertions, 0 deletions
diff --git a/src/VBox/ValidationKit/testboxscript/testboxcommons.py b/src/VBox/ValidationKit/testboxscript/testboxcommons.py
new file mode 100755
index 00000000..18a1c40a
--- /dev/null
+++ b/src/VBox/ValidationKit/testboxscript/testboxcommons.py
@@ -0,0 +1,146 @@
+# -*- coding: utf-8 -*-
+# $Id: testboxcommons.py $
+
+"""
+TestBox Script - Common Functions and Classes.
+
+This module contains constants and functions that are useful for all
+the files in this (testbox) directory.
+"""
+
+__copyright__ = \
+"""
+Copyright (C) 2012-2023 Oracle and/or its affiliates.
+
+This file is part of VirtualBox base platform packages, as
+available from https://www.virtualbox.org.
+
+This program is free software; you can redistribute it and/or
+modify it under the terms of the GNU General Public License
+as published by the Free Software Foundation, in version 3 of the
+License.
+
+This program is distributed in the hope that it will be useful, but
+WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program; if not, see <https://www.gnu.org/licenses>.
+
+The contents of this file may alternatively be used under the terms
+of the Common Development and Distribution License Version 1.0
+(CDDL), a copy of it is provided in the "COPYING.CDDL" file included
+in the VirtualBox distribution, in which case the provisions of the
+CDDL are applicable instead of those of the GPL.
+
+You may elect to license modified versions of this file under the
+terms and conditions of either the GPL or the CDDL or both.
+
+SPDX-License-Identifier: GPL-3.0-only OR CDDL-1.0
+"""
+__version__ = "$Revision: 155244 $"
+
+
+# Standard python imports.
+import sys
+import traceback
+
+# Validation Kit imports.
+from common import utils;
+
+#
+# Exceptions.
+#
+
+class TestBoxException(Exception):
+    """
+    Custom exception class
+    """
+    pass;                               # pylint: disable=unnecessary-pass
+
+#
+# Logging.
+#
+
+def log(sMessage, sCaller = None, sTsPrf = None):
+    """
+    Print out a message and flush stdout
+    """
+    if sTsPrf is None: sTsPrf = utils.getTimePrefix();
+    print('[%s] %s' % (sTsPrf, sMessage,));
+    sys.stdout.flush();
+    _ = sCaller;
+
+def log2(sMessage, sCaller = None, sTsPrf = None):
+    """
+    Debug logging, will later be disabled by default.
+    """
+    if True is True:                    # pylint: disable=comparison-with-itself
+        if sTsPrf is None: sTsPrf = utils.getTimePrefix();
+        print('[%s] %s' % (sTsPrf, sMessage,));
+        sys.stdout.flush()
+        _ = sCaller;
+
+def _logXcptWorker(fnLogger, sPrefix = '', sText = None, cFrames = 1, fnLogger1 = log):
+    """
+    Log an exception, optionally with a preceeding message and more than one
+    call frame.
+    """
+    ## @todo skip all this if iLevel is too high!
+
+    # Try get exception info.
+    sTsPrf = utils.getTimePrefix();
+    try:
+        oType, oValue, oTraceback = sys.exc_info();
+    except:
+        oType = oValue = oTraceback = None;
+    if oType is not None:
+
+        # Try format the info
+        try:
+            rc      = 0;
+            sCaller = utils.getCallerName(oTraceback.tb_frame);
+            if sText is not None:
+                rc = fnLogger('%s%s' % (sPrefix, sText), sCaller, sTsPrf);
+            asInfo = [];
+            try:
+                asInfo = asInfo + traceback.format_exception_only(oType, oValue);
+                if cFrames is not None and cFrames <= 1:
+                    asInfo = asInfo + traceback.format_tb(oTraceback, 1);
+                else:
+                    asInfo.append('Traceback:')
+                    asInfo = asInfo + traceback.format_tb(oTraceback, cFrames);
+                    asInfo.append('Stack:')
+                    asInfo = asInfo + traceback.format_stack(oTraceback.tb_frame.f_back, cFrames);
+            except:
+                fnLogger1('internal-error: Hit exception #2! %s' % (traceback.format_exc()), sCaller, sTsPrf);
+
+            if asInfo:
+                # Do the logging.
+                for sItem in asInfo:
+                    asLines = sItem.splitlines();
+                    for sLine in asLines:
+                        rc = fnLogger('%s%s' % (sPrefix, sLine), sCaller, sTsPrf);
+
+            else:
+                fnLogger('No exception info...', sCaller, sTsPrf);
+                rc = -3;
+        except:
+            fnLogger1('internal-error: Hit exception! %s' % (traceback.format_exc()), None, sTsPrf);
+            rc = -2;
+    else:
+        fnLogger1('internal-error: No exception! %s' % (utils.getCallerName(iFrame=3)), utils.getCallerName(iFrame=3), sTsPrf);
+        rc = -1;
+
+    return rc;
+
+
+def log1Xcpt(sText = None, cFrames = 1):
+    """Logs an exception."""
+    return _logXcptWorker(log, '', sText, cFrames);
+
+def log2Xcpt(sText = None, cFrames = 1):
+    """Debug logging of an exception."""
+    return _logXcptWorker(log2, '', sText, cFrames);
+