Make officers module more DRY (#94)

* add DELETE /term endpoint

* fix and test delete term endpoint

* switch to using date instead of datetime for officer term + cleaning

* clean up todos

* allow changing computing_id by admins

* remove tests backend endpoints (use fe instead please)

* fix tests and add basic endpoint tests

* many small bug fixes

* Update alembic.yml for python3.11

* add integration tests

Author: EarthenSky

.github/workflows/alembic.yml

@@ -32,7 +32,9 @@ jobs:
 
       - name: Install dependencies
         run: |
-          sudo apt-get install python3.11 python3.11-venv
+          # for python3.11 (dear internet gods: we'll update to 3.13 or something in a year, i promise)
+          sudo add-apt-repository ppa:deadsnakes/ppa
+          sudo apt install python3.11 python3.11-venv
           python3.11 -m pip install --upgrade pip
           python3.11 -m venv venv
           source ./venv/bin/activate

requirements.txt

@@ -1,5 +1,5 @@
 # major
-fastapi==0.109.1
+fastapi==0.115.6
 gunicorn==21.2.0
 uvicorn[standard]==0.27.1
 sqlalchemy[asyncio]==2.0.27
@@ -19,3 +19,4 @@ ruff==0.6.9
 # test
 pytest
 pytest-asyncio
+httpx

src/alembic/versions/166f3772fce7_auth_officer_init.py

@@ -42,8 +42,8 @@ def upgrade() -> None:
         sa.Column("id", sa.Integer(), primary_key=True, autoincrement=True),
         sa.Column("computing_id", sa.String(length=32), sa.ForeignKey("site_user.computing_id"), nullable=False),
         sa.Column("position", sa.String(length=128), nullable=False),
-        sa.Column("start_date", sa.DateTime(), nullable=False),
-        sa.Column("end_date", sa.DateTime(), nullable=True),
+        sa.Column("start_date", sa.Date(), nullable=False),
+        sa.Column("end_date", sa.Date(), nullable=True),
         sa.Column("nickname", sa.String(length=128), nullable=True),
         sa.Column("favourite_course_0", sa.String(length=32), nullable=True),
         sa.Column("favourite_course_1", sa.String(length=32), nullable=True),

src/cron/daily.py

@@ -7,7 +7,7 @@
 import google_api
 import utils
 from database import _db_session
-from officers.crud import all_officer_data, get_user_by_username
+from officers.crud import all_officers, get_user_by_username
 
 _logger = logging.getLogger(__name__)
 
@@ -18,7 +18,7 @@ async def update_google_permissions(db_session):
 
     # TODO: for performance, only include officers with recent end-date (1 yr)
     # but measure performance first
-    for term in await all_officer_data(db_session):
+    for term in await all_officers(db_session):
         if utils.is_active(term):
             # TODO: if google drive permission is not active, update them
             pass
@@ -31,7 +31,7 @@ async def update_google_permissions(db_session):
 async def update_github_permissions(db_session):
     github_permissions, team_id_map = github.all_permissions()
 
-    for term in await all_officer_data(db_session):
+    for term in await all_officers(db_session):
         new_teams = (
             # move all active officers to their respective teams
             github.officer_teams(term.position)

src/load_test_db.py

@@ -212,10 +212,9 @@ async def load_test_officers_data(db_session: AsyncSession):
     ))
     await db_session.commit()
 
+SYSADMIN_COMPUTING_ID = "gsa92"
 async def load_sysadmin(db_session: AsyncSession):
     # put your computing id here for testing purposes
