test: add a meta test to make sure that v4/objects/ files are imported

JohnVillalovos · JohnVillalovos · commit 87c823aabf11 · 2022-01-16T12:48:51.000-08:00
Add a test to make sure that all of the `gitlab/v4/objects/` files are
imported in `gitlab/v4/objects/__init__.py`
diff --git a/tests/meta/test_v4_objects_imported.py b/tests/meta/test_v4_objects_imported.py
@@ -0,0 +1,48 @@
+"""
+Ensure objects defined in gitlab.v4.objects are imported in
+`gitlab/v4/objects/__init__.py`
+
+"""
+import os
+import pprint
+from typing import Set
+
+RELATIVE_V4_OBJECTS_DIR = os.path.join("gitlab", "v4", "objects")
+V4_OBJECTS_DIR = os.path.join(os.getcwd(), RELATIVE_V4_OBJECTS_DIR)
+V4_OBJECTS_INIT = os.path.join(V4_OBJECTS_DIR, "__init__.py")
+
+
+def parse_import_line(line: str) -> str:
+    line = line.rstrip()
+    assert line.startswith("from .")
+    line = line[len("from .") :]
+    return line.split()[0]
+
+
+def test_verify_v4_objects_imported() -> None:
+    print(os.getcwd())
+    print(V4_OBJECTS_DIR)
+    object_files: Set[str] = set()
+    for filename in sorted(os.listdir(V4_OBJECTS_DIR)):
+        if not filename.endswith(".py"):
+            continue
+        if filename in ("__init__.py",):
+            continue
+        root, _ = os.path.splitext(filename)
+        object_files.add(root)
+
+    init_files: Set[str] = set()
+    with open(V4_OBJECTS_INIT, "r") as in_file:
+        for line in in_file.readlines():
+            if not line.startswith("from ."):
+                continue
+            init_files.add(parse_import_line(line))
+
+    if object_files == init_files:
+        return
+
+    missing_in_init = object_files - init_files
+    assert missing_in_init == set(), (
+        f"Missing imports in {V4_OBJECTS_INIT} for "
+        f"{pprint.pformat(sorted(missing_in_init))}"
+    )
