build/android/gradle/generate_gradle.py

#!/usr/bin/env python
# Copyright 2016 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.

"""Generates an Android Studio project from a GN target."""

import argparse
import codecs
import logging
import os
import shutil
import subprocess
import sys
import zipfile

_BUILD_ANDROID = os.path.join(os.path.dirname(__file__), os.pardir)
sys.path.append(_BUILD_ANDROID)
import devil_chromium
from devil.utils import run_tests_helper
from pylib import constants
from pylib.constants import host_paths

sys.path.append(os.path.join(_BUILD_ANDROID, 'gyp'))
import jinja_template
from util import build_utils


_DEFAULT_ANDROID_MANIFEST_PATH = os.path.join(
    host_paths.DIR_SOURCE_ROOT, 'build', 'android', 'AndroidManifest.xml')
_JINJA_TEMPLATE_PATH = os.path.join(
    os.path.dirname(__file__), 'build.gradle.jinja')

_JAVA_SUBDIR = 'symlinked-java'
_SRCJARS_SUBDIR = 'extracted-srcjars'


def _RebasePath(path_or_list, new_cwd=None, old_cwd=None):
  """Makes the given path(s) relative to new_cwd, or absolute if not specified.

  If new_cwd is not specified, absolute paths are returned.
  If old_cwd is not specified, constants.GetOutDirectory() is assumed.
  """
  if not isinstance(path_or_list, basestring):
    return [_RebasePath(p, new_cwd, old_cwd) for p in path_or_list]
  if old_cwd is None:
    old_cwd = constants.GetOutDirectory()
  old_cwd = os.path.abspath(old_cwd)
  if new_cwd:
    new_cwd = os.path.abspath(new_cwd)
    return os.path.relpath(os.path.join(old_cwd, path_or_list), new_cwd)
  return os.path.abspath(os.path.join(old_cwd, path_or_list))


def _IsSubpathOf(child, parent):
  """Returns whether |child| is a subpath of |parent|."""
  return not os.path.relpath(child, parent).startswith(os.pardir)


def _WriteFile(path, data):
  """Writes |data| to |path|, constucting parent directories if necessary."""
  logging.info('Writing %s', path)
  dirname = os.path.dirname(path)
  if not os.path.exists(dirname):
    os.makedirs(dirname)
  with codecs.open(path, 'w', 'utf-8') as output_file:
    output_file.write(data)


def _RunNinja(output_dir, ninja_targets):
  cmd = ['ninja', '-C', output_dir, '-j50']
  cmd.extend(ninja_targets)
  logging.info('Running: %r', cmd)
  subprocess.check_call(cmd)


class _ProjectEntry(object):
  """Helper class for various path transformations."""
  def __init__(self, gn_target):
    assert gn_target.startswith('//'), gn_target
    if ':' not in gn_target:
      gn_target = '%s:%s' % (gn_target, os.path.basename(gn_target))
    self._gn_target = gn_target
    self._build_config = None

  @classmethod
  def FromBuildConfigPath(cls, path):
    prefix = 'gen/'
    suffix = '.build_config'
    assert path.startswith(prefix) and path.endswith(suffix), path
    subdir = path[len(prefix):-len(suffix)]
    return cls('//%s:%s' % (os.path.split(subdir)))

  def __hash__(self):
    return hash(self._gn_target)

  def __eq__(self, other):
    return self._gn_target == other.GnTarget()

  def GnTarget(self):
    return self._gn_target

  def NinjaTarget(self):
    return self._gn_target[2:]

  def GnBuildConfigTarget(self):
    return '%s__build_config' % self._gn_target

  def NinjaBuildConfigTarget(self):
    return '%s__build_config' % self.NinjaTarget()

  def GradleSubdir(self):
    """Returns the output subdirectory."""
    return self.NinjaTarget().replace(':', os.path.sep)

  def ProjectName(self):
    """Returns the Gradle project name."""
    return self.GradleSubdir().replace(os.path.sep, '\\$')

  def BuildConfig(self):
    """Reads and returns the project's .build_config JSON."""
    if not self._build_config:
      path = os.path.join('gen', self.GradleSubdir() + '.build_config')
      self._build_config = build_utils.ReadJson(_RebasePath(path))
    return self._build_config


def _ComputeJavaSourceDirs(java_files):
  """Returns the list of source directories for the given files."""
  found_roots = set()
  for path in java_files:
    path_root = path
    # Recognize these tokens as top-level.
    while os.path.basename(path_root) not in ('javax', 'org', 'com', 'src'):
      assert path_root, 'Failed to find source dir for ' + path
      path_root = os.path.dirname(path_root)
    # Assume that if we've hit "src", the we're at the root.
    if os.path.basename(path_root) != 'src':
      path_root = os.path.dirname(path_root)
    found_roots.add(path_root)
  return list(found_roots)


