Add versioned endpoints (#92)

* Split up ETOS API into v0 and v1alpha

This also has the added effect of separating the API docs to
/api/docs, /api/v0/docs and /api/v1alpha/docs.
The default ETOS API version shall be served on /api
Also removed some unecessary code and routers and moved the
selftest to /api/etos/ping and /api/version/etos/ping so that
we can start doing a few checks when the client pings ETOS.
The old /selftest/ping endpoint still exists, but redirects
to the default API version/ping

manifests/base/deployment.yaml

@@ -28,9 +28,9 @@ spec:
               protocol: TCP
           livenessProbe:
             httpGet:
-              path: /selftest/ping
+              path: /api/etos/ping
               port: http
           readinessProbe:
             httpGet:
-              path: /selftest/ping
+              path: /api/etos/ping
               port: http

python/pyproject.toml

@@ -16,7 +16,7 @@ classifiers = [
 ]
 requires-python = ">=3.9"
 dependencies = [
-    "etos_lib==4.4.1",
+    "etos_lib==4.4.2",
     "etcd3gw~=2.3",
     "uvicorn~=0.22",
     "fastapi~=0.109.1",

python/src/etos_api/__init__.py

@@ -55,7 +55,7 @@
     trace.set_tracer_provider(PROVIDER)
 
     FastAPIInstrumentor().instrument_app(
-        APP, tracer_provider=PROVIDER, excluded_urls="selftest/.*,logs/.*"
+        APP, tracer_provider=PROVIDER, excluded_urls=".*/etos/ping"
     )
 
 RegisterProviders()

python/src/etos_api/main.py

@@ -14,44 +14,13 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 """ETOS API."""
-import logging
-
 from fastapi import FastAPI
+from etos_api.routers.v0 import ETOSv0
+from etos_api.routers.v1alpha import ETOSv1Alpha
 
-from starlette.responses import RedirectResponse
-
-from etos_api import routers
-
-# This allows the path to start either at '/api' or '/'.
-APP = FastAPI(root_path="/api")
-LOGGER = logging.getLogger(__name__)
-
-
-@APP.post("/")
-async def redirect_post_to_root():
-    """Redirect post requests to root to the start ETOS endpoint.
-
-    :return: Redirect to etos.
-    :rtype: :obj:`starlette.responses.RedirectResponse`
-    """
-    LOGGER.debug("Redirecting post requests to the root endpoint to '/etos'")
-    # DEPRECATED. Exists only for backwards compatibility.
-    return RedirectResponse(url="/etos", status_code=308)  # 308 = Permanent Redirect
-
-
-@APP.head("/")
-async def redirect_head_to_root():
-    """Redirect head requests to root to the selftest/ping endpoint.
-
-    :return: Redirect to selftest/ping.
-    :rtype: :obj:`starlette.responses.RedirectResponse`
-    """
-    LOGGER.debug("Redirecting head requests to the root endpoint to '/sefltest/ping'")
-    # DEPRECATED. Exists only for backwards compatibility.
-    return RedirectResponse(url="/selftest/ping", status_code=308)  # 308 = Permanent Redirect
-
+DEFAULT_VERSION = ETOSv0
 
-APP.include_router(routers.etos.ROUTER)
-APP.include_router(routers.testrun.ROUTER)
-APP.include_router(routers.selftest.ROUTER)
-APP.include_router(routers.logs.ROUTER)
+APP = FastAPI()
+APP.mount("/api/v1alpha", ETOSv1Alpha, "ETOS V1 Alpha")
+APP.mount("/api/v0", ETOSv0, "ETOS V0")
+APP.mount("/api", DEFAULT_VERSION, "ETOS V0")

python/src/etos_api/routers/__init__.py

@@ -16,7 +16,6 @@
 """ETOS API routers module."""
 import os
 from kubernetes import config
-from . import etos, testrun, logs, selftest
 
 if os.getenv("RUNNING_TESTS") is None:
     try:

python/src/etos_api/routers/etos/__init__.py → python/src/etos_api/routers/v0/__init__.py

@@ -14,5 +14,5 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 """ETOS API etos module."""
-from .router import ROUTER
+from .router import ETOSv0
 from . import schemas