scripts/slave/recipe_modules/gatekeeper/api.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 base64

from recipe_engine import recipe_api


class Gatekeeper(recipe_api.RecipeApi):
  """Module for Gatekeeper NG."""
  def __call__(self, gatekeeper_default_json, gatekeeper_trees_json):
    config = self.m.json.read(
      'reading %s' % self.m.path.basename(gatekeeper_trees_json),
      gatekeeper_trees_json,
    ).json.output

    if not self.m.properties['buildername'].startswith(
        'Chromium Gatekeeper'):
      # TODO(machenbach): Fallback for internal gatekeepers using annotated run.
      # Please remove this when those switched to remote_run.
      build_db_path = self.m.path['cache'].join('builder')
    else:
      build_db_path = self.m.path['builder_cache']
      if not self.m.runtime.is_luci:
        # TODO(machenbach): Deprecate after moving to LUCI.
        build_db_path = build_db_path.join('gate_keeper')

    self.m.file.ensure_directory('ensure cache', build_db_path)

    for tree_name, tree_args in config.iteritems():
      # Use tree-specific config if specified, otherwise use default.
      # Tree-specific configs must be relative to the trees file.
      gatekeeper_json = gatekeeper_default_json
      if tree_args.get('config'):
        assert '..' not in tree_args['config'].split('/')
        gatekeeper_json = self.m.path.join(
            self.m.path.dirname(gatekeeper_trees_json),
            *tree_args['config'].split('/'))
      elif tree_args.get('gitiles-config'):
        # Get config file by url.
        gatekeeper_json = self.m.raw_io.input(self.m.gitiles.download_file(
            tree_args['gitiles-config']['repo_url'],
            tree_args['gitiles-config']['path'],
            branch=tree_args['gitiles-config']['ref'],
            step_test_data= lambda: self.m.json.test_api.output({
              'value': base64.b64encode('{}'),
            }),
        ))

      args = [
          '--json', gatekeeper_json,
          '--service-account-path',
          self.m.puppet_service_account.get_key_path('gatekeeper'),
      ]

      if tree_args.get('status-url'):
        args.extend(['--status-url', tree_args['status-url']])
      if tree_args.get('sheriff-url'):
        args.extend(['--sheriff-url', tree_args['sheriff-url']])
      if tree_args.get('set-status'):
        args.append('--set-status')
      if tree_args.get('open-tree'):
        args.append('--open-tree')
      if tree_args.get('track-revisions'):
        args.append('--track-revisions')
      if tree_args.get('revision-properties'):
        args.extend(['--revision-properties', tree_args['revision-properties']])
      if tree_args.get('build-db'):
        args.extend(['--build-db', build_db_path.join(tree_args['build-db'])])
      if tree_args.get('password-file'):
        args.extend(['--password-file', tree_args['password-file']])
      if tree_args.get('use-project-email-address'):
        args.extend(['--default-from-email',
                     '%s-buildbot@chromium-build.appspotmail.com' % tree_name])
      elif tree_args.get('default-from-email'): # pragma: nocover
        args.extend(['--default-from-email', tree_args['default-from-email']])
      if tree_args.get('filter-domain'):
        args.extend(['--filter-domain', tree_args['filter-domain']])
      if tree_args.get('status-user'):
        args.extend(['--status-user', tree_args['status-user']])

      if tree_args.get('masters'):
        if self.c and self.c.use_new_logic:
          valid_masters = []

          for master, allowed in tree_args['masters'].items():
            if '*' in allowed:
              valid_masters.append(master)
            elif allowed:
              valid_masters.append(master + ':' + ','.join(allowed))
          args.extend(valid_masters)
        else: #pragma: no cover
          args.extend(tree_args['masters'])

      # TODO(machenbach): Remove printing of build-db after all gatekeeper
      # instances have migrated to LUCI. The extra printing helps to quickly
      # check if the build DB gets properly cached between runs.
      if tree_args.get('build-db'):
        self._print_build_db(
            'db before: %s' % tree_name,
            build_db_path.join(tree_args['build-db']),
        )

      try:
        self.m.build.python(
          'gatekeeper: %s' % str(tree_name),
          self.package_repo_resource('scripts', 'slave', 'gatekeeper_ng.py'),
          args,
        )
      except self.m.step.StepFailure:
        pass

      if tree_args.get('build-db'):
        self._print_build_db(
            'db after: %s' % tree_name,
            build_db_path.join(tree_args['build-db']),
        )

  def _print_build_db(self, name, build_db_path):  # pragma: no cover
    try:
      if self.m.path.exists(build_db_path):
        self.m.json.read(
            name, build_db_path,
            step_test_data=lambda: self.m.json.test_api.output({}),
        )
    except self.m.step.StepFailure:
      pass