tools: add ci_config.json TypedDict wrapper

Avoid duplicated code for reading ci_config.json, and ensure the type
checker has information about its contents.

Author: bgilbert

ci_config.json

@@ -2,7 +2,7 @@
   "_comment": [
     "This is intentionally undocumented in README.md, do not use it.",
     "Using it is an automatic CI error.",
-    "broken_linux, broken_windows and broken_macos are lists of wraps that are known",
+    "broken_linux, broken_windows and broken_darwin are lists of wraps that are known",
     "to be broken on the CI and ***MUST*** get repaired before updates",
     "will be accepted. If upstream does not support an Operating System,",
     "explicitly disable that Operating System in build_on.",

tools/create_release.py

@@ -26,7 +26,7 @@
 import json
 
 from pathlib import Path
-from utils import Releases, is_ci, is_debianlike, read_wrap, write_wrap
+from utils import CIConfig, Releases, is_ci, is_debianlike, read_wrap, write_wrap
 
 class CreateRelease:
     def __init__(self, repo: T.Optional[str], token: T.Optional[str], tag: str):
@@ -59,11 +59,9 @@ def create_patch_zip(self) -> None:
         generator = Path(srcdir, 'generator.sh')
         if generator.exists():
             try:
-                fn = 'ci_config.json'
-                with open(fn, 'r') as f:
-                    ci = json.load(f)
-            except json.decoder.JSONDecodeError:
-                raise RuntimeError(f'file {fn} is malformed')
+                ci = CIConfig.load()
+            except json.decoder.JSONDecodeError as ex:
+                raise RuntimeError(f'CI config is malformed') from ex
 
             debian_packages = ci.get(self.name, {}).get('debian_packages', [])
             if debian_packages and is_debianlike():

tools/sanity_checks.py

@@ -29,7 +29,7 @@
 import shutil
 
 from pathlib import Path
-from utils import Releases, Version, ci_group, is_ci, is_alpinelike, is_debianlike, is_macos, is_windows, is_msys, read_wrap, FormattingError, format_meson
+from utils import CIConfig, ProjectCIConfig, Releases, Version, ci_group, is_ci, is_alpinelike, is_debianlike, is_macos, is_windows, is_msys, read_wrap, FormattingError, format_meson
 
 PERMITTED_FILES = {'generator.sh', 'meson.build', 'meson_options.txt', 'meson.options', 'LICENSE.build'}
 PER_PROJECT_PERMITTED_FILES: dict[str, set[str]] = {
@@ -163,27 +163,8 @@
 IGNORE_SETUP_WARNINGS = None  # or re.compile(r'something')
 
 
-if T.TYPE_CHECKING:
-    class CiConfigProject(T.TypedDict, total=False):
-        build_options: list[str]
-        build_on: dict[str, bool]
-        alpine_packages: list[str]
-        brew_packages: list[str]
-        choco_packages: list[str]
-        debian_packages: list[str]
-        msys_packages: list[str]
-        python_packages: list[str]
-        fatal_warnings: bool
-        has_provides: bool
-        skip_dependency_check: list[str]
-        skip_program_check: list[str]
-        test_options: list[str]
-        skip_tests: bool
-
-
 class TestReleases(unittest.TestCase):
-    # requires casts for special keys e.g. broken_*
-    ci_config: dict[str, CiConfigProject]
+    ci_config: CIConfig
     fatal_warnings: bool
     annotate_context: bool
     skip_build: bool
@@ -211,14 +192,10 @@ def setUpClass(cls):
 
         try:
             cls.releases = Releases.load()
-            fn = 'ci_config.json'
-            with open(fn, 'r', encoding='utf-8') as f:
-                cls.ci_config = json.load(f)
+            cls.ci_config = CIConfig.load()
         except json.decoder.JSONDecodeError as ex:
             raise RuntimeError('metadata is malformed') from ex
 
-        system = platform.system().lower()
-        cls.skip = T.cast(T.List[str], cls.ci_config[f'broken_{system}'])
         cls.fatal_warnings = os.environ.get('TEST_FATAL_WARNINGS', 'yes') == 'yes'
         cls.annotate_context = os.environ.get('TEST_ANNOTATE_CONTEXT') == 'yes'
         cls.skip_build = os.environ.get('TEST_SKIP_BUILD') == 'yes'
@@ -345,7 +322,7 @@ def test_releases(self) -> None:
                             if not self.skip_build:
                                 self.check_new_release(name, deps=deps, progs=progs)
                                 with self.subTest(f'If this works now, please remove it from broken_{platform.system().lower()}!'):
-                                    self.assertNotIn(name, self.skip)
+                                    self.assertNotIn(name, self.ci_config.broken)
                                 self.check_meson_version(name, ver, patch_path)
                         if patch_path:
                             self.check_project_args(name, Path('subprojects') / wrap_section['directory'])
@@ -367,7 +344,7 @@ def test_build_all(self):
         failed = []
         errored = []
         for name, info in self.releases.items():
-            if name in self.skip:
+            if name in self.ci_config.broken:
                 skipped.append(name)
                 continue
             try:
@@ -550,7 +527,7 @@ def do_setup(builddir, options, meson_env):
                 raise
         subprocess.check_call(['meson', 'install', '-C', builddir, '--destdir', 'pkg'])
 
-    def install_packages(self, ci: CiConfigProject) -> dict[str, str]:
+    def install_packages(self, ci: ProjectCIConfig) -> dict[str, str]:
         debian_packages = ci.get('debian_packages', [])
         brew_packages = ci.get('brew_packages', [])
         choco_packages = ci.get('choco_packages', [])

tools/utils.py

@@ -134,6 +134,31 @@ class ProjectReleases(T.TypedDict):
 class Releases(dict[str, ProjectReleases], _JSONFile):
     FILENAME = 'releases.json'
 
+class ProjectCIConfig(T.TypedDict):
+    build_on: T.NotRequired[dict[str, bool]]
+    build_options: T.NotRequired[list[str]]
+    fatal_warnings: T.NotRequired[bool]
+    has_provides: T.NotRequired[bool]
+    skip_dependency_check: T.NotRequired[list[str]]
+    skip_program_check: T.NotRequired[list[str]]
+    skip_tests: T.NotRequired[bool]
+    test_options: T.NotRequired[list[str]]
+
+    alpine_packages: T.NotRequired[list[str]]
+    brew_packages: T.NotRequired[list[str]]
+    choco_packages: T.NotRequired[list[str]]
+    debian_packages: T.NotRequired[list[str]]
+    msys_packages: T.NotRequired[list[str]]
+    python_packages: T.NotRequired[list[str]]
+
+class CIConfig(dict[str, ProjectCIConfig], _JSONFile):
+    FILENAME = 'ci_config.json'
+
+    @property
+    def broken(self) -> list[str]:
+        system = platform.system().lower()
+        return T.cast('list[str]', self.get(f'broken_{system}', []))
+
 def wrap_path(name: str) -> Path:
     return Path('subprojects', f'{name}.wrap')