[Feature] Integrate Docker-based deployment

.dockerignore

@@ -0,0 +1,48 @@
+# experimental .dockerignore
+
+# do NOT include the util directory
+util
+
+# do NOT include the provided deployment-related files
+deploy
+# but DO include the production-related scripts/config files that are used
+# inside of the images
+!deploy/Docker/bin/*
+!deploy/Docker/django/entrypoint_django.sh
+!deploy/Docker/django/gunicorn_conf.py
+!deploy/Docker/django/run_gunicorn.sh
+!deploy/Docker/nginx/nginx.conf
+!deploy/Docker/nginx/entrypoint_nginx.sh
+
+# do NOT include the documentation
+# TODO: the original doc-folder of django-project-skeleton should be removed
+#   during initialisation of the project. On the other hand, there could be
+#   project specific documentation. However, this should be excluded from any
+#   image.
+docs
+
+# inside of the images, only the compiled requirements files with the '.txt'
+# extension are used. No need to include the source files.
+requirements/*.in
+
+# utility files/directories of the repository should not be included
+**/.git
+**/.tox
+**/.dockerignore
+**/.editorconfig
+**/.gitignore
+**/.travis.yml
+**/Makefile
+**/README*
+**/tox.ini
+
+# do not include any samples
+**/*.sample
+
+# do NOT track Python compilation stuff
+*.py[cod]
+**/__python__
+**/__pycache__
+
+# TODO: .gitignore excludes compiled language files. Is it safe to exclude the
+#   uncompiled language files for 'production'?

.gitignore

@@ -13,5 +13,7 @@ coverage_html
 *.mo
 *.pot
 
-# I started relying on putting temporary notes into TODO files
-*.todo
+# do NOT track environment files that are used for docker-compose, but do
+# include the sample
+deploy/Docker/env.*
+!deploy/Docker/env.sample

.travis.yml

@@ -11,7 +11,6 @@ language: python
 
 # listing the Python versions to be tested
 python:
-    - "2.7"
     - "3.4"
     - "3.5"
     - "3.6"

Makefile

@@ -1,34 +1,89 @@
 .SILENT:
-.PHONY: all clean current doc doc-srv serve tox
+.PHONY: clean init tree \
+		docker/build docker/build-context .docker/build-context
 
+# Docker command
+DOCKER_CMD := $(shell which docker)
 
-all:
-	echo ""
-	echo "  clean        Removes all temporary files"
-	echo "  current      Runs the tox-environment for the current development"
-	echo "  doc          Builds the documentation using 'Sphinx'"
-	echo "  doc-srv      Serves the documentation on port 8082 (and automatically builds it)"
-	echo "  serve        Runs the Django development server on port 8080"
-	echo "  tox          Runs complete tox test"
-	echo ""
+# Docker compose command
+DOCKER_COMPOSE_CMD := $(shell which docker-compose)
 
+# Docker related testing is performed by using tox:
+#	- an environment is used to setup a testing project (docker-testing)
+#	- the project is setup in the temporary directory, thus this step is
+#		performed by every run
+#	- the Docker build is triggered using the corresponding Makefile
+#		Makefile.deployment
+#	- this Makefile will automatically tag the created image
+#	- to start the image, this tagging has to be reproduced here
+#
+# During project setup, this variable is set to the project's name.
+# The described testing process will use 'dpstest' as the project's name
+DPS_BUILD_NAME_PREFIX := "dpstest"
+# While the image is build, the git commit's sha1 hash is used to tag the image
+# Additionally, 'latest' is applied to the image aswell.
+# In order to run the image, we rely on the 'latest' build.
+DPS_BUILD_ID := "latest"
 
-# deletes all temporary files created by Django
+
+# deletes all temporary and unwanted files
 clean:
+	# clean temporary Python files
 	find . -iname "*.pyc" -delete
 	find . -iname "__pycache__" -delete
+	# During development of django-project-skeleton, compiled requirement
+	# files are needed at some points, but the (compiled) requirements should
+	# not be included into version control of the skeleton.
+	# However, once the repository is fetched and used as a template for
+	# Django's startproject, the compiled requirements *should* be included
+	# into version control, thus, they can not simply included in a .gitignore.
+	rm requirements/common.txt
+	rm requirements/production.txt
+	rm configs/Docker/env.production
+
+init:
+	# TODO: Include some output to this function
+	# create the final version of different files by removing the '.template' suffix
+	mv ./deploy/apache2_vhost.sample.template ./deploy/apache2_vhost.sample
+	# switching the tox configuration file
+	mv ./util/init/tox.ini.template ./tox.ini
+	# switching the Makefile **should** be the last step
+	mv ./util/init/Makefile.template ./Makefile
+
+deploy/Docker/env.production:
+	echo "Initializing environment file for production..."
+	cp deploy/Docker/env.sample deploy/Docker/env.production
+	sed -i "s/#DPS_DJANGO_SECRET_KEY=/DPS_DJANGO_SECRET_KEY=$(shell ./util/bin/generate_secret_key.sh)/" deploy/Docker/env.production
+
+docker/build: deploy/Docker/env.production
+	tox -q -e docker-testing
+
+docker/build-context:
+	sudo $(MAKE) .docker/build-context
+
+docker/images:
+	sudo $(MAKE) .docker/images
+
+docker/run: docker/build
+	sudo $(MAKE) .docker/run
 
