Merge ~alemar99/maas-ci/+git/system-tests:openapi_system_test into ~maas-committers/maas-ci/+git/system-tests:master

[Alessandro Marcolini]

feat: verify openapi spec is in sync with nginx proxy rules

Mimic the test in src/tests/maasapiserver/test_main.py to ensure there is consistency with nginx proxy rules.

7329088... by Alessandro Marcolini on 2024-06-12

refactor: assert that client url ends with "MAAS/"

[MAAS Lander (maas-lander)]

UNIT TESTS
-b openapi_system_test lp:~alemar99/maas-ci/+git/system-tests into -b master lp:~maas-committers/maas-ci/+git/system-tests

STATUS: SUCCESS
COMMIT: b68d63faf691a5794dc642255bb1a5d0117a26c2

review: Approve

[MAAS Lander (maas-lander)]

UNIT TESTS
-b openapi_system_test lp:~alemar99/maas-ci/+git/system-tests into -b master lp:~maas-committers/maas-ci/+git/system-tests

STATUS: SUCCESS
COMMIT: 7329088c3ad3bb7baefb820944c00e3c9f7c4716

review: Approve

[Jacopo Rota (r00ta)]

lgtm

review: Approve

diff --git a/systemtests/general_tests/test_openapi.py b/systemtests/general_tests/test_openapi.py
new file mode 100644
index 0000000..1d7644f
--- /dev/null
+++ b/systemtests/general_tests/test_openapi.py
@@ -0,0 +1,17 @@
+import json
+
+from systemtests.api import UnauthenticatedMAASAPIClient
+
+
+def test_openapi_proxy(
+    unauthenticated_maas_api_client: UnauthenticatedMAASAPIClient,
+) -> None:
+    assert unauthenticated_maas_api_client.url.endswith("MAAS/")
+    openapi = unauthenticated_maas_api_client.execute(
+        [f"{unauthenticated_maas_api_client.url}/a/openapi.json"],
+        base_cmd=["curl", "-s", "-k"],
+    )
+    openapi_json = json.loads(openapi)
+    for path, specs in openapi_json["paths"].items():
+        assert path.startswith("/MAAS/a")
+        assert specs is not None