handle missing challenge template

falls back to configurable default template if the template is missing

neighbourhood/models.py

@@ -1,6 +1,7 @@
 from hashlib import sha256
 from random import randrange
 
+from django import template
 from django.conf import settings
 from django.contrib.auth.models import (
     AbstractBaseUser,
@@ -150,6 +151,13 @@ class Challenge(models.Model):
     created = models.DateTimeField(auto_now_add=True)
     last_updated = models.DateTimeField(auto_now=True)
 
+    def get_template_safe(self):
+        try:
+            template.loader.get_template(self.template)
+            return self.template
+        except template.TemplateDoesNotExist:
+            return settings.DEFAULT_CHALLENGE_TEMPLATE
+
     def __str__(self):
         return self.name
 

neighbourhood/templates/neighbourhood/team_private.html

@@ -111,7 +111,7 @@ <h2 class="h4 mb-4">Team progress</h2>
             <h2 class="h4 mb-4">Current challenge</h2>
 
             {% if team.challenge %}
-              {% include team.challenge.template with challenge=team.challenge %}
+              {% include team.challenge.get_template_safe with challenge=team.challenge %}
             {% else %}
             <div class="mb-5 p-4 p-md-5 border rounded shadow-lg">
                 <!-- TODO: Customise the current/next step based on member_count etc -->

neighbourhood/tests/test_views.py

@@ -166,6 +166,16 @@ def test_team_with_non_default_template_challenge_set(self):
 
         self.assertContains(response, "Use the share buttons below")
 
+    def test_team_with_bad_template_challenge_set(self):
+        challenge = Challenge.objects.get(name="Recruit first team member")
+        challenge.template = "neighbourhood/challenges/_missing.html"
+        challenge.save()
+
+        self.client.force_login(User.objects.get(email="[email protected]"))
+        response = self.client.get(reverse("team", args=("holyrood-palace",)))
+
+        self.assertContains(response, "Recruit your first team member")
+
     def test_team_with_no_challenge_set(self):
         self.client.force_login(
             User.objects.get(email="[email protected]")

neighbourhood_warmth/settings.py

@@ -26,6 +26,7 @@
     ALLOWED_HOSTS=(list, []),
     HIDE_DEBUG_TOOLBAR=(bool, False),
     LOG_LEVEL=(str, "WARNING"),
+    DEFAULT_CHALLENGE_TEMPLATE=(str, "neighbourhood/challenges/_default.html"),
 )
 environ.Env.read_env(BASE_DIR / ".env")
 
@@ -36,6 +37,7 @@
 HIDE_DEBUG_TOOLBAR = env("HIDE_DEBUG_TOOLBAR")
 MAPIT_URL = env("MAPIT_URL")
 MAPIT_API_KEY = env("MAPIT_API_KEY")
+DEFAULT_CHALLENGE_TEMPLATE = env("DEFAULT_CHALLENGE_TEMPLATE")
 
 # make sure CSRF checking still works behind load balancers
 SECURE_PROXY_SSL_HEADER = ("HTTP_X_FORWARDED_PROTO", "https")