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) 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 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 shutil
+import subprocess
+import sys
+
+from pylib import constants
+
+# From the Android Developer's website.
+SDK_BASE_URL = 'http://dl.google.com/android/adt'
+SDK_ZIP = 'adt-bundle-linux-x86_64-20130219.zip'
+
+# Android x86 system image 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-%s' % constants.ANDROID_SDK_VERSION
+
+
+def RunCommand(args):

[frankf, 2013/03/26 21:42:44]

You can use pylib.cmd_helper here

[navabi, 2013/03/26 23:05:38]

Done.

+  """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])
+    (_, stderr, rc) = RunCommand(['unzip', '-o', '/tmp/sdk.zip', '-d', '/tmp/'])
+    # Remove /tmp/sdk.zip
+    os.unlink('/tmp/sdk.zip')
+    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 hardware '
+                     'virtualization is enabled in BIOS (i.e. Intel VT-x or '
+                     'AMD SVM).')
+  print '%s\n%s' % output, stderr
+  # TODO(navabi): Use modprobe kvm-amd on AMD processors.
+  (output, stderr, rc) = RunCommand(['sudo', 'modprobe', 'kvm-intel'])
+  if rc:
+    logging.critical('ERROR: Did not add KVM module to Linux Kernal. Make sure '
+                     'hardware virtualization is enabled in BIOS.')
+  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 hardware '
+                     'virtualization is enabled in BIOS (i.e. Intel VT-x or '
+                     'AMD SVM).')
+  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])
+    (_, 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
+  finally:
+    os.unlink('/tmp/x86_img.zip')
+  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)

[frankf, 2013/03/26 21:42:44]

You can use pylib.utils.run_tests_helper for this

[navabi, 2013/03/26 23:05:38]

Done.

+
+  # 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():

[navabi, 2013/03/26 21:35:43]

Copied (and elaborated some) from response to pasko's comment on last patch:

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), and still allow them to
launch AMD emulators without hardware virtualization. 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?

[pasko-google - do not use, 2013/03/27 13:31:16]

I am assuming you mean ARM when you are saying "AMD" because AMD emulator
equally needs hardware virtualization support enabled in BIOS.
OK, so as far as I understand the case is that we want to run an ARM emulator
without a restart. I agree. The good news is that the ARM emulator does not need
KVM. The code should be something like:

if not StartingArmEmulator():
  if CheckKVM():
    logging.info('KVM already installed and enabled.')
  else:
    InstallKVM()
    if not CheckKVM():
      logging.info('KVM needs to be enabled in BIOS.')
      return

// The rest of the initialization code goes here.

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