pmaports/.ci/testcases/test_device.py

#!/usr/bin/env python3
# Copyright 2024 Oliver Smith
# SPDX-License-Identifier: GPL-3.0-or-later

import fnmatch
import glob
import os
import pytest
import sys

import add_pmbootstrap_to_import_path
import pmb.parse
import pmb.parse._apkbuild

# Cache for codeowners_parse
codeowners_parsed = {}

# Don't complain if these nicknames are the only maintainers of an APKBUILD,
# because they are actually a group of people
gitlab_groups = [
    "@sdm845-mainline",
]


def device_dependency_check(apkbuild, path):
    """ Raise an error if a device package has a dependency that is not allowed
        (e.g. because it should be in a subpackage instead). """

    for depend in apkbuild["depends"]:
        if depend == "mesa-dri-gallium":
            raise RuntimeError(f"{path}: mesa-dri-gallium shouldn't be in"
                               " depends anymore (see pmaports!3478)")


def test_aports_device(args):
    """
    Various tests performed on the /device/*/device-* aports.
    """
    for path in glob.iglob(args.aports + "/device/*/device-*/APKBUILD"):
        apkbuild = pmb.parse.apkbuild(path)

        # Depends: Require "postmarketos-base"
        depend_flag = False
        for dependency in apkbuild["depends"]:
            if "postmarketos-base" == dependency or "postmarketos-base>" in dependency:
                depend_flag = True
        if not depend_flag:
            raise RuntimeError("Missing 'postmarketos-base' in depends of " +
                               path)

        # Depends: Must not have specific packages
        for depend in apkbuild["depends"]:
            device_dependency_check(apkbuild, path)

        # Architecture
        device = apkbuild["pkgname"][len("device-"):]
        deviceinfo = pmb.parse.deviceinfo(args, device)
        if "".join(apkbuild["arch"]) != deviceinfo["arch"]:
            raise RuntimeError("wrong architecture, please change to arch=\"" +
                               deviceinfo["arch"] + "\": " + path)
        if "!archcheck" not in apkbuild["options"]:
            raise RuntimeError("!archcheck missing in options= line: " + path)

        if deviceinfo["flash_kernel_on_update"] == "true" \
                and "postmarketos-update-kernel" not in apkbuild["depends"]:
            raise RuntimeError(
                "Deviceinfo indicates this device supports automatic kernel"
                " flashing on update, but doesn't depend on"
                " 'postmarketos-update-kernel'. Please add the missing"
                " dependency.")


def test_aports_device_kernel(args):
    """
    Verify the kernels specified in the device packages:
    * Kernel must not be in depends when kernels are in subpackages
    * Check if only one kernel is defined in depends
    """

    # Iterate over device aports
    for path in glob.glob(args.aports + "/device/*/device-*/APKBUILD"):
        # Parse apkbuild and kernels from subpackages
        apkbuild = pmb.parse.apkbuild(path)
        device = apkbuild["pkgname"][len("device-"):]
        kernels_subpackages = pmb.parse._apkbuild.kernels(args, device)

        # Parse kernels from depends
        kernels_depends = []
        for depend in apkbuild["depends"]:
            if not depend.startswith("linux-") or depend.startswith("linux-firmware-"):
                continue
            kernels_depends.append(depend)

            # Kernel in subpackages *and* depends
            if kernels_subpackages:
                raise RuntimeError("Kernel package '" + depend + "' needs to"
                                   " be removed when using kernel" +
                                   " subpackages: " + path)

        # No kernel
        if not kernels_depends and not kernels_subpackages:
            raise RuntimeError("Device doesn't have a kernel in depends or"
                               " subpackages: " + path)

        # Multiple kernels in depends
        if len(kernels_depends) > 1:
            raise RuntimeError("Please use kernel subpackages instead of"
                               " multiple kernels in depends (see"
                               " <https://postmarketos.org/devicepkg>): " +
                               path)


def codeowners_parse(args):
    global codeowners_parsed

    pattern_prev = None

    with open(f"{args.aports}/CODEOWNERS") as h:
        for line in h:
            line = line.rstrip()
            if not line or line.startswith("#"):
                continue

            pattern_nicks = line.split()
            assert len(pattern_nicks) > 1, f"CODEOWNERS line without nicks: {line}"

            pattern = pattern_nicks[0]
            if pattern.endswith("/"):
                pattern += "*"

            nicks = []
            for word in pattern_nicks[1:]:
                if word.startswith("@"):
                    nicks += [word]
            codeowners_parsed[pattern] = nicks

            if pattern_prev:
                assert pattern_prev <= pattern, "CODEOWNERS: please order entries alphabetically"
            pattern_prev = pattern


def require_enough_codeowners_entries(args, path, maintainers):
    """
    :param path: full path to an APKBUILD (e.g. /home/user/…/APKBUILD)
    :param maintainers: list of one or more maintainers
    """
    path = os.path.relpath(path, args.aports)

    nicks = set()
    for pattern, pattern_nicks in codeowners_parsed.items():
        if fnmatch.fnmatch(path, pattern):
            for nick in pattern_nicks:
                nicks.add(nick)

    print(f"{path}:")
    print(f"  APKBUILD: {maintainers}")
    print(f"  CODEOWNERS: {nicks}")

    if len(nicks) < len(maintainers):
        for nick in nicks:
            if nick in gitlab_groups:
                print(f"  -> {nick} is a group")
                return

    assert len(nicks) >= len(maintainers), \
        f"{path}: make sure that each maintainer is listed in CODEOWNERS!"


def test_aports_maintained(args):
    """
    Ensure that aports in /device/{main,community} have "Maintainer:" and
    "Co-Maintainer:" (only required for main) listed in their APKBUILDs. Also
    check that at least as many are listed in CODEOWNERS.
    """
    codeowners_parse(args)

    for path in glob.iglob(f"{args.aports}/device/main/*/APKBUILD"):
        if '/firmware-' in path:
            continue
        maintainers = pmb.parse._apkbuild.maintainers(path)
        assert maintainers and len(maintainers) >= 2, \
            f"{path} in main needs at least 1 Maintainer and 1 Co-Maintainer"
        require_enough_codeowners_entries(args, path, maintainers)

    for path in glob.iglob(f"{args.aports}/device/community/*/APKBUILD"):
        if '/firmware-' in path:
            continue
        maintainers = pmb.parse._apkbuild.maintainers(path)
        assert maintainers, f"{path} in community needs at least 1 Maintainer"
        require_enough_codeowners_entries(args, path, maintainers)


def test_aports_unmaintained(args):
    """
    Ensure that aports in /device/unmaintained have an "Unmaintained:" comment
    that describes why the aport is unmaintained.
    """
    for path in glob.iglob(f"{args.aports}/device/unmaintained/*/APKBUILD"):
        unmaintained = pmb.parse._apkbuild.unmaintained(path)
        assert unmaintained, f"{path} should have an Unmaintained: " +\
            "comment that describes why the package is unmaintained"