From 1a8e6e849ee158f8fbde154f27c31c8628f38592 Mon Sep 17 00:00:00 2001
From: Conrad <grosserconrad@gmail.com>
Date: Thu, 10 Oct 2024 17:21:59 +0200
Subject: [PATCH] feat: added order by for logs

---
 app/routes/entry.py |  6 +++-
 app/test_main.py    | 83 +++++++++++++++++++++++++++++++++++++++++----
 2 files changed, 81 insertions(+), 8 deletions(-)

diff --git a/app/routes/entry.py b/app/routes/entry.py
index 9b24730..dc95dea 100644
--- a/app/routes/entry.py
+++ b/app/routes/entry.py
@@ -1,6 +1,9 @@
 from creyPY.fastapi.crud import (
     create_obj_from_data,
 )
+from creyPY.fastapi.order_by import order_by
+from typing import Any, Callable
+from sqlalchemy.sql.selectable import Select
 from creyPY.fastapi.db.session import get_db
 from fastapi import APIRouter, Depends, Security, HTTPException
 from sqlalchemy.orm import Session
@@ -60,6 +63,7 @@ async def get_log(
 @router.get("/")
 async def get_logs(
     search: str | SkipJsonSchema[None] = None,
+    order_by_query: Callable[[Select], Select] = Depends(order_by),
     sub: str = Security(verify),
     db: Session = Depends(get_db),
 ) -> Page[LogOUT]:
@@ -73,4 +77,4 @@ async def get_logs(
         the_select = the_select.filter(
             LogEntry.message.ilike(f"%{search}%") | LogEntry.author.ilike(f"%{search}%")
         )
-    return paginate(db, the_select)
+    return paginate(db, order_by_query(the_select))
diff --git a/app/test_main.py b/app/test_main.py
index 99dd857..e08df32 100644
--- a/app/test_main.py
+++ b/app/test_main.py
@@ -21,6 +21,34 @@ def app_context(self, name: str = "Testing"):
         self.destroy_app(app_id)
 
 
+@contextlib.contextmanager
+def log_examples(self):
+    LOG_EXAMPLES = [
+        {"l_type": "info", "t_type": "create", "message": "User Max Mustermann created"},
+        {"l_type": "info", "t_type": "update", "message": "User Max Mustermann updated"},
+        {
+            "l_type": "info",
+            "t_type": "create",
+            "author": "auth|max_muster",
+            "message": "User Max Mustermann created a Unit",
+            "object_reference": "1",
+        },
+        {
+            "l_type": "info",
+            "t_type": "update",
+            "author": "auth|max_muster",
+            "message": "User Max Mustermann updated Unit 1",
+            "object_reference": "1",
+            "previous_object": {"name": "Unit 1"},
+        },
+        {"l_type": "info", "t_type": "delete", "message": "User Max Mustermann deleted"},
+    ]
+    with app_context(self) as app_id:
+        for entry in LOG_EXAMPLES:
+            self.log_message({"application": app_id, **entry})
+        yield app_id
+
+
 class TestAPI:
     def setup_class(self):
         self.engine = create_engine(SQLALCHEMY_DATABASE_URL + "test", pool_pre_ping=True)
@@ -48,6 +76,19 @@ class TestAPI:
     def teardown_class(self):
         drop_database(self.engine.url)
 
+    # HELPERS
+    def create_app(self, name: str = "Testing"):
+        re = self.c.post("/app/", {"name": name})
+        return re["id"]
+
+    def destroy_app(self, app_id):
+        self.c.delete(f"/app/{app_id}")
+
+    def log_message(self, entry_obj):
+        re = self.c.post("/log/", entry_obj)
+        return re["id"]
+
+    # GENERIC TEST CASES
     def test_swagger_gen(self):
         re = self.c.get("/openapi.json")
         assert re["info"]["title"] == "ApiLog API"
@@ -55,6 +96,7 @@ class TestAPI:
     def test_health_check(self):
         self.c.get("/", parse_json=False)
 
+    # TESTS for module application
     def test_application_api(self):
         self.c.obj_lifecycle({"name": "Testing"}, "/app/")
 
@@ -73,13 +115,7 @@ class TestAPI:
                 assert re["total"] == 1
                 assert len(re["results"]) == 1
 
-    def create_app(self, name: str = "Testing"):
-        re = self.c.post("/app/", {"name": name})
-        return re["id"]
-
-    def destroy_app(self, app_id):
-        self.c.delete(f"/app/{app_id}")
-
+    # TESTS for module log
     def test_log_api(self):
         with app_context(self) as app_id:
             self.c.obj_lifecycle({"application": app_id}, "/log/")
@@ -98,3 +134,36 @@ class TestAPI:
             assert re["created_by_id"] == CURRENT_USER
 
             self.c.delete(f"/log/{log_id}")
+
+    def test_logging_search(self):
+        with log_examples(self) as app_id:
+            re = self.c.get("/log/")
+            assert re["total"] == 5
+            assert len(re["results"]) == 5
+
+            re = self.c.get("/log/?search=auth|max_muster")
+            assert re["total"] == 2
+            assert len(re["results"]) == 2
+
+            re = self.c.get("/log/?search=system")
+            assert re["total"] == 3
+            assert len(re["results"]) == 3
+
+            re = self.c.get("/log/?search=created%20a%20Unit")
+            assert re["total"] == 1
+            assert len(re["results"]) == 1
+
+    def test_logging_order(self):
+        with log_examples(self) as app_id:
+            re = self.c.get("/log/?order_by=created_at")
+            assert re["total"] == 5
+            assert len(re["results"]) == 5
+            assert re["results"][0]["created_at"] < re["results"][1]["created_at"]
+
+            re = self.c.get("/log/?order_by=-created_at")
+            assert re["total"] == 5
+            assert len(re["results"]) == 5
+            assert re["results"][0]["created_at"] > re["results"][1]["created_at"]
+
+    # def test_logging_filter(self):
+    #     pass