Merge pull request #18 from pamelafox/enhance

.devcontainer/devcontainer.json

@@ -30,15 +30,19 @@
 				],
 				"python.defaultInterpreterPath": "/usr/local/bin/python",
 				"python.linting.enabled": true,
-				"python.testing.unittestEnabled": false,
 				"python.testing.pytestEnabled": true,
+				"python.testing.unittestEnabled": false,
 				"[python]": {
 					"editor.formatOnSave": true,
 					"editor.codeActionsOnSave": {
 						"source.fixAll": true
 					}
 				},
-				"python.formatting.provider": "black"
+				"python.formatting.provider": "black",
+				"files.exclude": {
+					"**/*.coverage": true,
+					".ruff_cache": true
+				  }
 			},
 
 			// Add the IDs of extensions you want installed when the container is created.

.devcontainer/docker-compose.yml

@@ -7,7 +7,7 @@ services:
       dockerfile: .devcontainer/Dockerfile
       args:
         # [Choice] Python version: 3, 3.8, 3.7, 3.6
-        IMAGE: python:3.10
+        IMAGE: python:3.11
         # On Linux, you may need to update USER_UID and USER_GID below if not your local UID is not 1000.
         USER_UID: 1000
         USER_GID: 1000

.github/workflows/check.yaml

@@ -40,5 +40,9 @@ jobs:
             SECRET_KEY: django-insecure-key-${{ github.run_id }}-${{ github.run_attempt }}
           run: |
             python src/manage.py collectstatic
-            coverage run --source='.' src/manage.py test quizzes
-            coverage report
+            python3 -m pytest | tee pytest-coverage.txt
+        - name: Pytest coverage comment
+          uses: MishaKav/pytest-coverage-comment@main
+          with:
+              pytest-coverage-path: ./pytest-coverage.txt
+              junitxml-path: ./pytest.xml

.gitignore

@@ -4,3 +4,5 @@ staticfiles/
 .coverage
 .env
 .azure
+pytest.xml
+pytest-coverage.txt

.vscode/settings.json

@@ -0,0 +1,11 @@
+{
+    "python.testing.unittestArgs": [
+        "-v",
+        "-s",
+        "./src",
+        "-p",
+        "test*.py"
+    ],
+    "python.testing.pytestEnabled": false,
+    "python.testing.unittestEnabled": true
+}

.vscode/tasks.json

@@ -37,7 +37,7 @@
         "panel": "dedicated"
       }
     }, {
-      "label": "Run migrations",
+      "label": "Apply migrations",
       "type": "shell",
       "command": "./src/manage.py migrate",
       "problemMatcher": [],
@@ -54,5 +54,14 @@
         "reveal": "always",
         "panel": "dedicated"
       }
+    }, {
+      "label": "Flush database",
+      "type": "shell",
+      "command": "./src/manage.py flush --noinput",
+      "problemMatcher": [],
+      "presentation": {
+        "reveal": "always",
+        "panel": "dedicated"
+      }
     }]
   }

infra/main.bicep

@@ -66,17 +66,19 @@ module web 'core/host/appservice.bicep' = {
     tags: union(tags, { 'azd-service-name': 'web' })
     appServicePlanId: appServicePlan.outputs.id
     runtimeName: 'python'
-    runtimeVersion: '3.10'
+    runtimeVersion: '3.11'
     scmDoBuildDuringDeployment: true
     ftpsState: 'Disabled'
     managedIdentity: true
     appCommandLine: 'python manage.py migrate && gunicorn --workers 2 --threads 4 --timeout 60 --access-logfile \'-\' --error-logfile \'-\' --bind=0.0.0.0:8000 --chdir=/home/site/wwwroot quizsite.wsgi'
     appSettings: {
       ADMIN_URL: 'admin${uniqueString(appServicePlan.outputs.id)}'
-      DBHOST: postgresServerName
+      DBENGINE: 'django.db.backends.postgresql'
+      DBHOST: '${postgresServerName}.postgres.database.azure.com'
       DBNAME: postgresDatabaseName
       DBUSER: '@Microsoft.KeyVault(VaultName=${keyVault.outputs.name};SecretName=postgresAdminUser)'
       DBPASS: '@Microsoft.KeyVault(VaultName=${keyVault.outputs.name};SecretName=postgresAdminPassword)'
+      DBSSL: 'require'
       SECRET_KEY: '@Microsoft.KeyVault(VaultName=${keyVault.outputs.name};SecretName=djangoSecretKey)'
     }
   }

pyproject.toml

@@ -12,3 +12,9 @@ exclude = '''
   | migrations
 )/
 '''
+
+[tool.pytest.ini_options]
+addopts = "-ra --cov=src --cov-report=term-missing:skip-covered --junitxml=pytest.xml"
+pythonpath = ["src"]
+python_files = ["tests.py"]
+DJANGO_SETTINGS_MODULE = "quizsite.settings"

requirements-dev.txt

@@ -3,3 +3,5 @@ black
 pre-commit
 ruff
 coverage
