From 9d1145150d10a9451edab3ef7cde792032d4dd7b Mon Sep 17 00:00:00 2001
From: Joshua Benning <j.benning@iat.rwth-aachen.de>
Date: Thu, 2 Jul 2026 13:00:38 +0200
Subject: [PATCH] server.test: Add API base path consistency test

Previously the API base path (currently `api/v3.1`) was hardcoded across interface modules, dockerfiles and tests. Bumping the version risks drift across the occurences.

This change adds a unittest that extracts the version from each of the currently known files via regex and asserts the version matches.

The risk of newly added occurrences not being tracked remains.

Fixes #535
---
 server/test/test_api_base_path.py | 54 +++++++++++++++++++++++++++++++
 1 file changed, 54 insertions(+)
 create mode 100644 server/test/test_api_base_path.py

diff --git a/server/test/test_api_base_path.py b/server/test/test_api_base_path.py
new file mode 100644
index 00000000..7617102d
--- /dev/null
+++ b/server/test/test_api_base_path.py
@@ -0,0 +1,54 @@
+# Copyright (c) 2026 the Eclipse BaSyx Authors
+#
+# This program and the accompanying materials are made available under the terms of the MIT License, available in
+# the LICENSE file of this project.
+#
+# SPDX-License-Identifier: MIT
+import unittest
+import pathlib
+import re
+
+SERVER_ROOT = pathlib.Path(__file__).resolve().parent.parent
+
+API_PATH_REGEX = re.compile(r"/api/v[\d.]+")
+
+FILES_TO_CHECK = [
+    # Server routes
+    SERVER_ROOT / "app" / "interfaces" / "discovery.py",
+    SERVER_ROOT / "app" / "interfaces" / "registry.py",
+    SERVER_ROOT / "app" / "interfaces" / "repository.py",
+    # Dockerfiles
+    SERVER_ROOT / "docker" / "discovery" / "Dockerfile",
+    SERVER_ROOT / "docker" / "registry" / "Dockerfile",
+    SERVER_ROOT / "docker" / "repository" / "Dockerfile",
+    # Tests
+    SERVER_ROOT / "test" / "interfaces" / "test_shells_asset_ids.py",
+]
+
+
+def _extract(path: pathlib.Path) -> str:
+    match = API_PATH_REGEX.search(path.read_text())
+    if match is None:
+        raise AssertionError(str(path.relative_to(SERVER_ROOT)) + ": no base path found")
+    return match.group(0)
+
+
+def _list_divergences(values) -> str:
+    output = "API base path diverges across files:\n"
+    for p, v in values.items():
+        output += f"\n{p} {v}"
+    return output
+
+
+class APIBasePathConsistencyTest(unittest.TestCase):
+    def test_base_path_aligned_across_known_files(self) -> None:
+        values = {}
+        for path in FILES_TO_CHECK:
+            values[str(path.relative_to(SERVER_ROOT))] = _extract(path)
+
+        distinct = set(values.values())
+        self.assertEqual(
+            1,
+            len(distinct),
+            _list_divergences(values)
+        )