Changeset 103499 in vbox

Timestamp:

Feb 21, 2024 2:44:17 PM (9 months ago)

Author:

vboxsync

Message:

Validation Kit/tdAudioTest: Added new option "--audio-debug-img <path/to/vkat>" to upload own VKAT guest builds for quicker debugging.

File:

• trunk/src/VBox/ValidationKit/tests/audio/tdAudioTest.py (modified) (7 diffs)

trunk/src/VBox/ValidationKit/tests/audio/tdAudioTest.py

@@ -66 +66 @@
 
 # pylint: disable=unnecessary-semicolon
+
+class tdDebugSettings(object):
+    """
+    Contains local test debug settings.
+    """
+    def __init__(self, sVkatExeHst = None):
+        # Absolute path of VKAT on the host side which gets uploaded from the host.
+        self.sVkatExeHst = sVkatExeHst;
+        # Absolute path of VKAT on the guest side (which got uploaded from the host).
+        self.sVkatExeGst = None;
 
 class tdAudioTest(vbox.TestDriver):
@@ -96 +106 @@
         ];
         self.asTests          = self.asTestsDef;
+        self.oDebug           = tdDebugSettings();
 
         # Optional arguments passing to VKAT when doing the actual audio tests.
@@ -134 +145 @@
         reporter.log('  --audio-controller-type <HDA|AC97|SB16>');
         reporter.log('      Default: recommended controller');
+        reporter.log('  --audio-debug-img <path/to/vkat>');
         reporter.log('  --audio-test-count <number>');
         reporter.log('      Default: 0 (means random)');
@@ -178 +190 @@
             else:
                 raise base.InvalidOption('The "--audio-controller-type" value "%s" is not valid' % (asArgs[iArg]));
+        elif asArgs[iArg] == '--audio-debug-img':
+            iArg += 1;
+            if iArg >= len(asArgs):
+                raise base.InvalidOption('Option "%s" needs a value' % (asArgs[iArg - 1]));
+            self.oDebug.sVkatExeHst = asArgs[iArg];
         elif    asArgs[iArg] == '--audio-test-count' \
              or asArgs[iArg] == '--audio-test-tone-duration' \
@@ -210 +227 @@
         return iArg + 1;
 
+    def prepareGuestForDebugging(self, oSession, oTxsSession, oTestVm): # pylint: disable=unused-argument
+        """
+        Prepares a guest for (manual) debugging.
+
+        This involves copying over and invoking a the locally built VKAT binary.
+        """
+
+        if self.oDebug.sVkatExeHst is None: # If no debugging enabled, bail out.
+            reporter.log('Skipping debugging');
+            return True;
+
+        self.oDebug.sVkatExeGst = oTestVm.pathJoin(self.getGuestTempDir(oTestVm), 'vkat${EXESUFF}');
+
+        reporter.log('Preparing for debugging ...');
+
+        try:
+            reporter.log('Uploading "%s" to "%s" ...' % (self.oDebug.sVkatExeHst, self.oDebug.sVkatExeGst));
+            oTxsSession.syncUploadFile(self.oDebug.sVkatExeHst, self.oDebug.sVkatExeGst);
+
+            if oTestVm.isLinux():
+                oTxsSession.syncChMod(self.oDebug.sVkatExeGst, 0o755);
+        except:
+            return reporter.errorXcpt('Unable to prepare for debugging');
+
+        return True;
+
     def actionVerify(self):
         """
@@ -525 +568 @@
         reporter.log('Guest audio test tag is \"%s\"' % (sTag));
 
-        fRc, sVkatExe = self.locateGstBinary(oSession, oTxsSession, self.asGstVkatPaths);
+        if self.oDebug.sVkatExeGst is None:
+            fRc, sVkatExe = self.locateGstBinary(oSession, oTxsSession, self.asGstVkatPaths);
+        else:
+            sVkatExe = self.oDebug.sVkatExeGst;
+            fRc      = True;
         if fRc:
             reporter.log('Using VKAT on guest at \"%s\"' % (sVkatExe));
@@ -825 +872 @@
         reporter.testDone();
 
-        reporter.log('Waiting for any OS startup sounds getting played (to skip those) ...');
-        time.sleep(5);
-
-        if  oSession is not None:
+        if oSession is not None:
+
+            self.prepareGuestForDebugging(oSession, oTxsSession, oTestVm);
+
+            reporter.log('Waiting for any OS startup sounds getting played (to skip those) ...');
+            time.sleep(5);
+
             self.addTask(oTxsSession);