Dev -> Prod Changes

.devcontainer/Dockerfile

@@ -1,4 +1,4 @@
-FROM mcr.microsoft.com/devcontainers/python:0-3.11
+FROM mcr.microsoft.com/devcontainers/python:3.13
 
 ENV PYTHONUNBUFFERED 1
 

.github/workflows/pull_request_template.md

@@ -0,0 +1,14 @@
+## Issue Description
+
+Fixes #<!-- add issue number -->
+<!-- - Add issue description -->
+
+## Changes
+
+<!-- - Use bullet points to provide a description of added changes. -->
+<!-- - Add images, where possible, to provide more context to your changes. -->
+
+## Testing
+
+<!-- - Use `backticks` to highlight shell commands or file directories in your test descriptions. -->
+<!-- - Use bullet points to provide a concise description of testing procedure. -->

README.md

@@ -33,6 +33,7 @@ Python 3.7+
 2. Ensure your database connection is working by running ```python db_test.py```.
 3. Check your secret_config.yml and make sure you have the necessary config items (check example_secret_config.yml)
 4. Reset your database from the backup ```./reset_database.sh from-backup```.
+   - 4a. If you get an `ERROR 2026 (HY000): TLS/SSL error: self-signed certificate in certificate chain` error, fix it by going into `reset_database.sh` and add `--skip-ssl` after every instance of `-proot`
 5. Change your environment to ```staging```. Before starting the application, run ```export FLASK_ENV=staging```
 
 ## Updating pip dependencies (imports)

app/__init__.py

@@ -1,3 +1,5 @@
+import os
+
 from flask import Flask
 from flask_restful import Api
 from flask_bootstrap import Bootstrap
@@ -8,14 +10,18 @@
 bootstrap = Bootstrap(app)
 api = Api(app)
 
+app.env = os.environ.get('APP_ENV', 'production')
 from app.config.loadConfig import get_secret_cfg
 app.config.update(get_secret_cfg())
+print (" * Environment:", app.env)
+app.config['ENV'] = app.env
 
 app.secret_key = app.config["secret_key"]
 
 app.config['use_shibboleth'] = (app.config['ENV'] == 'production')
 app.config['use_tracy'] = (app.config['ENV'] in ('production','staging'))
-app.config['use_banner'] = (app.config['ENV'] in ('production','staging'))
+if 'use_banner' not in app.config.keys():
+    app.config['use_banner'] = (app.config['ENV'] in ('production','staging'))
 
 # Record and output queries if requested
 from flask import session

app/config/contributors.yaml

@@ -59,4 +59,7 @@ contributors:
   - name: "Oluwagbayi Makinde"
     username: "makindeo"
     year: 2024
+  - name: "Bhushan Sah "
+    username: "sahb"
+    year: 2029
 

app/controllers/admin_routes/adminManagement.py

@@ -1,5 +1,4 @@
 from app.controllers.admin_routes import *
-from app.models.user import User, DoesNotExist
 from app.models.user import *
 from app.controllers.admin_routes import admin
 from flask import request
@@ -8,7 +7,10 @@
 from app.models.supervisor import Supervisor
 from app.models.student import Student
 from app.logic.tracy import Tracy
-from app.logic.userInsertFunctions import createUser, createSupervisorFromTracy, createStudentFromTracy
+from app.logic.userInsertFunctions import createStudentFromTracy, createSupervisorFromTracy, createUser
+from app.logic.adminManagement import searchForAdmin, getUser
+from app.logic.utils import adminFlashMessage
+
 
 @admin.route('/admin/adminManagement', methods=['GET'])
 # @login_required
@@ -23,7 +25,9 @@ def admin_Management():
         elif currentUser.supervisor:
             return render_template('errors/403.html'), 403
 
