[Android] Add --blacklist-file as a command-line option.

build/android/buildbot/bb_device_status_check.py

 #!/usr/bin/env python
 #
 # Copyright 2013 The Chromium Authors. All rights reserved.
 # Use of this source code is governed by a BSD-style license that can be
 # found in the LICENSE file.
 
 """A class to keep track of devices across builds and report state."""
+import argparse
 import json
 import logging
-import optparse
 import os
 import psutil
 import re
 import signal
 import smtplib
 import subprocess
 import sys
 import time
 import urllib
 
@@ skipping 13 matching lines @@
 from pylib.device import battery_utils
 from pylib.device import device_blacklist
 from pylib.device import device_errors
 from pylib.device import device_list
 from pylib.device import device_utils
 from pylib.utils import run_tests_helper
 from pylib.utils import timeout_retry
 
 _RE_DEVICE_ID = re.compile('Device ID = (\d+)')
 
-def DeviceInfo(device, options):
+def DeviceInfo(device, args):

[rnephew (Reviews Here), 2015/08/07 22:26:31]

Should this transition from optprase to argparse be its own cl?

   """Gathers info on a device via various adb calls.
 
   Args:
     device: A DeviceUtils instance for the device to construct info about.
 
   Returns:
     Tuple of device type, build id, report as a string, error messages, and
     boolean indicating whether or not device can be used for testing.
   """
   battery = battery_utils.BatteryUtils(device)
@@ skipping 34 matching lines @@
         if m:
           json_data['imei_slice'] = m.group(1)[-6:]
     except device_errors.CommandFailedError:
       logging.exception('Failed to get IMEI slice for %s', str(device))
 
     if battery_level < 15:
       errors += ['Device critically low in battery.']
       dev_good = False
       if not battery.GetCharging():
         battery.SetCharging(True)
-    if not options.no_provisioning_check:
+    if not args.no_provisioning_check:
       setup_wizard_disabled = (
           device.GetProp('ro.setupwizard.mode') == 'DISABLED')
       if not setup_wizard_disabled and device.build_type != 'user':
         errors += ['Setup wizard not disabled. Was it provisioned correctly?']
     if (device.product_name == 'mantaray' and
         battery_info.get('AC powered', None) != 'true'):
       errors += ['Mantaray device not connected to AC power.']
   except device_errors.CommandFailedError:
     logging.exception('Failure while getting device status.')
     dev_good = False
   except device_errors.CommandTimeoutError:
     logging.exception('Timeout while getting device status.')
     dev_good = False
 
   return (build_product, build_id, battery_level, errors, dev_good, json_data)
 
 
-def CheckForMissingDevices(options, devices):
+def CheckForMissingDevices(args, devices):
   """Uses file of previous online devices to detect broken phones.
 
   Args:
-    options: out_dir parameter of options argument is used as the base
+    args: out_dir parameter of args argument is used as the base
       directory to load and update the cache file.
     devices: A list of DeviceUtils instance for the currently visible and
       online attached devices.
   """
-  out_dir = os.path.abspath(options.out_dir)
+  out_dir = os.path.abspath(args.out_dir)
   device_serials = set(d.adb.GetDeviceSerial() for d in devices)
 
   # last_devices denotes all known devices prior to this run
   last_devices_path = os.path.join(out_dir, device_list.LAST_DEVICES_FILENAME)
   last_missing_devices_path = os.path.join(out_dir,
       device_list.LAST_MISSING_DEVICES_FILENAME)
   try:
     last_devices = device_list.GetPersistentDeviceList(last_devices_path)
   except IOError:
     # Ignore error, file might not exist
@@ skipping 81 matching lines @@
         pass
   for p in GetAllAdb():
     try:
       logging.error('Unable to kill %d (%s [%s])', p.pid, p.name,
                     ' '.join(p.cmdline))
     except (psutil.NoSuchProcess, psutil.AccessDenied):
       pass
 
 
 def main():
-  parser = optparse.OptionParser()
-  parser.add_option('', '--out-dir',
-                    help='Directory where the device path is stored',
-                    default=os.path.join(constants.DIR_SOURCE_ROOT, 'out'))
-  parser.add_option('--no-provisioning-check', action='store_true',
-                    help='Will not check if devices are provisioned properly.')
-  parser.add_option('--device-status-dashboard', action='store_true',
-                    help='Output device status data for dashboard.')
-  parser.add_option('--restart-usb', action='store_true',
-                    help='DEPRECATED. '
-                         'This script now always tries to reset USB.')
-  parser.add_option('--json-output',
-                    help='Output JSON information into a specified file.')
-  parser.add_option('-v', '--verbose', action='count', default=1,
-                    help='Log more information.')
+  parser = argparse.ArgumentParser()
+  parser.add_argument('--out-dir',
+                      help='Directory where the device path is stored',
+                      default=os.path.join(constants.DIR_SOURCE_ROOT, 'out'))
+  parser.add_argument('--no-provisioning-check', action='store_true',
+                      help='Will not check if devices are provisioned '
+                           'properly.')
+  parser.add_argument('--device-status-dashboard', action='store_true',
+                      help='Output device status data for dashboard.')
+  parser.add_argument('--restart-usb', action='store_true',
+                      help='DEPRECATED. '
+                           'This script now always tries to reset USB.')
+  parser.add_argument('--json-output',
+                      help='Output JSON information into a specified file.')
+  parser.add_argument('--blacklist-file', help='Device blacklist JSON file.')
+  parser.add_argument('-v', '--verbose', action='count', default=1,
+                      help='Log more information.')
 
