diracx-testing 0.0.1a32__py3-none-any.whl → 0.0.1a34__py3-none-any.whl

diracx/testing/client_generation.py

@@ -0,0 +1,156 @@
+from __future__ import annotations
+
+__all__ = [
+    "regenerate_client",
+    "AUTOREST_VERSION",
+]
+
+import ast
+import importlib.util
+import subprocess
+from pathlib import Path
+
+import git
+
+AUTOREST_VERSION = "6.13.7"
+
+
+def extract_static_all(path):
+    tree = ast.parse(path.read_text(), filename=path)
+
+    name_to_module = {}
+    for node in tree.body:
+        if isinstance(node, ast.ImportFrom):
+            # Skip wildcard imports (like 'from ... import *')
+            for alias in node.names:
+                if alias.name == "*":
+                    continue
+                # Use the alias if available, otherwise the original name.
+                local_name = alias.asname if alias.asname else alias.name
+                name_to_module[local_name] = node.module
+
+    # Look for the first top-level assignment to __all__
+    for node in tree.body:
+        if not isinstance(node, ast.Assign):
+            continue
+        for target in node.targets:
+            if not (isinstance(target, ast.Name) and target.id == "__all__"):
+                continue
+            return {
+                name: name_to_module.get(name) for name in ast.literal_eval(node.value)
+            }
+    raise NotImplementedError("__all__ not found")
+
+
+def fixup_models_init(generated_dir, extension_name):
+    """Workaround for https://github.com/python/mypy/issues/15300."""
+    models_init_path = generated_dir / "models" / "__init__.py"
+    # Enums cannot be extended, so we don't need to patch them
+    object_names = {
+        name
+        for name, module in extract_static_all(models_init_path).items()
+        if module != "_enums"
+    }
+
+    patch_module = "diracx.client._generated.models._patch"
+    spec = importlib.util.find_spec(patch_module)
+    if spec is None or spec.origin is None:
+        raise ImportError(f"Cannot locate {patch_module} package")
+    missing = set(extract_static_all(Path(spec.origin))) - set(object_names)
+    missing_formatted = "\n".join(f'            "{name}",' for name in missing)
+
+    with models_init_path.open("a") as fh:
+        fh.write(
+            "if TYPE_CHECKING:\n"
+            "    __all__.extend(\n"
+            "        [\n"
+            f"{missing_formatted}"
+            "        ]\n"
+            "    )\n"
+        )
+
+
+def regenerate_client(openapi_spec: Path, client_module: str):
+    """Regenerate the AutoREST client and run pre-commit checks on it.
+
+    This test is skipped by default, and can be enabled by passing
+    --regenerate-client to pytest. It is intended to be run manually
+    when the API changes.
+
+    The reason this is a test is that it is the only way to get access to the
+    test_client fixture, which is required to get the OpenAPI spec.
+
+    WARNING: This test will modify the source code of the client!
+    """
+    spec = importlib.util.find_spec(client_module)
+    if spec is None:
+        raise ImportError("Cannot locate client_module package")
+    if spec.origin is None:
+        raise ImportError(
+            "Cannot locate client_module package, did you forget the __init__.py?"
+        )
+    client_root = Path(spec.origin).parent
+
+    assert client_root.is_dir()
+    assert client_root.name == "client"
+    assert (client_root / "_generated").is_dir()
+    extension_name = client_root.parent.name
+
+    repo_root = client_root.parents[3]
+    if extension_name == "gubbins":
+        # Gubbins is special because it has a different structure due to being
+        # in a subdirectory of diracx
+        repo_root = repo_root.parents[1]
+    assert (repo_root / ".git").is_dir()
+    repo = git.Repo(repo_root)
+    generated_dir = client_root / "_generated"
+    if repo.is_dirty(path=generated_dir):
+        raise AssertionError(
+            "Client is currently in a modified state, skipping regeneration"
+        )
+
+    cmd = [
+        "autorest",
+        "--python",
+        f"--input-file={openapi_spec}",
+        "--models-mode=msrest",
+        "--namespace=_generated",
+        f"--output-folder={client_root}",
+    ]
+
+    # This is required to be able to work offline
+    # TODO: if offline, find the version already installed
+    # and use it
+    # cmd += [f"--use=@autorest/python@{AUTOREST_VERSION}"]
+
+    # ruff: disable=S603
+    subprocess.run(cmd, check=True)
+
+    if extension_name != "diracx":
+        # For now we don't support extending the models in extensions. To make
+        # this clear manually remove the automatically generated _patch.py file
+        # and fixup the __init__.py file to use the diracx one.
+        (generated_dir / "models" / "_patch.py").unlink()
+        models_init_path = generated_dir / "models" / "__init__.py"
+        models_init = models_init_path.read_text()
+        assert models_init.count("from ._patch import") == 4
+        models_init = models_init.replace(
+            "from ._patch import",
+            "from diracx.client._generated.models._patch import",
+        )
+        models_init_path.write_text(models_init)
+
+    fixup_models_init(generated_dir, extension_name)
+
+    cmd = ["pre-commit", "run", "--all-files"]
+    print("Running pre-commit...")
+    subprocess.run(cmd, check=False, cwd=repo_root)
+    print("Re-running pre-commit...")
+    proc = subprocess.run(cmd, check=False, cwd=repo_root)
+    if proc.returncode == 0 and not repo.is_dirty(path=generated_dir):
+        return
+    # Show the diff to aid debugging
+    print(repo.git.diff(generated_dir))
+    if proc.returncode != 0:
+        raise AssertionError("Pre-commit failed")
+    raise AssertionError("Client was regenerated with changes")