-    users = User.select()
+    users = (User.select(User,Supervisor,Student)
+                .join(Supervisor,join_type=JOIN.LEFT_OUTER).switch()
+                .join(Student,join_type=JOIN.LEFT_OUTER))
     return render_template( 'admin/adminManagement.html',
                             title=('Admin Management'),
                             users = users
@@ -37,117 +41,46 @@ def adminSearch():
     """
     try:
         rsp = eval(request.data.decode("utf-8"))
-        userInput = rsp[1]
-        adminType = rsp[0]
-        userList = []
-        if adminType == "addlaborAdmin":
-            tracyStudents = Tracy().getStudentsFromUserInput(userInput)
-            students = []
-            for student in tracyStudents:
-                try:
-                    existingUser = User.get(User.student == student.ID)
-                    if existingUser.isLaborAdmin:
-                        pass
-                    else:
-                        students.append(student)
-                except DoesNotExist as e:
-                    students.append(student)
-            for student in students:
-                username = student.STU_EMAIL.split('@', 1)
-                userList.append({'username': username[0],
-                                'firstName': student.FIRST_NAME,
-                                'lastName': student.LAST_NAME,
-                                'type': 'Student'
-                                })
-        tracySupervisors = Tracy().getSupervisorsFromUserInput(userInput)
-        supervisors = []
-        for supervisor in tracySupervisors:
-            try:
-                existingUser = User.get(User.supervisor == supervisor.ID)
-                if ((existingUser.isLaborAdmin and adminType == "addlaborAdmin")
-                    or (existingUser.isSaasAdmin and adminType == "addSaasAdmin")
-                    or (existingUser.isFinancialAidAdmin and adminType == "addFinAidAdmin")):
-                    pass
-                else:
-                    supervisors.append(supervisor)
-            except DoesNotExist as e:
-                supervisors.append(supervisor)
-        for sup in supervisors:
-            username = sup.EMAIL.split('@', 1)
-            userList.append({'username': username[0],
-                            'firstName': sup.FIRST_NAME,
-                            'lastName': sup.LAST_NAME,
-                            'type': 'Supervisor'})
+        userList = searchForAdmin(rsp)
         return jsonify(userList)
     except Exception as e:
         print('ERROR Loading Non Labor Admins:', e, type(e))
         return jsonify(userList)
 
 @admin.route("/adminManagement/userInsert", methods=['POST'])
 def manageLaborAdmin():
-    if request.form.get("addAdmin"):
-        newAdmin = getUser('addAdmin')
-        addAdmin(newAdmin, 'labor')
-        flashMessage(newAdmin, 'added', 'Labor')
-
-    elif request.form.get("removeAdmin"):
-        oldAdmin = getUser('removeAdmin')
-        removeAdmin(oldAdmin, 'labor')
-        flashMessage(oldAdmin, 'removed', 'Labor')
-
-    elif request.form.get("addFinancialAidAdmin"):
-        newAdmin = getUser('addFinancialAidAdmin')
-        addAdmin(newAdmin, 'finAid')
-        flashMessage(newAdmin, 'added', 'Financial Aid')
-
-    elif request.form.get("removeFinancialAidAdmin"):
-        oldAdmin = getUser('removeFinancialAidAdmin')
-        removeAdmin(oldAdmin, 'finAid')
-        flashMessage(oldAdmin, 'removed', 'Financial Aid')
+    actionMap = {
+    "addLaborAdmin":     {"selectPickerID": "addAdmin",                "type": "Labor",        "action": "add",    "pretty": "Labor"},
+    "removeLaborAdmin":  {"selectPickerID": "removeAdmin",             "type": "Labor",        "action": "remove", "pretty": "Labor"},
+    "addFinAidAdmin":    {"selectPickerID": "addFinancialAidAdmin",    "type": "FinancialAid", "action": "add",    "pretty": "Financial Aid"},
+    "removeFinAidAdmin": {"selectPickerID": "removeFinancialAidAdmin", "type": "FinancialAid", "action": "remove", "pretty": "Financial Aid"},
+    "addSaasAdmin":      {"selectPickerID": "addSAASAdmin",            "type": "Saas",         "action": "add",    "pretty": "SAAS"},
+    "removeSaasAdmin":   {"selectPickerID": "removeSAASAdmin",         "type": "Saas",         "action": "remove", "pretty": "SAAS"},
+    }    
 
-    elif request.form.get("addSAASAdmin"):
-        newAdmin = getUser('addSAASAdmin')
-        addAdmin(newAdmin, 'saas')
-        flashMessage(newAdmin, 'added', 'SAAS')
-
-    elif request.form.get("removeSAASAdmin"):
-        oldAdmin = getUser('removeSAASAdmin')
-        removeAdmin(oldAdmin, 'saas')
-        flashMessage(oldAdmin, 'removed', 'SAAS')
+    key = request.form.get('action')
+    meta = actionMap[key]
+    user = getUser(actionMap[key]['selectPickerID'])
 
+    # pick addAdmin or removeAdmin dynamically
+    if meta['action'] == 'add':
+        addAdmin(user, meta['type'])
+    else:
+        removeAdmin(user, meta['type'])
+
+    flashMessage(user, 
+                    'added' if meta["action"] == "add" else 'removed', 
+                    meta["pretty"])
+
     return redirect(url_for('admin.admin_Management'))
 
-def getUser(selectpickerID):
-    username = request.form.get(selectpickerID)
-    try:
-        user = User.get(User.username == username)
-    except DoesNotExist as e:
-        usertype = Tracy().checkStudentOrSupervisor(username)
-        supervisor = student = None
-        if usertype == "Student":
-            student = createStudentFromTracy(username)
-        else:
-            supervisor = createSupervisorFromTracy(username)
-        user = createUser(username, student=student, supervisor=supervisor)
-    return user
-
-def addAdmin(newAdmin, adminType):
-    if adminType == 'labor':
-        newAdmin.isLaborAdmin = True
-    if adminType == 'finAid':
-        newAdmin.isFinancialAidAdmin = True
-    if adminType == 'saas':
-        newAdmin.isSaasAdmin = True
-    newAdmin.save()
+def addAdmin(user, adminType):
+    setattr(user, f"is{adminType}Admin", True)
+    user.save()
 
-def removeAdmin(oldAdmin, adminType):
-    if adminType == 'labor':
-        oldAdmin.isLaborAdmin = False
-    if adminType == 'finAid':
-        oldAdmin.isFinancialAidAdmin = False
-    if adminType == 'saas':
-        oldAdmin.isSaasAdmin = False
-    oldAdmin.save()
+def removeAdmin(user, adminType):
+    setattr(user, f"is{adminType}Admin", False)
+    user.save()
 
 def flashMessage(user, action, adminType):
     message = "{} has been {} as a {} Admin".format(user.fullName, action, adminType)