[Android] Extract isolate logic from gtest setup to its own module.

build/android/pylib/utils/isolator.py

+# Copyright 2014 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.
+
+import fnmatch
+import glob
+import os
+import shutil
+import sys
+
+from pylib import cmd_helper
+from pylib import constants
+
+
+_ISOLATE_SCRIPT = os.path.join(
+    constants.DIR_SOURCE_ROOT, 'tools', 'swarming_client', 'isolate.py')
+
+
+def DefaultPathVariables():
+  return {
+    'DEPTH': constants.DIR_SOURCE_ROOT,
+    'PRODUCT_DIR': constants.GetOutDirectory(),
+  }
+
+
+def DefaultConfigVariables():
+  return {
+    'CONFIGURATION_NAME': constants.GetBuildType(),
+    'OS': 'android',
+    'asan': '0',
+    'chromeos': '0',
+    'component': 'static_library',
+    'fastbuild': '0',
+    'icu_use_data_file_flag': '1',
+    'libpeer_target_type': 'static_library',
+    'lsan': '0',
+    # TODO(maruel): This may not always be true.
+    'target_arch': 'arm',
+    'use_openssl': '0',
+    'use_ozone': '0',
+    'v8_use_external_startup_data': '0',
+  }
+
+
+class Isolator(object):
+  """Manages calls to isolate.py for the android test runner scripts."""
+
+  def __init__(self, isolate_deps_dir):
+    """
+    Args:
+      isolate_deps_dir: The directory in which dependencies specified by
+        isolate are or should be stored.
+    """
+    self._isolate_deps_dir = isolate_deps_dir
+
+  def Clear(self):
+    """Deletes the isolate dependency directory."""
+    if os.path.exists(self._isolate_deps_dir):

[klundberg, 2014/10/30 21:21:41]

What if _isolate_deps_dir isn't a directory? Will this still work or throw an
exception?

[jbudorick, 2014/10/30 21:37:54]

Survey says:
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
  File
"/usr/local/google/code/clankium/src/build/android/pylib/utils/isolator.py",
line 59, in Clear
  File "/usr/lib/python2.7/shutil.py", line 239, in rmtree
    onerror(os.listdir, path, sys.exc_info())
  File "/usr/lib/python2.7/shutil.py", line 237, in rmtree
    names = os.listdir(path)
OSError: [Errno 20] Not a directory:
'/usr/local/google/code/clankium/src/isolate_deps_dir'

Not sure what we'd want to do in this case. We currently fail in the same way:

I    0.002s Main  [host]> adb devices
W    0.019s Main  Found target
/usr/local/google/code/clankium/src/out/Debug/events_unittests_apk/events_unittests-debug.apk
I    0.019s Main  Did not find an isolate file for the test suite.
I    0.021s TimeoutThread-for-PushDataDeps(05a06cb3)  [host]> adb -s 05a06cb3
shell 'echo $EXTERNAL_STORAGE; echo %$?;'
Traceback (most recent call last):
  File "./build/android/test_runner.py", line 953, in <module>
    sys.exit(main())
  File "./build/android/test_runner.py", line 949, in main
    return command_option_parser.ParseAndExecute(option_parser)
  File
"/usr/local/google/code/clankium/src/build/android/pylib/utils/command_option_parser.py",
line 75, in ParseAndExecute
    return cmd.run_command_func(argv[1], options, args, option_parser)
  File "./build/android/test_runner.py", line 855, in RunTestsCommand
    return _RunGTests(options, devices)
  File "./build/android/test_runner.py", line 601, in _RunGTests
    runner_factory, tests = gtest_setup.Setup(gtest_options, devices)
  File "/usr/local/google/code/clankium/src/build/android/pylib/gtest/setup.py",
line 335, in Setup
    PushDataDeps, test_options, test_package)
  File
"/usr/local/google/code/clankium/src/build/android/pylib/utils/parallelizer.py",
line 240, in pMap
    r.pFinish(None)
  File
"/usr/local/google/code/clankium/src/build/android/pylib/utils/parallelizer.py",
line 139, in pFinish
    self._objs.JoinAll()
  File
"/usr/local/google/code/clankium/src/build/android/pylib/utils/reraiser_thread.py",
line 141, in JoinAll
    self._JoinAll(watcher)
  File
"/usr/local/google/code/clankium/src/build/android/pylib/utils/reraiser_thread.py",
line 128, in _JoinAll
    thread.ReraiseIfException()
  File
"/usr/local/google/code/clankium/src/build/android/pylib/utils/reraiser_thread.py",
line 76, in run
    self._ret = self._func(*self._args, **self._kwargs)
  File "/usr/local/google/code/clankium/src/build/android/pylib/gtest/setup.py",
line 304, in PushDataDeps
    for p in os.listdir(constants.ISOLATE_DEPS_DIR)])
OSError: [Errno 20] Not a directory:
'/usr/local/google/code/clankium/src/isolate_deps_dir'

