Docker new

.devcontainer/devcontainer.json

@@ -0,0 +1,12 @@
+// For format details, see https://aka.ms/devcontainer.json. For config options, see the
+// README at: https://github.com/devcontainers/templates/tree/main/src/docker-existing-docker-compose
+{
+	"name": "Dev Container",
+	"dockerComposeFile": [
+		"../docker-compose.yml",
+		"docker-compose.yml"
+	],
+	"service": "app",
+	"workspaceFolder": "/app",
+	"postStartCommand": "git config --global --add safe.directory /app"
+}

.devcontainer/docker-compose.yml

@@ -0,0 +1,6 @@
+version: '3'
+services:
+  app:
+    volumes:
+      - .:/app:cached
+    command: flask run --debug --host=0.0.0.0 -p 80

Dockerfile

@@ -0,0 +1,15 @@
+FROM python:3.12
+
+COPY requirements.txt /tmp/requirements.txt
+RUN pip install --upgrade pip
+RUN pip install --upgrade wheel
+RUN pip install --no-cache-dir -r /tmp/requirements.txt
+
+COPY ./ /app
+WORKDIR /app
+
+ENV PYTHONPATH=/app
+ENV MODULE_NAME=wsgi
+EXPOSE 80
+ENTRYPOINT ["./entrypoint.sh"]
+CMD ["./start.sh"]

README.md

@@ -43,6 +43,11 @@ Import database backup:
 sudo -u postgres psql matheueben < backup.sql
 ```
 
+or in the container:
+```bash
+psql -U db_user -h postgres -p 5432 -d db_database < backup.sql
+```
+
 Clean up database:
 ```bash
 flask fab security-cleanup

app.env

@@ -0,0 +1,11 @@
+FLASK_SECRET_KEY=ONLY_FOR_DEVELOPMENT
+FLASK_SQLALCHEMY_DATABASE_URI=postgresql://db_user:db_password@postgres:5432/db_database
+FLASK_RECAPTCHA_PUBLIC_KEY=10000000-ffff-ffff-ffff-000000000001
+FLASK_RECAPTCHA_PRIVATE_KEY=0x0000000000000000000000000000000000000000
+FLASK_MAIL_SERVER=TODO
+FLASK_MAIL_PORT=587
+FLASK_MAIL_USE_TLS=False
+FLASK_MAIL_USERNAME=TODO
+FLASK_MAIL_PASSWORD=TODO
+FLASK_MAIL_DEFAULT_SENDER=TODO
+FLASK_ADMIN_PASSWORD=TODO

app/__init__.py

@@ -9,7 +9,7 @@
 from flask_debugtoolbar import DebugToolbarExtension
 from flask_migrate import Migrate
 from sentry_sdk.integrations.flask import FlaskIntegration
-
+from sqlalchemy import inspect
 from app.models.achievements import achievements
 from app.models.general import Achievement, Question
 from app.tools.mail import send_mail
@@ -41,29 +41,31 @@ def create_app(config="config"):
         db.init_app(app)
 
         # TODO: Only necessary until SQLAlchemy 2 is used.
-        result = db.session.execute(
-            "SELECT * FROM pg_collation WHERE collname = 'numeric';"
-        )
-        if not result.first():
+        if inspect(db.engine).has_table(Question.__tablename__):
+            result = db.session.execute(
+                "SELECT * FROM pg_collation WHERE collname = 'numeric';"
+            )
+            if not result.first():
+                db.session.execute(
+                    "CREATE COLLATION numeric (provider = icu, locale = 'de_DE@colNumeric=yes');"
+                )
             db.session.execute(
-                "CREATE COLLATION numeric (provider = icu, locale = 'de_DE@colNumeric=yes');"
+                f'ALTER TABLE "{Question.__tablename__}" '
+                f'ALTER COLUMN "{Question.external_id.name}" type VARCHAR COLLATE numeric;'
             )
