Update openapi module to read from mkdocs.yml

Author: pedro-psb

pyproject.toml

@@ -17,6 +17,7 @@ dependencies = [
     "httpx",
     "rich",
     "GitPython~=3.1.44",
+    "pytest>=8.4.1",
 ]
 license = "GPL-3.0-or-later"
 license-files = ["LICENSE"]

src/pulp_docs/openapi.py

@@ -7,28 +7,47 @@
 import shutil
 import subprocess
 import tempfile
-from importlib.resources import files
 from pathlib import Path
 from typing import NamedTuple, Optional
 
-from pulp_docs.repository import Repos
+from mkdocs.config import load_config
 
 BASE_TMPDIR_NAME = "pulpdocs_tmp"
+CURRENT_DIR = Path(__file__).parent.absolute()
 
 
 def main(output_dir: Path, plugins_filter: Optional[list[str]] = None, dry_run: bool = False):
     """Creates openapi json files for all or selected plugins in output dir."""
-    repolist = str(files("pulp_docs").joinpath("data/repolist.yml"))
-    repos = Repos.from_yaml(repolist).get_repos(["content"])
-    if plugins_filter:
-        repos = [p for p in repos if p.name in plugins_filter]
+
+    def get_plugin_name(path: str) -> str:
+        return path.rpartition("/")[-1]
+
+    def is_subpackage(path: str) -> bool:
+        return "/" in path
+
+    def filter_plugin(path: str) -> bool:
+        if not plugins_filter:
+            return True
+        return get_plugin_name(path) in plugins_filter or path == "pulpcore"
+
+    def get_plugins():
+        mkdocs_yml = str(CURRENT_DIR.parent.parent / "mkdocs.yml")
+        pulpdocs_plugin = load_config(mkdocs_yml).plugins["PulpDocs"]
+        all_components = pulpdocs_plugin.config.components
+        return [c for c in all_components if c.rest_api]
+
+    all_plugins = get_plugins()
+    all_plugins = [p for p in all_plugins if filter_plugin(p.path)]
 
     pulp_plugins = []
-    for repo in repos:
-        name = repo.name
-        label = name.split("_")[-1]
-        is_subpackage = bool(getattr(repo, "subpackage_of", False))
-        pulp_plugins.append(PulpPlugin(name, label, is_subpackage))
+    for plugin in all_plugins:
+        plugin = PulpPlugin(
+            name=get_plugin_name(plugin.path),
+            label=plugin.rest_api,
+            is_subpackage=is_subpackage(plugin.path),
+            git_url=plugin.git_url,
+        )
+        pulp_plugins.append(plugin)
 
     openapi = OpenAPIGenerator(plugins=pulp_plugins, dry_run=dry_run)
     openapi.generate(target_dir=output_dir)
@@ -47,10 +66,10 @@ class PulpPlugin(NamedTuple):
     name: str
     label: str
     is_subpackage: bool
-    remote_template: str = "https://github.com/pulp/{name}"
+    git_url: str
 
     def get_remote_url(self):
-        return self.remote_template.format(name=self.name)
+        return self.git_url
 
 
 class OpenAPIGenerator:
@@ -64,7 +83,7 @@ class OpenAPIGenerator:
     """
 
     def __init__(self, plugins: list[PulpPlugin], dry_run=False):
-        self.pulpcore = PulpPlugin("pulpcore", "core", False)
+        self.pulpcore = next(filter(lambda p: p.name == "pulpcore", plugins))
         self.plugins = plugins + [self.pulpcore]
         self.dry_run = dry_run
 

tests/test_openapi_generation.py

@@ -4,23 +4,28 @@
 from pulp_docs.openapi import main as openapi_main
 
 
-def test_openapi_generation(tmp_path: Path, monkeypatch):
-    output_dir = tmp_path / "openapi"
-    output_dir.mkdir()
-    assert len(list(output_dir.glob("*.json"))) == 0
-
-    with monkeypatch.context() as m:
-        m.setenv("TMPDIR", str(tmp_path))
+class TestOpenApiGeneration:
+    def test_dry_run(self, tmp_path: Path, monkeypatch):
+        output_dir = tmp_path / "openapi"
         plugins_filter = ["pulp_rpm", "pulp_file"]
         openapi_main(output_dir=output_dir, plugins_filter=plugins_filter, dry_run=True)
-        openapi_main(output_dir=output_dir, plugins_filter=plugins_filter)
 
-    output_paths = [f for f in output_dir.glob("*.json")]
-    output_ls = [f.name for f in output_paths]
-    output_labels = [f.rpartition("-")[0] for f in output_ls]
-    assert len(output_ls) == 3
-    assert {"core-api.json", "rpm-api.json", "file-api.json"} == set(output_ls)
+    def test_sample_generation(self, tmp_path: Path, monkeypatch):
+        output_dir = tmp_path / "openapi"
+        output_dir.mkdir()
+        assert len(list(output_dir.glob("*.json"))) == 0
+
+        with monkeypatch.context() as m:
+            m.setenv("TMPDIR", str(tmp_path))
+            plugins_filter = ["pulp_rpm", "pulp_file"]
+            openapi_main(output_dir=output_dir, plugins_filter=plugins_filter)
+
+        output_paths = [f for f in output_dir.glob("*.json")]
+        output_ls = [f.name for f in output_paths]
+        output_labels = [f.rpartition("-")[0] for f in output_ls]
+        assert len(output_ls) == 3
+        assert {"core-api.json", "rpm-api.json", "file-api.json"} == set(output_ls)
 
-    for label, path in zip(output_labels, output_paths):
-        openapi_data = json.loads(path.read_text())
-        assert label in openapi_data["info"]["x-pulp-app-versions"].keys()
+        for label, path in zip(output_labels, output_paths):
+            openapi_data = json.loads(path.read_text())
+            assert label in openapi_data["info"]["x-pulp-app-versions"].keys()