added support for testing postgres using docker

Author: matthewhegarty

docs/example-app.rst

@@ -17,3 +17,29 @@ We encourage you to give it a try with a few commandline calls:
 A screenshot of the example app:
 
 .. image:: _static/screenshot.jpg
+
+Postgres
+########
+
+You can use Postgres as the source database.  To do this, you will need to have `Docker <https://docker.com/>`_ installed.
+
+Initialise the database as follows:
+
+.. code:: bash
+
+  $ export DRFDT_TEST_TYPE=postgres
+  $ export DRFDT_POSTGRESQL_USER=pguser
+  $ export DRFDT_POSTGRESQL_PASSWORD=pguserpass
+  $ export DJANGO_SETTINGS_MODULE=example.settings
+
+  $ # start a local postgres instance
+  $ docker-compose -f example/pg/docker-compose.yml up -d
+
+  $ python example/manage.py migrate
+  $ python example/manage.py test
+
+  $ # only required if you want to login to the Admin site
+  $ ./manage.py createsuperuser --username admin  --email=email@example.com
+
+  $ # shutdown the db (append -v to remove the data volume and delete all data)
+  $ docker-compose -f example/pg/docker-compose.yml down

example/albums/migrations/0002_auto_20210720_2132.py

@@ -0,0 +1,25 @@
+# Generated by Django 3.2.5 on 2021-07-20 21:32
+
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('albums', '0001_initial'),
+    ]
+
+    operations = [
+        migrations.AlterModelOptions(
+            name='album',
+            options={'ordering': ['name'], 'verbose_name': 'Album', 'verbose_name_plural': 'Albums'},
+        ),
+        migrations.AlterModelOptions(
+            name='artist',
+            options={'ordering': ['name'], 'verbose_name': 'Artist', 'verbose_name_plural': 'Artists'},
+        ),
+        migrations.AlterModelOptions(
+            name='genre',
+            options={'ordering': ['name'], 'verbose_name': 'Genre', 'verbose_name_plural': 'Genres'},
+        ),
+    ]

example/example/settings.py

@@ -80,13 +80,25 @@
 # Database
 # https://docs.djangoproject.com/en/2.0/ref/settings/#databases
 
-DATABASES = {
-    'default': {
-        'ENGINE': 'django.db.backends.sqlite3',
-        'NAME': os.path.join(BASE_DIR, 'db.sqlite3'),
-        'TEST': {'NAME': os.path.join(BASE_DIR, 'test.sqlite3')},
+if os.environ.get('DRFDT_TEST_TYPE') == 'postgres':
+    DATABASES = {
+        'default': {
+            'ENGINE': 'django.db.backends.postgresql',
+            'NAME': 'pg',
+            'USER': os.environ.get('DRFDT_POSTGRESQL_USER'),
+            'PASSWORD': os.environ.get('DRFDT_POSTGRESQL_PASSWORD'),
+            'HOST': 'localhost',
+            'PORT': 5432
+        }
+    }
+else:
+    DATABASES = {
+        'default': {
+            'ENGINE': 'django.db.backends.sqlite3',
+            'NAME': os.path.join(BASE_DIR, 'db.sqlite3'),
+            'TEST': {'NAME': os.path.join(BASE_DIR, 'test.sqlite3')},
+        }
     }
-}
 
 
 # Password validation

example/pg/README.md

@@ -0,0 +1,38 @@
+## Create Postgres DB
+
+If you want to test with a postgres database, you can do so as follows:
+
+### Pre-requisites
+
+- [Docker](https://docker.com)
+- [virtualenvwrapper](https://virtualenvwrapper.readthedocs.io/en/latest/command_ref.html)
+
+### Set env vars
+
+```bash
+export DRFDT_TEST_TYPE=postgres
+export DRFDT_POSTGRESQL_USER=pguser
+export DRFDT_POSTGRESQL_PASSWORD=pguserpass
+export DJANGO_SETTINGS_MODULE=example.settings
+
+# start a local postgres instance
+docker-compose -f pg/docker-compose.yml up -d 
+
+python example/manage.py migrate
+python example/manage.py test
+
+# only required if you want to login to the Admin site
+./manage.py createsuperuser --username admin  --email=email@example.com
+```
+
+### Load test data
+
+```bash
+python example/manage.py loaddata test_data
+```
+
+### Run server
+
+```bash
+python example/manage.py runserver
+```

example/pg/docker-compose.yml

@@ -0,0 +1,23 @@
+version: '3.3'
+services:
+  db:
+    container_name: drfdt_pgdb
+    environment:
+      DRFDT_TEST_TYPE: 'postgres'
+      DB_HOST: 'db'
+      DB_PORT: '5432'
+      DB_NAME: 'pg'
+      DRFDT_POSTGRESQL_USER: ${DRFDT_POSTGRESQL_USER}
+      DRFDT_POSTGRESQL_PASSWORD: ${DRFDT_POSTGRESQL_PASSWORD}
+      POSTGRES_PASSWORD: ${DRFDT_POSTGRESQL_PASSWORD}
+    image: postgres:10
+    restart: "no"
+    ports:
+      - 5432:5432
+    volumes:
+      - ./docker/db/:/docker-entrypoint-initdb.d/
+      - local-db-data:/var/lib/postgresql/data
+
+volumes:
+  local-db-data:
+    driver: local

example/pg/docker/db/init-user-db.sh

@@ -0,0 +1,10 @@
+#!/usr/bin/env bash
+set -e
+echo "init-user-db.sh"
+
+psql -v ON_ERROR_STOP=1 --username "$POSTGRES_USER" --dbname "$POSTGRES_DB" <<-EOSQL
+    CREATE USER $DRFDT_POSTGRESQL_USER WITH PASSWORD '$DRFDT_POSTGRESQL_PASSWORD';
+    CREATE DATABASE $DB_NAME ENCODING 'utf-8';
+    GRANT ALL PRIVILEGES ON DATABASE $DB_NAME TO $DRFDT_POSTGRESQL_USER;
+    ALTER USER $DRFDT_POSTGRESQL_USER CREATEDB;
+EOSQL

requirements-dev.txt

@@ -3,3 +3,4 @@ Django>=2.0
 djangorestframework>=3.8
 pycodestyle>=2.3
 django-filter>=2.4.0
+psycopg2-binary==2.8