def _CreateSymlinkTree(entry_output_dir, symlink_dir, desired_files,
                       parent_dirs):
  """Creates a directory tree of symlinks to the given files.

  The idea here is to replicate a directory tree while leaving out files within
  it not listed by |desired_files|.
  """
  assert _IsSubpathOf(symlink_dir, entry_output_dir)
  if os.path.exists(symlink_dir):
    shutil.rmtree(symlink_dir)

  for target_path in desired_files:
    prefix = next(d for d in parent_dirs if target_path.startswith(d))
    subpath = os.path.relpath(target_path, prefix)
    symlinked_path = os.path.join(symlink_dir, subpath)
    symlinked_dir = os.path.dirname(symlinked_path)
    if not os.path.exists(symlinked_dir):
      os.makedirs(symlinked_dir)
    relpath = os.path.relpath(target_path, symlinked_dir)
    logging.debug('Creating symlink %s -> %s', symlinked_path, relpath)
    os.symlink(relpath, symlinked_path)


def _CreateJavaSourceDir(entry_output_dir, java_sources_file):
  """Computes and constructs when necessary the list of java source directories.

  1. Computes the root java source directories from the list of files.
  2. Determines whether there are any .java files in them that are not included
     in |java_sources_file|.
  3. If not, returns the list of java source directories. If so, constructs a
     tree of symlinks within |entry_output_dir| of all files in
     |java_sources_file|.
  """
  java_dirs = []
  if java_sources_file:
    java_files = _RebasePath(build_utils.ReadSourcesList(java_sources_file))
    java_dirs = _ComputeJavaSourceDirs(java_files)

    found_java_files = build_utils.FindInDirectories(java_dirs, '*.java')
    unwanted_java_files = set(found_java_files) - set(java_files)
    missing_java_files = set(java_files) - set(found_java_files)
    if unwanted_java_files:
      logging.debug('Target requires .java symlinks: %s', entry_output_dir)
      symlink_dir = os.path.join(entry_output_dir, _JAVA_SUBDIR)
      _CreateSymlinkTree(entry_output_dir, symlink_dir, java_files, java_dirs)
      java_dirs = [symlink_dir]
    if missing_java_files:
      logging.warning('Some java files were not found: %s', missing_java_files)

  return java_dirs


def _GenerateLocalProperties(sdk_dir):
  """Returns the data for project.properties as a string."""
  return '\n'.join([
      '# Generated by //build/android/gradle/generate_gradle.py',
      'sdk.dir=%s' % sdk_dir,
      ''])


def _GenerateGradleFile(build_config, config_json, java_dirs, relativize,
                        use_gradle_process_resources):
  """Returns the data for a project's build.gradle."""
  deps_info = build_config['deps_info']
  gradle = build_config['gradle']

  if deps_info['type'] == 'android_apk':
    target_type = 'android_apk'
  elif deps_info['type'] == 'java_library' and not deps_info['is_prebuilt']:
    if deps_info['requires_android']:
      target_type = 'android_library'
    else:
      target_type = 'java_library'
  else:
    return None

  variables = {}
  variables['template_type'] = target_type
  variables['use_gradle_process_resources'] = use_gradle_process_resources
  variables['build_tools_version'] = config_json['build_tools_version']
  variables['compile_sdk_version'] = config_json['compile_sdk_version']
  android_manifest = gradle.get('android_manifest',
                                _DEFAULT_ANDROID_MANIFEST_PATH)
  variables['android_manifest'] = relativize(android_manifest)
  variables['java_dirs'] = relativize(java_dirs)
  variables['prebuilts'] = relativize(gradle['dependent_prebuilt_jars'])
  deps = [_ProjectEntry.FromBuildConfigPath(p)
          for p in gradle['dependent_android_projects']]

  variables['android_project_deps'] = [d.ProjectName() for d in deps]
  deps = [_ProjectEntry.FromBuildConfigPath(p)
          for p in gradle['dependent_java_projects']]
  variables['java_project_deps'] = [d.ProjectName() for d in deps]

  processor = jinja_template.JinjaProcessor(host_paths.DIR_SOURCE_ROOT)
  return processor.Render(_JINJA_TEMPLATE_PATH, variables)


def _GenerateRootGradle():
  """Returns the data for the root project's build.gradle."""
  variables = {'template_type': 'root'}
  processor = jinja_template.JinjaProcessor(host_paths.DIR_SOURCE_ROOT)
  return processor.Render(_JINJA_TEMPLATE_PATH, variables)


def _GenerateSettingsGradle(project_entries):
  """Returns the data for settings.gradle."""
  project_name = os.path.basename(os.path.dirname(host_paths.DIR_SOURCE_ROOT))
  lines = []
  lines.append('// Generated by //build/android/gradle/generate_gradle.py')
  lines.append('rootProject.name = "%s"' % project_name)
  lines.append('rootProject.projectDir = settingsDir')
  lines.append('')

  for entry in project_entries:
    # Example target: android_webview:android_webview_java__build_config
    lines.append('include ":%s"' % entry.ProjectName())
    lines.append('project(":%s").projectDir = new File(settingsDir, "%s")' %
                 (entry.ProjectName(), entry.GradleSubdir()))
  return '\n'.join(lines)


