build/android/update_verification.py

   1 #!/usr/bin/env python
   2 #
   3 # Copyright 2013 The Chromium Authors. All rights reserved.
   4 # Use of this source code is governed by a BSD-style license that can be
   5 # found in the LICENSE file.
   6
   7 """Runs semi-automated update testing on a non-rooted device.
   8
   9 This script will help verify that app data is preserved during an update.
  10 To use this script first run it with the create_app_data option.
  11
  12 ./update_verification.py create_app_data --old-apk <path> --app-data <path>
  13
  14 The script will then install the old apk, prompt you to create some app data
  15 (bookmarks, etc.), and then save the app data in the path you gave it.
  16
  17 Next, once you have some app data saved, run this script with the test_update
  18 option.
  19
  20 ./update_verification.py test_update --old-apk <path> --new-apk <path>
  21 --app-data <path>
  22
  23 This will install the old apk, load the saved app data, install the new apk,
  24 and ask the user to verify that all of the app data was preserved.
  25 """
  26
  27 import argparse
  28 import logging
  29 import sys
  30
  31 from devil.android import apk_helper
  32 from devil.android import device_blacklist
  33 from devil.android import device_errors
  34 from devil.android import device_utils
  35 from devil.utils import run_tests_helper
  36
  37 def CreateAppData(device, old_apk, app_data, package_name):
  38   device.Install(old_apk)
  39   raw_input('Set the application state. Once ready, press enter and '
  40             'select "Backup my data" on the device.')
  41   device.adb.Backup(app_data, packages=[package_name])
  42   logging.critical('Application data saved to %s', app_data)
  43
  44 def TestUpdate(device, old_apk, new_apk, app_data, package_name):
  45   device.Install(old_apk)
  46   device.adb.Restore(app_data)
  47   # Restore command is not synchronous
  48   raw_input('Select "Restore my data" on the device. Then press enter to '
  49             'continue.')
  50   device_path = device.GetApplicationPaths(package_name)
  51   if not device_path:
  52     raise Exception('Expected package %s to already be installed. '
  53                     'Package name might have changed!' % package_name)
  54
  55   logging.info('Verifying that %s can be overinstalled.', new_apk)
  56   device.adb.Install(new_apk, reinstall=True)
  57   logging.critical('Successfully updated to the new apk. Please verify that '
  58                    'the application data is preserved.')
  59
  60 def main():
  61   parser = argparse.ArgumentParser(
  62       description="Script to do semi-automated upgrade testing.")
  63   parser.add_argument('-v', '--verbose', action='count',
  64                       help='Print verbose log information.')
  65   parser.add_argument('--blacklist-file', help='Device blacklist JSON file.')
  66   command_parsers = parser.add_subparsers(dest='command')
  67
  68   subparser = command_parsers.add_parser('create_app_data')
  69   subparser.add_argument('--old-apk', required=True,
  70                          help='Path to apk to update from.')
  71   subparser.add_argument('--app-data', required=True,
  72                          help='Path to where the app data backup should be '
  73                            'saved to.')
  74   subparser.add_argument('--package-name',
  75                          help='Chrome apk package name.')
  76
  77   subparser = command_parsers.add_parser('test_update')
  78   subparser.add_argument('--old-apk', required=True,
  79                          help='Path to apk to update from.')
  80   subparser.add_argument('--new-apk', required=True,
  81                          help='Path to apk to update to.')
  82   subparser.add_argument('--app-data', required=True,
  83                          help='Path to where the app data backup is saved.')
  84   subparser.add_argument('--package-name',
  85                          help='Chrome apk package name.')
  86
  87   args = parser.parse_args()
  88   run_tests_helper.SetLogLevel(args.verbose)
  89
  90   if args.blacklist_file:
  91     blacklist = device_blacklist.Blacklist(args.blacklist_file)
  92   else:
  93     blacklist = None
  94
  95   devices = device_utils.DeviceUtils.HealthyDevices(blacklist)
  96   if not devices:
  97     raise device_errors.NoDevicesError()
  98   device = devices[0]
  99   logging.info('Using device %s for testing.', str(device))
 100
 101   package_name = (args.package_name if args.package_name
 102                   else apk_helper.GetPackageName(args.old_apk))
 103   if args.command == 'create_app_data':
 104     CreateAppData(device, args.old_apk, args.app_data, package_name)
 105   elif args.command == 'test_update':
 106     TestUpdate(
 107         device, args.old_apk, args.new_apk, args.app_data, package_name)
 108   else:
 109     raise Exception('Unknown test command: %s' % args.command)
 110
 111 if __name__ == '__main__':
 112   sys.exit(main())