-        db.session.execute(
-            f'ALTER TABLE "{Question.__tablename__}" '
-            f'ALTER COLUMN "{Question.external_id.name}" type VARCHAR COLLATE numeric;'
-        )
 
         # Init achievements
-        for achievement in achievements:
-            result = (
-                db.session.query(Achievement).filter_by(name=achievement.name).first()
-            )
-            if not result:
-                db.session.add(achievement)
-            else:
-                result.title = achievement.title
-                result.description = achievement.description
-            db.session.commit()
+        if inspect(db.engine).has_table(Achievement.__tablename__):
+            for achievement in achievements:
+                result = (
+                    db.session.query(Achievement).filter_by(name=achievement.name).first()
+                )
+                if not result:
+                    db.session.add(achievement)
+                else:
+                    result.title = achievement.title
+                    result.description = achievement.description
+                db.session.commit()
 
         migrate.init_app(app, db)
         appbuilder.init_app(app, db.session)

config.py

@@ -104,7 +104,6 @@
         ["ExtendedUserDBModelView", "can_confirm_account_delete"],
         ["ExtendedUserDBModelView", "can_export_data"],
         ["ExtendedUserDBModelView", "export_data_action"],
-        ["QuestionRandom", "can_random_question_redirect"],
         ["IdToForm", "can_id_to_form"],
         ["Verwaltung", "menu_access"],
         ["classes", "menu_access"],

docker-compose.yml

@@ -0,0 +1,37 @@
+services:
+  app:
+    build: ./
+    restart: always
+    ports:
+      - 5000:80
+    env_file:
+      - app.env
+    environment:
+      - GUNICORN_CONF=/app/gunicorn_conf_dev.py
+    depends_on:
+      postgres:
+        condition: service_healthy
+    volumes:
+      - ./:/app
+      - static:/app/app/static
+
+  postgres:
+    image: postgres:alpine
+    restart: always
+    environment:
+      - POSTGRES_PASSWORD=db_password
+      - POSTGRES_DB=db_database
+      - POSTGRES_USER=db_user
+    volumes:
+      - postgres:/var/lib/postgresql/data
+      - ./:/app
+    healthcheck:
+      test: [ "CMD-SHELL", "pg_isready -U db_user -d db_database" ]
+      start_period: 10s
+      interval: 5s
+      timeout: 5s
+      retries: 10
+
+volumes:
+  static:
+  postgres:

entrypoint.sh

@@ -0,0 +1,16 @@
+#!/usr/bin/env sh
+set -e
+
+if [ -f /app/app/main.py ]; then
+    DEFAULT_MODULE_NAME=app.main
+elif [ -f /app/main.py ]; then
+    DEFAULT_MODULE_NAME=main
+fi
+MODULE_NAME=${MODULE_NAME:-$DEFAULT_MODULE_NAME}
+VARIABLE_NAME=${VARIABLE_NAME:-app}
+export APP_MODULE=${APP_MODULE:-"$MODULE_NAME:$VARIABLE_NAME"}
+
+DEFAULT_GUNICORN_CONF=/app/gunicorn_conf.py
+export GUNICORN_CONF=${GUNICORN_CONF:-$DEFAULT_GUNICORN_CONF}
+
+exec "$@"

gunicorn_conf.py

