RepoProfilesCheck: check for banned&deprecated profile EAPIs

Author: mgorny

requirements/install.txt

@@ -4,4 +4,4 @@ lxml
 pathspec
 tree-sitter~=0.19.0
 snakeoil~=0.9.6
-pkgcore~=0.12.2
+pkgcore~=0.12.3

requirements/pyproject.toml

@@ -7,6 +7,6 @@ requires = [
 	"pathspec",
 	"tree-sitter~=0.19.0",
 	"snakeoil~=0.9.6",
-	"pkgcore~=0.12.2",
+	"pkgcore~=0.12.3",
 ]
 build-backend = "setuptools.build_meta"

src/pkgcheck/checks/profiles.py

@@ -302,6 +302,33 @@ def desc(self):
         )
 
 
+class _ProfileEapiResult(results.ProfilesResult):
+    """Generic profile EAPI result."""
+
+    _type = None
+
+    def __init__(self, profile, eapi):
+        super().__init__()
+        self.profile = profile
+        self.eapi = str(eapi)
+
+    @property
+    def desc(self):
+        return f"{self.profile!r} profile is using {self._type} EAPI {self.eapi}"
+
+
+class BannedProfileEapi(_ProfileEapiResult, results.Error):
+    """Profile has an EAPI that is banned in the repository."""
+
+    _type = 'banned'
+
+
+class DeprecatedProfileEapi(_ProfileEapiResult, results.Warning):
+    """Profile has an EAPI that is deprecated in the repository."""
+
+    _type = 'deprecated'
+
+
 class UnknownCategoryDirs(results.ProfilesResult, results.Warning):
     """Category directories that aren't listed in a repo's categories.
 
@@ -359,7 +386,7 @@ class RepoProfilesCheck(RepoCheck):
     known_results = frozenset([
         ArchesWithoutProfiles, UnusedProfileDirs, NonexistentProfilePath,
         UnknownCategoryDirs, NonexistentCategories, LaggingProfileEapi,
-        ProfileError, ProfileWarning,
+        ProfileError, ProfileWarning, BannedProfileEapi, DeprecatedProfileEapi,
     ])
 
     # known profile status types for the gentoo repo
@@ -401,7 +428,12 @@ def finish(self):
                 known_status=known_profile_statuses, known_arch=self.arches)
         yield from log_reports
 
+        banned_eapis = self.repo.config.profile_eapis_banned
+        deprecated_eapis = self.repo.config.profile_eapis_deprecated
+
         seen_profile_dirs = set()
+        banned_profile_eapi = set()
+        deprecated_profile_eapi = set()
         lagging_profile_eapi = defaultdict(list)
         for p in profiles:
             try:
@@ -413,11 +445,19 @@ def finish(self):
                 seen_profile_dirs.update(dir_parents(parent.name))
                 if profile.eapi is not parent.eapi and profile.eapi in parent.eapi.inherits:
                     lagging_profile_eapi[profile].append(parent)
+                if str(parent.eapi) in banned_eapis:
+                    banned_profile_eapi.add(parent)
+                if str(parent.eapi) in deprecated_eapis:
+                    deprecated_profile_eapi.add(parent)
 
         for profile, parents in lagging_profile_eapi.items():
             parent = parents[-1]
             yield LaggingProfileEapi(
                 profile.name, str(profile.eapi), parent.name, str(parent.eapi))
+        for profile in banned_profile_eapi:
+            yield BannedProfileEapi(profile.name, profile.eapi)
+        for profile in deprecated_profile_eapi:
+            yield DeprecatedProfileEapi(profile.name, profile.eapi)
 
         if unused_profile_dirs := available_profile_dirs - seen_profile_dirs:
             yield UnusedProfileDirs(sorted(unused_profile_dirs))

testdata/data/repos/profiledir/RepoProfilesCheck/BannedProfileEapi/expected.json

@@ -0,0 +1 @@
+{"__class__": "BannedProfileEapi", "profile": "banned-eapi", "eapi": "0"}

testdata/data/repos/profiledir/RepoProfilesCheck/BannedProfileEapi/fix.patch

@@ -0,0 +1,5 @@
+diff -Naur profiledir/profiles/banned-eapi/eapi fixed/profiles/banned-eapi/eapi
+--- profiledir/profiles/banned-eapi/eapi	1970-01-01 01:00:00.000000000 +0100
++++ fixed/profiles/banned-eapi/eapi	2021-08-09 12:02:18.373080570 +0200
+@@ -0,0 +1 @@
++7

testdata/data/repos/profiledir/RepoProfilesCheck/DeprecatedProfileEapi/expected.json

@@ -0,0 +1 @@
+{"__class__": "DeprecatedProfileEapi", "profile": "deprecated-eapi", "eapi": "1"}

testdata/data/repos/profiledir/RepoProfilesCheck/DeprecatedProfileEapi/fix.patch

@@ -0,0 +1,6 @@
+diff -Naur profiledir/profiles/deprecated-eapi/eapi fixed/profiles/deprecated-eapi/eapi
+--- profiledir/profiles/deprecated-eapi/eapi	2021-08-09 11:54:37.593718237 +0200
++++ fixed/profiles/deprecated-eapi/eapi	2021-08-09 12:02:23.956527121 +0200
+@@ -1 +1 @@
+-1
++7

testdata/repos/profiledir/metadata/layout.conf

@@ -1,3 +1,5 @@
 masters =
 cache-formats =
 thin-manifests = true
+profile-eapis-banned = 0
+profile-eapis-deprecated = 1 2 3

testdata/repos/profiledir/profiles/banned-eapi/make.defaults

@@ -0,0 +1 @@
+

testdata/repos/profiledir/profiles/default/bad_parent/eapi

@@ -0,0 +1 @@
+7