Dockerize app

.gitignore

@@ -4,4 +4,5 @@ web/node_modules
 .idea
 app/__pycache__
 .vscode/
-__pycache__/
+__pycache__/
+postgres-data/

README.md

@@ -22,9 +22,9 @@ Pangea Network Admin Dashboard
 
 4. Run the application:
 
-    `python3 app.py`
+    `python3 pangeanetwork.py`
 
-    The backend will run at `localhost:5000`. The first time you run this example, a sample sqlite database gets populated automatically. To suppress this behaviour, comment the following lines in app.py:
+    The backend will run at `localhost:5001`. The first time you run this example, a sample sqlite database gets populated automatically. To suppress this behaviour, comment the following lines in app.py:
 
         if not os.path.exists(database_path):
             build_sample_db()

api/Dockerfile

@@ -0,0 +1,35 @@
+FROM python:3.6
+
+# set work directory
+WORKDIR /opt/api
+
+# set environment variables
+ENV PYTHONDONTWRITEBYTECODE 1
+ENV PYTHONUNBUFFERED 1
+ENV FLASK_ENV development
+ENV FLASK_DEBUG 1
+ENV FLASK_APP run.py
+
+# install postgres client
+RUN apt update && \
+      apt install postgresql-client -y && \
+      rm -rf /var/cache/apt/archives
+
+# install dependencies
+RUN pip install --upgrade pip
+RUN pip install pipenv
+COPY ./Pipfile .
+RUN export LDFLAGS="-L/usr/local/opt/openssl/lib"
+RUN pipenv install --system --skip-lock --dev --deploy
+
+# Setup a Development User
+RUN useradd -ms /bin/bash pangea 
+USER pangea
+
+# copy project
+COPY . .
+
+# Run Commands
+EXPOSE 5000
+ENTRYPOINT ["/opt/api/cmds/entrypoint.sh"]
+CMD ["python", "-m", "flask", "run", "--host=0.0.0.0"]

api/Pipfile

@@ -0,0 +1,18 @@
+[[source]]
+url = "https://pypi.python.org/simple"
+verify_ssl = true
+name = "pypi"
+
+[packages]
+Flask = "==2.0.1"
+Flask-SQLAlchemy = "==2.5.1"
+psycopg2 = "==2.9.1"
+flask-restful = "==0.3.9"
+flask-cors = "==3.0.10"
+flask-jwt = "*"
+werkzeug = "*"
+africastalking = "*"
+
+[dev-packages]
+black = "*"
+pytest = "==4.4.1"

api/bootstrap/__init__.py

@@ -0,0 +1,5 @@
+""" Bootstraps the Flask application and its dependencies. """
+
+
+from .base import *
+

api/bootstrap/base.py

@@ -0,0 +1,58 @@
+""" An intermediary bootstrapping file that makes factories of various reusable app components. """
+
+import os
+import typing as t
+
+from flask import Flask
+from flask_sqlalchemy import SQLAlchemy
+
+from models import db
+
+
+
+def app_factory(config: t.Optional[t.Dict[str, t.Any]] = None) -> Flask:
+    """ Bootstraps a Flask application and adds dependencies to the resulting object.
+
+    After bootstrap, it's a good idea to never import from `run` or the source of the bootstraped
+    Flask application. Instead, all boostrapped extensions should be accessed with Flask's `current_app`.
+
+    Example:
+        from flask import current_app as app
+
+        ...
+
+        def my_method():
+            with app.appcontext():
+                result = app.db.session.query(MyModel).first()
+
+    Args:
+        config (Optional[Dict[str, Any]]): A configuration object to update the app's config with
+
+    Returns:
+        Flask: The bootstrapped flask application object
+    """
+    app = Flask(__name__)
+    app.config["SQLALCHEMY_DATABASE_URI"] = os.environ.get("SQLALCHEMY_DATABASE_URI")
+    app.config["SQLALCHEMY_TRACK_MODIFICATIONS"] = bool(
+        os.environ.get("SQLALCHEMY_TRACK_MODIFICATIONS", 0)
+    )
+    app.config["DEBUG"] = True
+    app.config.update(**(config or {}))
+    app.db = database_factory(app)
+    return app
+
+
+def database_factory(app: Flask) -> SQLAlchemy:
+    """ Bootstraps SQLAlchemy for use with the Flask-SQLAlchemy extension. 
+
+    Override this method with another db factory if you'd prefer, just be
+    sure to update the return typing of the `database_factory` method.
+
+    Args:
+        app (Flask): The flask app to add this db engine to
+
+    Returns:
+        SQLAlchemy: The SQLAlchemy engine
+    """
+    db.init_app(app)
+    return db