@@ -0,0 +1,40 @@
+import multiprocessing
+import os
+
+workers_per_core_str = os.getenv("WORKERS_PER_CORE", "2")
+web_concurrency_str = os.getenv("WEB_CONCURRENCY", None)
+host = os.getenv("HOST", "0.0.0.0")
+port = os.getenv("PORT", "80")
+bind_env = os.getenv("BIND", None)
+use_loglevel = os.getenv("LOG_LEVEL", "info")
+if bind_env:
+    use_bind = bind_env
+else:
+    use_bind = "{host}:{port}".format(host=host, port=port)
+
+cores = multiprocessing.cpu_count()
+workers_per_core = float(workers_per_core_str)
+default_web_concurrency = workers_per_core * cores
+if web_concurrency_str:
+    web_concurrency = int(web_concurrency_str)
+    assert web_concurrency > 0
+else:
+    web_concurrency = int(default_web_concurrency)
+
+# Gunicorn config variables
+loglevel = use_loglevel
+workers = web_concurrency
+bind = use_bind
+keepalive = 120
+errorlog = "-"
+
+# For debugging and testing
+log_data = {
+    "loglevel": loglevel,
+    "workers": workers,
+    "bind": bind,
+    # Additional, non-gunicorn variables
+    "workers_per_core": workers_per_core,
+    "host": host,
+    "port": port,
+}

gunicorn_conf_dev.py

@@ -0,0 +1,19 @@
+import json
+from gunicorn_conf import *
+
+reload = True
+
+# For debugging and testing
+log_data = {
+    "loglevel": loglevel,
+    "workers": workers,
+    "bind": bind,
+    # Additional, non-gunicorn variables
+    "workers_per_core": workers_per_core,
+    "host": host,
+    "port": port,
+    "reload": reload,
+}
+
+
+print(json.dumps(log_data))

prestart.sh

@@ -0,0 +1,17 @@
+#!/bin/sh
+
+if flask db current | grep "(head)"; then
+    echo "Running database upgrade."
+    flask db upgrade
+else
+    echo "Initializing database."
+    flask fab create-db
+    flask db stamp
+    # TODO: Fix! user creation functionality broken!
+    flask fab create-admin \
+        --username admin \
+        --firstname admin \
+        --lastname admin \
+        --email admin@matheworkout.at \
+        --password ${FLASK_ADMIN_PASSWORD:-$(tr -dc A-Za-z0-9 </dev/urandom | head -c 20; echo)}
+fi

requirements.txt

@@ -1,13 +1,14 @@
-git+https://github.com/Dosenpfand/Flask-AppBuilder.git@multiple-actions-fix#egg=Flask-AppBuilder
+# TODO: rebase!
+# git+https://github.com/Dosenpfand/Flask-AppBuilder.git@multiple-actions-fix#egg=Flask-AppBuilder
+flask-appbuilder~=4.5
 flask-mail~=0.9
 Pillow~=10.0 # For image processing in Flask-AppBuilder
 psycopg2-binary~=2.9 # for postgresql
 Flask-Migrate~=3.1
 WTForms~=2.3
 Flask~=2.1
 alembic~=1.7
-gunicorn~=22.0 # for deployment via nginx
-python-dotenv~=0.21
-Flask-DebugToolbar~=0.13
+gunicorn~=23.0
+Flask-DebugToolbar~=0.15
 simpleeval~=0.9
 sentry-sdk[flask,sqlalchemy]~=2.12 # for error collection

start.sh

@@ -0,0 +1,14 @@
+#! /usr/bin/env sh
+set -e
+
+PRE_START_PATH=./prestart.sh
+echo "Checking for script in $PRE_START_PATH"
+if [ -f $PRE_START_PATH ] ; then
+    echo "Running script $PRE_START_PATH"
+    . "$PRE_START_PATH"
+else
+    echo "There is no script $PRE_START_PATH"
+fi
+
+# Start Gunicorn
+exec gunicorn -c "$GUNICORN_CONF" "$APP_MODULE"

wsgi.py

@@ -1,12 +1,8 @@
 import logging
 import sys
 
-# activate_this = '/var/www/FlaskApp/venv/bin/activate_this.py'
-# with open(activate_this) as file_:
-#     exec(file_.read(), dict(__file__=activate_this))
-
 logging.basicConfig(stream=sys.stderr)
 sys.path.insert(0, "/var/www/FlaskApp/")
 from app import create_app  # noqa
 
-application = create_app()
+app = create_app()