-    SYSADMIN_COMPUTING_ID = "gsa92"
-
     print(f"loading new sysadmin '{SYSADMIN_COMPUTING_ID}'")
     await create_user_session(db_session, f"temp_id_{SYSADMIN_COMPUTING_ID}", SYSADMIN_COMPUTING_ID)
     await create_new_officer_info(db_session, OfficerInfo(
@@ -232,28 +231,11 @@ async def load_sysadmin(db_session: AsyncSession):
     await create_new_officer_term(db_session, OfficerTerm(
         computing_id=SYSADMIN_COMPUTING_ID,
 
-        position=OfficerPosition.SYSTEM_ADMINISTRATOR,
-        start_date=date.today() - timedelta(days=365),
-        end_date=None,
-
-        nickname="Gabe",
-        favourite_course_0="CMPT 379",
-        favourite_course_1="CMPT 295",
-
-        favourite_pl_0="Rust",
-        favourite_pl_1="C",
-
-        biography="The systems are good o7",
-        photo_url=None,
-    ))
-    await create_new_officer_term(db_session, OfficerTerm(
-        computing_id=SYSADMIN_COMPUTING_ID,
-
         position=OfficerPosition.FIRST_YEAR_REPRESENTATIVE,
         start_date=date.today() - timedelta(days=(365*3)),
         end_date=date.today() - timedelta(days=(365*2)),
 
-        nickname="Gabe",
+        nickname="G1",
         favourite_course_0="MACM 101",
         favourite_course_1="CMPT 125",
 
@@ -270,7 +252,7 @@ async def load_sysadmin(db_session: AsyncSession):
         start_date=date.today() - timedelta(days=365),
         end_date=None,
 
-        nickname="Gabe",
+        nickname="G2",
         favourite_course_0="CMPT 379",
         favourite_course_1="CMPT 295",
 
@@ -280,6 +262,24 @@ async def load_sysadmin(db_session: AsyncSession):
         biography="The systems are good o7",
         photo_url=None,
     ))
+    # a future term
+    await create_new_officer_term(db_session, OfficerTerm(
+        computing_id=SYSADMIN_COMPUTING_ID,
+
+        position=OfficerPosition.DIRECTOR_OF_ARCHIVES,
+        start_date=date.today() + timedelta(days=365*1),
+        end_date=date.today() + timedelta(days=365*2),
+
+        nickname="G3",
+        favourite_course_0="MACM 102",
+        favourite_course_1="CMPT 127",
+
+        favourite_pl_0="C%",
+        favourite_pl_1="C$$",
+
+        biography="o hey fellow kids \n\n\n I will can newline .... !!",
+        photo_url=None,
+    ))
     await db_session.commit()
 
 async def async_main(sessionmanager):

src/main.py

@@ -6,7 +6,6 @@
 import database
 import officers.urls
 import permission.urls
-import tests.urls
 
 logging.basicConfig(level=logging.DEBUG)
 database.setup_database()
@@ -17,8 +16,6 @@
 app.include_router(officers.urls.router)
 app.include_router(permission.urls.router)
 
-app.include_router(tests.urls.router)
-
 @app.get("/")
 async def read_root():
     return {"message": "Hello! You might be lost, this is actually the sfucsss.org's backend api."}

src/officers/constants.py

@@ -28,8 +28,7 @@ def position_list() -> list[str]:
 
     @staticmethod
     def length_in_semesters(position: str) -> int | None:
-        # TODO: ask the committee to maintain a json file with all the important details from the constitution
-        # (I can create the version version of the file)
+        # TODO (#101): ask the committee to maintain a json file with all the important details from the constitution
         """How many semester position is active for, according to the CSSS Constitution"""
         return _LENGTH_MAP[position]
 
@@ -71,6 +70,7 @@ def is_signer(position: str) -> bool:
 
     @staticmethod
     def expected_positions() -> list[str]:
+        # TODO (#93): use this function in the daily cronjobs
         return [
             OfficerPosition.PRESIDENT,
             OfficerPosition.VICE_PRESIDENT,
@@ -81,11 +81,11 @@ def expected_positions() -> list[str]:
             OfficerPosition.DIRECTOR_OF_EDUCATIONAL_EVENTS,
             OfficerPosition.ASSISTANT_DIRECTOR_OF_EVENTS,
             OfficerPosition.DIRECTOR_OF_COMMUNICATIONS,
-            #OfficerPosition.DIRECTOR_OF_OUTREACH, # TODO: when https://github.com/CSSS/documents/pull/9/files merged
+            #OfficerPosition.DIRECTOR_OF_OUTREACH, # TODO (#101): when https://github.com/CSSS/documents/pull/9/files merged
             OfficerPosition.DIRECTOR_OF_MULTIMEDIA,
             OfficerPosition.DIRECTOR_OF_ARCHIVES,
             OfficerPosition.EXECUTIVE_AT_LARGE,
-            # TODO: expect these only during fall & spring semesters. Also, TODO: this todo is correct...
+            # TODO (#101): expect these only during fall & spring semesters.
             #OfficerPosition.FIRST_YEAR_REPRESENTATIVE,
 
             #ElectionsOfficer,
@@ -121,8 +121,6 @@ def expected_positions() -> list[str]:
     OfficerPosition.SOCIAL_MEDIA_MANAGER: "N/A",
 }
 
-# TODO: when an officer's start date is modified, update the end date as well if it's defined in this list
-# a number of semesters (a semester begins on the 1st of each four month period, starting january)
 # None, means that the length of the position does not have a set length in semesters
 _LENGTH_MAP = {
     OfficerPosition.PRESIDENT: 3,