fix: make all datetimes timezone aware

Author: jbriones1

src/elections/tables.py

@@ -24,9 +24,9 @@ class Election(Base):
     slug: Mapped[str] = mapped_column(String(MAX_ELECTION_SLUG), primary_key=True)
     name: Mapped[str] = mapped_column(String(MAX_ELECTION_NAME), nullable=False)
     type: Mapped[str] = mapped_column(String(64), default="general_election")
-    datetime_start_nominations: Mapped[datetime] = mapped_column(DateTime(), nullable=False)
-    datetime_start_voting: Mapped[datetime] = mapped_column(DateTime(), nullable=False)
-    datetime_end_voting: Mapped[datetime] = mapped_column(DateTime(), nullable=False)
+    datetime_start_nominations: Mapped[datetime] = mapped_column(DateTime(timezone=True), nullable=False)
+    datetime_start_voting: Mapped[datetime] = mapped_column(DateTime(timezone=True), nullable=False)
+    datetime_end_voting: Mapped[datetime] = mapped_column(DateTime(timezone=True), nullable=False)
 
     # a comma-separated string of positions which must be elements of OfficerPosition
     # By giving it the type `StringList`, the database entry will automatically be marshalled to the correct form

src/elections/urls.py

@@ -1,4 +1,4 @@
-from datetime import datetime
+import datetime
 
 from fastapi import APIRouter, HTTPException, Request, status
 from fastapi.responses import JSONResponse
