Dockerized dev environment

Dockerfile

@@ -0,0 +1,30 @@
+FROM python:3.7-slim
+
+ENV FLASK_APP=runserver.py
+ENV FLASK_RUN_HOST=0.0.0.0
+
+WORKDIR /app
+
+# libz and libjpeg are needed for pillow (PIL)
+RUN apt-get update && apt-get install -y \
+    gcc \
+    libpq-dev \
+    libz-dev \
+    libjpeg-dev
+
+COPY requirements.txt /app/requirements.txt
+COPY dev-requirements.txt /app/dev-requirements.txt
+RUN pip install -r /app/requirements.txt
+# Just to fix an issue installing black, uninstall typing
+# https://stackoverflow.com/questions/55833509/attributeerror-type-object-callable-has-no-attribute-abc-registry
+RUN pip uninstall -y typing
+RUN pip install -r /app/dev-requirements.txt
+
+# Clean some space
+# RUN apt-get autoremove -y gcc
+
+# COPY . /app
+expose 5000
+
+CMD [ "flask", "run" ]
+

README.md

@@ -34,10 +34,15 @@ A Flask webapp using Python Image Library to reconstruct and display a summary o
 
 `DEBUG` set to True for helpful debugging; never set to True in production environment
 
+`ASSETS_PATH` where images are stored
+
+`LANGUAGES` List of supported languages
+
 #### Database
 
 `USE_SQLITE` NOTE: in testing we've moved to Postgres, so this probably doesn't work any more
 
+
 ##### SQLite
 
 `DB_SQLITE`
@@ -93,6 +98,71 @@ FLASK_APP=runserver.py flask run
 
 Assets for image generation go in `sdv\assets\[subfolder]`. Assets used as-is go in `sdv\static\assets\[subfolder]`.
 
