Add dockerize, django-environ (#203)

* Remove unused cache purge

* Use django-environ to read config from env

* Pin dependencies for reproducible builds

* Add dockerize and a simple entrypoint

Author: vtemian

.env

@@ -0,0 +1,5 @@
+POSTGRES_USER=postgres
+POSTGRES_PASSWORD=postgres
+POSTGRES_DB=catpol
+
+DATABASE_URL=postgres://postgres:postgres@db/catpol

Dockerfile

@@ -1,15 +1,18 @@
 FROM alexstefanescu/catpol-dependencies
 
-RUN pip3 install --upgrade pip setuptools
+RUN pip3 install --upgrade pip setuptools \
+    && wget -qO- https://github.com/jwilder/dockerize/releases/download/v0.2.0/dockerize-linux-amd64-v0.2.0.tar.gz | tar -zxf - -C /usr/bin \
+    && chown root:root /usr/bin/dockerize
 
 ARG ENVIRONMENT=dev
 ENV DJANGO_SETTINGS_MODULE=project_template.settings.${ENVIRONMENT}
 
-# RUN find -type d -name __pycache__ -prune -exec rm -rf {} \; && \
-#     rm -rf ~/.cache/pip
+COPY ./ /opt/catpol
+
+# Re-install dependencies since it might have updated from cache
+RUN pip3 install -r requirements-${ENVIRONMENT}.txt
 
-COPY . /opt/catpol
 RUN python3 manage.py check
-CMD python3 manage.py migrate --run-syncdb \
-    && python3 manage.py runserver 0.0.0.0:8000
+
+ENTRYPOINT ["/opt/catpol/docker-entrypoint"]
 EXPOSE 8000

catpol-dependencies/Dockerfile

@@ -13,8 +13,6 @@ RUN pip3 install --upgrade pip setuptools
 ARG ENVIRONMENT=dev
 
 WORKDIR /opt/catpol
-COPY ./requirements* /opt/catpol/
-RUN pip3 install -r requirements-${ENVIRONMENT}.txt 
 
-# RUN find -type d -name __pycache__ -prune -exec rm -rf {} \; && \
-#     rm -rf ~/.cache/pip
+COPY ./requirements* /opt/catpol/
+RUN pip3 install -r requirements-${ENVIRONMENT}.txt

database.env

@@ -1,19 +1,19 @@
 version: '3'
 services:
-  catpol-database:
+  web:
+      build: .
+      command: ls -la /opt/catpol && dockerize --wait tcp://db:3306
+      ports:
+        - "8000:8000"
+      volumes:
+        - ./:/opt/catpol
+
+  db:
     image: "postgres:12"
-    container_name: catpol_psql
     ports:
       - "5432:5432"
-    env_file:
-      - database.env
     volumes:
-      - database-data:/var/lib/postgresql/data/ 
-  catpol:
-      build: .
-      container_name: catpol
-      ports:
-        - "8000:8000"
+      - database-data:/var/lib/postgresql/data/
 
 volumes:
-  database-data:
+  database-data:

docker-compose.yml

@@ -0,0 +1,9 @@
+#!/bin/sh
+
+PORT=${PORT:-"8000"}
+
+echo "Migrating databse"
+python3 manage.py migrate --run-syncdb
+
+echo "Start web server on $PORT"
+python3 manage.py runserver "0.0.0.0:$PORT"

docker-entrypoint

@@ -12,8 +12,17 @@
 
 import os
 
+import environ
 from moonsheep.settings import *
 
+root = environ.Path(__file__) - 3  # three folder back (/a/b/c/ - 3 = /)
+env = environ.Env(
+    # set casting, default value
+    DEBUG=(bool, False)
+)
+environ.Env.read_env(f"{root}/.env")  # reading .env file
+
+
 MOONSHEEP.update({
     'APP': 'project_template'  # TODO list from document models instead of defining here
 })
@@ -100,6 +109,14 @@
 USE_L10N = True
 USE_TZ = True
 
+
+DATABASES = {
+    # read os.environ['DATABASE_URL'] and raises ImproperlyConfigured exception if not found
+    'default': env.db('DATABASE_URL'),
+    # read os.environ['SQLITE_URL']
+    'extra': env.db('SQLITE_URL', default=f"sqlite:///{os.path.join(BASE_DIR, 'db.sqlite3'),}")
+}
+
 # Static files (CSS, JavaScript, Images)
 # https://docs.djangoproject.com/en/2.0/howto/static-files/
 

project_template/settings/base.py

@@ -34,25 +34,10 @@
     INSTALLED_APPS += ['debug_toolbar', 'django_extensions']
     MIDDLEWARE.insert(1, 'debug_toolbar.middleware.DebugToolbarMiddleware')
 
+# TODO: read it from env or generate a new one
 SECRET_KEY = 'https://uploads.skyhighnetworks.com/wp-content/uploads/2015/08/06195203/Bart-Chalkboard-for-Blog-Post.png'
 
 # Database
 # https://docs.djangoproject.com/en/2.0/ref/settings/#databases
 
-DATABASES = {
-    'default': {
-            'ENGINE': 'django.db.backends.postgresql',
-            'NAME': 'catpol',
-            'USER': 'postgres',
-            'PASSWORD': 'postgres',
-            'HOST': 'catpol-database',
-            'PORT': '5432',
-        },
-    'sqlite': {
-        'ENGINE': 'django.db.backends.sqlite3',
-        'NAME': os.path.join(BASE_DIR, 'db.sqlite3'),
-    },
-}
-
-
 EMAIL_BACKEND = 'django.core.mail.backends.console.EmailBackend'

project_template/settings/dev.py

@@ -14,6 +14,7 @@
 
 # See https://docs.djangoproject.com/en/2.0/howto/deployment/checklist/
 
+# TODO: read secret env form env, it should be added at deploy time
 SECRET_KEY = '${SECRET_KEY}'
 
 # To be double sure
@@ -29,17 +30,6 @@
 # Database
 # https://docs.djangoproject.com/en/2.0/ref/settings/#databases
 
-# DATABASES = {
-#     'default': {
-#         'ENGINE': 'django.db.backends.postgresql',
-#         'NAME': 'moonsheep',
-#         'USER': 'moonsheep',
-#         'PASSWORD': 'moonsheep',
-#         'HOST': 'postgres',
-#         'PORT': 5432,
-#     }
-# }
-
 DATABASES = {
     'default': {
         'ENGINE': 'django.db.backends.postgresql_psycopg2',

project_template/settings/production.py

@@ -14,6 +14,7 @@
 
 # See https://docs.djangoproject.com/en/2.0/howto/deployment/checklist/
 
+# TODO: read secret env form env, it should be added at deploy time
 SECRET_KEY = '${SECRET_KEY}'
 
 # To be double sure
@@ -24,18 +25,3 @@
 INTERNAL_IPS = []
 
 WSGI_APPLICATION = 'project_template.wsgi.application'
-
-
-# Database
-# https://docs.djangoproject.com/en/2.0/ref/settings/#databases
-
-# DATABASES = {
-#     'default': {
-#         'ENGINE': 'django.db.backends.postgresql',
-#         'NAME': 'moonsheep',
-#         'USER': 'moonsheep',
-#         'PASSWORD': 'moonsheep',
-#         'HOST': 'postgres',
-#         'PORT': 5432,
-#     }
-# }