+pytest-django
+pytest-cov

src/manage.py

@@ -3,21 +3,11 @@
 import os
 import sys
 
-from dotenv import load_dotenv
-
 
 def main():
     """Run administrative tasks."""
-    # If WEBSITE_HOSTNAME is defined as an environment variable, then we're running on Azure App Service
-
-    # Only for Local Development - Load environment variables from the .env file
-    if "WEBSITE_HOSTNAME" not in os.environ:
-        print("Loading environment variables for .env file")
-        load_dotenv("./.env")
 
-    # When running on Azure App Service you should use the production settings.
-    settings_module = "quizsite.production" if "WEBSITE_HOSTNAME" in os.environ else "quizsite.settings"
-    os.environ.setdefault("DJANGO_SETTINGS_MODULE", settings_module)
+    os.environ.setdefault("DJANGO_SETTINGS_MODULE", "quizsite.settings")
 
     try:
         from django.core.management import execute_from_command_line

src/quizsite/production.py

@@ -1,25 +0,0 @@
-from .settings import *  # noqa
-import os
-
-# Configure the domain name using the environment variable
-# that Azure automatically creates for us.
-ALLOWED_HOSTS = [os.environ["WEBSITE_HOSTNAME"]] if "WEBSITE_HOSTNAME" in os.environ else []
-CSRF_TRUSTED_ORIGINS = ["https://" + os.environ["WEBSITE_HOSTNAME"]] if "WEBSITE_HOSTNAME" in os.environ else []
-DEBUG = False
-ADMIN_URL = os.environ["ADMIN_URL"]
-
-# DBHOST is only the server name, not the full URL
-hostname = os.environ["DBHOST"]
-
-# Configure Postgres database; the full username for PostgreSQL flexible server is
-# username (not @sever-name).
-DATABASES = {
-    "default": {
-        "ENGINE": "django.db.backends.postgresql",
-        "NAME": os.environ["DBNAME"],
-        "HOST": hostname + ".postgres.database.azure.com",
-        "USER": os.environ["DBUSER"],
-        "PASSWORD": os.environ["DBPASS"],
-        "OPTIONS": {"sslmode": "require"},
-    }
-}

src/quizsite/settings.py

@@ -13,25 +13,47 @@ https://docs.djangoproject.com/en/4.1/ref/settings/
 import os
 from pathlib import Path
 
+import environ
+
+env = environ.Env(
+    # set casting, default value
+    DEBUG=(bool, False),
+    DBENGINE=(str, "django.db.backends.postgresql_psycopg2"),
+    DBSSL=(str, "disable"),
+    ADMIN_URL=(str, "admin/"),
+)
+
 # Build paths inside the project like this: BASE_DIR / 'subdir'.
 BASE_DIR = Path(__file__).resolve().parent.parent
 
+# Take environment variables from .env file
+environ.Env.read_env(os.path.join(BASE_DIR.parent, ".env"))
 
 # Quick-start development settings - unsuitable for production
 # See https://docs.djangoproject.com/en/4.1/howto/deployment/checklist/
 
 # SECURITY WARNING: keep the secret key used in production secret!
-SECRET_KEY = os.getenv("SECRET_KEY")
+SECRET_KEY = env("SECRET_KEY")
 
 # SECURITY WARNING: don't run with debug turned on in production!
-DEBUG = True
-
-ADMIN_URL = "admin/"
-
-CSRF_TRUSTED_ORIGINS = [
-    "http://localhost:8000",
-    f"https://{os.getenv('CODESPACE_NAME')}-8000.{os.getenv('GITHUB_CODESPACES_PORT_FORWARDING_DOMAIN')}",
-]
+DEBUG = env("DEBUG")
+
+# Configure the domain name using the environment variable
+# that Azure automatically creates for us.
+if env.get_value("WEBSITE_HOSTNAME", default=None):
+    ALLOWED_HOSTS = [os.environ["WEBSITE_HOSTNAME"]]
+    CSRF_TRUSTED_ORIGINS = ["https://" + os.environ["WEBSITE_HOSTNAME"]]
+else:
+    ALLOWED_HOSTS = []
+    CSRF_TRUSTED_ORIGINS = [
+        "http://localhost:8000",
+    ]
+    if env.get_value("CODESPACE_NAME", default=None):
+        CSRF_TRUSTED_ORIGINS.append(
+            f"https://{env('CODESPACE_NAME')}-8000.{env('GITHUB_CODESPACES_PORT_FORWARDING_DOMAIN')}"
+        )
+
+ADMIN_URL = env("ADMIN_URL")
 
 # Application definition
 
@@ -83,14 +105,16 @@ WSGI_APPLICATION = "quizsite.wsgi.application"
 
 DATABASES = {
     "default": {
-        "ENGINE": "django.db.backends.postgresql_psycopg2",
-        "NAME": os.environ["DBNAME"],
-        "HOST": os.environ["DBHOST"],
-        "USER": os.environ["DBUSER"],
-        "PASSWORD": os.environ["DBPASS"],
+        "ENGINE": env("DBENGINE"),
+        "NAME": env("DBNAME"),
+        "HOST": env("DBHOST"),
+        "USER": env("DBUSER"),
+        "PASSWORD": env("DBPASS"),
+        "OPTIONS": {"sslmode": env("DBSSL")},
     }
 }
 
