Add backend support for the Admin dashboard (#66)

* rename files, start writing add new exec endpoint

* rename auth models.py to table.py

* complete crud functions for officer info & officer term

* add endpoints for creating & updating executive info

* fix bugs with officer info/term create/update

* fix ruff issue

* fix bugs with all endpoints & login test

* remove dead code

* remove debug print statement

* remove accidental inclusions

Author: EarthenSky

.github/workflows/ruff.yml

@@ -6,3 +6,5 @@ jobs:
     steps:
       - uses: actions/checkout@v4
       - uses: chartboost/ruff-action@v1
+        with:
+          version: 0.4.4

src/alembic/env.py

@@ -1,9 +1,9 @@
 import asyncio
 from logging.config import fileConfig
 
-import auth.models
+import auth.tables
 import database
-import officers.models
+import officers.tables
 from alembic import context
 from sqlalchemy import pool
 from sqlalchemy.engine import Connection

src/auth/crud.py

@@ -3,7 +3,7 @@
 from typing import Optional
 
 import sqlalchemy
-from auth.models import SiteUser, UserSession
+from auth.tables import SiteUser, UserSession
 from sqlalchemy.ext.asyncio import AsyncSession
 
 

src/auth/models.py renamed to src/auth/tables.py

@@ -45,7 +45,7 @@ async def login_user(
     # verify the ticket is valid
     url = (
         f"https://cas.sfu.ca/cas/serviceValidate?service={urllib.parse.quote(root_ip_address)}"
-        f"/auth/login%3Fnext_url%3D{urllib.parse.quote(next_url)}&ticket={ticket}"
+        f"/api/auth/login%3Fnext_url%3D{urllib.parse.quote(next_url)}&ticket={ticket}"
     )
     cas_response = xmltodict.parse(requests.get(url).text)
 

src/auth/urls.py

@@ -1,12 +1,13 @@
 import os
 
-root_ip_address = "http://localhost:8000" if os.environ.get("LOCAL") == "true" else "https://api.sfucsss.org"
+root_ip_address = "http://localhost:8080" if os.environ.get("LOCAL") == "true" else "https://api.sfucsss.org"
 guild_id = "1260652618875797504" if os.environ.get("LOCAL") == "true" else "228761314644852736"
 github_org_name = "CSSS-Test-Organization" if os.environ.get("LOCAL") == "true" else "CSSS"
 
 SESSION_ID_LEN = 512
 # technically a max of 8 digits https://www.sfu.ca/computing/about/support/tips/sfu-userid.html
 COMPUTING_ID_LEN = 32
+COMPUTING_ID_MAX = 8
 
 # see https://support.discord.com/hc/en-us/articles/4407571667351-How-to-Find-User-IDs-for-Law-Enforcement#:~:text=Each%20Discord%20user%20is%20assigned,user%20and%20cannot%20be%20changed.
 DISCORD_ID_LEN = 18

src/constants.py

@@ -3,14 +3,14 @@
 # python load_test_db.py
 
 import asyncio
-from datetime import datetime, timedelta
+from datetime import date, datetime, timedelta
 
 import sqlalchemy
 from auth.crud import create_user_session
 from database import SQLALCHEMY_TEST_DATABASE_URL, Base, DatabaseSessionManager
 from officers.constants import OfficerPosition
-from officers.crud import update_officer_info, update_officer_term
-from officers.schemas import OfficerInfoData, OfficerTermData
+from officers.crud import create_new_officer_info, create_new_officer_term, update_officer_info, update_officer_term
+from officers.types import OfficerInfoData, OfficerTermData
 from sqlalchemy.ext.asyncio import AsyncSession
 
 
@@ -68,7 +68,7 @@ async def load_test_officers_data(db_session: AsyncSession):
 
     print("add officer info")
     # this person has uploaded all of their info
-    update_officer_info(db_session, OfficerInfoData(
+    await create_new_officer_info(db_session, OfficerInfoData(
         legal_name="Person A",
         discord_id=str(88_1234_7182_4877_1111),
         discord_name="person_a_yeah",
@@ -80,7 +80,7 @@ async def load_test_officers_data(db_session: AsyncSession):
         google_drive_email="[email protected]",
     ))
     # this person has not joined the CSSS discord, so their discord name & nickname could not be found
-    update_officer_info(db_session, OfficerInfoData(
+    await create_new_officer_info(db_session, OfficerInfoData(
         legal_name="Person B",
         discord_id=str(88_1234_7182_4877_2222),
         discord_name=None,
@@ -92,7 +92,7 @@ async def load_test_officers_data(db_session: AsyncSession):
         google_drive_email="[email protected]",
     ))
     # this person has uploaded the minimal amount of information
-    update_officer_info(db_session, OfficerInfoData(
+    await create_new_officer_info(db_session, OfficerInfoData(
         legal_name="Person C",
         discord_id=None,
         discord_name=None,
@@ -105,13 +105,12 @@ async def load_test_officers_data(db_session: AsyncSession):
     ))
     await db_session.commit()
 
-
-    update_officer_term(db_session, OfficerTermData(
+    await create_new_officer_term(db_session, OfficerTermData(
         computing_id="abc11",
 
         position=OfficerPosition.VicePresident.value,
-        start_date=datetime.today() - timedelta(days=365),
-        end_date=datetime.today() - timedelta(days=1),
+        start_date=date.today() - timedelta(days=365),
+        end_date=date.today() - timedelta(days=1),
 
         nickname="the A",
         favourite_course_0="CMPT 125",
@@ -123,11 +122,11 @@ async def load_test_officers_data(db_session: AsyncSession):
         biography="Hi! I'm person A and I do lots of cool things! :)",
         photo_url=None, # TODO: this should be replaced with a default image
     ))
-    update_officer_term(db_session, OfficerTermData(
+    await create_new_officer_term(db_session, OfficerTermData(
         computing_id="abc11",
 
         position=OfficerPosition.ExecutiveAtLarge.value,
-        start_date=datetime.today(),
+        start_date=date.today(),
         end_date=None,
 
         nickname="the holy A",
@@ -140,12 +139,12 @@ async def load_test_officers_data(db_session: AsyncSession):
         biography="Hi! I'm person A and I want school to be over ; _ ;",
         photo_url=None, # TODO: this should be replaced with a default image
     ))
-    update_officer_term(db_session, OfficerTermData(
+    await create_new_officer_term(db_session, OfficerTermData(
         computing_id="abc33",
 
         position=OfficerPosition.President.value,
-        start_date=datetime.today(),
-        end_date=datetime.today() + timedelta(days=365),
+        start_date=date.today(),
+        end_date=date.today() + timedelta(days=365),
 
         nickname="CC",
         favourite_course_0="CMPT 999",
@@ -157,13 +156,98 @@ async def load_test_officers_data(db_session: AsyncSession):
         biography="I'm person C...",
         photo_url=None, # TODO: this should be replaced with a default image
     ))
+    # this officer term is not fully filled in
+    await create_new_officer_term(db_session, OfficerTermData(
+        computing_id="abc22",
+
+        position=OfficerPosition.DirectorOfArchives.value,
+        start_date=date.today(),
+        end_date=date.today() + timedelta(days=365),
+
+        nickname="Bee",
+        favourite_course_0="CMPT 604",
+        favourite_course_1=None,
+
+        favourite_pl_0="B",
+        favourite_pl_1="N/A",
+
+        biography=None,
+        photo_url=None, # TODO: this should be replaced with a default image
+    ))
+    await db_session.commit()
+
+    await update_officer_info(db_session, OfficerInfoData(
+        legal_name="Person C ----",
+        discord_id=None,
+        discord_name=None,
+        discord_nickname=None,
+
+        computing_id="abc33",
+        # adds a phone number
+        phone_number="123-456-7890",
+        github_username=None,
+        google_drive_email=None,
+    ))
+    await update_officer_term(db_session, OfficerTermData(
+        computing_id="abc33",
+
+        position=OfficerPosition.President.value,
+        start_date=date.today(),
+        end_date=date.today() + timedelta(days=365),
+
+        nickname="SEE SEE",
+        favourite_course_0="CMPT 999",
+        favourite_course_1="CMPT 354",
+
+        favourite_pl_0="C++",
+        favourite_pl_1="C",
+
+        biography="You see, I'm person C...",
+        photo_url=None,
+    ))
+    await db_session.commit()
+
+async def load_sysadmin(db_session: AsyncSession):
+    print("loading new sysadmin")
+    # put your computing id here for testing purposes
+    SYSADMIN_COMPUTING_ID = "gsa92"
+
+    await create_new_officer_info(db_session, OfficerInfoData(
+        legal_name="Gabe Schulz",
+        discord_id=None,
+        discord_name=None,
+        discord_nickname=None,
+
+        computing_id=SYSADMIN_COMPUTING_ID,
+        phone_number=None,
+        github_username=None,
+        google_drive_email=None,
+    ))
+    await create_new_officer_term(db_session, OfficerTermData(
+        computing_id=SYSADMIN_COMPUTING_ID,
+
+        position=OfficerPosition.SystemAdministrator.value,
+        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 db_session.commit()
 
 async def async_main(sessionmanager):
     await reset_db(sessionmanager._engine)
     async with sessionmanager.session() as db_session:
         # load_test_auth_data
         await load_test_officers_data(db_session)
+        await load_sysadmin(db_session)
 
 if __name__ == "__main__":
     response = input(f"This will reset the {SQLALCHEMY_TEST_DATABASE_URL} database, are you okay with this? (y/N): ")

src/load_test_db.py

@@ -11,7 +11,7 @@
 logging.basicConfig(level=logging.DEBUG)
 database.setup_database()
 
-app = FastAPI(lifespan=database.lifespan, title="CSSS Site Backend")
+app = FastAPI(lifespan=database.lifespan, title="CSSS Site Backend", root_path="/api")
 
 app.include_router(auth.urls.router)
 app.include_router(officers.urls.router)

src/main.py

@@ -4,7 +4,7 @@
 
 _logger = logging.getLogger(__name__)
 
-
+# TODO: remove enum, b/d python enums suck
 class OfficerPosition(Enum):
     President = "president"
     VicePresident = "vice-president"
@@ -29,6 +29,10 @@ class OfficerPosition(Enum):
     Webmaster = "webmaster"
     SocialMediaManager = "social media manager"
 
+    @staticmethod
+    def position_values() -> list[str]:
+        return _OFFICER_POSITION_VALUES
+
     @staticmethod
     def from_string(position: str) -> Self | None:
         for item in OfficerPosition:
@@ -140,3 +144,7 @@ def expected_positions() -> list[Self]:
             OfficerPosition.SystemAdministrator,
             OfficerPosition.Webmaster,
         ]
+
+_OFFICER_POSITION_VALUES = [
+    pos.value for pos in OfficerPosition.__members__.values()
+]