Changeset 65461 in vbox for trunk/src/VBox/ValidationKit/tests/usb

Timestamp:

Jan 26, 2017 4:59:23 PM (8 years ago)

Author:

vboxsync

svn:sync-xref-src-repo-rev:

113086

Message:

ValidationKit/tdUsb1: Add option to capture USB traffic and upload it for failed tests

File:

• trunk/src/VBox/ValidationKit/tests/usb/tdUsb1.py (modified) (9 diffs)

trunk/src/VBox/ValidationKit/tests/usb/tdUsb1.py

@@ -108 +108 @@
         self.sGadgetHostnameDef    = 'usbtest.de.oracle.com';
         self.uGadgetPortDef        = None;
+        self.sUsbCapturePathDef    = self.sScratchPath;
+        self.sUsbCapturePath       = self.sUsbCapturePathDef;
+        self.fUsbCapture           = False;
 
     #
@@ -140 +143 @@
         reporter.log('  --default-gadget-port <port>');
         reporter.log('      Default: %s' % (6042));
+        reporter.log('  --usb-capture-path <path>');
+        reporter.log('      Default: %s' % (self.sUsbCapturePathDef));
+        reporter.log('  --usb-capture');
+        reporter.log('      Whether to capture the USB traffic for each test');
         return rc;
 
@@ -222 +229 @@
                 raise base.InvalidOption('The "--default-gadget-port" value "%s" is zero or negative.' \
                     % (self.uGadgetPortDef,));
+        elif asArgs[iArg] == '--usb-capture-path':
+            if iArg >= len(asArgs): raise base.InvalidOption('The "--usb-capture-path" takes a path argument');
+            self.sUsbCapturePath = asArgs[iArg];
+        elif asArgs[iArg] == '--usb-capture':
+            self.fUsbCapture = True;
         else:
             return vbox.TestDriver.parseOption(self, asArgs, iArg);
@@ -306 +318 @@
         return (self.sGadgetHostnameDef, self.uGadgetPortDef);
 
+    def getCaptureFilePath(self, sUsbCtrl, sSpeed):
+        """
+        Returns capture filename from the given data.
+        """
+
+        return '%s/%s-%s.pcap' % (self.sUsbCapturePath, sUsbCtrl, sSpeed);
+
+    def attachUsbDeviceToVm(self, oSession, sVendorId, sProductId, iBusId,
+                            sCaptureFile = None):
+        """
+        Attaches the given USB device to the VM either via a filter
+        or directly if capturing the USB traffic is enabled.
+
+        Returns True on success, False on failure.
+        """
+        fRc = False;
+        if sCaptureFile is None:
+            fRc = oSession.addUsbDeviceFilter('Compliance device', sVendorId = sVendorId, sProductId = sProductId, \
+                                              sPort = format(iBusId, 'x'));
+        else:
+            # Search for the correct device in the USB device list waiting for some time
+            # to let it appear.
+            iVendorId = int(sVendorId, 16);
+            iProductId = int(sProductId, 16);
+
+            # Try a few times to give VBoxSVC a chance to detect the new device.
+            for _ in xrange(5):
+                fFound = False;
+                aoUsbDevs = self.oVBoxMgr.getArray(self.oVBox.host, 'USBDevices');
+                for oUsbDev in aoUsbDevs:
+                    if     oUsbDev.vendorId == iVendorId \
+                       and oUsbDev.productId == iProductId \
+                       and oUsbDev.port == iBusId:
+                        fFound = True;
+                        fRc = oSession.attachUsbDevice(oUsbDev.id, sCaptureFile);
+                        break;
+
+                if fFound:
+                    break;
+
+                # Wait a moment until the next try.
+                self.sleep(1);
+
+        if fRc:
+            # Wait a moment to let the USB device appear
+            self.sleep(3);
+
+        return fRc;
+
     #
     # Test execution helpers.
     #
-    def testUsbCompliance(self, oSession, oTxsSession, sUsbCtrl, sSpeed):
+    def testUsbCompliance(self, oSession, oTxsSession, sUsbCtrl, sSpeed, sCaptureFile = None):
         """
         Test VirtualBoxs USB stack in a VM.
@@ -331 +392 @@
             if fRc is True:
                 iBusId, _ = oUsbGadget.getGadgetBusAndDevId();
-                fRc = oSession.addUsbDeviceFilter('Compliance device', sVendorId = '0525', sProductId = 'a4a0', \
-                                                  sPort = format(iBusId, 'x'));
+                fRc = self.attachUsbDeviceToVm(oSession, '0525', 'a4a0', iBusId, sCaptureFile);
                 if fRc is True:
-
-                    # Wait a moment to let the USB device appear
-                    self.sleep(3);
-
                     tupCmdLine = ('UsbTest', );
                     # Exclude a few tests which hang and cause a timeout, need investigation.
@@ -362 +418 @@
         return fRc;
 
-    def testUsbReattach(self, oSession, oTxsSession, sUsbCtrl, sSpeed): # pylint: disable=W0613
+    def testUsbReattach(self, oSession, oTxsSession, sUsbCtrl, sSpeed, sCaptureFile = None): # pylint: disable=W0613
         """
         Tests that rapid connect/disconnect cycles work.
@@ -383 +439 @@
             if fRc is True:
                 iBusId, _ = oUsbGadget.getGadgetBusAndDevId();
-                fRc = oSession.addUsbDeviceFilter('Compliance device', sVendorId = '0525', sProductId = 'a4a0', \
-                                                  sPort = str(iBusId));
+                fRc = self.attachUsbDeviceToVm(oSession, '0525', 'a4a0', iBusId, sCaptureFile);
                 if fRc is True:
 
@@ -456 +511 @@
                 self.sleep(5);
 
+                sCaptureFile = None;
+                if self.fUsbCapture:
+                    sCaptureFile = self.getCaptureFilePath(sUsbCtrl, sSpeed);
+
                 if sUsbTest == 'Compliance':
-                    fRc = self.testUsbCompliance(oSession, oTxsSession, sUsbCtrl, sSpeed);
+                    fRc = self.testUsbCompliance(oSession, oTxsSession, sUsbCtrl, sSpeed, sCaptureFile);
                 elif sUsbTest == 'Reattach':
-                    fRc = self.testUsbReattach(oSession, oTxsSession, sUsbCtrl, sSpeed);
+                    fRc = self.testUsbReattach(oSession, oTxsSession, sUsbCtrl, sSpeed, sCaptureFile);
 
                 # cleanup.
                 self.removeTask(oTxsSession);
                 self.terminateVmBySession(oSession)
+
+                # Add the traffic dump if it exists and the test failed
+                if reporter.testErrorCount() > 0 \
+                   and sCaptureFile is not None \
+                   and os.path.exists(sCaptureFile):
+                    reporter.addLogFile(sCaptureFile, 'misc/other', 'USB traffic dump');
             else:
                 fRc = False;
@@ -472 +537 @@
         Runs one VM thru the various configurations.
         """
+        fRc = False;
         reporter.testStart(sVmName);
         for sUsbCtrl in self.asUsbCtrls: