Merge branch 'develop' into housing-points

Author: shaeespring

.dockerignore

@@ -1,2 +1,4 @@
 Dockerfile
 .gitignore
+node_modules
+venv

.github/pull_request_template.md

@@ -0,0 +1,19 @@
+## What
+
+_what the PR changes_
+
+## Why
+
+_why these changes were made_
+
+## Test Plan
+
+_how did you verify these changes did what you expected_
+
+## Env Vars
+
+_did you add, remove, or rename any environment variables_
+
+## Checklist
+
+- [ ] Tested all changes locally

.github/workflows/node-js.yml

@@ -15,7 +15,7 @@ jobs:
 
     strategy:
       matrix:
-        python-version: [3.8, 3.9]
+        python-version: [3.12]
 
     steps:
       - name: Install ldap dependencies

.github/workflows/python-app.yml

@@ -0,0 +1,21 @@
+name: Build
+
+on:
+  push:
+    branches:
+      - develop
+
+
+jobs:
+  build:
+    name: Build and analyze
+    runs-on: ubuntu-latest
+    
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0  # Shallow clones should be disabled for a better relevancy of analysis
+      - uses: SonarSource/sonarqube-scan-action@v6
+        env:
+          SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
+          SONAR_HOST_URL: ${{ secrets.SONAR_HOST_URL }}

.github/workflows/sonarqube.yml

@@ -9,7 +9,6 @@ disable =
 	duplicate-code,
 	no-member,
 	parse-error,
-	bad-continuation,
 	too-few-public-methods,
 	global-statement,
 	cyclic-import,
@@ -18,14 +17,11 @@ disable =
 
 [REPORTS]
 output-format = text
-files-output = no
 reports = no
 
 [FORMAT]
 max-line-length = 120
-max-statement-lines = 75
 single-line-if-stmt = no
-no-space-check = trailing-comma,dict-separator
 max-module-lines = 1000
 indent-string = '    '
 
@@ -73,8 +69,6 @@ good-names=logger,id,ID
 # Bad variable names which should always be refused, separated by a comma
 bad-names=foo,bar,baz,toto,tutu,tata
 
-# List of builtins function names that should not be used, separated by a comma
-bad-functions=apply,input
 
 
 [DESIGN]
@@ -90,4 +84,4 @@ min-public-methods = 2
 max-public-methods = 20
 
 [EXCEPTIONS]
-overgeneral-exceptions = Exception
+overgeneral-exceptions = builtins.Exception

.nvmrc

@@ -1,28 +1,44 @@
-FROM docker.io/python:3.8-buster
-MAINTAINER Devin Matte <matted@csh.rit.edu>
+FROM node:25-bookworm-slim AS build-frontend
 
 RUN mkdir /opt/conditional
 
-ADD requirements.txt /opt/conditional
+WORKDIR /opt/conditional
+
+RUN apt-get -yq update && \
+    apt-get -yq install curl git
+
+COPY package.json package-lock.json /opt/conditional/
+
+RUN npm ci 
+
+COPY webpack.config.js /opt/conditional
+COPY frontend /opt/conditional/frontend
+
+RUN npm run webpack
+
+FROM docker.io/python:3.12-slim-bookworm
+MAINTAINER Computer Science House <webmaster@csh.rit.edu>
+
+RUN mkdir /opt/conditional
+
+COPY requirements.txt /opt/conditional
 
 WORKDIR /opt/conditional
 
 RUN apt-get -yq update && \
-    apt-get -yq install libsasl2-dev libldap2-dev libssl-dev gcc g++ make && \
+    apt-get -yq install libsasl2-dev libldap2-dev libldap-common libssl-dev gcc g++ make && \
     pip install -r requirements.txt && \
     apt-get -yq clean all
 
-ADD . /opt/conditional
+ARG PORT=8080
+ENV PORT=${PORT}
+EXPOSE ${PORT}
 
-RUN curl -sL https://deb.nodesource.com/setup_10.x | bash - && \
-    apt-get -yq update && \
-    apt-get -yq install nodejs && \
-    npm install && \
-    npm run production && \
-    rm -rf node_modules && \
-    apt-get -yq remove nodejs npm && \
-    apt-get -yq clean all
+COPY conditional /opt/conditional/conditional
+COPY *.py package.json /opt/conditional
+COPY --from=build-frontend /opt/conditional/conditional/static /opt/conditional/conditional/static
 
 RUN ln -sf /usr/share/zoneinfo/America/New_York /etc/localtime
 
-CMD ["ddtrace-run", "gunicorn", "conditional:app", "--bind=0.0.0.0:8080", "--access-logfile=-", "--timeout=256"]
+CMD ["sh", "-c", "gunicorn"]
+

.pylintrc

@@ -8,59 +8,104 @@ A comprehensive membership evaluations solution for Computer Science House.
 Development
 -----------
 
-To run the application, you must have the latest version of [Python 3](https://www.python.org/downloads/) and [virtualenv](https://virtualenv.pypa.io/en/stable/installation/) installed. Once you have those installed, create a new virtualenv and install the Python dependencies:
+### Config
+
+You must create `config.py` in the top-level directory with the appropriate credentials for the application to run. See `config.env.py` for an example.
 
+#### Add OIDC Config
+Reach out to an RTP to get OIDC credentials that will allow you to develop locally behind OIDC auth
+```py
+# OIDC Config
+OIDC_ISSUER = "https://sso.csh.rit.edu/auth/realms/csh"
+OIDC_CLIENT_CONFIG = {
+    'client_id': '',
+    'client_secret': '',
+    'post_logout_redirect_uris': ['http://0.0.0.0:6969/logout']
+}
 ```
+
+#### Database 
+You can either develop using the dev database, or use the local database provided in the docker compose file
+
+Using the local database is detailed below, but both options will require the dev database password, so you will have to ask an RTP for this too
+
+### Run (Without Docker)
+
+To run the application without using containers, you must have the latest version of [Python 3](https://www.python.org/downloads/) and [virtualenv](https://virtualenv.pypa.io/en/stable/installation/) installed. Once you have those installed, create a new virtualenv and install the Python dependencies:
+
+```sh
 virtualenv .conditionalenv -p `which python3`
 source .conditionalenv/bin/activate
 pip install -r requirements.txt
-export FLASK_APP=app.py
 ```
 
-In addition, you must have Node, NPM, and Gulp CLI installed to properly execute the asset pipeline. If you don't have Node installed, we recommending installing with [NVM](https://github.com/creationix/nvm):
+In addition, you must have Node, NPM, and Weback CLI installed to properly execute the asset pipeline. If you don't have Node installed, we recommending installing with [NVM](https://github.com/creationix/nvm):
 
-```
+```sh
 nvm install
 nvm use
-npm install -g gulp
+npm install -g webpack
 ```
 
-Then, install the pipeline and frontend dependencies:
+Then, install the pipeline and frontend dependencies: (do this in the `frontend` directory)
 
-```
+```sh
 npm install
 ```
 
-### Config
+Once you have all of the dependencies installed, run
 
-You must create `config.py` in the top-level directory with the appropriate credentials for the application to run. See `config.sample.py` for an example.
+```sh
+npm webpack
+```
 
-#### Add OIDC Config
-Reach out to an RTP to get OIDC credentials that will allow you to develop locally behind OIDC auth
+This will build the frontend assets and put them in the correct place for use with flask
+
+Finally, start the flask app with `gunicorn`
+
+```sh
+gunicorn
 ```
-# OIDC Config
-OIDC_ISSUER = "https://sso.csh.rit.edu/auth/realms/csh"
-OIDC_CLIENT_CONFIG = {
-    'client_id': '',
-    'client_secret': '',
-    'post_logout_redirect_uris': ['http://0.0.0.0:6969/logout']
-}
+
+or 
+
+```sh
+python -m gunicorn
 ```
 
-### Run
+### Run (containerized)
 
-Once you have all of the dependencies installed, simply run:
+It is likely easier to use containers like `podman` or `docker` or the corresponding compose file
 
-```
-npm start
+With podman, I have been using 
+
+```sh
+podman compose up --force-recreate --build
 ```
 
-This will run the asset pipeline, start the Python server, and start BrowserSync. Your default web browser will open automatically. If it doesn't, navigate to `http://127.0.0.1:3000`. Any changes made to the frontend files in `frontend` or the Jinja templates in `conditional/templates` will cause the browser to reload automatically.
+Which can be restarted every time changes are made
 
 ### Dependencies
 
 To add new dependencies, add them to `requirements.in` and then run `pip-compile requirements.in` to produce a new locked `requirements.txt`. Do not edit `requirements.txt` directly as it will be overwritten by future PRs.
 
+### Local database
+
+You can run the database locally using the docker compose
+
+To populate it with dev data for example, you can use the command
+
+```sh
+PGPASSWORD='[DB PASSWORD]' pg_dump -h postgres.csh.rit.edu -p 5432 -U conditionaldev conditionaldev |  PGPASSWORD='fancypantspassword' psql -h localhost -p 5432 -U conditional conditional
+```
+
+This can be helpful for changing the database schema
+
+To run migration commands in the local database, you can run the commands inside the docker container. Any migrations created will also be in the local repository since migrations are mounted in the docker compose
+```sh
+podman exec conditional flask db upgrade
+```
+
 ### Database Migrations
 
 If the database schema is changed after initializing the database, you must migrate it to the new schema by running: