add avaliable positions & make it configurable. clean code too

EarthenSky · EarthenSky · commit a32f905f68fb · 2025-04-11T14:20:46.000-07:00
diff --git a/src/alembic/versions/243190df5588_create_election_tables.py b/src/alembic/versions/243190df5588_create_election_tables.py
@@ -28,6 +28,7 @@ def upgrade() -> None:
         sa.Column("datetime_start_nominations", sa.DateTime(), nullable=False),
         sa.Column("datetime_start_voting", sa.DateTime(), nullable=False),
         sa.Column("datetime_end_voting", sa.DateTime(), nullable=False),
+        sa.Column("avaliable_positions", sa.Text(), nullable=False),
         sa.Column("survey_link", sa.String(length=300), nullable=True),
         sa.PrimaryKeyConstraint("slug")
     )
diff --git a/src/elections/crud.py b/src/elections/crud.py
@@ -22,36 +22,27 @@ async def get_election(db_session: AsyncSession, election_slug: str) -> Election
         .where(Election.slug == election_slug)
     )
 
-async def create_election(db_session: AsyncSession, election: Election) -> None:
+async def create_election(db_session: AsyncSession, election: Election):
     """
     Creates a new election with given parameters.
     Does not validate if an election _already_ exists
     """
     db_session.add(election)
 
-async def update_election(db_session: AsyncSession, new_election: Election) -> bool:
+async def update_election(db_session: AsyncSession, new_election: Election):
     """
-    You attempting to change the name or slug will fail. Instead, you must create a new election.
+    Attempting to change slug will fail. Instead, you must create a new election.
     """
-    target_slug = new_election.slug
-    # TODO: does this check need to be performed?
-    target_election = await get_election(db_session, target_slug)
-
-    if target_election is None:
-        return False
-    else:
-        await db_session.execute(
-            sqlalchemy
-            .update(Election)
-            .where(Election.slug == target_slug)
-            .values(new_election.to_update_dict())
-        )
-        return True
+    await db_session.execute(
+        sqlalchemy
+        .update(Election)
+        .where(Election.slug == new_election.slug)
+        .values(new_election.to_update_dict())
+    )
 
 async def delete_election(db_session: AsyncSession, slug: str) -> None:
     """
-    Deletes a given election by its slug.
-    Does not validate if an election exists
+    Deletes a given election by its slug. Does not validate if an election exists
     """
     await db_session.execute(
         sqlalchemy
diff --git a/src/elections/tables.py b/src/elections/tables.py
@@ -16,9 +16,15 @@
     DISCORD_NICKNAME_LEN,
 )
 from database import Base
+from officers.constants import COUNCIL_REP_ELECTION_POSITIONS, GENERAL_ELECTION_POSITIONS
 
+# If you wish to add more elections & defaults, please see `create_election`
 election_types = ["general_election", "by_election", "council_rep_election"]
 
+DEFAULT_POSITIONS_GENERAL_ELECTION = ",".join(GENERAL_ELECTION_POSITIONS)
+DEFAULT_POSITIONS_BY_ELECTION = ",".join(GENERAL_ELECTION_POSITIONS)
+DEFAULT_POSITIONS_COUNCIL_REP_ELECTION = ",".join(COUNCIL_REP_ELECTION_POSITIONS)
+
 STATUS_BEFORE_NOMINATIONS = "before_nominations"
 STATUS_NOMINATIONS = "nominations"
 STATUS_VOTING = "voting"
@@ -37,6 +43,9 @@ class Election(Base):
     datetime_start_nominations = Column(DateTime, nullable=False)
     datetime_start_voting = Column(DateTime, nullable=False)
     datetime_end_voting = Column(DateTime, nullable=False)
+
+    # a csv list of positions which must be elements of OfficerPosition
+    avaliable_positions = Column(Text, nullable=False)
     survey_link = Column(String(300))
 
     def private_details(self, at_time: datetime) -> dict:
@@ -51,10 +60,26 @@ def private_details(self, at_time: datetime) -> dict:
             "datetime_end_voting": self.datetime_end_voting.isoformat(),
 
             "status": self.status(at_time),
+            "avaliable_positions": self.avaliable_positions,
             "survey_link": self.survey_link,
         }
 
     def public_details(self, at_time: datetime) -> dict:
+        # is serializable
+        return {
+            "slug": self.slug,
+            "name": self.name,
+            "type": self.type,
+
+            "datetime_start_nominations": self.datetime_start_nominations.isoformat(),
+            "datetime_start_voting": self.datetime_start_voting.isoformat(),
+            "datetime_end_voting": self.datetime_end_voting.isoformat(),
+
+            "status": self.status(at_time),
+            "avaliable_positions": self.avaliable_positions,
+        }
+
+    def public_metadata(self, at_time: datetime) -> dict:
         # is serializable
         return {
             "slug": self.slug,
@@ -78,6 +103,7 @@ def to_update_dict(self) -> dict:
             "datetime_start_voting": self.datetime_start_voting,
             "datetime_end_voting": self.datetime_end_voting,
 
+            "avaliable_positions": self.avaliable_positions,
             "survey_link": self.survey_link,
         }
 