+      shutil.rmtree(self._isolate_deps_dir)
+
+  def Remap(self, isolate_abs_path, isolated_abs_path,
+            path_variables=None, config_variables=None):
+    """Remaps data dependencies into |self._isolate_deps_dir|.
+
+    Args:
+      isolate_abs_path: The absolute path to the .isolate file.
+      isolated_abs_path: The absolute path to the .isolated file.

[klundberg, 2014/10/30 21:21:41]

I read the doc for isolate/swarming and cannot decide whether you should explain
what .isolate and .isolated are used for here:-)
I think it would be nice with with an explanation here but I don't feel
strongly.

[jbudorick, 2014/10/30 21:37:54]

I'm not sure the caller really needs to know what they are, but I guess I can
explain Isolate in a bit more detail either in here or in the class comments.

+      path_variables: A dict containing everything that should be passed
+        as a |--path-variable| to the isolate script. Defaults to the return
+        value of |DefaultPathVariables()|.
+      config_variables: A dict containing everything that should be passed
+        as a |--config-variable| to the isolate script. Defaults to the return
+        value of |DefaultConfigVariables()|.
+    Raises:
+      Exception if the isolate command fails for some reason.
+    """
+    if not path_variables:
+      path_variables = DefaultPathVariables()
+    if not config_variables:
+      config_variables = DefaultConfigVariables()
+
+    isolate_cmd = [
+      sys.executable, _ISOLATE_SCRIPT, 'remap',
+      '--isolate', isolate_abs_path,
+      '--isolated', isolated_abs_path,
+      '--outdir', self._isolate_deps_dir,
+    ]
+    for k, v in path_variables.iteritems():
+      isolate_cmd.extend(['--path-variable', k, v])
+    for k, v in config_variables.iteritems():
+      isolate_cmd.extend(['--config-variable', k, v])
+
+    if cmd_helper.RunCmd(isolate_cmd):
+      raise Exception('isolate command failed: %s' % ' '.join(isolate_cmd))
+
+  def VerifyHardlinks(self):
+    """Checks |isolate_deps_dir| for a hardlink.
+
+    Returns:
+      True if a hardlink is found.
+      False if nothing is found.
+    Raises:
+      Exception if a non-hardlink is found.
+    """
+    for root, _, filenames in os.walk(self._isolate_deps_dir):
+      if filenames:
+        linked_file = os.path.join(root, filenames[0])
+        orig_file = os.path.join(
+            self._isolate_deps_dir,
+            os.path.relpath(linked_file, self._isolate_deps_dir))
+        if os.stat(linked_file).st_ino == os.stat(orig_file).st_ino:
+          return True
+        else:
+          raise Exception('isolate remap command did not use hardlinks.')
+    return False
+
+  def PurgeExcluded(self, deps_exclusion_list):
+    """Deletes anything on |deps_exclusion_list| from |self._isolate_deps_dir|.
+
+    Args:
+      deps_exclusion_list: A list of globs to exclude from the isolate
+        dependency directory.
+    """
+    excluded_paths = (
+        x for y in deps_exclusion_list
+        for x in glob.glob(
+            os.path.abspath(os.path.join(self._isolate_deps_dir, y))))
+    for p in excluded_paths:
+      if os.path.isdir(p):
+        shutil.rmtree(p)
+      else:
+        os.remove(p)
+
+  def MoveOutputDeps(self):
+    """Moves files from the output directory to the top level.

[klundberg, 2014/10/30 21:21:41]

"...top level" of what?

[jbudorick, 2014/10/30 21:37:54]

... of self._isolate_deps_dir. I suppose I should add that.

+
+    Moves pak files from the output directory to to <isolate_deps_dir>/paks
+    Moves files from the product directory to <isolate_deps_dir>
+    """
+    # On Android, all pak files need to be in the top-level 'paks' directory.
+    paks_dir = os.path.join(self._isolate_deps_dir, 'paks')
+    os.mkdir(paks_dir)

[klundberg, 2014/10/30 21:21:41]

Do we have targets that don't have pak files?
If so, do we care about having an empty paks dir?
I assume not but just wanted to make sure.

[jbudorick, 2014/10/30 21:37:54]

Not sure / no.

+
+    deps_out_dir = os.path.join(
+        self._isolate_deps_dir,
+        os.path.relpath(os.path.join(constants.GetOutDirectory(), os.pardir),
+                        constants.DIR_SOURCE_ROOT))
+    for root, _, filenames in os.walk(deps_out_dir):
+      for filename in fnmatch.filter(filenames, '*.pak'):
+        shutil.move(os.path.join(root, filename), paks_dir)
+
+    # Move everything in PRODUCT_DIR to top level.
+    deps_product_dir = os.path.join(deps_out_dir, constants.GetBuildType())
+    if os.path.isdir(deps_product_dir):
+      for p in os.listdir(deps_product_dir):
+        shutil.move(os.path.join(deps_product_dir, p), self._isolate_deps_dir)
+      os.rmdir(deps_product_dir)
+      os.rmdir(deps_out_dir)
+