Add script to download SDK, system images and create and start AVDs for testing.

build/android/install-emulator-deps.py

+#!/usr/bin/env python
+# Copyright (c) 2012 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 deps for using SDK emulator for testing.
+
+The script will download the SDK and system images, if they are not present, and
+install and enable KVM, if virtualization has been enabled in the BIOS.
+"""
+
+
+import logging
+import os
+import subprocess
+import shutil

[pasko-google - do not use, 2013/03/21 12:08:37]

import order needs tiny treatment

[navabi, 2013/03/26 21:27:30]

Done.

+import sys
+
+
+# From the Android Developer's website.
+SDK_BASE_URL = 'http://dl.google.com/android/adt'
+SDK_ZIP = 'adt-bundle-linux-x86_64-20130219.zip'
+
+# From the Intel website:
+# http://software.intel.com/en-us/articles/intel-eula-x86-android-4-2-jelly-bean-bin
+X86_IMG_URL = 'http://download-software.intel.com/sites/landingpage/android/sysimg_x86-17_r01.zip'
+
+# Android API level
+API_TARGET = 'android-17'
+
+
+def RunCommand(args):
+  """Execute a command and return stdout and stderr.
+
+  Args:
+    args: list of the command and the args to the command.
+
+  Returns:
+    (output, stderr, rc): stdout and stderr and return code
+  """
+  logging.info('Running command: %s' % args)
+  proc = subprocess.Popen(args, stdout=subprocess.PIPE, stderr=subprocess.PIPE)
+  output, stderr = proc.communicate()
+  rc = proc.returncode
+  return (str(output).strip(), stderr, rc)
+
+
+def CheckSDK():
+  """Check if SDK is already installed.
+
+  Returns:
+    true if android_tools directory exists in current directory.
+  """
+  return os.path.exists(os.path.join(os.getcwd(), 'android_tools'))
+
+
+def CheckX86Image():
+  """Check if Android system images have been installed.
+
+  Returns:
+    true if android_tools/sdk/system-images directory exists.
+  """
+  return os.path.exists(os.path.join(os.getcwd(), 'android_tools', 'sdk',
+                                     'system-images', API_TARGET, 'x86'))
+
+
+def CheckKVM():
+  """Check if KVM is enabled.
+
+  Returns:
+    true if kvm-ok returns 0 (already enabled)
+  """
+  (_, _, rc) = RunCommand(['kvm-ok'])
+  return not rc
+
+
+def GetSDK():
+  """Download the SDK and unzip in android_tools directory.
+
+  Returns:
+    true if SDK successfully downloaded, false otherwise
+  """
+  logging.info('Download Android SDK.')
+  sdk_url = '%s/%s' % (SDK_BASE_URL, SDK_ZIP)
+  try:
+    # RunCommand(['curl', '-o', '/tmp/sdk.zip', sdk_url])

[pasko-google - do not use, 2013/03/21 12:08:37]

please don't forget to uncomment before committing

[navabi, 2013/03/26 21:27:30]

Done.

+    (_, stderr, rc) = RunCommand(['unzip', '-o', '/tmp/sdk.zip', '-d', '/tmp/'])

[pasko-google - do not use, 2013/03/21 12:08:37]

/tmp/sdk.zip is never removed, should probably do it in the finally: section

[navabi, 2013/03/26 21:27:30]

Done.

+    if rc:
+      print stderr
+      raise
+    # Get the name of the sub-directory that everything will be extracted to.
+    dirname, _ = os.path.splitext(SDK_ZIP)
+    zip_dir = '/tmp/%s' % dirname
+    # Move the extracted directory to the current working directory.
+    shutil.move(zip_dir, 'android_tools')
+  except:
+    logging.critical('ERROR: Could not download Android SDK.')
+    return False
+  return True
+
+
+def InstallKVM():
+  """Installs KVM packages."""
+  (output, stderr, rc) = RunCommand(['sudo', 'apt-get', 'install', 'kvm'])
+  if rc:
+    logging.critical('ERROR: Did not install KVM. Make sure Intel KVM is \

[pasko-google - do not use, 2013/03/21 12:08:37]

This is not necessarily Intel, there is analogous virtualization support from
AMD, which also should work with the Android emulator. So the correct wording
should be something like:
logging.critical('ERROR: Failed to install KVM. Make sure hardware '
                 'virtualization is enabled in BIOS.')

[digit1, 2013/03/21 12:48:53]

This, also the BIOS will have no mention of KVM, which is Linux-specific.

In case you want to be more specific, the BIOS features are typically named as:

  Intel VT-x
  AMD SVM

(On recent CPUS, there is a bunch of other "hardware virtualization"
technologies, which relate to I/O and other stuff, the ones above are
technically the only thing required for what we need).

[navabi, 2013/03/26 21:27:30]

Done.

+enabled in BIOS.')
+  print '%s\n%s' % output, stderr
+  (output, stderr, rc) = RunCommand(['sudo', 'modprobe', 'kvm-intel'])

[pasko-google - do not use, 2013/03/21 12:08:37]

please put a TODO(navabi): Use modprobe kvm-amd on AMD processors.


This is easily detectable with looking at /proc/cpuinfo for 'vmx' or 'svm', but
not for this CL..

[navabi, 2013/03/26 21:27:30]

Done.

+  if rc:
+    logging.critical('ERROR: Did not add KVM module to Linux Kernal. Make sure \
+Intel KVM is enabled in BIOS.')

[pasko-google - do not use, 2013/03/21 12:08:37]

please no carriage return escaping here and below, looks awkward :)

[navabi, 2013/03/26 21:27:30]

Done.

+  print '%s\n%s' % output, stderr
+  # Now check to ensure KVM acceleration can be used.
+  (output, stderr, rc) = RunCommand(['kvm-ok'])
+  if rc:
+    logging.critical('ERROR: Can not use KVM acceleration. Make sure Intel KVM \
+is enabled in BIOS.')

[pasko-google - do not use, 2013/03/21 12:08:37]

same thing about replacing 'Intel KVM' with 'hardware virtualization'

[navabi, 2013/03/26 21:27:30]

Done.

+  print '%s\n%s' % output, stderr
+
+
+def GetX86Image():
+  """Download x86 system image from Intel's website.
+
+  Returns:
+    true if x86 system image successfully downloaded, false otherwise
+  """
+  logging.info('Download x86 system image directory into sdk directory.')
+  try:
+    RunCommand(['curl', '-o', '/tmp/x86_img.zip', X86_IMG_URL])

[pasko-google - do not use, 2013/03/21 12:08:37]

please also remove /tmp/x86_img.zip:
finally:
  os.unlink('/tmp/x86_img.zip')

[navabi, 2013/03/26 21:27:30]

Done.

+    (_, stderr, rc) = RunCommand(['unzip', '-o', '/tmp/x86_img.zip', '-d',
+                                  '/tmp/'])
+    if rc:
+      print stderr
+      raise
+    sys_imgs = os.path.join(os.getcwd(), 'android_tools', 'sdk',
+                            'system-images', API_TARGET, 'x86')
+    shutil.move('/tmp/x86', sys_imgs)
+  except:
+    logging.critical('ERROR: Could not download x86 image.')
+    return False
+  return True
+
+
+def main(argv):
+  # Run script from parent directory of chrome checkout, because we do not want
+  # to put SDK and system images into chrome checkout.
+  new_cwd = os.path.join(os.path.dirname(os.path.abspath(__file__)), '..', '..',
+                         '..', '..')
+  os.chdir(new_cwd)
+
+  # The location of the SDK used to launch the emulator
+  emulator_sdk = os.path.join(new_cwd, 'android_tools', 'sdk')
+  os.environ['ANDROID_SDK_ROOT'] = emulator_sdk
+
+  logging.basicConfig(level=logging.INFO,
+                      format='# %(asctime)-15s: %(message)s')
+  logging.root.setLevel(logging.INFO)
+
+  # Calls below will download emulator SDK and/or system images only if needed.
+  if CheckSDK():
+    logging.info('android_tools directory already exists (not downloading).')
+  elif not GetSDK():
+    # Can not continue without downloading SDK.
+    return 1
+  if CheckX86Image():
+    logging.info('system-images directory already exists.')
+  else:
+    GetX86Image()
+
+  # Make sure KVM packages are installed and enabled.
+  if CheckKVM():

[pasko-google - do not use, 2013/03/21 12:08:37]

I would like to move it to the first part of work to make the script a noop if
hardware virtualization is not enabled. Just warn the user to reboot and enable
the flag, that's more comfortable to have the system unaffected if not all
preconditions are met.

[navabi, 2013/03/26 21:27:30]

Since the script currently only support Intel virtualization, the AMD emulator
does not require hardware virtualization to be enabled.

I would prefer to let developers launch emulators via this script before having
to do a restart (I know a restart for me is a big deal). The --enable-kvm flag
guarantees that for Intel emualtors, you must have virtualization enabled,
installed and working.

Since the AMD emulator does not require virtualization, I did not want enabling
hardware acceleration to be a precondition for this script. WDYT?

+    logging.info('KVM already installed and enabled.')
+  else:
+    InstallKVM()
+
+
+if __name__ == '__main__':
+  sys.exit(main(sys.argv))