Update request method headers and unittests to work with pagination

Author: JAB1305

api/server/routes/aas.py

@@ -17,7 +17,7 @@ def __init__(self, global_obj_store: ObjectStore[Identifiable]):
     def _setup_routes(self):
         @self.router.get("/shells")
         @paginated()
-        async def get_all_aas() -> Any:
+        async def get_all_aas(request: Request) -> Any:
             return self.service.get_all_shells_as_jsonable()
 
         @self.router.post("/shells")

api/server/routes/aas_registry_server.py

@@ -19,7 +19,7 @@ def __init__(self, global_obj_store: ObjectStore[Identifiable]):
     def _setup_routes(self):
         @self.router.get("/")
         @paginated()
-        async def get_all_aas_descriptors() -> Any:
+        async def get_all_aas_descriptors(request: Request) -> Any:
             return self.service.get_all_asset_administration_shell_descriptors()
 
         @self.router.get("/{aas_descriptor_id}")

api/server/routes/aasx_file_server.py

@@ -19,7 +19,7 @@ def __init__(self, global_obj_store: ObjectStore[Identifiable]):
     def _setup_routes(self):
         @self.router.get("")
         @paginated()
-        async def get_all_aasx() -> Any:
+        async def get_all_aasx(request: Request) -> Any:
             return self.service.get_all_aasx_package_ids()
 
         @self.router.get("/{aasx_package_id}")

api/server/routes/submodel.py

@@ -99,7 +99,7 @@ async def post_submodel_elements(submodel_identifier: str, request: Request) ->
 
         @self.router.get("/{submodel_identifier}/submodel-elements")
         @paginated()
-        async def get_submodel_submodel_elements(submodel_identifier: str) -> Any:
+        async def get_submodel_submodel_elements(request: Request, submodel_identifier: str) -> Any:
             # Get submodel elements
             self.service.get_submodel_elements(submodel_identifier)
 
@@ -122,7 +122,7 @@ async def not_implemented_submodel_elements_path(submodel_identifier: str) -> An
 
         @self.router.get("/{submodel_identifier}/submodel-elements/{id_short_path}")
         @paginated()
-        async def get_submodel_submodel_elements_id_short_path(submodel_identifier: str, id_short_path: str) -> Any:
+        async def get_submodel_submodel_elements_id_short_path(request: Request, submodel_identifier: str, id_short_path: str) -> Any:
             return self.service.get_submodel_element(submodel_identifier, id_short_path)
 
         @self.router.post("/{submodel_identifier}/submodel-elements/{id_short_path}")

api/server/routes/submodel_registry_server.py

@@ -19,7 +19,7 @@ def __init__(self, global_obj_store: ObjectStore[Identifiable]):
     def _setup_routes(self):
         @self.router.get("/")
         @paginated()
-        async def get_all_submodel_descriptors() -> Any:
+        async def get_all_submodel_descriptors(request: Request) -> Any:
             return self.service.get_all_submodel_descriptors()
 
         @self.router.get("/{submodel_id}")

api/test/__init__.py

@@ -0,0 +1,7 @@
+def wrap_paginated(result):
+    return {
+        "result": result,
+        "paging_metadata": {
+            "next_cursor": None
+        }
+    }

api/test/examples/empty_paged_result.json

@@ -0,0 +1,6 @@
+{
+  "result": [],
+  "paging_metadata": {
+    "next_cursor": null
+  }
+}

api/test/test_aas_service.py

@@ -5,6 +5,8 @@
 
 from server import app
 
+from api.test import wrap_paginated
+
 BASE_URL = "/api/v3.0/"
 
 
@@ -31,6 +33,9 @@ def setUp(self):
         with open(os.path.join(base_path, "examples/aas", "thumbnail_modified.json"), encoding="utf-8") as f:
             self.thumbnail_example_modified = json.load(f)
 
+        with open(os.path.join(base_path, "examples", "empty_paged_result.json"), encoding="utf-8") as f:
+            self.empty_result = json.load(f)
+
         # FIXME: modified AAS should contain more complex types but deserialization seems to fail
         with open(os.path.join(base_path, "examples/aas", "aas_modified.json"), encoding="utf-8") as f:
             self.aas_example_modified = json.load(f)
