scripts/build/parse_board_metadata.py

# Copyright 2026 The Pigweed Authors
#
# Licensed under the Apache License, Version 2.0 (the "License"); you may not
# use this file except in compliance with the License. You may obtain a copy of
# the License at
#
#     https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
# License for the specific language governing permissions and limitations under
# the License.

#!/usr/bin/env python3
import argparse
import json
import os
import sys

try:
    import yaml
except ImportError:
    yaml = None

# Allow importing from scripts/build
sys.path.insert(0, os.path.dirname(os.path.abspath(__file__)))
from discovery_utils import extract_board_revisions


def parse_args(argv=None):
    parser = argparse.ArgumentParser()
    parser.add_argument(
        "--boards-json",
        required=True,
        help="Path to input JSON mapping board directory paths to metadata",
    )
    parser.add_argument(
        "--output-json",
        required=True,
        help="Path to write output JSON mapping board directory paths to revision lists",
    )
    return parser.parse_args(argv)

# TODO(tbk): Determine if this can be cleanly merged with discover_board_variants.
def discover_revisions_for_board(board_dir):
    revisions = []

    # 1. Parse board.yml / board.yaml
    if yaml is not None:
        for yml_name in ["board.yml", "board.yaml"]:
            yml_path = os.path.join(board_dir, yml_name)
            if os.path.exists(yml_path):
                try:
                    with open(yml_path, "r", encoding="utf-8") as f:
                        data = yaml.safe_load(f)
                    if isinstance(data, dict):
                        board_obj = data.get("board", data)
                        rev_list = extract_board_revisions(data)
                        if not rev_list and isinstance(board_obj, dict):
                            rev_list = extract_board_revisions(board_obj)
                        for r in rev_list:
                            if r and r not in revisions:
                                revisions.append(r)
                except Exception as e:
                    sys.stderr.write(f"Warning: Failed to parse {yml_path}: {e}\n")
                break

    # 2. Check revisions/ directory
    rev_dir = os.path.join(board_dir, "revisions")
    if os.path.isdir(rev_dir):
        try:
            for fname in os.listdir(rev_dir):
                for suffix in ["_defconfig", ".conf", ".overlay"]:
                    if fname.endswith(suffix):
                        r_name = fname[:-len(suffix)]
                        if r_name and r_name not in revisions:
                            revisions.append(r_name)
        except Exception as e:
            sys.stderr.write(f"Warning: Failed to read {rev_dir}: {e}\n")

    return revisions


def main(argv=None):
    args = parse_args(argv)

    with open(args.boards_json, "r", encoding="utf-8") as f:
        boards_map = json.load(f)

    result = {}
    for board_dir in boards_map.keys():
        result[board_dir] = discover_revisions_for_board(board_dir)

    with open(args.output_json, "w", encoding="utf-8") as f:
        json.dump(result, f, indent=2)


if __name__ == "__main__":
    main()