container: use DJANGO_SETTINGS_MODULE=ynr.settings

This reverts all changes to ynr.settings.testing, and defaults the
containerised YNR app to use the base ynr.settings module throughout the build
process and the compose invocation. The pytest wrapper script is allowed to use
pytest's default settings already configured via pyproject.toml.

This change is generally implemented by removing the explicit use of
ynr.settings.testing across various scenarios, and opting in to manage.py's
default of ynr.settings (which inherits ynr.settings.base).

Also: small tweaks to docs.

Signed-off-by: Jonathan Matthews <github@hello.jonathanmatthews.com>

Author: jpluscplusm

.circleci/config.yml

@@ -177,12 +177,11 @@ jobs:
             net="$(docker network inspect $(docker network ls -q -f "label=task-network") --format '{{.Name}}')"
             docker run -it --rm \
               --net="$net" \
-              -e RUN_ENV=test \
               -e PGHOST=dbpsql \
               -e CIRCLECI=true \
               \
               ynr:test \
-              pytest --ds=ynr.settings.testing -x
+              pytest -x
 
 workflows:
   test_build_deploy:

.gitignore

@@ -20,7 +20,7 @@ ynr/assets/*
 .pytest_cache
 *.css.map
 test-results
-env/
+/env/*.env
 node_modules/
 .vscode/
 /test-env

container/build/Containerfile

@@ -88,14 +88,14 @@ WORKDIR $APP_CODE
 # Invoke a lightweight, post-build test that proves the container reaches a
 # baseline level of correctness, whilst also generating .pyc files for faster
 # app startup.
-RUN python manage.py check --settings=ynr.settings.testing
+RUN DJANGO_SECRET_KEY=insecure python manage.py check
 
 ###########
 ## Assets #
 ###########
 RUN date \
  && npm run build \
- && python manage.py collectstatic --no-input --settings=ynr.settings.testing \
+ && DJANGO_SECRET_KEY=insecure python manage.py collectstatic --no-input \
  && date
 
 ###########################################################################

docs/DEVELOPMENT.md

@@ -119,7 +119,9 @@ Run a Django management command:
    `podman compose up -d`
 1. Use the `container.manage-py.bash` script to invoke the command:
    ```
-   ./scripts/container.manage-py.bash command-to-invoke --command-args command params
+   # ./scripts/container.manage-py.bash command-to-invoke --command-args command params
+   # e.g.
+   ./scripts/container.manage-py.bash check
    ```
 1. Stop the compose stack:
    `podman compose down`
@@ -190,8 +192,6 @@ GitHub-rendered view so that command strings don't line-wrap. -->
 
 These executable scripts are available from the [`scripts`](../scripts) directory.
 
-<!-- The &nbsp; HTML entities force the Script column to be wide enough in the
-GitHub-rendered view so that command strings don't line-wrap. -->
 | Script | Purpose | Parameters
 | :--- | :--- | :---
 | `container.image.build.bash` | Builds the YNR container image | $1 -- The named stage from [`container/build/Containerfile`](../container/build/Containerfile) to build and tag (*required*)<br>$2, $3, ... -- Any parameters to pass to the underlying builder process (*optional*)

docs/INSTALL.md

@@ -38,11 +38,16 @@ and to get closer to the intended future state of the application's
    `podman compose build`
 1. Pull any 3rd-party container images used by the compose stack:
    `podman compose pull`
-1. Set up your local/development envvars as needed, by placing keys and values
-   `env/frontend.env`, like this:
+1. Set up your development envvars as needed, by placing keys and values in
+   `env/frontend.env`, using `env/frontend.env.example` as a template.
+    In general, the only envar you should need is this:
    ```
-   DJANGO_SETTINGS_MODULE=ynr.settings.testing
+   DJANGO_SETTINGS_MODULE=ynr.settings
    ```
+1. Copy `ynr/settings/local.py.container.example` to `ynr/settings/local.py`.
+   If you already have a `ynr/settings/local.py` file, incorporate the example
+   file's settings. **If you don't use most of the example file's settings, you
+   *will* experience problems interacting with the app, later**.
 1. Test that the compose stack can be stood up:
    ```bash
    podman compose up -d # NB Space between "podman" and "compose"!

env/.gitkeep

@@ -0,0 +1 @@
+DJANGO_SETTINGS_MODULE=ynr.settings

env/frontend.env.example

@@ -1,13 +1,13 @@
 #!/usr/bin/env bash
 set -euo pipefail
 
-# container.test.bash invokes a `pytest` command in a "frontend" container.
+# container.pytest.bash invokes a `pytest` command in a "frontend" container.
 # The container and a database server must be running before running this
 # script (see README.md).
 #
 # Usage:
-#    scripts/container.test.bash    # run all tests; continue after failures
-#    scripts/container.test.bash -x # stop after first failure
+#    scripts/container.pytest.bash    # run all tests; continue after failures
+#    scripts/container.pytest.bash -x # stop after first failure
 
 # The command being invoked does not need to be quoted, unless it contains
 # shell meta-characters or similar. Multiple words are fine, without quotes.

scripts/container.pytest.bash

@@ -2,11 +2,19 @@
 DEBUG = True
 
 # These Postgres settings should match docker-compose.yml.
-DATABASES["default"]["NAME"] = "ynr"  # noqa
-DATABASES["default"]["USER"] = "ynr"  # noqa
+# Credentials are not required.
+DATABASES = {"default": {
+  "ENGINE": "django.db.backends.postgresql",
+  "HOST": "dbpsql", "NAME": 'ynr', "USER": "ynr",
+}}
+
+# The containerised setup does not include the same memcache service that
+# production currently uses for its cache, so we explicitly set up a dummy
+# cache when running locally.
+CACHES = {"default": {"BACKEND": "django.core.cache.backends.dummy.DummyCache"}}
 
 # This short, known value is insecure.
-SECRET_KEY = "development"
+SECRET_KEY = "insecure"
 
 # Certain errors are very noisy (obscuring the real problem) if this list is
 # empty.

ynr/settings/local.py.container.example

@@ -17,7 +17,6 @@ def __contains__(self, item):
     def __getitem__(self, item):
         return None
 
-ADMINS = [("dummy", "dummy@dummy.example")]
 
 MIGRATION_MODULES = DisableMigrations()
 
@@ -30,7 +29,7 @@ def __getitem__(self, item):
 RUNNING_TESTS = True
 
 SECRET_KEY = "just here for testing"
-ALLOWED_HOSTS = ["candidates.democracyclub.org.uk","*"]
+ALLOWED_HOSTS = ["candidates.democracyclub.org.uk"]
 
 SHOW_SOPN_TRACKER = False
 SHOW_RESULTS_PROGRESS = False