Turn Django DebugToolbar off in tests

Author: nickjj

src/config/settings.py

@@ -12,6 +12,7 @@
 
 import os
 import socket
+import sys
 from distutils.util import strtobool
 from pathlib import Path
 
@@ -22,14 +23,15 @@
 
 DEBUG = bool(strtobool(os.getenv("DEBUG", "false")))
 
+TESTING = "test" in sys.argv
+
 # https://docs.djangoproject.com/en/5.0/ref/settings/#std:setting-ALLOWED_HOSTS
 allowed_hosts = os.getenv("ALLOWED_HOSTS", ".localhost,127.0.0.1,[::1]")
 ALLOWED_HOSTS = list(map(str.strip, allowed_hosts.split(",")))
 
 # Application definitions
 INSTALLED_APPS = [
     "pages.apps.PagesConfig",
-    "debug_toolbar",
     "django.contrib.admin",
     "django.contrib.auth",
     "django.contrib.contenttypes",
@@ -39,7 +41,6 @@
 ]
 
 MIDDLEWARE = [
-    "debug_toolbar.middleware.DebugToolbarMiddleware",
     "django.middleware.security.SecurityMiddleware",
     "whitenoise.middleware.WhiteNoiseMiddleware",
     "django.contrib.sessions.middleware.SessionMiddleware",
@@ -50,6 +51,13 @@
     "django.middleware.clickjacking.XFrameOptionsMiddleware",
 ]
 
+if not TESTING:
+    INSTALLED_APPS = [*INSTALLED_APPS, "debug_toolbar"]
+    MIDDLEWARE = [
+        "debug_toolbar.middleware.DebugToolbarMiddleware",
+        *MIDDLEWARE,
+    ]
+
 ROOT_URLCONF = "config.urls"
 
 # Starting with Django 4.1+ we need to pick which template loaders to use

src/config/urls.py

@@ -15,6 +15,7 @@
     2. Add a URL to urlpatterns:  path('blog/', include('blog.urls'))
 """
 
+from django.conf import settings
 from django.contrib import admin
 from django.urls import include
 from django.urls import path
@@ -23,5 +24,9 @@
     path("up/", include("up.urls")),
     path("", include("pages.urls")),
     path("admin/", admin.site.urls),
-    path("__debug__/", include("debug_toolbar.urls")),
 ]
+if not settings.TESTING:
+    urlpatterns = [
+        *urlpatterns,
+        path("__debug__/", include("debug_toolbar.urls")),
+    ]