chore: add reserved keywords linter (#46)

.github/workflows/ci.yml

@@ -16,7 +16,7 @@ jobs:
       matrix:
         os: [ubuntu-20.04]
         python-version: ['3.8']
-        toxenv: [quality, django32, django42]
+        toxenv: [quality, django32, django42, check_keywords]
     steps:
     - uses: actions/checkout@v4
     - name: setup python

Makefile

@@ -1,4 +1,4 @@
-.PHONY: clean coverage help quality requirements test test-all upgrade validate selfcheck
+.PHONY: clean coverage help quality requirements test test-all upgrade validate selfcheck check_keywords
 
 .DEFAULT_GOAL := help
 
@@ -75,3 +75,6 @@ validate: quality test ## run tests and quality checks
 
 selfcheck: ## check that the Makefile is well-formed
 	@echo "The Makefile is well-formed."
+
+check_keywords: ## Scan the Django models in all installed apps in this project for restricted field names
+	python manage.py check_reserved_keywords --override_file db_keyword_overrides.yml

db_keyword_overrides.yml

@@ -0,0 +1,10 @@
+# This file is used by the 'check_reserved_keywords' management command to allow specific field names to be overridden
+# when checking for conflicts with lists of restricted keywords used in various database/data warehouse tools.
+# For more information, see: https://github.com/edx/edx-django-release-util/release_util/management/commands/check_reserved_keywords.py
+#
+# overrides should be added in the following format:
+#   - ModelName.field_name
+---
+MYSQL:
+SNOWFLAKE:
+STITCH:

requirements/test.in

@@ -5,3 +5,4 @@
 pytest-catchlog           # Show log output for test failures
 pytest-cov                # pytest extension for code coverage statistics
 pytest-django             # pytest extension for better Django support
+edx-django-release-util   # Contains the reserved keyword check

requirements/test.txt

@@ -13,6 +13,9 @@ coverage[toml]==7.3.3
     # via
     #   -c requirements/common_constraints.txt
     #   -r requirements/base.in
+    #   edx-django-release-util
+edx-django-release-util==1.3.0
+    # via -r requirements/test.in
 exceptiongroup==1.2.0
     # via pytest
 iniconfig==2.0.0
@@ -36,6 +39,10 @@ pytest-django==4.7.0
     # via -r requirements/test.in
 pytz==2023.3.post1
     # via django
+pyyaml==6.0.1
+    # via edx-django-release-util
+six==1.16.0
+    # via edx-django-release-util
 sqlparse==0.4.4
     # via django
 tomli==2.0.1

test_settings.py

@@ -30,6 +30,7 @@ def root(*args):
     'django.contrib.auth',
     'django.contrib.contenttypes',
     'help_tokens',
+    'release_util',
 )
 
 LOCALE_PATHS = [

tox.ini

@@ -43,3 +43,11 @@ commands =
     twine check dist/*
     isort --check-only tests help_tokens manage.py setup.py test_settings.py
     make selfcheck
+
+[testenv:check_keywords]
+allowlist_externals =
+    make
+deps =
+    -r{toxinidir}/requirements/test.txt
+commands =
+    make check_keywords