-current:
-	tox -q -e util
+run: docker/run
 
-doc:
-	tox -q -e doc
+tree:
+	tree -a -I ".git|.tox|docs|run" --dirsfirst -C | less -r
 
-doc-srv: doc
-	tox -q -e doc-srv
+.docker/build-context:
+	echo " \
+		FROM busybox\n \
+		COPY . /build-context\n \
+		WORKDIR /build-context\n \
+		CMD find ." | \
+	$(DOCKER_CMD) build -t "$(DPS_BUILD_NAME_PREFIX)/build-context:latest" -f- . && \
+	$(DOCKER_CMD) container run --rm "$(DPS_BUILD_NAME_PREFIX)/build-context:latest"
 
-serve:
-	tox -q -e run
+.docker/images:
+	$(DOCKER_CMD) images
 
-tox:
-	tox -q
+.docker/run:
+	DPS_BUILD_NAME_PREFIX=$(DPS_BUILD_NAME_PREFIX) DPS_BUILD_ID=$(DPS_BUILD_ID) \
+	$(DOCKER_COMPOSE_CMD) -f deploy/Docker/docker-compose.yml up

config/settings/common.py

@@ -0,0 +1,156 @@
+# Python imports
+import logging
+import os
+import sys
+
+logger = logging.getLogger(__name__)
+
+
+# ##### PATH CONFIGURATION ################################
+
+# fetch Django's project directory
+DJANGO_ROOT = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
+
+# fetch the project_root
+PROJECT_ROOT = os.path.dirname(DJANGO_ROOT)
+
+# the name of the whole site
+SITE_NAME = os.path.basename(DJANGO_ROOT)
+
+# collect static files here
+STATIC_ROOT = os.path.join(PROJECT_ROOT, 'run', 'static')
+
+# collect media files here
+MEDIA_ROOT = os.path.join(PROJECT_ROOT, 'run', 'media')
+
+# look for static assets here
+STATICFILES_DIRS = [
+    os.path.join(PROJECT_ROOT, 'static'),
+]
+
+# look for templates here
+# This is an internal setting, used in the TEMPLATES directive
+PROJECT_TEMPLATES = [
+    os.path.join(PROJECT_ROOT, 'templates'),
+]
+
+# add apps/ to the Python path
+sys.path.append(os.path.normpath(os.path.join(PROJECT_ROOT, 'apps')))
+
+
+# ##### APPLICATION CONFIGURATION #########################
+
+# set the project's default timezone
+TIME_ZONE = os.environ.get('DPS_TIMEZONE', 'Etc/UTC')
+
+# these are the apps
+DEFAULT_APPS = [
+    'django.contrib.admin',
+    'django.contrib.auth',
+    'django.contrib.contenttypes',
+    'django.contrib.sessions',
+    'django.contrib.messages',
+    'django.contrib.staticfiles',
+]
+
+# Middlewares
+MIDDLEWARE = [
+    'django.middleware.security.SecurityMiddleware',
+    'django.contrib.sessions.middleware.SessionMiddleware',
+    'django.middleware.common.CommonMiddleware',
+    'django.middleware.csrf.CsrfViewMiddleware',
+    'django.contrib.auth.middleware.AuthenticationMiddleware',
+    'django.contrib.messages.middleware.MessageMiddleware',
+    'django.middleware.clickjacking.XFrameOptionsMiddleware',
+]
+
+# template stuff
+TEMPLATES = [
+    {
+        'BACKEND': 'django.template.backends.django.DjangoTemplates',
+        'DIRS': PROJECT_TEMPLATES,
+        'APP_DIRS': True,
+        'OPTIONS': {
+            'context_processors': [
+                'django.contrib.auth.context_processors.auth',
+                'django.template.context_processors.debug',
+                'django.template.context_processors.i18n',
+                'django.template.context_processors.media',
+                'django.template.context_processors.static',
+                'django.template.context_processors.tz',
+                'django.contrib.messages.context_processors.messages'
+            ],
+        },
+    },
+]
+
+# The WSGI application to be used by Django's internal servers.
+# Please note, Django's 'runserver' should **not** be used in production
+# environments.
+# If set to 'None', 'django.core.wsgi.get_wsgi_application()' will be used to
+# determine the WSGI application.
+WSGI_APPLICATION = os.environ.get('DPS_DJANGO_WSGI_APP', None)
+
+# the root URL configuration
+ROOT_URLCONF = '{}.urls'.format(SITE_NAME)
+
+# the URL for static files
+STATIC_URL = os.environ.get('DPS_STATIC_URL', '/static/')
+
+# the URL for media files
+MEDIA_URL = os.environ.get('DPS_DJANGO_MEDIA_URL', '/media/')
+
+# adjust the minimal login
+LOGIN_URL = 'core_login'
+LOGIN_REDIRECT_URL = os.environ.get('DPS_DJANGO_LOGIN_REDIRECT_URL', '/')
+LOGOUT_REDIRECT_URL = os.environ.get('DPS_DJANGO_LOGOUT_REDIRECT_URL', 'core_login')
+
+# Internationalization
+USE_I18N = False
+
+# uncomment the following line to include i18n
+# from .i18n import *
+
+
+# ##### SECURITY CONFIGURATION ############################
+
+# We store the secret key here
+# The required SECRET_KEY is fetched at the end of this file
+SECRET_FILE = os.path.normpath(os.path.join(PROJECT_ROOT, 'run', 'SECRET.key'))
+
+# these persons receive error notification
+ADMINS = (
+    ('your name', 'your_name@example.com'),
+)
+MANAGERS = ADMINS
+
+
+# ##### DEBUG CONFIGURATION ###############################
+DEBUG = False
+
+
+logger.debug('Trying to fetch SECRET_KEY from the environment...')
+SECRET_KEY = os.environ.get('DPS_DJANGO_SECRET_KEY')
+if SECRET_KEY is None:
+    logger.debug('Could not find key in the environment!')
+
+    logger.debug('Trying to read SECRET_KEY from SECRET_FILE...')
+    try:
+        SECRET_KEY = open(SECRET_FILE).read().strip()
+        logger.info('Read SECRET_KEY from SECRET_FILE.')
+    except IOError:
+        logger.debug('Could not open SECRET_FILE ({})!'.format(SECRET_FILE))
+
+        try:
+            from django.utils.crypto import get_random_string
+            chars = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789!$%&()=+-_'
+            SECRET_KEY = get_random_string(50, chars)
+            with open(SECRET_FILE, 'w') as f:
+                f.write(SECRET_KEY)
+
+            logger.info('Generated a new SECRET_KEY and stored it in SECRET_FILE ({})!'.format(SECRET_FILE))
+        except IOError:
+            logger.exception('Could not open SECRET_FILE ({}) for writing!'.format(SECRET_FILE))
+            raise Exception('Could not open {} for writing!'.format(SECRET_FILE))
+else:
+    logger.info('Fetched SECRET_KEY from environment.')

