build/android/gyp/apk_install.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.

"""Installs an APK.

"""

import optparse
import os
import re
import sys

from util import build_device
from util import build_utils
from util import md5_check

BUILD_ANDROID_DIR = os.path.join(os.path.dirname(__file__), '..')
sys.path.append(BUILD_ANDROID_DIR)

from pylib import constants
from pylib.utils import apk_helper

_DPI_TO_DENSITY = {
    120: 'ldpi',
    160: 'mdpi',
    240: 'hdpi',
    320: 'xhdpi',
    480: 'xxhdpi',
    }


def RetrieveDeviceConfig(device):
  """Probes the given device for its split-select config.

  For example: en-rUS-xhdpi:armeabi-v7a
  Run "split-select --help" for more info about the format.
  """
  language = device.GetProp('persist.sys.language')
  country = device.GetProp('persist.sys.country')
  density_dpi = int(device.GetProp('ro.sf.lcd_density'))
  density = _DPI_TO_DENSITY.get(density_dpi, 'tvdpi')
  abi = device.product_cpu_abi
  return '%s-r%s-%s:%s' % (language, country, density, abi)


def GetNewMetadata(device, apk_package):
  """Gets the metadata on the device for the apk_package apk."""
  output = device.RunShellCommand('ls -l /data/app/')
  # Matches lines like:
  # -rw-r--r-- system   system    7376582 2013-04-19 16:34 \
  # org.chromium.chrome.shell.apk
  # -rw-r--r-- system   system    7376582 2013-04-19 16:34 \
  # org.chromium.chrome.shell-1.apk
  apk_matcher = lambda s: re.match('.*%s(-[0-9]*)?(.apk)?$' % apk_package, s)
  matches = filter(apk_matcher, output)
  return matches[0] if matches else None

def HasInstallMetadataChanged(device, apk_package, metadata_path):
  """Checks if the metadata on the device for apk_package has changed."""
  if not os.path.exists(metadata_path):
    return True

  with open(metadata_path, 'r') as expected_file:
    return expected_file.read() != device.GetInstallMetadata(apk_package)


def RecordInstallMetadata(device, apk_package, metadata_path):
  """Records the metadata from the device for apk_package."""
  metadata = GetNewMetadata(device, apk_package)
  if not metadata:
    raise Exception('APK install failed unexpectedly.')

  with open(metadata_path, 'w') as outfile:
    outfile.write(metadata)


def main():
  parser = optparse.OptionParser()
  parser.add_option('--apk-path',
      help='Path to .apk to install.')
  parser.add_option('--split-apk-path',
      help='Path to .apk splits (can specify multiple times, causes '
      '--install-multiple to be used.',
      action='append')
  parser.add_option('--android-sdk-tools',
      help='Path to the Android SDK build tools folder. ' +
           'Required when using --split-apk-path.')
  parser.add_option('--install-record',
      help='Path to install record (touched only when APK is installed).')
  parser.add_option('--build-device-configuration',
      help='Path to build device configuration.')
  parser.add_option('--stamp',
      help='Path to touch on success.')
  parser.add_option('--configuration-name',
      help='The build CONFIGURATION_NAME')
  options, _ = parser.parse_args()

  device = build_device.GetBuildDeviceFromPath(
      options.build_device_configuration)
  if not device:
    return

  constants.SetBuildType(options.configuration_name)

  serial_number = device.GetSerialNumber()
  apk_package = apk_helper.GetPackageName(options.apk_path)

  metadata_path = '%s.%s.device.time.stamp' % (options.apk_path, serial_number)

  # If the APK on the device does not match the one that was last installed by
  # the build, then the APK has to be installed (regardless of the md5 record).
  force_install = HasInstallMetadataChanged(device, apk_package, metadata_path)

  def SelectSplits(target_config, base_apk, split_apks, android_sdk_tools):
    cmd = [os.path.join(android_sdk_tools, 'split-select'),
           '--target', target_config,
           '--base', base_apk,
           ]
    for split in split_apks:
      cmd.extend(('--split', split))

    # split-select outputs one path per line and a blank line at the end.
    output = build_utils.CheckOutput(cmd)
    return [x for x in output.split('\n') if x]

  def Install():
    if options.split_apk_path:
      requiredSdkVersion = constants.ANDROID_SDK_VERSION_CODES.LOLLIPOP
      actualSdkVersion = device.device.build_version_sdk
      if actualSdkVersion < requiredSdkVersion:
        raise Exception(('--split-apk-path requires sdk version %s. Device has '
                         'version %s') % (requiredSdkVersion, actualSdkVersion))
      device_config = RetrieveDeviceConfig(device.device)
      active_splits = SelectSplits(
          device_config,
          options.apk_path,
          options.split_apk_path,
          options.android_sdk_tools)

      all_apks = [options.apk_path] + active_splits
      device.device.adb.InstallMultiple(all_apks, reinstall=True)
    else:
      device.Install(options.apk_path, reinstall=True)

    RecordInstallMetadata(device, apk_package, metadata_path)
    build_utils.Touch(options.install_record)


  record_path = '%s.%s.md5.stamp' % (options.apk_path, serial_number)
  md5_check.CallAndRecordIfStale(
      Install,
      record_path=record_path,
      input_paths=[options.apk_path],
      force=force_install)

  if options.stamp:
    build_utils.Touch(options.stamp)


if __name__ == '__main__':
  sys.exit(main())