api/cmds/entrypoint.sh

@@ -0,0 +1,10 @@
+#!/bin/bash
+
+cd /opt/api
+
+# The entrypoint for the Postscript Homework API
+./cmds/wait-for-it.sh db:5432 -s -- printf "Database Successfully Started\n"
+
+# Execute main run command
+exec "$@"
+exit

api/cmds/wait-for-it.sh

@@ -0,0 +1,200 @@
+#!/usr/bin/env bash
+#   Use this script to test if a given TCP host/port are available
+#   https://github.com/vishnubob/wait-for-it
+
+# The MIT License (MIT)
+# Copyright (c) 2016 Giles Hall
+# 
+# Permission is hereby granted, free of charge, to any person obtaining a copy of
+# this software and associated documentation files (the "Software"), to deal in
+# the Software without restriction, including without limitation the rights to
+# use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+# of the Software, and to permit persons to whom the Software is furnished to do
+# so, subject to the following conditions:
+# 
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+WAITFORIT_cmdname=${0##*/}
+
+echoerr() { if [[ $WAITFORIT_QUIET -ne 1 ]]; then echo "$@" 1>&2; fi }
+
+usage()
+{
+    cat << USAGE >&2
+Usage:
+    $WAITFORIT_cmdname host:port [-s] [-t timeout] [-- command args]
+    -h HOST | --host=HOST       Host or IP under test
+    -p PORT | --port=PORT       TCP port under test
+                                Alternatively, you specify the host and port as host:port
+    -s | --strict               Only execute subcommand if the test succeeds
+    -q | --quiet                Don't output any status messages
+    -t TIMEOUT | --timeout=TIMEOUT
+                                Timeout in seconds, zero for no timeout
+    -- COMMAND ARGS             Execute command with args after the test finishes
+USAGE
+    exit 1
+}
+
+wait_for()
+{
+    if [[ $WAITFORIT_TIMEOUT -gt 0 ]]; then
+        echoerr "$WAITFORIT_cmdname: waiting $WAITFORIT_TIMEOUT seconds for $WAITFORIT_HOST:$WAITFORIT_PORT"
+    else
+        echoerr "$WAITFORIT_cmdname: waiting for $WAITFORIT_HOST:$WAITFORIT_PORT without a timeout"
+    fi
+    WAITFORIT_start_ts=$(date +%s)
+    while :
+    do
+        if [[ $WAITFORIT_ISBUSY -eq 1 ]]; then
+            nc -z $WAITFORIT_HOST $WAITFORIT_PORT
+            WAITFORIT_result=$?
+        else
+            (echo > /dev/tcp/$WAITFORIT_HOST/$WAITFORIT_PORT) >/dev/null 2>&1
+            WAITFORIT_result=$?
+        fi
+        if [[ $WAITFORIT_result -eq 0 ]]; then
+            WAITFORIT_end_ts=$(date +%s)
+            echoerr "$WAITFORIT_cmdname: $WAITFORIT_HOST:$WAITFORIT_PORT is available after $((WAITFORIT_end_ts - WAITFORIT_start_ts)) seconds"
+            break
+        fi
+        sleep 1
+    done
+    return $WAITFORIT_result
+}
+
+wait_for_wrapper()
+{
+    # In order to support SIGINT during timeout: http://unix.stackexchange.com/a/57692
+    if [[ $WAITFORIT_QUIET -eq 1 ]]; then
+        timeout $WAITFORIT_BUSYTIMEFLAG $WAITFORIT_TIMEOUT $0 --quiet --child --host=$WAITFORIT_HOST --port=$WAITFORIT_PORT --timeout=$WAITFORIT_TIMEOUT &
+    else
+        timeout $WAITFORIT_BUSYTIMEFLAG $WAITFORIT_TIMEOUT $0 --child --host=$WAITFORIT_HOST --port=$WAITFORIT_PORT --timeout=$WAITFORIT_TIMEOUT &
+    fi
+    WAITFORIT_PID=$!
+    trap "kill -INT -$WAITFORIT_PID" INT
+    wait $WAITFORIT_PID
+    WAITFORIT_RESULT=$?
+    if [[ $WAITFORIT_RESULT -ne 0 ]]; then
+        echoerr "$WAITFORIT_cmdname: timeout occurred after waiting $WAITFORIT_TIMEOUT seconds for $WAITFORIT_HOST:$WAITFORIT_PORT"
+    fi
+    return $WAITFORIT_RESULT
+}
+
+# process arguments
+while [[ $# -gt 0 ]]
+do
+    case "$1" in
+        *:* )
+        WAITFORIT_hostport=(${1//:/ })
+        WAITFORIT_HOST=${WAITFORIT_hostport[0]}
+        WAITFORIT_PORT=${WAITFORIT_hostport[1]}
+        shift 1
+        ;;
+        --child)
+        WAITFORIT_CHILD=1
+        shift 1
+        ;;
+        -q | --quiet)
+        WAITFORIT_QUIET=1
+        shift 1
+        ;;
+        -s | --strict)
+        WAITFORIT_STRICT=1
+        shift 1
+        ;;
+        -h)
+        WAITFORIT_HOST="$2"
+        if [[ $WAITFORIT_HOST == "" ]]; then break; fi
+        shift 2
+        ;;
+        --host=*)
+        WAITFORIT_HOST="${1#*=}"
+        shift 1
+        ;;
+        -p)
+        WAITFORIT_PORT="$2"
+        if [[ $WAITFORIT_PORT == "" ]]; then break; fi
+        shift 2
+        ;;
+        --port=*)
+        WAITFORIT_PORT="${1#*=}"
+        shift 1
+        ;;
+        -t)
+        WAITFORIT_TIMEOUT="$2"
+        if [[ $WAITFORIT_TIMEOUT == "" ]]; then break; fi
+        shift 2
+        ;;
+        --timeout=*)
+        WAITFORIT_TIMEOUT="${1#*=}"
+        shift 1
+        ;;
+        --)
+        shift
+        WAITFORIT_CLI=("$@")
+        break
+        ;;
+        --help)
+        usage
+        ;;
+        *)
+        echoerr "Unknown argument: $1"
+        usage
+        ;;
+    esac
+done
+
+if [[ "$WAITFORIT_HOST" == "" || "$WAITFORIT_PORT" == "" ]]; then
+    echoerr "Error: you need to provide a host and port to test."
+    usage
+fi
+
+WAITFORIT_TIMEOUT=${WAITFORIT_TIMEOUT:-120}
+WAITFORIT_STRICT=${WAITFORIT_STRICT:-0}
+WAITFORIT_CHILD=${WAITFORIT_CHILD:-0}
+WAITFORIT_QUIET=${WAITFORIT_QUIET:-0}
+
+# check to see if timeout is from busybox?
+WAITFORIT_TIMEOUT_PATH=$(type -p timeout)
+WAITFORIT_TIMEOUT_PATH=$(realpath $WAITFORIT_TIMEOUT_PATH 2>/dev/null || readlink -f $WAITFORIT_TIMEOUT_PATH)
+if [[ $WAITFORIT_TIMEOUT_PATH =~ "busybox" ]]; then
+        WAITFORIT_ISBUSY=1
+        WAITFORIT_BUSYTIMEFLAG="-t"
+
+else
+        WAITFORIT_ISBUSY=0
+        WAITFORIT_BUSYTIMEFLAG=""
+fi
+
+if [[ $WAITFORIT_CHILD -gt 0 ]]; then
+    wait_for
+    WAITFORIT_RESULT=$?
+    exit $WAITFORIT_RESULT
+else
+    if [[ $WAITFORIT_TIMEOUT -gt 0 ]]; then
+        wait_for_wrapper
+        WAITFORIT_RESULT=$?
+    else
+        wait_for
+        WAITFORIT_RESULT=$?
+    fi
+fi
+
+if [[ $WAITFORIT_CLI != "" ]]; then
+    if [[ $WAITFORIT_RESULT -ne 0 && $WAITFORIT_STRICT -eq 1 ]]; then
+        echoerr "$WAITFORIT_cmdname: strict mode, refusing to execute subprocess"
+        exit $WAITFORIT_RESULT
+    fi
+    exec "${WAITFORIT_CLI[@]}"
+else
+    exit $WAITFORIT_RESULT
+fi

api/models/__init__.py

@@ -0,0 +1,5 @@
+""" Base folder for SQLAlchemy models. """
+
+
+from .base import *
+

api/models/base.py

@@ -0,0 +1,7 @@
+""" Initializes the model bases without mounting it to the Flask App. """
+
+
+from flask_sqlalchemy import SQLAlchemy
+
+
+db = SQLAlchemy()