refactor: remove env vars + code that allowed different data migrations

this change reflects our decision to use the data migration provided in
the repo. configuration values can still vary by setting different
values in the Key Vault.

documentation has also been updated

Author: angela-tran

appcontainer/Dockerfile

@@ -11,10 +11,9 @@ COPY manage.py manage.py
 COPY bin/ bin/
 COPY benefits/ benefits/
 
-# ensure $USER can compile messages in the locale directories and copy migration files from $DJANGO_MIGRATIONS_DIR
+# ensure $USER can compile messages in the locale directories
 USER root
 RUN chmod -R 777 benefits/locale
-RUN chmod -R 777 benefits/core/migrations
 USER $USER
 
 # configure container executable

benefits/core/migrations/0002_sample_data.py

@@ -1,19 +1,13 @@
 """Data migration which loads sample data.
-Set environment variable DJANGO_LOAD_SAMPLE_DATA to False to skip loading sample data.
 """
 import json
 import os
 
-from django.conf import settings
 from django.db import migrations
 from django.utils.translation import gettext_lazy as _
 
 
 def load_sample_data(app, *args, **kwargs):
-    if not settings.LOAD_SAMPLE_DATA:
-        print("  LOAD_SAMPLE_DATA is set to False, skipping sample data")
-        return
-
     EligibilityType = app.get_model("core", "EligibilityType")
 
     mst_senior_type = EligibilityType.objects.create(

benefits/settings.py

@@ -151,8 +151,6 @@ def _filter_empty(ls):
     }
 }
 
-LOAD_SAMPLE_DATA = os.environ.get("DJANGO_LOAD_SAMPLE_DATA", "true").lower() != "false"
-
 # Password validation
 
 AUTH_PASSWORD_VALIDATORS = []

bin/init.sh

@@ -8,15 +8,6 @@ rm -f django.db
 
 # run database migrations
 
-if [[ ${DJANGO_LOAD_SAMPLE_DATA:-true} = false ]]; then
-    if [[ -d ${DJANGO_MIGRATIONS_DIR:-false} ]]; then
-        echo "Copying migrations from ${DJANGO_MIGRATIONS_DIR}"
-        cp ${DJANGO_MIGRATIONS_DIR}/0002_*.py ./benefits/core/migrations/
-    else
-        echo "DJANGO_MIGRATIONS_DIR is either unset or not a directory"
-    fi
-fi
-
 python manage.py migrate
 
 # create a superuser account for backend admin access

docs/configuration/data.md

@@ -68,35 +68,6 @@ Run these commands from within the repository root, inside the devcontainer:
 bin/init.sh
 ```
 
-## Loading new data for different environment
-
-Django will run all migration files found in an app's `migrations` module.
-
-To load new data for a different environment:
-
-1. (Optional) Set an environment variable `DJANGO_LOAD_SAMPLE_DATA` to `false` if you don't want the `core` app's sample data to be loaded.
-1. Create a data migration file, and make sure the name is prefixed with `0002`. (The migration process for Benefits expects data migration files to named as such). The basic structure for the contents of this file is:
-```python
-from django.db import migrations
-
-
-def load_data(app, *args, **kwargs):
-    pass
-
-
-class Migration(migrations.Migration):
-    dependencies = [
-        ("core", "0001_initial"),
-    ]
-
-    operations = [
-        migrations.RunPython(load_data),
-    ]
-```
-1. Put this file under `benefits/core/migrations`
-1. If `DJANGO_LOAD_SAMPLE_DATA` is `false`, you can also set [`DJANGO_MIGRATIONS_DIR`](../environment-variables/#django_migrations_dir) to a directory path, and put your data migration there.
-
-
 [core-models]: https://github.com/cal-itp/benefits/blob/dev/benefits/core/models.py
 [django-load-initial-data]: https://docs.djangoproject.com/en/4.0/howto/initial-data/
 [eligibility-server]: https://docs.calitp.org/eligibility-server

docs/configuration/environment-variables.md

@@ -73,19 +73,6 @@ Boolean:
   files are served
 - `False` (default): the application is launched with debug mode turned off, similar to how it runs in production
 
-### `DJANGO_LOAD_SAMPLE_DATA`
-
-!!! warning "Deployment configuration"
-
-    You may change this setting when deploying the app to a non-localhost domain
-
-Boolean:
-
-- `True` (default): The sample data in `benefits/core/migrations/0002_sample_data.py` is used to initialize the Django configuration database.
-- `False`: The sample data from `benefits/core/migrations/0002_sample_data.py` will not be loaded.
-
-See [Configuration data](data.md) for more.
-
 ### `DJANGO_LOCAL_PORT`
 
 !!! info "Local configuration"
@@ -113,14 +100,6 @@ The log level used in the application's logging configuration.
 
 By default the application sends logs to `stdout`.
 
-### `DJANGO_MIGRATIONS_DIR`
-
-!!! warning "Deployment configuration"
-
-    You may change this setting when deploying the app to a non-localhost domain
-
-If [`DJANGO_LOAD_SAMPLE_DATA`](#django_load_sample_data) is `false`, then you can set `DJANGO_MIGRATIONS_DIR` to the path of a directory containing data migrations that you want to be run. Those data migration files need to be prefixed with `0002` so that the [helper migration file](data.md)) can find it. See [Configuration data](./data.md) for more on loading data for different environments.
-
 ### `DJANGO_SECRET_KEY`
 
 !!! warning "Deployment configuration"

terraform/app_service.tf

@@ -70,9 +70,7 @@ resource "azurerm_linux_web_app" "main" {
     "DJANGO_ADMIN"            = (local.is_prod || local.is_test) ? null : "${local.secret_prefix}django-admin)",
     "DJANGO_ALLOWED_HOSTS"    = "${local.secret_prefix}django-allowed-hosts)",
     "DJANGO_DEBUG"            = local.is_prod ? null : "${local.secret_prefix}django-debug)",
-    "DJANGO_LOAD_SAMPLE_DATA" = "false",
     "DJANGO_LOG_LEVEL"        = "${local.secret_prefix}django-log-level)",
-    "DJANGO_MIGRATIONS_DIR"   = "./config",
 
     "DJANGO_RATE_LIMIT"         = local.is_dev ? null : "${local.secret_prefix}django-rate-limit)",
     "DJANGO_RATE_LIMIT_METHODS" = local.is_dev ? null : "${local.secret_prefix}django-rate-limit-methods)",