[Android] Add a configurable environment for devil/.

build/android/devil/devil_env.py

+# Copyright 2015 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 json
+import logging
+import os
+import sys
+import tempfile
+import threading
+
+# TODO(jbudorick): Update this once dependency_manager moves to catapult.
+_TELEMETRY_PATH = os.path.abspath(os.path.join(
+    os.path.dirname(__file__), os.pardir, os.pardir, os.pardir,
+    'tools', 'telemetry'))
+sys.path.append(_TELEMETRY_PATH)
+from catapult_base import dependency_manager # pylint: disable=import-error
+
+
+_DEFAULT_CONFIG_FILES = [
+  os.path.abspath(os.path.join(
+      os.path.dirname(__file__), os.pardir, 'devil_config.json')),
+]
+
+
+class _Environment(object):
+
+  def __init__(self):
+    self._config = None
+    self._config_init_lock = threading.Lock()
+
+  def Initialize(self, configs=None, config_files=None):
+    """Initialize devil's environment.
+
+    This uses all configurations provided via |configs| and |config_files|
+    to determine the locations of devil's dependencies. Configurations should
+    all take the form described by catapult_base.dependency_manager.BaseConfig.
+    If no configurations are provided, a default one will be used if available.
+
+    Args:
+      configs: An optional list of dict configurations.
+      config_files: An optional list of files to load
+    """
+
+    # Make sure we only initialize self._config once.
+    with self._config_init_lock:
+      if self._config is not None:
+        return
+      self._config = {}
+
+    self._InitializeRecursive(configs=configs, config_files=config_files)
+
+  def _InitializeRecursive(self, configs=None, config_files=None):
+    if configs:
+      with tempfile.NamedTemporaryFile() as next_config_file:
+        next_config_file.write(json.dumps(configs[0]))
+        next_config_file.flush()
+        self._InitializeRecursive(
+            configs=configs[1:],
+            config_files=[next_config_file.name] + (config_files or []))

[perezju, 2015/09/14 16:15:06]

ugh, this is a somewhat ugly use of recursion... after a while I figured this
probably is because of the tempfile's, to open/close them properly.

nit: Maybe just add a comment explaining that's why we can't do a more simple
iterative implementation? And/or a TODO to avoid this if at some point the
dependency manager supports loading from dicts in addition to files?

[jbudorick, 2015/09/14 17:45:39]

Correct.
Will do.

[aiolos (Not reviewing), 2015/09/16 03:37:54]

I designed the dependency_manager to allow subclassing of base config to allow
for more flexibility, and can easily add one that allows you to use a dictionary
instead of a json file. Feel free to block on that or land as-is.

[jbudorick, 2015/09/18 15:08:20]

Landing as-is. I'll send you a follow-up CL.

+    else:
+      self._InitializeImpl(config_files)
+
+  def _InitializeImpl(self, config_files):
+    if not config_files:
+      config_files = _DEFAULT_CONFIG_FILES
+
+    dm = dependency_manager.DependencyManager(
+        [dependency_manager.BaseConfig(c) for c in config_files])
+    platform = 'linux_android'
+
+    self._config['android_sdk_path'] = dm.FetchPath('android_sdk', platform)
+    self._config['adb_path'] = (
+        dm.FetchPath('adb_path', platform)
+        or os.path.join(self.android_sdk_path, 'platform-tools', 'adb'))
+
+    build_tools_contents = os.listdir(
+        os.path.join(self.android_sdk_path, 'build-tools'))
+    if not build_tools_contents:
+      self._config['android_sdk_build_tools_path'] = None
+    else:
+      if len(build_tools_contents) > 1:
+        build_tools_contents.sort()
+        logging.warning(
+            'More than one set of build-tools provided by the Android SDK: %s',
+            ','.join(build_tools_contents))
+        logging.warning('Defaulting to %s', build_tools_contents[-1])
+      self._config['android_sdk_build_tools_path'] = os.path.join(
+          self.android_sdk_path, 'build-tools', build_tools_contents[-1])
+
+    self._config['forwarder_host_path'] = dm.FetchPath(
+        'forwarder_host', platform)
+    self._config['forwarder_device_path'] = dm.FetchPath(
+        'forwarder_device', platform)
+
+    self._config['md5sum_host_path'] = dm.FetchPath('md5sum_host', platform)
+    self._config['md5sum_device_path'] = dm.FetchPath('md5sum_device', platform)
+
+    self._config['pymock_path'] = dm.FetchPath('pymock', platform)
+
+  def __getattr__(self, name):
+    if self._config is None:
+      self.Initialize()
+
+    if name not in self._config:
+      raise AttributeError('devil environment has no %r attribute', name)

[perezju, 2015/09/14 16:15:06]

This is not logging. I think here you really need: msg % params

[jbudorick, 2015/09/14 17:45:39]

O_O

fixed.

+
+    return self._config[name]
+
+
+config = _Environment()
+
+
+def GenerateDynamicConfig(deps):
+  """Generate a configuration dict from the provided deps dict.
+
+  Args:
+    deps: A dict mapping dependency names to lists of local files.
+  Returns:
+    A BaseConfig-compatible dict.
+  """
+  return {
+    'config_type': 'BaseConfig',
+    'dependencies': {
+      k: {
+        'file_info': {
+          'linux_android': {
+            'local_paths': v
+          }
+        }
+      } for k, v in deps.iteritems()
+    }
+  }
+