setup_environment.py

# Copyright 2017 The Chromium OS Authors. All rights reserved.
# Use of this source code is governed by a BSD-style license that can be
# found in the LICENSE file.

"""Module for setup environemtn for local testing & Google App Engine."""


from __future__ import print_function

import argparse
import os
import shutil
import subprocess

import file_getter

import local_import  # pylint: disable=unused-import
try:
  from chromite.lib import gs, git, osutils  # pylint: disable=g-import-not-at-top
except ImportError:
  print('Cannot import chromite')
  gs = None
  git = None
  osutils = None


# The credentials folder for suite-scheduler service.
CREDS_GS_PATH = 'gs://suite-scheduler.google.com.a.appspot.com/credentials/'

# Remote repositories of luci-py and Chromite.
LUCI_REPO = 'https://chromium.googlesource.com/infra/luci/luci-py'
CHROMITE_REPO = 'https://chromium.googlesource.com/chromiumos/chromite'


def _install_third_party_lib(input_args):
  """Install useful third-party lib.

  The libraries are specified in requirement.txt. They're used in both local
  development environment and Google App Engine, which means they will be
  uploaded to GAE.

  Args:
    input_args: the arguments passed in by users.
  """
  third_party_lib_path = file_getter.THIRD_PARTY_LIB_PATH
  if input_args.update_lib and os.path.exists(third_party_lib_path):
    os.rmdir(third_party_lib_path)

  if not os.path.exists(third_party_lib_path):
    print('Creating lib path: %s' % third_party_lib_path)
    os.mkdir(third_party_lib_path)
    print('Installing packages')
    cmd = ['pip', 'install', '-t', 'lib', '-r', 'requirements.txt']
    try:
      subprocess.check_call(cmd)
    except subprocess.CalledProcessError:
      # TODO(crbug.com/792690): this is a workround of fixing installing
      # third-party packages on different versions of Ubuntu/Debian.
      print("Failed to run '%s'; trying a different command." % ' '.join(cmd))
      subprocess.check_call(['pip', 'install', '-t', 'lib', '--system',
                             '-r', 'requirements.txt'])


def _install_infra_libs(skip_install_infra_libs):
  """Install useful libs from Chromium infra and Chromite.

  infra_libs consists of prpc client from luci and necessary proto files from
  Chromite. Suite scheduler relies on those libs to conduct prpc call to
  Buildbucket.

  Args:
    skip_install_infra_libs: A boolean variable to indicate whether to skip
      downloading the infra libs.
  """

  if skip_install_infra_libs:
    return

  print('Recreate infra_libs directory if already exists...')
  if os.path.exists(file_getter.INFRA_LIBS_PATH):
    osutils.RmDir(file_getter.INFRA_LIBS_PATH)
  os.mkdir(file_getter.INFRA_LIBS_PATH)
  os.mkdir(file_getter.LUCI_PATH)
  os.mkdir(file_getter.CHROMITE_PATH)

  print('Fetching prpc client from luci-py lib...')
  luci_checkout = [
      '/appengine/components/components/auth/**/*.py',
      '/appengine/components/components/datastore_utils/**/*.py',
      '/appengine/components/components/prpc/**/*.py',
      '/appengine/components/components/*.py',
      '!*test.py']
  git.ShallowFetch(file_getter.LUCI_PATH, LUCI_REPO,
                   sparse_checkout=luci_checkout)

  print('Fetching proto files from Chromite...')
  chromite_checkout = [
      '/api/gen/**/*.py',
      '/api/__init__.py',
      '/third_party/infra_libs/*',
      '/third_party/google/*',
      '/third_party/__init__.py',
      '/__init__.py',
      '!*test.py']
  git.ShallowFetch(file_getter.CHROMITE_PATH, CHROMITE_REPO,
                   sparse_checkout=chromite_checkout)


def fetch_service_credentials(force_update_cred):
  """Fetch service credentials from GS bucket.

  Args:
    force_update_cred: A boolean variable to indicate whether to force to
      re-download the creds.

  Raises:
    ValueError: if credentials cannot be fetched due to no valid gs package.
  """
  credentials_path = file_getter.CREDENTIALS_PATH
  if force_update_cred and os.path.exists(credentials_path):
    shutil.rmtree(credentials_path)

  if not os.path.exists(credentials_path):
    if gs is None:
      raise ValueError(
          'Chromite cannot be imported.\nPlease download the credentials '
          'manually:\n\tgsutil cp -r %s %s' % (
              CREDS_GS_PATH, os.path.dirname(credentials_path)))

    os.mkdir(credentials_path)
    try:
      ctx = gs.GSContext(init_boto=True)
      ctx.Copy(CREDS_GS_PATH + '*', credentials_path)
    except gs.GSCommandError as e:
      print('The GS credentials is not configured properly. '
            'Please contact ChromeOS Infrastructure'
            'team for more info about it.')
      print('Failed to get suite_scheduler service credentials: %r.'
            'Deleting %s' % (str(e), credentials_path))
      os.rmdir(credentials_path)


def _verify():
  """Verify the credentials & third_party lib work."""
  subprocess.check_call(['python', 'runner.py'])


def _make_parser():
  """Return parser."""
  parser = argparse.ArgumentParser(
      description=__doc__,
      formatter_class=argparse.RawDescriptionHelpFormatter)
  parser.add_argument(
      '--update_lib',
      action='store_true',
      help='Force to reinstall all required third-party libraries.')
  parser.add_argument(
      '--update_cred',
      action='store_true',
      help='Force to re-copy the credentials from Google Storage.')
  parser.add_argument(
      '--skip_infra_libs',
      action='store_true',
      help='Skip to install infra libs.')
  return parser


if __name__ == '__main__':
  setup_parser = _make_parser()
  setup_args = setup_parser.parse_args()
  _install_third_party_lib(setup_args)
  fetch_service_credentials(setup_args.update_cred)
  _install_infra_libs(setup_args.skip_infra_libs)
  _verify()