blob: 828e3bdcdfad8264e72806985414467bfbbe1978 [file] [log] [blame]
# -*- coding: utf-8 -*-
# Copyright 2019 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.
"""Build target class and related functionality."""
from __future__ import print_function
import os
import re
from chromite.api.gen.chromiumos import common_pb2
class Error(Exception):
"""Base module error class."""
class InvalidNameError(Error):
"""Error for invalid target name argument."""
class BuildTarget(object):
"""Class to handle the build target information."""
def __init__(self, name, profile=None, build_root=None):
"""Build Target init.
name (str): The full name of the target.
profile (str): The profile name.
build_root (str): The path to the buildroot.
if not name:
raise InvalidNameError('Name is required.')
self._name = name
self.board, _, self.variant = name.partition('_')
self.profile = profile
if build_root:
self.root = os.path.normpath(build_root)
self.root = get_default_sysroot_path(
def __eq__(self, other):
if self.__class__ is other.__class__:
return ( == and self.profile == other.profile and
self.root == other.root)
return NotImplemented
def __hash__(self):
return hash(
def __str__(self):
def name(self):
return self._name
def as_protobuf(self):
return common_pb2.BuildTarget(
def from_protobuf(cls, message):
return cls(
def profile_protobuf(self):
return common_pb2.Profile(name=self.profile)
def full_path(self, *args):
"""Turn a sysroot-relative path into an absolute path."""
return os.path.join(self.root, *[part.lstrip(os.sep) for part in args])
def get_command(self, base_command):
"""Get the build target's variant of the given base command.
We create wrappers for many scripts that handle the build target's
arguments. Build the target-specific variant for such a command.
e.g. emerge -> emerge-eve.
TODO: Add optional validation the command exists.
base_command (str): The wrapped command.
str: The build target's command wrapper.
return '%s-%s' % (base_command,
def get_default_sysroot_path(build_target_name=None):
"""Get the default sysroot location or '/' if |build_target_name| is None."""
if build_target_name is None:
return '/'
return os.path.join('/build', build_target_name)
def is_valid_name(build_target_name):
"""Validate |build_target_name| is a valid name."""
return bool(re.match(r'^[a-zA-Z0-9-_]+$', build_target_name))