diracx/testing/entrypoints.py

@@ -57,11 +57,13 @@ def verify_entry_points(request, pytestconfig):
     else:
         return
 
-    installed_eps = get_installed_entry_points()
-    current_eps = get_current_entry_points(repo_base)
+    installed_eps = set(get_installed_entry_points())
+    current_eps = set(get_current_entry_points(repo_base))
 
     if installed_eps != current_eps:
         pytest.fail(
             "Project and installed entry-points are not consistent. "
-            "You should run `pip install -r requirements-dev.txt`",
+            "You should run `pip install -r requirements-dev.txt`"
+            f"{installed_eps-current_eps=}",
+            f"{current_eps-installed_eps=}",
         )

{diracx_testing-0.0.1a32.dist-info → diracx_testing-0.0.1a34.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: diracx-testing
-Version: 0.0.1a32
+Version: 0.0.1a34
 Summary: TODO
 License: GPL-3.0-only
 Classifier: Intended Audience :: Science/Research

{diracx_testing-0.0.1a32.dist-info → diracx_testing-0.0.1a34.dist-info}/RECORD

@@ -1,11 +1,12 @@
 diracx/testing/__init__.py,sha256=nGbnGP8m53N9rqHR-hyqDa5vetcsmnQp806HadV6_dE,984
+diracx/testing/client_generation.py,sha256=vegOUVQPcB7NTUFDr0HbasH5eByKQvLh_xYqKBYajzk,5539
 diracx/testing/dummy_osdb.py,sha256=bNk3LF8KgMuQx3RVFNYuw4hMmpG2A80sZ58rEZqHo7M,907
-diracx/testing/entrypoints.py,sha256=MbH0VLUQz96XPdHzb7XWFwYtWEitAqPrrGM1H1FzDLo,2231
+diracx/testing/entrypoints.py,sha256=ql7byyUOnUBdDoiN5xznlUTQSbD1YCNy4UF5t9MBhgc,2330
 diracx/testing/mock_osdb.py,sha256=hHuvmQZ3212SaSGX11dQv4ki3ZWsmqJZFYwdn6kg2MA,6029
 diracx/testing/osdb.py,sha256=m6mUBLnGOoQLTCIBie9P2GhmLMybrgzIrlIYfhF1_Ss,3230
 diracx/testing/routers.py,sha256=UW-TnikMQgcNxF5sUZD5DWoucGiCpP6s8mYmuahDiSc,979
 diracx/testing/utils.py,sha256=T3tTzEOhmibcIu6TPwvoaZ6lFgHlU0t9FDHSetKP5EI,24341
-diracx_testing-0.0.1a32.dist-info/METADATA,sha256=-dsExEwjQmFmUKtKuGycQkhu5MwMoXu0sK0nH7eRFfg,634
-diracx_testing-0.0.1a32.dist-info/WHEEL,sha256=CmyFI0kx5cdEMTLiONQRbGQwjIoR1aIYB7eCAQ4KPJ0,91
-diracx_testing-0.0.1a32.dist-info/top_level.txt,sha256=vJx10tdRlBX3rF2Psgk5jlwVGZNcL3m_7iQWwgPXt-U,7
-diracx_testing-0.0.1a32.dist-info/RECORD,,
+diracx_testing-0.0.1a34.dist-info/METADATA,sha256=GbjNnEnETJgIdg383Y8EI8-s_UghxUkFNtkRFPKAqKo,634
+diracx_testing-0.0.1a34.dist-info/WHEEL,sha256=CmyFI0kx5cdEMTLiONQRbGQwjIoR1aIYB7eCAQ4KPJ0,91
+diracx_testing-0.0.1a34.dist-info/top_level.txt,sha256=vJx10tdRlBX3rF2Psgk5jlwVGZNcL3m_7iQWwgPXt-U,7
+diracx_testing-0.0.1a34.dist-info/RECORD,,