project_name/settings/development.py → config/settings/development.py

@@ -1,33 +1,25 @@
 # Python imports
-from os.path import join
+import os
 
-# project imports
+# fetch the common settings
 from .common import *
 
-# uncomment the following line to include i18n
-# from .i18n import *
-
-
-# ##### DEBUG CONFIGURATION ###############################
-DEBUG = True
+# ##### APPLICATION CONFIGURATION #########################
 
 # allow all hosts during development
 ALLOWED_HOSTS = ['*']
 
-# adjust the minimal login
-LOGIN_URL = 'core_login'
-LOGIN_REDIRECT_URL = '/'
-LOGOUT_REDIRECT_URL = 'core_login'
+INSTALLED_APPS = DEFAULT_APPS
 
 
 # ##### DATABASE CONFIGURATION ############################
 DATABASES = {
     'default': {
         'ENGINE': 'django.db.backends.sqlite3',
-        'NAME': join(PROJECT_ROOT, 'run', 'dev.sqlite3'),
+        'NAME': os.path.join(PROJECT_ROOT, 'run', 'dev.sqlite3'),
     }
 }
 
-# ##### APPLICATION CONFIGURATION #########################
 
-INSTALLED_APPS = DEFAULT_APPS
+# ##### DEBUG CONFIGURATION ###############################
+DEBUG = True

project_name/settings/i18n.py → config/settings/i18n.py

@@ -1,5 +1,5 @@
 # Python imports
-from os.path import join
+import os
 
 # Django imports
 from django.utils.translation import ugettext_lazy as _
@@ -10,7 +10,6 @@
 # ##### INTERNATIONALIZATION ##############################
 
 LANGUAGE_CODE = 'de'
-TIME_ZONE = 'Europe/Berlin'
 
 # Internationalization
 USE_I18N = True
@@ -29,7 +28,7 @@
 
 # Look for translations in these locations
 LOCALE_PATHS = (
-    join(PROJECT_ROOT, 'locale'),
+    os.path.join(PROJECT_ROOT, 'locale'),
 )
 
 # Inject the localization middleware into the right position