Updated fixture name from 'ispyb_db' to 'ispyb_db_session'

Author: tieneupin

tests/conftest.py

@@ -128,9 +128,9 @@ def get_or_create_db_entry(
     insert_kwargs: dict[str, Any] = {},
 ) -> SQLAlchemyTable:
     """
-    Helper function to facilitate looking up SQLAlchemy tables for
-    matching entries. Returns the entry if it exists and creates it
-    if it doesn't.
+    Helper function to facilitate looking up or creating SQLAlchemy table entries.
+    Returns the entry if a match based on the lookup criteria is found, otherwise
+    creates and returns a new entry.
     """
 
     # if lookup kwargs are provided, check if entry exists
@@ -143,6 +143,7 @@ def get_or_create_db_entry(
         )
         if entry:
             return entry
+
     # If not present, create and return new entry
     # Use new kwargs if provided; otherwise, use lookup kwargs
     insert_kwargs = insert_kwargs or lookup_kwargs
@@ -153,14 +154,14 @@ def get_or_create_db_entry(
 
 
 @pytest.fixture(scope="session")
-def ispyb_session_factory(ispyb_engine):
+def ispyb_db_session_factory(ispyb_engine):
     factory = scoped_session(sessionmaker(bind=ispyb_engine))
-    ispyb_db = factory()
 
     # Populate the ISPyB table with some initial values
     # Return existing table entry if already present
+    ispyb_db_session = factory()
     person_db_entry = get_or_create_db_entry(
-        session=ispyb_db,
+        session=ispyb_db_session,
         table=Person,
         lookup_kwargs={
             "givenName": ExampleVisit.given_name,
@@ -169,37 +170,41 @@ def ispyb_session_factory(ispyb_engine):
         },
     )
     proposal_db_entry = get_or_create_db_entry(
-        session=ispyb_db,
+        session=ispyb_db_session,
         table=Proposal,
         lookup_kwargs={
             "personId": person_db_entry.personId,
             "proposalCode": ExampleVisit.proposal_code,
             "proposalNumber": str(ExampleVisit.proposal_number),
         },
     )
-    bl_session_db_entry = get_or_create_db_entry(
-        session=ispyb_db,
+    _ = get_or_create_db_entry(
+        session=ispyb_db_session,
         table=BLSession,
         lookup_kwargs={
             "proposalId": proposal_db_entry.proposalId,
             "beamLineName": ExampleVisit.instrument_name,
             "visit_number": ExampleVisit.visit_number,
         },
     )
-    ispyb_db.add(bl_session_db_entry)
-    ispyb_db.commit()
-
-    ispyb_db.close()
+    ispyb_db_session.close()
     return factory  # Return its current state
 
 
 @pytest.fixture
-def ispyb_db(ispyb_session_factory) -> Generator[SQLAlchemySession, None, None]:
+def ispyb_db_session(
+    ispyb_db_session_factory,
+) -> Generator[SQLAlchemySession, None, None]:
+
     # Get a new session from the session factory
-    ispyb_db: SQLAlchemySession = ispyb_session_factory()
-    yield ispyb_db
-    ispyb_db.rollback()
-    ispyb_db.close()
+    ispyb_db_session: SQLAlchemySession = ispyb_db_session_factory()
+
+    # Let other function run
+    yield ispyb_db_session
+
+    # Tidy up after function is complete
+    ispyb_db_session.rollback()
+    ispyb_db_session.close()
 
 
 """

tests/server/test_ispyb.py

@@ -7,11 +7,11 @@
 
 
 def test_get_session_id(
-    ispyb_db: Session,
+    ispyb_db_session: Session,
 ):
     # Manually get the BLSession ID for comparison
     query = (
-        ispyb_db.execute(
+        ispyb_db_session.execute(
             select(BLSession)
             .join(Proposal)
             .where(BLSession.proposalId == Proposal.proposalId)
@@ -30,17 +30,17 @@ def test_get_session_id(
         proposal_code=ExampleVisit.proposal_code,
         proposal_number=str(ExampleVisit.proposal_number),
         visit_number=str(ExampleVisit.visit_number),
-        db=ispyb_db,
+        db=ispyb_db_session,
     )
     assert query == result
 
 
 def test_get_proposal_id(
-    ispyb_db: Session,
+    ispyb_db_session: Session,
 ):
     # Manually query the Proposal ID
     query = (
-        ispyb_db.execute(
+        ispyb_db_session.execute(
             select(Proposal)
             .where(Proposal.proposalCode == ExampleVisit.proposal_code)
             .where(Proposal.proposalNumber == ExampleVisit.proposal_number)
@@ -53,6 +53,6 @@ def test_get_proposal_id(
     result = get_proposal_id(
         proposal_code=ExampleVisit.proposal_code,
         proposal_number=ExampleVisit.proposal_number,
-        db=ispyb_db,
+        db=ispyb_db_session,
     )
     assert query == result