contrib/portage_explorer/get_boards_spider.py

# Copyright 2022 The ChromiumOS Authors
# Use of this source code is governed by a BSD-style license that can be
# found in the LICENSE file.

"""Spider to find all board names."""

import re

from chromite.contrib.portage_explorer import spiderlib
from chromite.lib import portage_util


BOARD_NAME_RE = re.compile(
    r"(?<!-)(?=overlay-.*-private)overlay-"
    r"(?P<board_from_private>.*)-private|(?<!-)overlay-"
    r"(?P<board_from_public>.*)"
)


def get_board_name(overlay_path: str) -> str:
    """Parse overlay path with regex to find board name.

    Args:
        regex: Regex to match the board name from the path.
        overlay_path: Path to the overlay.

    Returns:
        The board name as a string.
    """
    board = BOARD_NAME_RE.search(overlay_path)
    if board:
        if board.group("board_from_private"):
            return board.group("board_from_private")
        return board.group("board_from_public")
    return ""


def execute(output: spiderlib.SpiderOutput) -> None:
    """Get the board names from all the overlay paths and add to the output.

    Args:
        output: SpiderOutput representing the final output from all the spiders.
    """
    overlays = portage_util.FindOverlays("both")
    boards = set()
    for overlay_path in overlays:
        board_name = get_board_name(overlay_path)
        if board_name:
            boards.add(board_name)
    for board in sorted(boards):
        output.build_targets.append(spiderlib.BuildTarget(board))