Meta: Add Flatpak linting for vcpkg equality

The Flatpak manifest linter matches dependencies against vcpkg.json
and if there is a match checks if versions are equal.
If there is no match it checks if there is a listed exclusion.
If there is no version match or no listed exclusion then linting fails.

Author: JanKoudijs

Meta/check-flatpak.py

@@ -0,0 +1,183 @@
+#!/usr/bin/env python3
+
+# Copyright (c) 2025, The Ladybird contributors
+#
+# SPDX-License-Identifier: BSD-2-Clause
+
+import glob
+import json
+import sys
+
+from enum import Enum
+
+VCPKG = "vcpkg.json"
+VCPKG_OVERLAYS_PORTS = "Meta/CMake/vcpkg/overlay-ports/*"
+FLATPAK_MANIFEST = "Meta/CMake/flatpak/org.ladybird.Ladybird.json"
+SELF = "Ladybird"
+
+# List of build tools that are not provided by the Flatpak SDK and therefor in the manifest
+# For a vcpkg build these are installed on the host system
+flatpak_build_tools = [
+    "gn",
+]
+
+# List of libraries that are dependencies of dependencies
+# These are in the manifest to fetch before the build but not explicitely versioned in vcpkg
+flatpak_deps_of_deps = [
+    "brotli",
+    "dav1d",
+    "highway",
+    "libdwarf",
+    "libxml2",
+    "libyuv",
+    "vulkan-memory-allocator",
+    "zstd",
+]
+
+# List of libraries that are in the Flatpak runtime and therefor not in the manifest
+# See: https://docs.flatpak.org/en/latest/available-runtimes.html#check-software-available-in-runtimes
+flatpak_runtime_libs = [
+    "curl",
+    "dbus",
+    "ffmpeg",
+    "fontconfig",
+    "harfbuzz",
+    "libjpeg-turbo",
+    "libproxy",
+    "openssl",
+    "qtbase",
+    "qtmultimedia",
+    "sqlite3",
+    "zlib",
+]
+
+# List of libraries that are in vcpkg but not needed for the Linux platform
+vcpkg_not_linux = [
+    "dirent",
+    "mman",
+]
+
+
+class DepMatch(Enum):
+    Match = (0,)
+    NoMatch = (1,)
+    VersionMismatch = (2,)
+    Excluded = (3,)
+
+
+def check_for_match(vcpkg: dict, name: str, identifier: str) -> DepMatch:
+    if name in vcpkg:
+        if vcpkg[name] not in identifier:
+            return DepMatch.VersionMismatch
+        else:
+            return DepMatch.Match
+    elif name == SELF or name in flatpak_build_tools or name in flatpak_deps_of_deps:
+        return DepMatch.Excluded
+    else:
+        return DepMatch.NoMatch
+
+
+def check_vcpkg_vs_flatpak_versioning():
+    vcpkg = {}
+    flatpak = []
+    mismatch_found = False
+
+    with open(VCPKG) as input:
+        for package in json.load(input)["overrides"]:
+            # Add name/version pair, strip any '#' postfix from the version
+            vcpkg[package["name"]] = str(package["version"]).split("#")[0]
+
+    # Check the vcpkg overlay ports for packages not listed in overrides
+    for path in glob.glob(VCPKG_OVERLAYS_PORTS):
+        with open(f"{path}/vcpkg.json") as input:
+            overlay = json.load(input)
+
+            if "name" in overlay and overlay["name"] not in vcpkg and "version" in overlay:
+                vcpkg[overlay["name"]] = overlay["version"]
+
+    with open(FLATPAK_MANIFEST) as input:
+        for module in json.load(input)["modules"]:
+            name = module["name"]
+
+            for source in module["sources"]:
+                if "type" in source and source["type"] == "git":
+                    if "tag" in source:
+                        # Get the tag
+                        # Replace '-' with '.': 76-1 vs 76.1
+                        tag = str(source["tag"]).replace("-", ".")
+                        dep_match = check_for_match(vcpkg, name, tag)
+
+                        if dep_match == DepMatch.Match or dep_match == DepMatch.Excluded:
+                            if name in vcpkg:
+                                del vcpkg[name]
+                        else:
+                            mismatch_found = True
+
+                            if dep_match == DepMatch.VersionMismatch:
+                                print(f"{name} version mismatch. vcpkg: {vcpkg[name]}, Flatpak: {source['tag']}")
+                                del vcpkg[name]
+                            elif dep_match == DepMatch.NoMatch:
+                                flatpak.append(name)
+
+                        break
+                    elif "branch" in source:
+                        # Get the branch
+                        # Strip '_' postfix, replace '/' with '_': chromium/7258_13 vs chromium_7258
+                        branch = str(source["branch"]).split("_")[0].replace("/", "_")
+                        dep_match = check_for_match(vcpkg, name, branch)
+
+                        if dep_match == DepMatch.Match or dep_match == DepMatch.Excluded:
+                            if name in vcpkg:
+                                del vcpkg[name]
+                        else:
+                            mismatch_found = True
+
+                            if dep_match == DepMatch.VersionMismatch:
+                                print(f"{name} version mismatch. vcpkg: {vcpkg[name]}, Flatpak: {source['branch']}")
+                                del vcpkg[name]
+                            elif DepMatch == DepMatch.NoMatch:
+                                flatpak.append(name)
+
+                        break
+            else:
+                if not (name == SELF or name in flatpak_build_tools or name in flatpak_deps_of_deps):
+                    flatpak.append(name)
+
+        # Remove excluded dependencies from the vcpkg list
+        for name in flatpak_runtime_libs + vcpkg_not_linux:
+            if name in vcpkg:
+                del vcpkg[name]
+
+        if len(vcpkg):
+            mismatch_found = True
+            print(f"There are {len(vcpkg)} vcpkg dependencies that have no match in flatpak")
+
+            for name in vcpkg.keys():
+                print(f"- {name}")
+
+        if len(flatpak):
+            mismatch_found = True
+            print(f"There are {len(flatpak)} flatpak dependencies that have no match in vcpkg")
+
+            for name in flatpak:
+                print(f"- {name}")
+
+    return mismatch_found
+
+
+def main():
+    file_list = sys.argv[1:] if len(sys.argv) > 1 else [VCPKG]
+    did_fail = False
+
+    if VCPKG in file_list or FLATPAK_MANIFEST in file_list:
+        did_fail = check_vcpkg_vs_flatpak_versioning()
+
+    # TODO: Add linting of Flatpak and AppStream manifest
+    # See #5594, bullet point "Missing lint job in CI to ensure Flatpak and AppStream manifests are up to snuff"
+
+    if did_fail:
+        sys.exit(1)
+
+
+if __name__ == "__main__":
+    main()

Meta/lint-ci.sh

@@ -15,6 +15,7 @@ set +e
 
 for cmd in \
         Meta/check-debug-flags.sh \
+        Meta/check-flatpak.py \
         Meta/check-html-doctype.py \
         Meta/check-idl-files.py \
         Meta/check-newlines-at-eof.py \