diff --git a/src/elections/urls.py b/src/elections/urls.py
@@ -7,6 +7,7 @@
 
 import database
 import elections
+import elections.tables
 from elections.tables import Election, NomineeApplication, election_types
 from officers.constants import OfficerPosition
 from permission.types import ElectionOfficer, WebsiteAdmin
@@ -56,7 +57,7 @@ async def list_elections(
 
     current_time = datetime.now()
     election_metadata_list = [
-        election.public_details(current_time)
+        election.public_metadata(current_time)
         for election in election_list
     ]
 
@@ -94,6 +95,45 @@ async def get_election(
 
     return JSONResponse(election_json)
 
+def _raise_if_bad_election_data(
+    name: str,
+    election_type: str,
+    datetime_start_nominations: datetime,
+    datetime_start_voting: datetime,
+    datetime_end_voting: datetime,
+    avaliable_positions: str | None,
+):
+    if election_type not in election_types:
+        raise HTTPException(
+            status_code=status.HTTP_400_BAD_REQUEST,
+            detail=f"unknown election type {election_type}",
+        )
+    elif not (
+        (datetime_start_nominations <= datetime_start_voting)
+        and (datetime_start_voting <= datetime_end_voting)
+    ):
+        raise HTTPException(
+            status_code=status.HTTP_400_BAD_REQUEST,
+            detail="dates must be in order from earliest to latest",
+        )
+    elif avaliable_positions is not None:
+        for position in avaliable_positions.split(","):
+            if position not in OfficerPosition.position_list():
+                raise HTTPException(
+                    status_code=status.HTTP_400_BAD_REQUEST,
+                    detail=f"unknown position found in position list {position}",
+                )
+    elif len(name) > elections.tables.MAX_ELECTION_NAME:
+        raise HTTPException(
+            status_code=status.HTTP_400_BAD_REQUEST,
+            detail=f"election name {name} is too long",
+        )
+    elif len(_slugify(name)) > elections.tables.MAX_ELECTION_SLUG:
+        raise HTTPException(
+            status_code=status.HTTP_400_BAD_REQUEST,
+            detail=f"election slug {_slugify(name)} is too long",
+        )
+
 @router.post(
     "/by_name/{name:str}",
     description="Creates an election and places it in the database. Returns election json on success",
@@ -106,15 +146,19 @@ async def create_election(
     datetime_start_nominations: datetime,
     datetime_start_voting: datetime,
     datetime_end_voting: datetime,
+    # allows None, which assigns it to the default
+    avaliable_positions: str | None,
     survey_link: str | None,
 ):
     current_time = datetime.now()
-
-    if election_type not in election_types:
-        raise HTTPException(
-            status_code=status.HTTP_400_BAD_REQUEST,
-            detail=f"unknown election type {election_type}",
-        )
+    _raise_if_bad_election_data(
+        name,
+        election_type,
+        datetime_start_nominations,
+        datetime_start_voting,
+        datetime_end_voting,
+        avaliable_positions,
+    )
 
     is_valid_user, _, _ = await _validate_user(request, db_session)
     if not is_valid_user:
@@ -124,30 +168,25 @@ async def create_election(
             # TODO: is this header actually required?
             headers={"WWW-Authenticate": "Basic"},
         )
-    elif len(name) > elections.tables.MAX_ELECTION_NAME:
-        raise HTTPException(
-            status_code=status.HTTP_400_BAD_REQUEST,
-            detail=f"election name {name} is too long",
-        )
-    elif len(_slugify(name)) > elections.tables.MAX_ELECTION_SLUG:
-        raise HTTPException(
-            status_code=status.HTTP_400_BAD_REQUEST,
-            detail=f"election slug {_slugify(name)} is too long",
-        )
     elif await elections.crud.get_election(db_session, _slugify(name)) is not None:
         # don't overwrite a previous election
         raise HTTPException(
             status_code=status.HTTP_400_BAD_REQUEST,
             detail="would overwrite previous election",
         )
-    elif not (
-        (datetime_start_nominations <= datetime_start_voting)
-        and (datetime_start_voting <= datetime_end_voting)
-    ):
-        raise HTTPException(
-            status_code=status.HTTP_400_BAD_REQUEST,
-            detail="dates must be in order from earliest to latest",
-        )
+
+    if avaliable_positions is None:
+        if election_type == "general_election":
+            avaliable_positions = elections.tables.DEFAULT_POSITIONS_GENERAL_ELECTION
+        elif election_type == "by_election":
+            avaliable_positions = elections.tables.DEFAULT_POSITIONS_BY_ELECTION
+        elif election_type == "council_rep_election":
+            avaliable_positions = elections.tables.DEFAULT_POSITIONS_COUNCIL_REP_ELECTION
+        else:
+            raise HTTPException(
+                status_code=status.HTTP_400_BAD_REQUEST,
+                detail=f"invalid election type {election_type} for avaliable positions"
+            )
 
     await elections.crud.create_election(
         db_session,
@@ -158,6 +197,7 @@ async def create_election(
             datetime_start_nominations = datetime_start_nominations,
             datetime_start_voting = datetime_start_voting,
             datetime_end_voting = datetime_end_voting,
+            avaliable_positions = avaliable_positions,
             survey_link = survey_link
         )
     )
@@ -185,47 +225,49 @@ async def update_election(
     datetime_start_nominations: datetime,
     datetime_start_voting: datetime,
     datetime_end_voting: datetime,
+    avaliable_positions: str,
     survey_link: str | None,
 ):
     current_time = datetime.now()
+    _raise_if_bad_election_data(
+        name,
+        election_type,
+        datetime_start_nominations,
+        datetime_start_voting,
+        datetime_end_voting,
+        avaliable_positions,
+    )
 
     is_valid_user, _, _ = await _validate_user(request, db_session)
     if not is_valid_user:
-        # let's workshop how we actually wanna handle this
         raise HTTPException(
             status_code=status.HTTP_401_UNAUTHORIZED,
             detail="must have election officer or admin permission",
             headers={"WWW-Authenticate": "Basic"},
         )
-    elif not (
-        (datetime_start_nominations <= datetime_start_voting)
-        and (datetime_start_voting <= datetime_end_voting)
-    ):
+    elif await elections.crud.get_election(db_session, _slugify(name)) is None:
         raise HTTPException(
             status_code=status.HTTP_400_BAD_REQUEST,
-            detail="dates must be in order from earliest to latest",
+            detail=f"election with slug {_slugify(name)} does not exist",
         )
 
-    new_election = Election(
-        slug = _slugify(name),
-        name = name,
-        type = election_type,
-        datetime_start_nominations = datetime_start_nominations,
-        datetime_start_voting = datetime_start_voting,
-        datetime_end_voting = datetime_end_voting,
-        survey_link = survey_link
-    )
-    success = await elections.crud.update_election(db_session, new_election)
-    if not success:
-        raise HTTPException(
-            status_code=status.HTTP_400_BAD_REQUEST,
-            detail=f"election with slug {_slugify(name)} does not exist",
+    await elections.crud.update_election(
+        db_session,
+        Election(
+            slug = _slugify(name),
+            name = name,
+            type = election_type,
+            datetime_start_nominations = datetime_start_nominations,
+            datetime_start_voting = datetime_start_voting,
+            datetime_end_voting = datetime_end_voting,
+            avaliable_positions = avaliable_positions,
+            survey_link = survey_link
         )
-    else:
-        await db_session.commit()
+    )
+    await db_session.commit()
 
-        election = await elections.crud.get_election(db_session, _slugify(name))
-        return JSONResponse(election.private_details(current_time))
+    election = await elections.crud.get_election(db_session, _slugify(name))
+    return JSONResponse(election.private_details(current_time))
 
 @router.delete(
     "/by_name/{name:str}",
diff --git a/src/officers/constants.py b/src/officers/constants.py
@@ -175,3 +175,22 @@ def expected_positions() -> list[str]:
     OfficerPosition.WEBMASTER,
     OfficerPosition.SOCIAL_MEDIA_MANAGER,
 ]
+
+GENERAL_ELECTION_POSITIONS = [
+    OfficerPosition.PRESIDENT,
+    OfficerPosition.VICE_PRESIDENT,
+    OfficerPosition.TREASURER,
+
+    OfficerPosition.DIRECTOR_OF_RESOURCES,
+    OfficerPosition.DIRECTOR_OF_EVENTS,
+    OfficerPosition.DIRECTOR_OF_EDUCATIONAL_EVENTS,
+    OfficerPosition.ASSISTANT_DIRECTOR_OF_EVENTS,
+    OfficerPosition.DIRECTOR_OF_COMMUNICATIONS,
+    #OfficerPosition.DIRECTOR_OF_OUTREACH,
+    OfficerPosition.DIRECTOR_OF_MULTIMEDIA,
+    OfficerPosition.DIRECTOR_OF_ARCHIVES,
+]
+
+COUNCIL_REP_ELECTION_POSITIONS = [
+    OfficerPosition.SFSS_COUNCIL_REPRESENTATIVE,
+]

Original file line number	Diff line number	Diff line change
`@@ -28,6 +28,7 @@ def upgrade() -> None:`
`28`	`28`	`sa.Column("datetime_start_nominations", sa.DateTime(), nullable=False),`
`29`	`29`	`sa.Column("datetime_start_voting", sa.DateTime(), nullable=False),`
`30`	`30`	`sa.Column("datetime_end_voting", sa.DateTime(), nullable=False),`
	`31`	`+ sa.Column("avaliable_positions", sa.Text(), nullable=False),`
`31`	`32`	`sa.Column("survey_link", sa.String(length=300), nullable=True),`
`32`	`33`	`sa.PrimaryKeyConstraint("slug")`
`33`	`34`	`)`