+## Run With Docker compose
+
+### Create the DB
+
+Build all the containers but start only the postgres one for now. Then, run the
+`createadmin.py` from the webapps container:
+
+```bash
+docker compose build
+docker compose up postges
+docker run \
+    -it \
+    -e PYTHONPATH=. \
+    -v "$(pwd)"/:/app \
+    --network=sdv-summary_postgres \
+    sdv-summary_webapp \
+    bas -c "python sdv/createadmin.py; python sdv/createdb.py"
+docker-compose down
+```
+
+### Run the webapp + database
+
+```bash
+docker compose up
+```
+
+This command:
+- Download necessary docker images for python, postgres and pgAdmin, if not present.
+- Creates a database `postgres` with user:password `postgres:postgres` for administration.
+- Creates a database `sdv_summary_development` and a `user:password`
+  `sdv_summary:sdv_summary` with all rights on the `sdv_summary_development`
+  database.
+- TODO: Creates tables?
+- TODO: Inits data?
+- Runs PGAdmin on port 5050, and postgre on 5432
+
+## PgAdmin
+You can access it on http://localhost:5050 with:
+- Username: [email protected]
+- Password: admin
+
+Then you should add a server. Call it "docker" for example. For the connection:
+- host: postgres
+- port: 5432
+- maintenance database: postgres
+- username: admin
+- password: admin
+
+CREATE USER sdv_summary WITH PASSWORD = 'sdv_summary';
+CREATE DATABASE sdv_summary_development;
+GRANT ALL PRIVILEGES ON DATABASE sdv_summary_development TO sdv_summary;
+
+
+When you are done for the day, just:
+
+```bash
+docker compose down
+```
+
+And if you want to nuke the databases *LOSING ALL THE DATA*:
+
+```bash
+docker compose down --volumes
+```
+
 ## Code Style
 
 In order to keep the code style consistent, this project is formatted using [Black](https://github.com/psf/black). 

docker-compose.yml

@@ -0,0 +1,71 @@
+# With help from https://github.com/khezen/compose-postgres/blob/master/docker-compose.yml
+version: '3.5'
+
+services:
+
+    postgres:
+        container_name: postgres
+        image: postgres
+        restart: always
+        environment:
+            POSTGRES_DB: ${POSTGRES_DB:-postgres}
+            POSTGRES_USER: ${POSTGRES_USER:-admin}
+            POSTGRES_PASSWORD: ${POSTGRES_PASSWORD:-admin}
+            POSTGRES_HOST_AUTH_METHOD: trust
+            # PGDATA: /data/postgres
+        volumes:
+            - db-data:/var/lib/postgresql/data
+            - ./init.sql:/docker-entrypoint-initdb.d/10-init.sql
+        ports:
+            - 5432:5432
+        networks:
+            - postgres
+
+    pgadmin:
+        container_name: pgadmin
+        image: dpage/pgadmin4
+        environment:
+          PGADMIN_DEFAULT_EMAIL: ${PGADMIN_DEFAULT_EMAIL:[email protected]}
+          PGADMIN_DEFAULT_PASSWORD: ${PGADMIN_DEFAULT_PASSWORD:-admin}
+        volumes:
+           - pgadmin:/root/.pgadmin
+        ports:
+          - "${PGADMIN_PORT:-5050}:80"
+        networks:
+          - postgres
+        restart: unless-stopped
+
+    adminer:
+        image: adminer
+        restart: always
+        ports:
+            - 8080:8080
+        networks:
+          - postgres
+
+    webapp:
+        container_name: webapp
+        restart: always
+        build: .
+        depends_on:
+            - "postgres"
+        ports:
+            - 5000:5000
+        volumes:
+            - .:/app
+        networks:
+          - postgres
+        environment:
+            PYTHONPATH: .:sdv
+            # FLASK_APP: ./runserver.py
+            FLASK_RUN_HOST: 0.0.0.0
+            FLASK_ENV: development
+
+
+networks:
+  postgres:
+    driver: bridge
+
+volumes:
+    db-data:
+    pgadmin:

init.sql

@@ -0,0 +1,8 @@
+-- Initialization script
+-- Creates the database and tables
+
+-- This is not needed as the suer and database are created from the docker
+-- compose environment variables
+CREATE USER sdv_summary WITH PASSWORD 'sdv_summary';
+CREATE DATABASE sdv_summary_development;
+GRANT ALL PRIVILEGES ON DATABASE sdv_summary_development TO sdv_summary;

requirements.txt

@@ -7,7 +7,7 @@ blinker==1.4
 certifi==2017.4.17
 cffi==1.11.5
 chardet==3.0.4
-Click==7.0
+Click>=7.1
 colorama==0.3.9
 cryptography==2.3.1
 defusedxml==0.5.0
@@ -52,7 +52,6 @@ six==1.11.0
 speaklater==1.3
 SQLAlchemy==1.2.14
 termcolor==1.1.0
-typing==3.6.6
 urllib3==1.24.1
 webassets==0.12.1
 Werkzeug==0.14.1

runserver.py

@@ -1,10 +1,11 @@
 import os
 
-os.chdir(os.path.join(os.path.dirname(__file__), "sdv"))
+# os.chdir(os.path.join(os.path.dirname(__file__), "sdv"))
 
 import sys
 
 sys.path.insert(0, "./")
+sys.path.insert(1, "./sdv/")
 
 # for some reason on Python 3.4 on Linux Mint, using runserver.py crashes on first reload if os.chdir() is used
 # so to avoid this (and break some of the site, but oh well...) remove os.chdir and add sdv to path

sdv/__init__.py

@@ -45,6 +45,7 @@
 
 from sdv.utils.log import app_logger
 from sdv.utils.helpers import random_id
+from sdv.utils.postgres import get_db_connection_string
 
 # from sdv.playerInfo import playerInfo
 from sdv.playerinfo2 import GameInfo
@@ -116,14 +117,9 @@ def connect_db():
 
     else:
         logger.info("Application set to use Postgres")
-        app.database = (
-            "dbname="
-            + app.config["DB_NAME"]
-            + " user="
-            + app.config["DB_USER"]
-            + " password="
-            + app.config["DB_PASSWORD"]
-        )
+
+        connstr = get_db_connection_string(app.config)
+        app.database = (connstr)
         app.sqlesc = "%s"
 
     return app

sdv/config.py.sample

@@ -1,11 +1,32 @@
 #!/usr/bin/env python
 
 class DevelopmentConfig():
-  DEBUG = True
-  USE_SQLITE = False
-  DB_NAME = 'sdv_summary_development'
-  DB_USER = ''
-  DB_PASSWORD = ''
+
+    # Mandatory settings
+    UPLOAD_FOLDER = 'uploads'
+    SECRET_KEY = 'changeme'
+    MAX_CONTENT_LENGTH = 16*1024*1024
+    PASSWORD_ATTEMPTS_LIMIT = None
+    PASSWORD_MIN_LENGTH = 6
+    IMGUR_CLIENTID = ''
+    IMGUR_SECRET = ''
+    IMGUR_DIRECT_UPLOAD = True
+    RECAPTCHA_ENABLED = False
+    RECAPTCHA_SITE_KEY = None
+    RECAPTCHA_SECRET_KEY = None
+    ANALYTICS_ID = ''
+    DEBUG = True
+    ASSET_PATH = 'sdv/assets'
+    LANGUAGES = ['en']
+
+    # Database
+    USE_SQLITE = False
+    DB_NAME = 'sdv_summary_development'
+    DB_USER = 'sdv_summary'
+    DB_PASSWORD = 'sdv_summary'
+    # NOTE: Leave commented to use unix socket
+    # Or specify Host if DB is not in the same machine
+    # DB_HOST = 'postgres'
 
 config = {
   'development': DevelopmentConfig

sdv/createadmin.py

@@ -4,6 +4,7 @@
 import os
 import sys
 from werkzeug.security import generate_password_hash
+from sdv.utils.postgres import get_db_connection_string
 
 app = Flask(__name__)
 config_name = os.environ.get("SDV_APP_SETTINGS", "development")
@@ -27,15 +28,8 @@ def connect_db():
         connection = sqlite3.connect(app.config["DB_SQLITE"])
     else:
         import psycopg2
-
-        connection = psycopg2.connect(
-            "dbname="
-            + app.config["DB_NAME"]
-            + " user="
-            + app.config["DB_USER"]
-            + " password="
-            + app.config["DB_PASSWORD"]
-        )
+        connstr = get_db_connection_string(app.config)
+        connection = psycopg2.connect(connstr)
     return connection
 
 

sdv/createdb.py

@@ -5,9 +5,10 @@
 import getpass
 from werkzeug import check_password_hash
 from config import config
+from sdv.utils.postgres import get_db_connection_string
 
 app = Flask(__name__)
-config_name = os.environ.get("SDV_APP_SETTINGS", None)
+config_name = os.environ.get("SDV_APP_SETTINGS", 'development')
 app.config.from_object(config[config_name])
 
 database_structure_dict = {
@@ -267,15 +268,8 @@ def connect_db():
         connection = sqlite3.connect(app.config["DB_SQLITE"])
     else:
         import psycopg2
-
-        connection = psycopg2.connect(
-            "dbname="
-            + app.config["DB_NAME"]
-            + " user="
-            + app.config["DB_USER"]
-            + " password="
-            + app.config["DB_PASSWORD"]
-        )
+        connstr = get_db_connection_string(app.config)
+        connection = psycopg2.connect(connstr)
     return connection
 
 

sdv/utils/postgres.py

@@ -0,0 +1,15 @@
+
+def get_db_connection_string(config):
+    """Given app.config, returns the connection string for postgres"""
+    params = dict(
+        dbname=config["DB_NAME"],
+        user=config["DB_USER"],
+    )
+    # Host is optional.
+    # If not present, use unix sockets
+    if 'DB_PASSWORD' in config:
+        params['password'] = config["DB_PASSWORD"]
+    if 'DB_HOST' in config:
+        params['host'] = config["DB_HOST"]
+    connstr = ' '.join(f'{key}={value}' for key, value in params.items())
+    return connstr

tests/utils/test_postgres.py

@@ -0,0 +1,30 @@
+import pytest
+from sdv.utils.postgres import get_db_connection_string
+
+class TestGetDBConnectionString:
+
+    def test_empty_raises_exception(self):
+        with pytest.raises(KeyError):
+            get_db_connection_string({})
+
+    def test_db_name_and_user(self):
+        assert get_db_connection_string(dict(
+            DB_NAME="mydb",
+            DB_USER="myusr",
+        )) == "dbname=mydb user=myusr"
+
+    def test_db_name_user_password(self):
+        assert get_db_connection_string(dict(
+            DB_NAME="mydb",
+            DB_USER="myusr",
+            DB_PASSWORD="mypass",
+        )) == "dbname=mydb user=myusr password=mypass"
+
+    def test_all_attributes(self):
+        assert get_db_connection_string(dict(
+            DB_HOST="thehost",
+            DB_NAME="mydb",
+            DB_USER="myusr",
+            DB_PASSWORD="mypass",
+        )) == "dbname=mydb user=myusr password=mypass host=thehost"
+