Improve USB device reset logic

webrtc/tools/run_video_analysis.py

 #!/usr/bin/env python
 # Copyright (c) 2017 The WebRTC project authors. All Rights Reserved.
 #
 # Use of this source code is governed by a BSD-style license
 # that can be found in the LICENSE file in the root of the source
 # tree. An additional intellectual property rights grant can be found
 # in the file PATENTS.  All contributing project authors may
 # be found in the AUTHORS file in the root of the source tree.
 
 import optparse
 import os
 import subprocess
 import sys
 import time
 import glob
-import re
 import shutil
 
 # Used to time-stamp output files and directories
 CURRENT_TIME = time.strftime("%d_%m_%Y-%H:%M:%S")
 
 
 class Error(Exception):
   pass
 
 
@@ skipping 124 matching lines @@
   os.makedirs(test_rec_dir)
 
   record_paths = {
     'ref_rec_location' : os.path.abspath(ref_rec_dir),
     'test_rec_location' : os.path.abspath(test_rec_dir)
   }
 
   return record_paths
 
 
-def RestartMagewellDevices(ref_video_device, test_video_device):
-  """Reset the USB ports where Magewell capture devices are connected to.
+def FindUsbPortForV4lDevices(ref_video_device, test_video_device):
+  """Tries to find the usb port for ref_video_device and test_video_device.
 
   Tries to find the provided ref_video_device and test_video_device devices
   which use video4linux and then do a soft reset by using USB unbind and bind.
+
+  Args:
+    ref_device(string): reference recording device path.
+    test_device(string): test recording device path
+
+  Returns:
+    usb_ports(list): USB ports(string) for the devices found.
+  """
+
+  # Find the device location including USB and USB Bus ID's. Use the usb1
+  # in the path since the driver folder is a symlink which contains all the
+  # usb device port mappings and it's the same in all usbN folders. Tested
+  # on Ubuntu 14.04.
+  v4l_device_path = '/sys/bus/usb/devices/usb1/1-1/driver/**/**/video4linux/'
+  v4l_ref_device = glob.glob('%s%s' % (v4l_device_path, ref_video_device))
+  v4l_test_device = glob.glob('%s%s' % (v4l_device_path, test_video_device))
+  usb_ports = []
+  paths = []
+
+  # Split on the driver folder first since we are only interested in the
+  # folders thereafter.
+  ref_path = str(v4l_ref_device).split('driver')[1].split('/')
+  test_path = str(v4l_test_device).split('driver')[1].split('/')
+  paths.append(ref_path)
+  paths.append(test_path)
+
+  for path in paths:
+    for usb_id in path:
+      # Look for : separator and then use the first element in the list.
+      # E.g 3-3.1:1.0 split on : and [0] becomes 3-3.1 which can be used
+      # for bind/unbind.
+      if ':' in usb_id:
+        usb_ports.append(usb_id.split(':')[0])
+  return usb_ports
+
+
+def RestartMagewellDevices(ref_video_device_path, test_video_device_path):
+  """Reset the USB ports where Magewell capture devices are connected to.
+
+  Performs a soft reset by using USB unbind and bind.
   This is due to Magewell capture devices have proven to be unstable after the
   first recording attempt.
 
-  Args :
-    ref_video_device(string): reference recording device path.
-    test_video_device(string): test recording device path
+  Args:
+    ref_video_device_path(string): reference recording device path.
+    test_video_device_path(string): test recording device path
 
   Raises:
     MagewellError: If no magewell devices are found.
   """
 
   # Get the dev/videoN device name from the command line arguments.
-  ref_magewell = ref_video_device.split('/')[2]
-  test_magewell = test_video_device.split('/')[2]
-
-  # Find the device location including USB and USB Bus ID's.
-  device_string = '/sys/bus/usb/devices/usb*/**/**/video4linux/'
-  ref_magewell_device = glob.glob('%s%s' % (device_string, ref_magewell))
-  test_magewell_device = glob.glob('%s%s' % (device_string, test_magewell))
-
-  magewell_usb_ports = []
-
-  # Figure out the USB bus and port ID for each device.
-  ref_magewell_path = str(ref_magewell_device).split('/')
-  for directory in ref_magewell_path:
-    # Find the folder with pattern "N-N", e.g. "4-3" or \
-    # "[USB bus ID]-[USB port]"
-    if re.match(r'^\d-\d$', directory):
-      magewell_usb_ports.append(directory)
-
-  test_magewell_path = str(test_magewell_device).split('/')
-  for directory in test_magewell_path:
-    # Find the folder with pattern "N-N", e.g. "4-3" or \
-    # "[USB bus ID]-[USB port]"
-    if re.match(r'^\d-\d$', directory):
-      magewell_usb_ports.append(directory)
+  ref_magewell_path = ref_video_device_path.split('/')[2]
+  test_magewell_path = test_video_device_path.split('/')[2]
+  magewell_usb_ports = FindUsbPortForV4lDevices(ref_magewell_path,
+                                                test_magewell_path)
 
   # Abort early if no devices are found.
   if len(magewell_usb_ports) == 0:
     raise MagewellError('No magewell devices found.')
   else:
     print '\nResetting USB ports where magewell devices are connected...'
     # Use the USB bus and port ID (e.g. 4-3) to unbind and bind the USB devices
     # (i.e. soft eject and insert).
     for usb_port in magewell_usb_ports:
       echo_cmd = ['echo', usb_port]
@@ skipping 263 matching lines @@
   if options.compare_videos_script:
     CompareVideos(options, recording_result['cropped_ref_file'],
                   recording_result['cropped_test_file'])
   else:
     print ('Skipping compare videos step due to compare_videos flag were not '
            'passed.')
 
 
 if __name__ == '__main__':
   sys.exit(main())