+
 # Password validation
 # https://docs.djangoproject.com/en/4.1/ref/settings/#auth-password-validators
 
@@ -128,7 +152,11 @@ USE_TZ = True
 STATIC_URL = "static/"
 
 # https://whitenoise.evans.io/en/stable/django.html
-STATICFILES_STORAGE = "whitenoise.storage.CompressedManifestStaticFilesStorage"
+STORAGES = {
+    "staticfiles": {
+        "BACKEND": "whitenoise.storage.CompressedManifestStaticFilesStorage",
+    },
+}
 STATIC_ROOT = os.path.join(BASE_DIR, "staticfiles")
 
 # Default primary key field type

src/quizsite/wsgi.py

@@ -11,7 +11,6 @@ import os
 
 from django.core.wsgi import get_wsgi_application
 
-settings_module = "quizsite.production" if "WEBSITE_HOSTNAME" in os.environ else "quizsite.settings"
-os.environ.setdefault("DJANGO_SETTINGS_MODULE", settings_module)
+os.environ.setdefault("DJANGO_SETTINGS_MODULE", "quizsite.settings")
 
 application = get_wsgi_application()

src/quizzes/models.py

@@ -1,3 +1,5 @@
+import typing
+
 from django.contrib.postgres import fields
 from django.db import models
 
@@ -16,6 +18,9 @@ class Question(models.Model):
     def __str__(self):
         return self.prompt
 
+    def get_answer(self) -> typing.Union["Answer", None]:
+        return getattr(self, "multiplechoiceanswer", None) or getattr(self, "freetextanswer", None)
+
 
 class Answer(models.Model):
     question = models.OneToOneField(Question, on_delete=models.CASCADE)
@@ -24,14 +29,17 @@ class Answer(models.Model):
     class Meta:
         abstract = True
 
+    def __str__(self) -> str:
+        return self.correct_answer
+
+    def is_correct(self, user_answer) -> bool:
+        return user_answer == self.correct_answer
+
 
 class FreeTextAnswer(Answer):
     case_sensitive = models.BooleanField(default=False)
 
-    def __str__(self):
-        return self.correct_answer
-
-    def is_correct(self, user_answer):
+    def is_correct(self, user_answer) -> bool:
         if not self.case_sensitive:
             return user_answer.lower() == self.correct_answer.lower()
         return user_answer == self.correct_answer
@@ -40,8 +48,5 @@ class FreeTextAnswer(Answer):
 class MultipleChoiceAnswer(Answer):
     choices = fields.ArrayField(models.CharField(max_length=200, blank=True))
 
-    def __str__(self):
+    def __str__(self) -> str:
         return f"{self.correct_answer} from {self.choices}"
-
-    def is_correct(self, user_answer):
-        return user_answer == self.correct_answer

src/quizzes/templates/quizzes/partial.html

@@ -1,5 +1,13 @@
+{% if error %}
+<div class="alert alert-danger" role="alert">
+  {{ error }}
+</div>
+{% else %}
+
 {% if is_correct %}
 ✅ You got it!
 {% else %}
 ❌ Sorry! The correct answer is {{ correct_answer }}
 {% endif %}
+
+{% endif %}

src/quizzes/tests.py

@@ -53,12 +53,12 @@ class IndexViewTests(TestCase):
         response = self.client.get(reverse("quizzes:index"))
         self.assertEqual(response.status_code, 200)
         self.assertContains(response, "No quizzes are available.")
-        self.assertQuerysetEqual(response.context["quiz_list"], [])
+        self.assertQuerySetEqual(response.context["quiz_list"], [])
 
     def test_one_quiz(self):
         quiz, _, _ = create_quiz()
         response = self.client.get(reverse("quizzes:index"))
-        self.assertQuerysetEqual(
+        self.assertQuerySetEqual(
             response.context["quiz_list"],
             [quiz],
         )

src/quizzes/views.py

@@ -36,7 +36,9 @@ def display_question(request, quiz_id, question_id):
 
 def grade_question(request, question_id):
     question = get_object_or_404(Question, pk=question_id)
-    answer = getattr(question, "multiplechoiceanswer", None) or getattr(question, "freetextanswer")
+    answer = question.get_answer()
+    if answer is None:
+        return render(request, "quizzes/partial.html", {"error": "Question must have an answer"}, status=422)
     is_correct = answer.is_correct(request.POST.get("answer"))
     return render(
         request,

src/requirements.txt

@@ -2,3 +2,4 @@ Django==4.2
 psycopg2==2.9.6
 python-dotenv==1.0.0
 whitenoise[brotli]==6.4.0
+django-environ==0.10.0