scripts/slave/recipe_modules/codesearch/config.py

# Copyright 2017 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 types

from recipe_engine.config import config_item_context, ConfigGroup
from recipe_engine.config import Single, Static, Dict, List
from recipe_engine.config_types import Path

def BaseConfig(CHECKOUT_PATH, COMPILE_TARGETS=None, PLATFORM=None,
               EXPERIMENTAL=False, SYNC_GENERATED_FILES=False,
               GEN_REPO_BRANCH='master', GEN_REPO_OUT_DIR='', CORPUS=None,
               ROOT=None, **_kwargs):
  """Filter out duplicate compilation units.

  Args:
    CHECKOUT_PATH: the source checkout path.
    COMPILE_TARGETS: the compile targets.
    PLATFORM: The platform for which the code is compiled.
    EXPERIMENTAL: If True, appends '_experimental' to the generated kzip file.
      Used to mark kzips that aren't ready for ingestion by Kythe.
    SYNC_GENERATED_FILES: Whether to sync generated files into a git repo.
    GEN_REPO_BRANCH: Which branch in the generated files repo to sync to.
    GEN_REPO_OUT_DIR: Which output dir in the generated files repo to sync to.
    CORPUS: Kythe corpus to generate index packs under.
    ROOT: Kythe root to generate index packs under.
  """
  if not COMPILE_TARGETS:
    COMPILE_TARGETS = []
  return ConfigGroup(
    CHECKOUT_PATH = Static(CHECKOUT_PATH),
    COMPILE_TARGETS = List(COMPILE_TARGETS),
    PLATFORM = Static(PLATFORM),
    EXPERIMENTAL = Static(EXPERIMENTAL),
    SYNC_GENERATED_FILES = Static(SYNC_GENERATED_FILES),
    GEN_REPO_BRANCH = Static(GEN_REPO_BRANCH),
    GEN_REPO_OUT_DIR = Static(GEN_REPO_OUT_DIR),
    CORPUS = Static(CORPUS),
    ROOT = Static(ROOT),
    debug_path = Single(Path),
    compile_commands_json_file = Single(Path),
    gn_targets_json_file = Single(Path),
    bucket_name = Single(basestring, required=False),
    chromium_git_url = Single(basestring, required=False,
                              empty_val='https://chromium.googlesource.com'),
    generated_repo = Single(basestring, required=False),
    generated_author_email = Single(
        basestring, required=False,
        empty_val='git-generated-files-sync@chromium.org'),
    generated_author_name = Single(basestring, required=False,
                                   empty_val='Automatic Generated Files Sync'),
  )

config_ctx = config_item_context(BaseConfig)

@config_ctx(is_root=True)
def base(c):
  c.debug_path = c.CHECKOUT_PATH.join('out', c.GEN_REPO_OUT_DIR or 'Debug')
  c.compile_commands_json_file = c.debug_path.join('compile_commands.json')
  c.gn_targets_json_file = c.debug_path.join('gn_targets.json')

@config_ctx(includes=['generate_file', 'chromium_gs'])
def chromium(_):
  pass

@config_ctx()
def chromium_gs(c):
  c.bucket_name = 'chrome-codesearch'

@config_ctx()
def generate_file(c):
  c.generated_repo = '%s/chromium/src/out' % c.chromium_git_url