StableKeywordsCheck: detect packages using stable keywords

src/pkgcheck/checks/stable_keywords.py

@@ -0,0 +1,58 @@
+from collections import defaultdict
+
+from pkgcore.ebuild.misc import sort_keywords
+from pkgcore.restrictions import packages, values
+from snakeoil.strings import pluralism
+
+from .. import addons, results, sources
+from . import OptionalCheck
+
+
+class StableKeywords(results.PackageResult, results.Error):
+    """Package uses stable keywords."""
+
+    def __init__(self, versions, arches, **kwargs):
+        super().__init__(**kwargs)
+        self.versions = tuple(versions)
+        self.arches = tuple(arches)
+
+    @property
+    def desc(self):
+        s = pluralism(self.arches)
+        arches = ", ".join(self.arches)
+        versions = ", ".join(self.versions)
+        return f"stable keyword{s} [ {arches} ] used on version{s}: [ {versions} ]"
+
+
+class StableKeywordsCheck(OptionalCheck):
+    """Scan for packages using stable keywords."""
+
+    _source = sources.PackageRepoSource
+    required_addons = (addons.StableArchesAddon,)
+    known_results = frozenset([StableKeywords])
+
+    def __init__(self, *args, stable_arches_addon=None):
+        super().__init__(*args)
+        self.arches = {x.strip().lstrip("~") for x in self.options.stable_arches}
+
+        self.arch_restricts = {
+            arch: packages.PackageRestriction("keywords", values.ContainmentMatch2((arch,)))
+            for arch in self.arches
+        }
+
+    def feed(self, pkgset):
+        pkgs_arches = defaultdict(set)
+        for arch, r in self.arch_restricts.items():
+            for pkg in pkgset:
+                if r.match(pkg):
+                    pkgs_arches[pkg].add(arch)
+
+        # invert
+        arches_pkgs = defaultdict(list)
+        for pkg, arches in pkgs_arches.items():
+            arches_pkgs[frozenset(arches)].append(pkg)
+
+        # collapse reports by sets of arches
+        for arches, pkgs in arches_pkgs.items():
+            versions = (pkg.fullver for pkg in sorted(pkgs))
+            yield StableKeywords(versions, sort_keywords(arches), pkg=pkgs[0])

testdata/data/repos/stable_keywords/StableKeywordsCheck/StableKeywords/expected.json

@@ -0,0 +1,2 @@
+{"__class__": "StableKeywords", "category": "StableKeywordsCheck", "package": "StableKeywords", "versions": ["0"], "arches": ["amd64"]}
+{"__class__": "StableKeywords", "category": "StableKeywordsCheck", "package": "StableKeywords", "versions": ["1"], "arches": ["x86"]}

testdata/data/repos/stable_keywords/StableKeywordsCheck/StableKeywords/fix.patch

@@ -0,0 +1,20 @@
+diff --git stable_keywords/StableKeywordsCheck/StableKeywords/StableKeywords-0.ebuild fixed/StableKeywordsCheck/StableKeywords/StableKeywords-0.ebuild
+index fc606dee..52f19ba0 100644
+--- stable_keywords/StableKeywordsCheck/StableKeywords/StableKeywords-0.ebuild
++++ fixed/StableKeywordsCheck/StableKeywords/StableKeywords-0.ebuild
+@@ -9,4 +9,4 @@ SRC_URI="https://example.com/"
+
+ LICENSE="MIT"
+ SLOT="0"
+-KEYWORDS="amd64"
++KEYWORDS="~amd64"
+diff --git stable_keywords/StableKeywordsCheck/StableKeywords/StableKeywords-1.ebuild fixed/StableKeywordsCheck/StableKeywords/StableKeywords-1.ebuild
+index e8774608..12e0329a 100644
+--- stable_keywords/StableKeywordsCheck/StableKeywords/StableKeywords-1.ebuild
++++ fixed/StableKeywordsCheck/StableKeywords/StableKeywords-1.ebuild
+@@ -9,4 +9,4 @@ SRC_URI="https://example.com/"
+
+ LICENSE="MIT"
+ SLOT="0"
+-KEYWORDS="~amd64 x86"
++KEYWORDS="~amd64 ~x86"

testdata/repos/stable_keywords/StableKeywordsCheck/StableKeywords/StableKeywords-0.ebuild

@@ -0,0 +1,12 @@
+# Copyright 2026 Gentoo Authors
+# Distributed under the terms of the GNU General Public License v2
+
+EAPI=8
+
+DESCRIPTION="StableKeywords"
+HOMEPAGE="https://example.com/"
+SRC_URI="https://example.com/"
+
+LICENSE="MIT"
+SLOT="0"
+KEYWORDS="amd64"

testdata/repos/stable_keywords/StableKeywordsCheck/StableKeywords/StableKeywords-1.ebuild

@@ -0,0 +1,12 @@
+# Copyright 2026 Gentoo Authors
+# Distributed under the terms of the GNU General Public License v2
+
+EAPI=8
+
+DESCRIPTION="StableKeywords"
+HOMEPAGE="https://example.com/"
+SRC_URI="https://example.com/"
+
+LICENSE="MIT"
+SLOT="0"
+KEYWORDS="~amd64 x86"

testdata/repos/stable_keywords/StableKeywordsCheck/StableKeywords/StableKeywords-2.ebuild

@@ -0,0 +1,12 @@
+# Copyright 2026 Gentoo Authors
+# Distributed under the terms of the GNU General Public License v2
+
+EAPI=8
+
+DESCRIPTION="StableKeywords"
+HOMEPAGE="https://example.com/"
+SRC_URI="https://example.com/"
+
+LICENSE="MIT"
+SLOT="0"
+KEYWORDS="~amd64"

testdata/repos/stable_keywords/StableKeywordsCheck/StableKeywords/StableKeywords-9999.ebuild

@@ -0,0 +1,11 @@
+# Copyright 2026 Gentoo Authors
+# Distributed under the terms of the GNU General Public License v2
+
+EAPI=8
+
+DESCRIPTION="StableKeywords"
+HOMEPAGE="https://example.com/"
+SRC_URI="https://example.com/"
+
+LICENSE="MIT"
+SLOT="0"

testdata/repos/stable_keywords/metadata/layout.conf

@@ -0,0 +1,2 @@
+masters =
+cache-formats =

testdata/repos/stable_keywords/profiles/arch.list

@@ -0,0 +1,2 @@
+amd64
+x86

testdata/repos/stable_keywords/profiles/categories

@@ -0,0 +1 @@
+StableKeywordsCheck

testdata/repos/stable_keywords/profiles/default/amd64/make.defaults

@@ -0,0 +1 @@
+ARCH="amd64"

testdata/repos/stable_keywords/profiles/default/x86/make.defaults

@@ -0,0 +1 @@
+ARCH="x86"

testdata/repos/stable_keywords/profiles/profiles.desc

@@ -0,0 +1,2 @@
+amd64 default/amd64 stable
+x86 default/x86 stable

testdata/repos/stable_keywords/profiles/repo_name

@@ -0,0 +1 @@
+stable_keywords