def _ExtractSrcjars(entry_output_dir, srcjar_tuples):
  """Extracts all srcjars to the directory given by the tuples."""
  extracted_paths = set(s[1] for s in srcjar_tuples)
  for extracted_path in extracted_paths:
    assert _IsSubpathOf(extracted_path, entry_output_dir)
    if os.path.exists(extracted_path):
      shutil.rmtree(extracted_path)

  for srcjar_path, extracted_path in srcjar_tuples:
    logging.info('Extracting %s to %s', srcjar_path, extracted_path)
    with zipfile.ZipFile(srcjar_path) as z:
      z.extractall(extracted_path)


def _FindAllProjectEntries(main_entry):
  """Returns the list of all _ProjectEntry instances given the root project."""
  found = set()
  to_scan = [main_entry]
  while to_scan:
    cur_entry = to_scan.pop()
    if cur_entry in found:
      continue
    found.add(cur_entry)
    build_config = cur_entry.BuildConfig()
    sub_config_paths = build_config['deps_info']['deps_configs']
    to_scan.extend(
        _ProjectEntry.FromBuildConfigPath(p) for p in sub_config_paths)
  return list(found)


def main():
  parser = argparse.ArgumentParser()
  parser.add_argument('--output-directory',
                      help='Path to the root build directory.')
  parser.add_argument('-v',
                      '--verbose',
                      dest='verbose_count',
                      default=0,
                      action='count',
                      help='Verbose level')
  parser.add_argument('--target',
                      help='GN target to generate project for.',
                      default='//chrome/android:chrome_public_apk')
  parser.add_argument('--project-dir',
                      help='Root of the output project.',
                      default=os.path.join('$CHROMIUM_OUTPUT_DIR', 'gradle'))
  parser.add_argument('--use-gradle-process-resources',
                      action='store_true',
                      help='Have gradle generate R.java rather than ninja')
  args = parser.parse_args()
  if args.output_directory:
    constants.SetOutputDirectory(args.output_directory)
  constants.CheckOutputDirectory()
  output_dir = constants.GetOutDirectory()
  devil_chromium.Initialize(output_directory=output_dir)
  run_tests_helper.SetLogLevel(args.verbose_count)

  gradle_output_dir = os.path.abspath(
      args.project_dir.replace('$CHROMIUM_OUTPUT_DIR', output_dir))
  logging.warning('Creating project at: %s', gradle_output_dir)

  main_entry = _ProjectEntry(args.target)
  logging.warning('Building .build_config files...')
  _RunNinja(output_dir, [main_entry.NinjaBuildConfigTarget()])

  all_entries = _FindAllProjectEntries(main_entry)
  logging.info('Found %d dependent build_config targets.', len(all_entries))

  config_json = build_utils.ReadJson(
      os.path.join(output_dir, 'gradle', 'config.json'))
  project_entries = []
  srcjar_tuples = []
  for entry in all_entries:
    build_config = entry.BuildConfig()
    if build_config['deps_info']['type'] not in ('android_apk', 'java_library'):
      continue

    entry_output_dir = os.path.join(gradle_output_dir, entry.GradleSubdir())
    relativize = lambda x, d=entry_output_dir: _RebasePath(x, d)

    srcjars = _RebasePath(build_config['gradle'].get('bundled_srcjars', []))
    if not args.use_gradle_process_resources:
      srcjars += _RebasePath(build_config['javac']['srcjars'])

    java_sources_file = build_config['gradle'].get('java_sources_file')
    if java_sources_file:
      java_sources_file = _RebasePath(java_sources_file)

    java_dirs = _CreateJavaSourceDir(entry_output_dir, java_sources_file)
    if srcjars:
      java_dirs.append(os.path.join(entry_output_dir, _SRCJARS_SUBDIR))

    data = _GenerateGradleFile(build_config, config_json, java_dirs, relativize,
                               args.use_gradle_process_resources)
    if data:
      project_entries.append(entry)
      srcjar_tuples.extend(
          (s, os.path.join(entry_output_dir, _SRCJARS_SUBDIR)) for s in srcjars)
      _WriteFile(os.path.join(entry_output_dir, 'build.gradle'), data)

  _WriteFile(os.path.join(gradle_output_dir, 'build.gradle'),
             _GenerateRootGradle())

  _WriteFile(os.path.join(gradle_output_dir, 'settings.gradle'),
             _GenerateSettingsGradle(project_entries))

  sdk_path = _RebasePath(config_json['android_sdk_root'])
  _WriteFile(os.path.join(gradle_output_dir, 'local.properties'),
             _GenerateLocalProperties(sdk_path))

  if srcjar_tuples:
    logging.warning('Building all .srcjar files...')
    targets = _RebasePath([s[0] for s in srcjar_tuples], output_dir)
    _RunNinja(output_dir, targets)
    _ExtractSrcjars(gradle_output_dir, srcjar_tuples)
  logging.warning('Project created successfully!')


if __name__ == '__main__':
  main()