devtoolslib/paths.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.

"""Supports inferring locations of files in default checkout layouts.

These functions allow devtools scripts to work out-of-the-box with regular Mojo
checkouts.
"""

import collections
import os.path
import sys

DEVTOOLS_ROOT = os.path.join(os.path.dirname(os.path.realpath(__file__)), '..')


def find_ancestor_with(relpath, start_path=None):
  """Returns the lowest ancestor of this file that contains |relpath|."""
  cur_dir_path = start_path or os.path.abspath(os.path.dirname(__file__))
  while True:
    if os.path.exists(os.path.join(cur_dir_path, relpath)):
      return cur_dir_path

    next_dir_path = os.path.dirname(cur_dir_path)
    if next_dir_path != cur_dir_path:
      cur_dir_path = next_dir_path
    else:
      return None


def find_within_ancestors(target_relpath, start_path=None):
  """Returns the absolute path to |target_relpath| in the lowest ancestor of
  |start_path| that contains it.
  """
  ancestor = find_ancestor_with(target_relpath, start_path)
  if not ancestor:
    return None
  return os.path.join(ancestor, target_relpath)


def infer_params(is_android, is_debug, target_cpu):
  """Infers the locations of select build output artifacts in a regular
  Chromium-like checkout. This should grow thinner or disappear as we introduce
  per-repo config files, see https://github.com/domokit/devtools/issues/28.

  Returns:
    Defaultdict with the inferred paths.
  """
  build_dir = (('android_' if is_android else '') +
               (target_cpu + '_' if target_cpu else '') +
               ('Debug' if is_debug else 'Release'))
  out_build_dir = os.path.join('out', build_dir)

  root_path = find_ancestor_with(out_build_dir)
  params = collections.defaultdict(lambda: None)
  if not root_path:
    return params

  build_dir_path = os.path.join(root_path, out_build_dir)
  params['build_dir_path'] = build_dir_path
  if is_android:
    params['shell_path'] = os.path.join(build_dir_path, 'apks', 'MojoShell.apk')
    adb_path = os.path.join(root_path, 'third_party', 'android_tools',
                            'sdk', 'platform-tools', 'adb')
    if os.path.isfile(adb_path):
      params['adb_path'] = adb_path
  else:
    params['shell_path'] = os.path.join(build_dir_path, 'mojo_shell')

  mojo_version_file = find_within_ancestors('MOJO_VERSION')
  if mojo_version_file:
    with open(mojo_version_file) as f:
      params['mojo_version'] = f.read().strip()
  return params


# Based on Chromium //tools/find_depot_tools.py.
def find_depot_tools():
  """Searches for depot_tools.

  Returns:
    Path to the depot_tools checkout present on the machine, None if not found.
  """
  def _is_real_depot_tools(path):
    return os.path.isfile(os.path.join(path, 'gclient.py'))

  # First look if depot_tools is already in PYTHONPATH.
  for i in sys.path:
    if i.rstrip(os.sep).endswith('depot_tools') and _is_real_depot_tools(i):
      return i
  # Then look if depot_tools is in PATH, common case.
  for i in os.environ['PATH'].split(os.pathsep):
    if _is_real_depot_tools(i):
      return i
  # Rare case, it's not even in PATH, look upward up to root.
  root_dir = os.path.dirname(os.path.abspath(__file__))
  previous_dir = os.path.abspath(__file__)
  while root_dir and root_dir != previous_dir:
    i = os.path.join(root_dir, 'depot_tools')
    if _is_real_depot_tools(i):
      return i
    previous_dir = root_dir
    root_dir = os.path.dirname(root_dir)
  return None