Streamline environment bootstrapping, move contents of docker/ to t…

…op level (#510)

In this commit, we:
- consolidate sources of local development config (`.env.dist` `local_dev.env`) to one `.env.example`, which is copied to `.env` with `Make`
- move contents of `docker/` to top level, which allows us to remove some config options with Docker commands
- delete `docker/log_config.json`, which appeared to be unused

.env.example

@@ -0,0 +1,38 @@
+# This file is for settings that are specific to your local development
+# environment
+
+# Linux users may want to set these to their own UID and GID
+# so that files created in the container will have the same permissions
+# id -u and id -g may return the proper values
+# This is unnecessary for Docker Desktop for Mac or Windows
+# CTMS_UID=
+# CTMS_GID=
+
+# Docker
+# Set this to always call docker-compose run with --service-ports in the Makefile
+# MK_WITH_SERVICE_PORTS=--service-ports
+# Set this to skip calling "docker-compose down" after "make tests"
+# MK_KEEP_DOCKER_UP=1
+
+# Logging
+CTMS_USE_MOZLOG=False
+CTMS_LOGGING_LEVEL=INFO
+CTMS_LOG_SQLALCHEMY=False
+
+# Change the webserver port
+# PORT=8000
+
+# Database
+# The host for this URL is so that services running outside of docker
+# (e.g. pytest) can use the database. It's overridden in docker-compose.yaml
+# for use with `docker-compose up`
+CTMS_DB_URL=postgresql://postgres@localhost:5432/postgres
+
+# Encryption key for OAuth2 and other hashes
+CTMS_SECRET_KEY=dev_only_secret_key_not_for_production
+
+# Webserver protocol and domain
+CTMS_SERVER_PREFIX=http://localhost:8000
+
+# Reload server when files are changed
+CTMS_APP_RELOAD=True

.github/workflows/build-image.yaml

@@ -76,7 +76,7 @@ jobs:
             "$IMAGE_TAG" \
             "$GITHUB_SERVER_URL/$GITHUB_REPOSITORY" \
             "$GITHUB_SERVER_URL/$GITHUB_REPOSITORY/actions/runs/$GITHUB_RUN_ID" > ./version.json
-          docker build --file docker/Dockerfile -t $ECR_REGISTRY/$ECR_REPOSITORY:$IMAGE_TAG .
+          docker build -t $ECR_REGISTRY/$ECR_REPOSITORY:$IMAGE_TAG .
           docker image tag $ECR_REGISTRY/$ECR_REPOSITORY:$IMAGE_TAG $ECR_REGISTRY/$ECR_REPOSITORY:latest
           docker push $ECR_REGISTRY/$ECR_REPOSITORY:$IMAGE_TAG
           docker push $ECR_REGISTRY/$ECR_REPOSITORY:latest

.github/workflows/test-build.yaml

@@ -48,7 +48,6 @@ jobs:
         uses: docker/build-push-action@v2
         with:
           context: .
-          file: docker/Dockerfile
           push: false
           target: "production"
           tags: ghcr.io/${{ github.repository }}:${{ github.sha }}-test-build

.gitignore

@@ -1,6 +1,7 @@
 .bash_history
 .cache
 .coverage
+.DS_STORE
 .env
 .idea/
 .mypy_cache/

.secrets.baseline

@@ -150,15 +150,6 @@
         "line_number": 16
       }
     ],
-    "docker/config/local_dev.env": [
-      {
-        "type": "Secret Keyword",
-        "filename": "docker/config/local_dev.env",
-        "hashed_secret": "9f33da7ed96322c0564596c334a5d7b3cc440621",
-        "is_verified": false,
-        "line_number": 7
-      }
-    ],
     "docs/developer_setup.md": [
       {
         "type": "Secret Keyword",
@@ -203,5 +194,5 @@
       }
     ]
   },
-  "generated_at": "2023-01-11T16:11:56Z"
+  "generated_at": "2023-01-13T18:46:50Z"
 }

Makefile

@@ -30,11 +30,8 @@ help:
 
 
 .env:
-	@if [ ! -f .env ]; \
-	then \
-	echo "Copying env.dist to .env..."; \
-	cp docker/config/env.dist .env; \
-	fi
+	echo "Copying .env.example to .env"; \
+	cp .env.example .env;
 
 install: $(INSTALL_STAMP)
 $(INSTALL_STAMP): poetry.lock
@@ -47,7 +44,7 @@ build: .env
 	docker-compose build --build-arg userid=${CTMS_UID} --build-arg groupid=${CTMS_GID}
 
 .PHONY: lint
-lint: .env $(INSTALL_STAMP)
+lint: $(INSTALL_STAMP)
 	bin/lint.sh
 
 .PHONY: db-only

bin/update_baseline.sh

@@ -2,6 +2,6 @@
 
 set -euo pipefail
 
-detect-secrets scan . \
+poetry run detect-secrets scan . \
 --baseline .secrets.baseline \
 --exclude-files "(poetry.lock$)|(htmlcov/)"

docker-compose.yaml

@@ -3,7 +3,6 @@ services:
   web:
     build:
       context: .
-      dockerfile: docker/Dockerfile
     image: web
     volumes: 
       - .:/app
@@ -12,9 +11,9 @@ services:
     # Let the init system handle signals for us.
     # among other things this helps shutdown be fast
     init: true
-    env_file:
-      - docker/config/local_dev.env
-      - .env
+    environment:
+      CTMS_DB_URL: postgresql://postgres@postgres/postgres
+    env_file: .env
     depends_on:
       - postgres
   postgres:

docs/configuration.md

@@ -86,22 +86,19 @@ instances and read by the CTMS API application for configuration. When
 possible, the default values of environment variables are appropriate for
 production.
 
-In the local development environment, the default configuration is in
-``docker/config/local_dev.env``, and overrides are in ``.env``. The file
-``docker/config/env.dist`` is the ``.env`` template for new developer
+In the local development environment, the default configuration is in ``.env``.
+The file ``.env.example`` is the ``.env`` template for new developer
 environments.
 
-All configuration in ``.env`` is optional. Linux users should set
-``CTMS_UID`` and ``CTMS_GID`` to match their user account, so that files
-created inside the docker container have the same permissions as their user
-account.
-
 ``.env`` is loaded in the ``Makefile``, making those configuration items
-available in Makefile targets and commands. ``local_dev.env`` and ``.env``
-are loaded by ``docker-compose`` and passed to Docker. Some adjust the build
-process by setting `ARG` variables in the ``Dockerfile``. Others are passed
-to the runtime environment. The CTMS API application then loads these from
-the environment.
+available in Makefile targets and commands. ``.env`` is also loaded by
+``docker-compose`` and passed to Docker. Some adjust the build process by
+setting `ARG` variables in the ``Dockerfile``. Others are passed to the runtime
+environment. The CTMS API application then loads these from the environment.
+
+Linux users should set ``CTMS_UID`` and ``CTMS_GID`` to match their user account,
+so that files created inside the docker container have the same permissions as
+their user account.
 
 ---
 [View All Docs](./)

pyproject.toml

@@ -119,7 +119,7 @@ profile = "black"
     ]
 
 [tool.mypy]
-# Sync Python version with docker/Dockerfile
+# Sync Python version with Dockerfile
 python_version = "3.10"
 # Look for errors in this file
 warn_unused_configs = true