@@ -48,14 +53,14 @@ def test_aas_post(self):
     def test_get_all_shells(self):
         response = self.client.get(BASE_URL + "aas/shells")
         self.assertEqual(response.status_code, 200)
-        self.assertEqual(response.json(), [])
+        self.assertEqual(response.json(), self.empty_result)
 
         # Setup
         self.client.post(BASE_URL + "aas/shells", json=self.aas_example)
 
         response = self.client.get(BASE_URL + "aas/shells")
         self.assertEqual(response.status_code, 200)
-        self.assertEqual(response.json(), [self.aas_example])
+        self.assertEqual(response.json(), wrap_paginated([self.aas_example]))
 
         # Teardown
         self.client.delete(BASE_URL + "ass/shells/" + self.shell_example_id)

api/test/test_aasx_file_server_service.py

@@ -6,6 +6,8 @@
 from server import app
 from aas_core3 import jsonization
 
+from api.test import wrap_paginated
+
 client = TestClient(app)
 BASE_URL = "/api/v3.0/"
 
@@ -18,21 +20,25 @@ def setUp(self):
         with open(os.path.join(base_path, "examples/aasx", "aasx.json"), encoding="utf-8") as f:
             self.aasx_json = json.load(f)
 
+        with open(os.path.join(base_path, "examples", "empty_paged_result.json"), encoding="utf-8") as f:
+            self.empty_result = json.load(f)
+
+
         self.test_aasx_id = self.aasx_json["id"]
         self.aasx = jsonization.asset_administration_shell_from_jsonable(self.aasx_json)
 
     def test_get_all_aasx_package_ids(self):
         # Test empty
         response = self.client.get(BASE_URL + "aasx")
         self.assertEqual(response.status_code, 200)
-        self.assertEqual(response.json(), [])
+        self.assertEqual(response.json(), self.empty_result)
 
         # Setup
         self.client.post(BASE_URL + "aasx", json=self.aasx_json)
 
         response = self.client.get(BASE_URL + "aasx")
         self.assertEqual(response.status_code, 200)
-        self.assertEqual(response.json(), [self.test_aasx_id])
+        self.assertEqual(response.json(), wrap_paginated([self.test_aasx_id]))
 
         # Teardown
         self.client.delete(BASE_URL + "aasx/" + self.test_aasx_id)

api/test/test_submodel_service.py

@@ -6,6 +6,8 @@
 
 from server import app
 
+from api.test import wrap_paginated
+
 client = TestClient(app)
 BASE_URL = "/api/v3.0/"
 
@@ -27,6 +29,9 @@ def setUp(self):
             self.submodel_element_new = json.load(f)
         with open(os.path.join(base_path, "examples/submodel", "submodel_with_new_element.json"), encoding="utf-8") as f:
             self.submodel_with_new_element = json.load(f)
+        with open(os.path.join(base_path, "examples", "empty_paged_result.json"), encoding="utf-8") as f:
+            self.empty_result = json.load(f)
+
 
         self.submodel_example_id = self.submodel_example["id"]
         self.submodel_example_2_id = self.submodel_example_2["id"]
@@ -37,14 +42,14 @@ def setUp(self):
     def test_get_all_submodels(self):
         response = self.client.get(BASE_URL + "submodels")
         self.assertEqual(response.status_code, 200)
-        self.assertEqual(response.json(), [])
+        self.assertEqual(response.json(), self.empty_result)
 
         # Setup
         self.client.post(BASE_URL + "submodels", json=self.submodel_example)
 
         response = self.client.get(BASE_URL + "submodels")
         self.assertEqual(response.status_code, 200)
-        self.assertEqual(response.json(), [self.submodel_example])
+        self.assertEqual(response.json(), wrap_paginated([self.submodel_example]))
 
         # Teardown
         self.client.delete(BASE_URL + "submodels/" + self.submodel_example_id)
@@ -101,6 +106,9 @@ def test_post_submodel_element(self):
         self.assertEqual(new_submodel.status_code, 200)
         self.assertEqual(new_submodel.json(), self.submodel_with_new_element)
 
+        # Teardown
+        self.client.delete(BASE_URL + "submodels/" + self.submodel_example_id + "/")
+
     def test_delete_submodel_element(self):
         # Setup
         self.client.post(BASE_URL + "submodels", json=self.submodel_example)