test: Added a test for the context manager

Author: Robin-Van-de-Merghel

diracx-db/src/diracx/db/sql/utils/__init__.py

@@ -6,7 +6,7 @@
     apply_search_filters,
     apply_sort_constraints,
 )
-from .functions import hash, substract_date, utcnow
+from .functions import DBStateAssertion, hash, substract_date, utcnow
 from .types import Column, DateNowColumn, EnumBackedBool, EnumColumn, NullColumn
 
 __all__ = (
@@ -22,4 +22,5 @@
     "substract_date",
     "hash",
     "SQLDBUnavailableError",
+    "DBStateAssertion",
 )

diracx-db/src/diracx/db/sql/utils/functions.py

@@ -117,8 +117,10 @@ def hash(code: str):
     return hashlib.sha256(code.encode()).hexdigest()
 
 
-class DBStateAssertation:
-    """Class to handler context where we should not raise any excepted error.
+class DBStateAssertion:
+    """Context manager to ensure the integrity of a database transaction,
+    specifically by rolling back any changes if certain expected exceptions
+    occur—and raising a standardized error to indicate the database is in a bad state.
 
     Example:
     with DBStateAssertation(self.conn, [PilotNotFoundError, SecretNotFoundError]):
@@ -143,21 +145,21 @@ async def __aexit__(self, exc_type, exc_value, exc_tb):
             # No exception occurred
             return False
 
-        # If we get here, an error occured, so we rollback changes
+        # If we get here, an error occurred, so we rollback changes
         await self.conn.rollback()
 
         # Check if the exception is among the expected ones
         if any(issubclass(exc_type, exc) for exc in self.exceptions):
             logger.error(
-                f"An error occured with the db, exception message: {exc_value}"
+                f"An error occurred with the db, exception message: {exc_value}"
             )
             raise DBInBadStateError(
                 "This error may NOT have been raised. "
-                "Please report this error: https://github.com/DIRACGrid/diracx/issues"
+                "Please report this at https://github.com/DIRACGrid/diracx/issues"
             ) from exc_value
 
         # Not an expected exception; raise an unexpected error
         raise DBInBadStateError(
-            "This should NOT happen. A miscellaneous error occured. "
-            "Please report this error: https://github.com/DIRACGrid/diracx/issues"
+            f"Unexpected error ({exc_type.__name__}): {exc_value}. "
+            "Please report this at https://github.com/DIRACGrid/diracx/issues"
         ) from exc_value

diracx-db/tests/test_context_manager.py

@@ -0,0 +1,82 @@
+from __future__ import annotations
+
+import pytest
+from sqlalchemy.exc import IntegrityError
+from uuid_utils import uuid7
+
+from diracx.db.exceptions import DBInBadStateError
+from diracx.db.sql.auth.db import AuthDB
+from diracx.db.sql.utils import DBStateAssertion
+
+
+@pytest.fixture
+async def auth_db(tmp_path):
+    auth_db = AuthDB("sqlite+aiosqlite:///:memory:")
+    async with auth_db.engine_context():
+        async with auth_db.engine.begin() as conn:
+            await conn.run_sync(auth_db.metadata.create_all)
+        yield auth_db
+
+
+async def test_context_manager(auth_db: AuthDB):
+    """We will test with refresh tokens the context manager.
+
+    1. Insert a refresh token in the DB with a proper jti
+    2. Insert a refresh token with another jti
+    3. Insert a refresh token with the first jti, except the right error /!\
+    4. Insert a refresh token with the first jti, except the wrong error /!\
+
+    1. and 2. should pass
+    3. and 4. should raise DBInBadStateError
+
+    3. Saying that the expected error was raised.
+    4. Saying that an unexpected error was raised.
+    """
+    # Insert a refresh token details
+    async with auth_db as auth_db:
+        jti = uuid7()
+        await auth_db.insert_refresh_token(
+            jti,
+            "subject",
+            "scope",
+        )
+
+    # Revoke the token
+    async with auth_db as auth_db:
+
+        # No error should be raised
+        async with DBStateAssertion(auth_db.conn, [IntegrityError]):
+            await auth_db.insert_refresh_token(
+                uuid7(),
+                "subject",
+                "scope",
+            )
+
+        # Await the right error (IntegrityError)
+        with pytest.raises(DBInBadStateError) as exc_info:
+            # DBInBadStateError because we say that IntegrityError should not be raised
+            async with DBStateAssertion(auth_db.conn, [IntegrityError]):
+                await auth_db.insert_refresh_token(
+                    jti,
+                    "subject",
+                    "scope",
+                )
+
+        assert (
+            str(exc_info.value)
+            == "This error may NOT have been raised. Please report this at https://github.com/DIRACGrid/diracx/issues"
+        )
+
+        # Await the wrong error
+        with pytest.raises(DBInBadStateError) as exc_info:
+            # DBInBadStateError because we say that IntegrityError should not be raised
+            async with DBStateAssertion(auth_db.conn, [ValueError]):
+                await auth_db.insert_refresh_token(
+                    jti,
+                    "subject",
+                    "scope",
+                )
+
+        # (We use "in" because the error details can change depending on the engine)
+        assert str(exc_info.value).startswith("Unexpected error (IntegrityError):")
+        assert "IntegrityError" in str(exc_info)