chore: add reserved keywords linter (#166)

openedx · Jan 12, 2024 · ad26c15 · ad26c15
1 parent 7a5594c
commit ad26c15
Show file tree

Hide file tree

Showing 8 changed files with 36 additions and 3 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -15,7 +15,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@v3

diff --git a/Makefile b/Makefile
@@ -1,4 +1,4 @@
-.PHONY: clean quality requirements test upgrade
+.PHONY: clean quality requirements test upgrade check_keywords
 
 clean:
 	coverage erase
@@ -45,3 +45,6 @@ upgrade: $(COMMON_CONSTRAINTS_TXT)  ## update the requirements/*.txt files with
 	# Let tox control the Django version for tests
 	sed '/^[dD]jango==/d' requirements/test.txt > requirements/test.tmp
 	mv requirements/test.tmp requirements/test.txt
+
+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
diff --git a/db_keyword_overrides.yml b/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:
diff --git a/requirements/dev.txt b/requirements/dev.txt
@@ -77,7 +77,10 @@ django==3.2.23
     # via
     #   -c requirements/common_constraints.txt
     #   -r requirements/test.txt
+    #   edx-django-release-util
     #   social-auth-app-django
+edx-django-release-util==1.3.0
+    # via -r requirements/test.txt
 edx-lint==5.3.6
     # via -r requirements/test.txt
 exceptiongroup==1.2.0
@@ -222,6 +225,7 @@ pyyaml==6.0.1
     # via
     #   -r requirements/test.txt
     #   code-annotations
+    #   edx-django-release-util
 requests==2.31.0
     # via
     #   -r requirements/test.txt
@@ -235,6 +239,7 @@ six==1.16.0
     # via
     #   -r requirements/ci.txt
     #   -r requirements/test.txt
+    #   edx-django-release-util
     #   edx-lint
     #   tox
     #   unittest2

diff --git a/requirements/test.in b/requirements/test.in
@@ -12,3 +12,4 @@ pytest-cov
 pytest-django
 tox
 unittest2
+edx-django-release-util   # Contains the reserved keyword check
diff --git a/requirements/test.txt b/requirements/test.txt
@@ -56,7 +56,10 @@ distlib==0.3.8
     # via
     #   -c requirements/common_constraints.txt
     #   -r requirements/base.txt
+    #   edx-django-release-util
     #   social-auth-app-django
+edx-django-release-util==1.3.0
+    # via -r requirements/test.in
 edx-lint==5.3.6
     # via -r requirements/test.in
 exceptiongroup==1.2.0
@@ -150,7 +153,9 @@ pytz==2023.3.post1
     #   -r requirements/base.txt
     #   django
 pyyaml==6.0.1
-    # via code-annotations
+    # via
+    #   code-annotations
+    #   edx-django-release-util
 requests==2.31.0
     # via
     #   -r requirements/base.txt
@@ -163,6 +168,7 @@ requests-oauthlib==1.3.1
 six==1.16.0
     # via
     #   -r requirements/base.txt
+    #   edx-django-release-util
     #   edx-lint
     #   tox
     #   unittest2

diff --git a/test_settings.py b/test_settings.py
@@ -13,6 +13,7 @@
     'django.contrib.sessions',
     'social_django',
     'auth_backends',
+    'release_util',
 )
 
 DATABASES = {

diff --git a/tox.ini b/tox.ini
@@ -17,3 +17,10 @@ commands =
     pycodestyle --config=.pep8 auth_backends
     pylint --rcfile=pylintrc auth_backends
 
+[testenv:check_keywords]
+whitelist_externals =
+    make
+deps =
+    -r{toxinidir}/requirements/test.txt
+commands =
+    make check_keywords