Docker configuration and other improvements 🐳 (#2)

* Fix old code references, add better logging and refactor code
* Docker and Docker Compose configuration
* Procfile configuration
* Minor README improvements

Author: mrsarm

.dockerignore

@@ -0,0 +1,39 @@
+# Files to ignore when building Docker image, basically the same than .gitignore
+
+# Python compiled byte code
+*.pyc
+
+# Staticfiles
+staticfiles/
+
+# Log files
+*.log
+
+# IDE files
+.idea
+*.iml
+*.ipr
+*.iws
+.settings
+.project
+.pydevproject
+.directory
+
+# Script for different environments
+prod.sh
+dev.sh
+
+# Static files collected
+/static
+
+# Virtual environments
+venv*/
+.venv*/
+
+/.env*
+
+# Files from source that aren't needed in the image
+Dockerfile
+README*
+COPYING
+__*

.editorconfig

@@ -9,5 +9,5 @@ charset = utf-8
 indent_style = space
 indent_size = 4
 
-[*.html]
+[*.{html,yml}]
 indent_size = 2

.env.example

@@ -0,0 +1,3 @@
+PORT=8888
+DCOLEMAN_ENDPOINT=http://django-coleman:8000/api/v1
+DJANGO_COLEMAN_IP=10.0.0.4

.gitignore

@@ -28,3 +28,4 @@ dev.sh
 venv*/
 .venv*/
 
+/.env

Dockerfile

@@ -0,0 +1,31 @@
+FROM python:3.10-alpine
+LABEL maintainer="Mariano Ruiz <[email protected]>"
+
+ENV PROCESS_TYPE="web" \
+    PORT=8888
+
+WORKDIR /usr/src/app
+
+COPY requirements.txt /usr/src/app/
+
+RUN apk add --no-cache --purge shadow \
+    && useradd -ms /bin/bash worker \
+    && chown -R worker:worker /usr/src/app \
+    && chown worker:worker requirements.txt \
+    && pip install --no-cache-dir -U pip \
+    && pip3 install --no-cache-dir \
+        honcho \
+    && pip3 install --no-cache-dir -r requirements.txt
+
+COPY --chown=worker ./ ./
+
+ARG BUILD
+LABEL build=${BUILD}
+RUN echo "Build: $BUILD" > image_build \
+    && echo "UTC: $(date --utc +%FT%R)" >> image_build
+
+RUN chown worker -R *
+
+USER worker
+
+CMD ["sh", "-c", "exec honcho start --no-prefix $PROCESS_TYPE"]

Procfile

@@ -0,0 +1 @@
+web: ./app.py

README.rst

@@ -70,11 +70,27 @@ Settings
 +---------------------------+---------+----------------------------------+--------------------------------------------------------------+
 
 
+Docker
+------
+
+A reference `<Dockerfile>`_ is provided, that's is going to be published
+in Docker Hub *(in progress)*.
+
+Also a `<docker-compose.yml>`_ is provided, you can build and run the
+the app with Docker Compose with::
+
+    $ docker-compose up
+
+Although when using Docker Compose, it's recommended to use the compose
+file from the Django Coleman project instead of the local here, that
+allows to run all: Django Coleman, this Viewer app and Postgres at once.
+
+
 About
 -----
 
 **Project**: https://github.com/mrsarm/tornado-dcoleman-mtasks-viewer
 
-**Authors**: (2019-2021) Mariano Ruiz <[email protected]>
+**Authors**: (2019-2022) Mariano Ruiz <[email protected]>
 
 **License**: AGPL-v3

app.py

@@ -1,4 +1,5 @@
 #!/usr/bin/env python3
+
 import logging
 import os
 import datetime
@@ -13,23 +14,75 @@
 salt       = os.getenv('DCOLEMAN_TASKS_VIEWER_HASH_SALT', '1two3')
 title      = "Django Coleman - Task Viewer | {}".format
 mtasks_url = (endpoint + "/tasks/{}/").format
+port       = int(os.getenv('PORT', 8888))
 master_t   = os.getenv('DCOLEMAN_MASTER_TOKEN', 'porgs')      # A master token to access to any order,
                                                               # REPLACE in production or leave it blank to disable
 
+logger = logging.getLogger('dcoleman-viewer')
+logger.setLevel(logging.INFO)
+handler = logging.StreamHandler()
+handler.setFormatter(logging.Formatter('%(asctime)s %(levelname)s [%(name)s] %(message)s'))
+logging.root.addHandler(handler)
+logging.root.setLevel(logging.INFO)
+
+
+def get_assigned_to(user):
+    if not user:
+        return ""
+    full_name = " ".join(
+        filter(None, (user.get("first_name"), user.get("last_name")))
+    )
+    return full_name if full_name else user["username"]
+
+
+def get_created_at(created_at):
+    if not created_at:
+        return ""
+    return datetime.datetime.strptime(created_at, "%Y-%m-%dT%H:%M:%S.%fZ") \
+                            .strftime("%B %d, %Y")
+
+
+def get_deadline(deadline):
+    if not deadline:
+        return ""
+    return datetime.datetime.strptime(deadline, "%Y-%m-%d") \
+                            .strftime("%B %d, %Y")
+
+
+def is_valid_token(order_number, token_url):
+    """
+    Verifies whether the token is valid or not.
+    It uses the same algorithm used by Django Coleman to
+    generates the token using as input a salt code and
+    the Order Number
+
+    See: ``mtasks.models.Task#get_tasks_viewer_url`` from the
+         Django Coleman project
+    """
+    if master_t and token_url == master_t:  # Master Token is Magic !
+        return True
+    pk = int(order_number)      # Removes the leading zeros
+    token = "{}-{}".format(salt, pk)
+    token = sha1(token.encode('utf-8')).hexdigest()
+    return token == token_url
+
+
 class BaseHandler(RequestHandler):
+
     def error(self, status, msg="Unexpected Error", exc_info=None):
         if exc_info:
-            logging.error("Unexpected error %s", exc_info.__class__.__name__, exc_info=exc_info)
+            logger.error("Unexpected error %s", exc_info.__class__.__name__, exc_info=exc_info)
         self.set_status(status)
         return self.render("error.html", title=title(msg), error=msg)
 
 
 class MainHandler(BaseHandler):
+
     async def get(self, task_number):
         token = self.get_argument("t", None)
         if not token:
             return self.error(401, "Unauthorized Access")
-        if not self.is_valid_token(task_number, token):
+        if not is_valid_token(task_number, token):
             return self.error(401, "Invalid Authorization Code")
         http_client = AsyncHTTPClient()
         try:
@@ -43,9 +96,9 @@ async def get(self, task_number):
             return self.error(500, exc_info=e)
         order = json_decode(response.body)
         state = order['state']
-        assigned_to = self.get_assigned_to(order.get('user'))
-        created_at = self.get_created_at(order.get('created_at'))
-        deadline = self.get_deadline(order.get('deadline'))
+        assigned_to = get_assigned_to(order.get('user'))
+        created_at = get_created_at(order.get('created_at'))
+        deadline = get_deadline(order.get('deadline'))
         return self.render("index.html",
                            title=title(f"Task #{task_number}"),
                            order=order,
@@ -54,45 +107,9 @@ async def get(self, task_number):
                            state=state,
                            assigned_to=assigned_to)
 
-    def get_assigned_to(self, user):
-        if not user:
-            return ""
-        full_name = " ".join(
-            filter(None, (user.get("first_name"), user.get("last_name")))
-        )
-        return full_name if full_name else user["username"]
-
-    def get_created_at(self, created_at):
-        if not created_at:
-            return ""
-        return datetime.datetime.strptime(created_at, "%Y-%m-%dT%H:%M:%S.%fZ") \
-                                .strftime("%B %d, %Y")
-
-    def get_deadline(self, deadline):
-        if not deadline:
-            return ""
-        return datetime.datetime.strptime(deadline, "%Y-%m-%d") \
-                                .strftime("%B %d, %Y")
-
-    def is_valid_token(self, order_number, token_url):
-        """
-        Verifies whether the token is valid or not.
-        It uses the same algorithm used by Django Coleman to
-        generates the token using as input a salt code and
-        the Order Number
-
-        See: ``mtasks.models.Task#get_tasks_viewer_url`` from the
-             Django Coleman project
-        """
-        if master_t and token_url == master_t:  # Master Token is Magic !
-            return True
-        pk = int(order_number)      # Removes the leading zeros
-        token = "{}-{}".format(salt, pk)
-        token = sha1(token.encode('utf-8')).hexdigest()
-        return token == token_url
-
 
 class NotFoundHandler(BaseHandler):
+
     def prepare(self):  # for all methods
         return self.error(404, "Resource Not Found")
 
@@ -104,6 +121,15 @@ def make_app():
 
 
 if __name__ == "__main__":
+    logger.info('Starting server at port %d', port)
     app = make_app()
-    app.listen(8888)
-    IOLoop.current().start()
+    app.listen(port)
+    try:
+        loop = IOLoop.current()
+        loop.start()
+    except KeyboardInterrupt:
+        pass
+    finally:
+        loop.stop()
+        loop.close(True)  # needed to close all open sockets
+        logger.info("Server shut down, exiting...")

docker-build.sh

@@ -0,0 +1,25 @@
+#!/usr/bin/env sh
+
+# Get the tag
+if [ "$#" -gt 0 ] ; then
+    export TAG="$1"
+#elif [ -n "$GITHUB_REF" ]; then
+#    export TAG=${GITHUB_REF##*/}
+else
+    export TAG="latest"
+fi
+
+# Get the build
+if [ -n "$GITHUB_SHA" ] ; then
+    GIT_HASH=${GITHUB_SHA}
+    GIT_BRANCH=${GITHUB_REF#refs/heads/}
+else
+    GIT_HASH=$(git rev-parse HEAD)
+    GIT_BRANCH=$(git symbolic-ref --short HEAD)
+fi
+GIT_HASH_SHORT=$(git rev-parse --short "$GIT_HASH")
+export BUILD=${GIT_BRANCH}.${GIT_HASH_SHORT}
+
+echo "Building mrsarm/django-coleman-mtasks-viewer:${TAG} with image_build $BUILD ..."
+#docker-compose build
+docker build --build-arg=BUILD="$BUILD" -t mrsarm/django-coleman-mtasks-viewer:${TAG} .

docker-compose.yml

@@ -0,0 +1,21 @@
+version: '3.7'
+
+
+# Use this compose file as reference or to build the image,
+# but better to start the app from the main django-coleman compose
+services:
+  django-coleman-mtasks-viewer:
+    image: "mrsarm/django-coleman-mtasks-viewer:${TAG:-latest}"
+    build:
+      context: .
+      args:
+        - BUILD
+    ports:
+      - "8888:8888"
+    environment:
+      - PORT
+      - DCOLEMAN_ENDPOINT
+      - DCOLEMAN_TASKS_VIEWER_HASH_SALT
+      - DCOLEMAN_MASTER_TOKEN
+    extra_hosts:
+      - "django-coleman:${DJANGO_COLEMAN_IP}"