-  options, args = parser.parse_args()
-  if args:
-    parser.error('Unknown options %s' % args)
+  args = parser.parse_args()
 
-  run_tests_helper.SetLogLevel(options.verbose)
+  run_tests_helper.SetLogLevel(args.verbose)
+
+  if args.blacklist_file:
+    blacklist = device_blacklist.Blacklist(args.blacklist_file)
+  else:
+    # TODO(jbudorick): Remove this once bots pass the blacklist file.
+    blacklist = device_blacklist.Blacklist(device_blacklist.BLACKLIST_JSON)
 
   # Remove the last build's "bad devices" before checking device statuses.
-  device_blacklist.ResetBlacklist()
+  blacklist.Reset()
 
   KillAllAdb()
   reset_usb.reset_all_android_devices()
 
   try:
     expected_devices = set(device_list.GetPersistentDeviceList(
-        os.path.join(options.out_dir, device_list.LAST_DEVICES_FILENAME)))
+        os.path.join(args.out_dir, device_list.LAST_DEVICES_FILENAME)))
   except IOError:
     expected_devices = set()
 
   def all_devices_found():
-    devices = device_utils.DeviceUtils.HealthyDevices()
+    devices = device_utils.DeviceUtils.HealthyDevices(blacklist)
     device_serials = set(d.adb.GetDeviceSerial() for d in devices)
     return not bool(expected_devices.difference(device_serials))
 
   timeout_retry.WaitFor(all_devices_found, wait_period=1, max_tries=5)
 
-  devices = device_utils.DeviceUtils.HealthyDevices()
+  devices = device_utils.DeviceUtils.HealthyDevices(blacklist)
   device_serials = set(d.adb.GetDeviceSerial() for d in devices)
 
   missing_devices = expected_devices.difference(device_serials)
   new_devices = device_serials.difference(expected_devices)
 
   if missing_devices or new_devices:
     logging.warning('expected_devices:')
     for d in sorted(expected_devices):
       logging.warning('  %s', d)
     logging.warning('devices:')
     for d in sorted(device_serials):
       logging.warning('  %s', d)
 
   types, builds, batteries, errors, devices_ok, json_data = (
       [], [], [], [], [], [])
   if devices:
     types, builds, batteries, errors, devices_ok, json_data = (
-        zip(*[DeviceInfo(dev, options) for dev in devices]))
+        zip(*[DeviceInfo(dev, args) for dev in devices]))
 
   # Write device info to file for buildbot info display.
   if os.path.exists('/home/chrome-bot'):
     with open('/home/chrome-bot/.adb_device_info', 'w') as f:
       for device in json_data:
         try:
           f.write('%s %s %s %.1fC %s%%\n' % (device['serial'], device['type'],
               device['build'], float(device['battery']['temperature']) / 10,
               device['battery']['level']))
         except Exception:
           pass
 
-  err_msg = CheckForMissingDevices(options, devices) or []
+  err_msg = CheckForMissingDevices(args, devices) or []
 
   unique_types = list(set(types))
   unique_builds = list(set(builds))
 
   bb_annotations.PrintMsg('Online devices: %d. Device types %s, builds %s'
                            % (len(devices), unique_types, unique_builds))
 
   for j in json_data:
     logging.info('Device %s (%s)', j.get('serial'), j.get('type'))
     logging.info('  Build: %s (%s)', j.get('build'), j.get('build_detail'))
@@ skipping 13 matching lines @@
     bb_annotations.PrintWarning()
     for e in err_msg:
       logging.error(e)
     from_address = 'buildbot@chromium.org'
     to_addresses = ['chromium-android-device-alerts@google.com']
     bot_name = os.environ.get('BUILDBOT_BUILDERNAME')
     slave_name = os.environ.get('BUILDBOT_SLAVENAME')
     subject = 'Device status check errors on %s, %s.' % (slave_name, bot_name)
     SendEmail(from_address, to_addresses, [], subject, '\n'.join(err_msg))
 
-  if options.device_status_dashboard:
+  if args.device_status_dashboard:
     offline_devices = [
         device_utils.DeviceUtils(a)
         for a in adb_wrapper.AdbWrapper.Devices(is_ready=False)
         if a.GetState() == 'offline']
 
     perf_tests_results_helper.PrintPerfResult('BotDevices', 'OnlineDevices',
                                               [len(devices)], 'devices')
     perf_tests_results_helper.PrintPerfResult('BotDevices', 'OfflineDevices',
                                               [len(offline_devices)], 'devices',
                                               'unimportant')
     for dev, battery in zip(devices, batteries):
       perf_tests_results_helper.PrintPerfResult('DeviceBattery', str(dev),
                                                 [battery], '%',
                                                 'unimportant')
 
-  if options.json_output:
-    with open(options.json_output, 'wb') as f:
+  if args.json_output:
+    with open(args.json_output, 'wb') as f:
       f.write(json.dumps(json_data, indent=4))
 
   num_failed_devs = 0
   for device_ok, device in zip(devices_ok, devices):
     if not device_ok:
       logging.warning('Blacklisting %s', str(device))
-      device_blacklist.ExtendBlacklist([str(device)])
+      blacklist.Extend([str(device)])
       num_failed_devs += 1
 
   if num_failed_devs == len(devices):
     return 2
 
   if not devices:
     return 1
 
 
 if __name__ == '__main__':
   sys.exit(main())