@@ -53,9 +53,9 @@ def _default_election_positions(election_type: ElectionTypeEnum) -> list[Officer
 def _raise_if_bad_election_data(
     slug: str,
     election_type: str,
-    datetime_start_nominations: datetime,
-    datetime_start_voting: datetime,
-    datetime_end_voting: datetime,
+    datetime_start_nominations: datetime.datetime,
+    datetime_start_voting: datetime.datetime,
+    datetime_end_voting: datetime.datetime,
     available_positions: list[OfficerPositionEnum]
 ):
     if election_type not in ElectionTypeEnum:
@@ -104,7 +104,7 @@ async def list_elections(
             detail="no election found"
         )
 
-    current_time = datetime.now()
+    current_time = datetime.datetime.now(tz=datetime.UTC)
     if is_admin:
         election_metadata_list = [
             election.private_details(current_time)
@@ -136,7 +136,7 @@ async def get_election(
     db_session: database.DBSession,
     election_name: str
 ):
-    current_time = datetime.now()
+    current_time = datetime.datetime.now(tz=datetime.UTC)
     slugified_name = slugify(election_name)
     election = await elections.crud.get_election(db_session, slugified_name)
     if election is None:
@@ -218,10 +218,10 @@ async def create_election(
         available_positions = body.available_positions
 
     slugified_name = slugify(body.name)
-    current_time = datetime.now()
-    start_nominations = datetime.fromisoformat(body.datetime_start_nominations)
-    start_voting = datetime.fromisoformat(body.datetime_start_voting)
-    end_voting = datetime.fromisoformat(body.datetime_end_voting)
+    current_time = datetime.datetime.now(tz=datetime.UTC)
+    start_nominations = datetime.datetime.fromisoformat(body.datetime_start_nominations)
+    start_voting = datetime.datetime.fromisoformat(body.datetime_start_voting)
+    end_voting = datetime.datetime.fromisoformat(body.datetime_end_voting)
 
     # TODO: We might be able to just use a validation function from Pydantic or SQLAlchemy to check this
     _raise_if_bad_election_data(
@@ -332,7 +332,7 @@ async def update_election(
     election = await elections.crud.get_election(db_session, slugified_name)
     if election is None:
         raise HTTPException(status_code=status.HTTP_500_INTERNAL_SERVER_ERROR, detail="couldn't find updated election")
-    return JSONResponse(election.private_details(datetime.now()))
+    return JSONResponse(election.private_details(datetime.datetime.now(tz=datetime.UTC)))
 
 @router.delete(
     "/{election_name:str}",

src/registrations/urls.py

@@ -1,4 +1,4 @@
-from datetime import datetime
+import datetime
 
 from fastapi import APIRouter, HTTPException, Request, status
 from fastapi.responses import JSONResponse
@@ -105,7 +105,7 @@ async def register_in_election(
             detail=f"{body.position} is not available to register for in this election"
         )
 
-    if election.status(datetime.now()) != ElectionStatusEnum.NOMINATIONS:
+    if election.status(datetime.datetime.now(tz=datetime.UTC)) != ElectionStatusEnum.NOMINATIONS:
         raise HTTPException(
             status_code=status.HTTP_400_BAD_REQUEST,
             detail="registrations can only be made during the nomination period"
@@ -174,7 +174,7 @@ async def update_registration(
         )
 
     # self updates can only be done during nomination period. Officer updates can be done whenever
-    if election.status(datetime.now()) != ElectionStatusEnum.NOMINATIONS:
+    if election.status(datetime.datetime.now(tz=datetime.UTC)) != ElectionStatusEnum.NOMINATIONS:
         raise HTTPException(
             status_code=status.HTTP_400_BAD_REQUEST,
             detail="speeches can only be updated during the nomination period"
@@ -237,7 +237,7 @@ async def delete_registration(
             detail=f"election with slug {slugified_name} does not exist"
         )
 
-    if election.status(datetime.now()) != ElectionStatusEnum.NOMINATIONS:
+    if election.status(datetime.datetime.now(tz=datetime.UTC)) != ElectionStatusEnum.NOMINATIONS:
         raise HTTPException(
             status_code=status.HTTP_400_BAD_REQUEST,
             detail="registration can only be revoked during the nomination period"

tests/integration/test_elections.py

@@ -1,5 +1,6 @@
 import asyncio
-from datetime import datetime, timedelta
+import datetime
+from datetime import timedelta
 
 import pytest
 from httpx import ASGITransport, AsyncClient
@@ -197,9 +198,9 @@ async def test_endpoints_admin(client, database_setup):
     response = await client.post("/election", json={
         "name": "testElection4",
         "type": "general_election",
-        "datetime_start_nominations": (datetime.now() - timedelta(days=1)).isoformat(),
-        "datetime_start_voting": (datetime.now() + timedelta(days=7)).isoformat(),
-        "datetime_end_voting": (datetime.now() + timedelta(days=14)).isoformat(),
+        "datetime_start_nominations": (datetime.datetime.now(tz=datetime.UTC) - timedelta(days=1)).isoformat(),
+        "datetime_start_voting": (datetime.datetime.now(tz=datetime.UTC) + timedelta(days=7)).isoformat(),
+        "datetime_end_voting": (datetime.datetime.now(tz=datetime.UTC) + timedelta(days=14)).isoformat(),
         "available_positions": ["president", "treasurer"],
         "survey_link": "https://youtu.be/dQw4w9WgXcQ?si=kZROi2tu-43MXPM5"
     })
@@ -208,9 +209,9 @@ async def test_endpoints_admin(client, database_setup):
     response = await client.post("/election", json={
         "name": "byElection4",
         "type": "by_election",
-        "datetime_start_nominations": (datetime.now() - timedelta(days=1)).isoformat(),
-        "datetime_start_voting": (datetime.now() + timedelta(days=7)).isoformat(),
-        "datetime_end_voting": (datetime.now() + timedelta(days=14)).isoformat(),
+        "datetime_start_nominations": (datetime.datetime.now(tz=datetime.UTC) - timedelta(days=1)).isoformat(),
+        "datetime_start_voting": (datetime.datetime.now(tz=datetime.UTC) + timedelta(days=7)).isoformat(),
+        "datetime_end_voting": (datetime.datetime.now(tz=datetime.UTC) + timedelta(days=14)).isoformat(),
         "survey_link": "https://youtu.be/dQw4w9WgXcQ?si=kZROi2tu-43MXPM5"
     })
     assert response.status_code == 200
@@ -275,9 +276,9 @@ async def test_endpoints_admin(client, database_setup):
     # update the above election
     response = await client.patch("/election/testElection4", json={
         "election_type": "general_election",
-        "datetime_start_nominations": (datetime.now() - timedelta(days=1)).isoformat(),
-        "datetime_start_voting": (datetime.now() + timedelta(days=7)).isoformat(),
-        "datetime_end_voting": (datetime.now() + timedelta(days=14)).isoformat(),
+        "datetime_start_nominations": (datetime.datetime.now(tz=datetime.UTC) - timedelta(days=1)).isoformat(),
+        "datetime_start_voting": (datetime.datetime.now(tz=datetime.UTC) + timedelta(days=7)).isoformat(),
+        "datetime_end_voting": (datetime.datetime.now(tz=datetime.UTC) + timedelta(days=14)).isoformat(),
         "available_positions": ["president", "vice-president", "treasurer"],  # update this
         "survey_link": "https://youtu.be/dQw4w9WgXcQ?si=kZROi2tu-43MXPM5"
     })