lib/project_sdk.py

# Copyright 2015 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.

"""Common utilities for working with Project SDK."""

from __future__ import print_function

import os
import re

from chromite.cbuildbot import constants
from chromite.lib import cros_build_lib
from chromite.lib import cros_logging as logging
from chromite.lib import osutils


def FindRepoRoot(sdk_dir=None):
  """Locate the SDK root directly by looking for .repo dir.

  This is very similar to constants.SOURCE_ROOT, except that it can operate
  against repo checkouts outside our current code base.

  CAUTION! Using SDKs from directories other than the default is likely to
  break assumptions that our tools are built upon.  As a rule of thumb, do not
  expose this argument externally unless you know what you're doing.

  Args:
    sdk_dir: Path of the SDK, or any dir inside it. None defaults to
      constants.SOURCE_ROOT.

  Returns:
    Root dir of SDK, or None.
  """
  if sdk_dir is None:
    return constants.SOURCE_ROOT

  # Make sure we're looking at an actual directory.
  if not os.path.isdir(sdk_dir):
    return None

  # Find the .repo directory and return the path leading up to it, if found.
  repo_dir = osutils.FindInPathParents('.repo', os.path.abspath(sdk_dir),
                                       test_func=os.path.isdir)
  return os.path.dirname(repo_dir) if repo_dir else None


def VersionFile(sdk_dir):
  return os.path.join(sdk_dir, 'SDK_VERSION')


def FindVersion(sdk_dir=None):
  """Find the version of a given SDK.

  If the SDK was fetched by any means other than "brillo sdk" then it will
  always appear to be 'non-official', even if an official manifest was used.

  Args:
    sdk_dir: path to the SDK, or any of its sub directories.

  Returns:
    The version of your SDK as a string. '6500.0.0'
    None if the directory doesn't appear to be an SDK.
  """
  sdk_root = FindRepoRoot(sdk_dir)
  if sdk_root is None:
    return None

  v_file = VersionFile(sdk_root)
  return osutils.ReadFile(v_file) if os.path.exists(v_file) else None


def VerifyEnvironment():
  """Verify the environment we are installed to.

  Returns:
    boolean: True if the environment looks friendly.
  """
  result = True

  # Verify Python:
  #   We assume the python environment is acceptable, because we got here.
  #   However, we can add imports here to check for any required external
  #   packages.

  # Verify that bash is available in the expected place.
  test = cros_build_lib.RunCommand(
      ['/bin/bash', '--version'],
      error_code_ok=True, print_cmd=False, capture_output=True)

  if test.returncode:
    logging.warn('/bin/bash is required to use the SDK.')
    result = False

  # Verify Git.
  test = cros_build_lib.RunCommand(
      ['git', '--version'],
      error_code_ok=True, print_cmd=False, capture_output=True)

  if test.returncode:
    logging.warn('Git is required to use the SDK.')
    result = False
  else:
    # Eg: 'git version 2.2.0.rc0.207.ga3a616c'.
    git_version = test.output

    m = re.match(r'git version (\d+)\.(\d+)', git_version)
    if not m:
      logging.warn("Git version not recognized from: '%s'", git_version)
      result = False
    else:
      gv_int_list = [int(d) for d in m.groups()] # Something like [2, 3]
      if gv_int_list < [1, 8]:
        logging.warn("Git 1.8 or greater required. Not supported: %s",
                     git_version)
        result = False

  # Verify curl.
  test = cros_build_lib.RunCommand(
      ['curl', '--version'],
      error_code_ok=True, print_cmd=False, capture_output=True)

  if test.returncode:
    logging.warn('Curl is required to use the SDK.')
    result = False

  return result