Used fix for ChannelsLiveServerTestCase from #2164 and cleaned conftest.py

Author: dee077

channels/testing/live.py

@@ -1,7 +1,6 @@
 from functools import partial
 
 from daphne.testing import DaphneProcess
-from django import VERSION
 from django.contrib.staticfiles.handlers import ASGIStaticFilesHandler
 from django.core.exceptions import ImproperlyConfigured
 from django.db import connections
@@ -40,47 +39,46 @@ def live_server_url(self):
     def live_server_ws_url(self):
         return "ws://%s:%s" % (self.host, self._port)
 
-    def _pre_setup(self):
+    @classmethod
+    def setUpClass(cls):
         for connection in connections.all():
-            if self._is_in_memory_db(connection):
+            if cls._is_in_memory_db(connection):
                 raise ImproperlyConfigured(
                     "ChannelLiveServerTestCase can not be used with in memory databases"
                 )
 
-        super(ChannelsLiveServerTestCase, self)._pre_setup()
+        super().setUpClass()
 
-        self._live_server_modified_settings = modify_settings(
-            ALLOWED_HOSTS={"append": self.host}
+        cls._live_server_modified_settings = modify_settings(
+            ALLOWED_HOSTS={"append": cls.host}
         )
-        self._live_server_modified_settings.enable()
+        cls._live_server_modified_settings.enable()
 
         get_application = partial(
             make_application,
-            static_wrapper=self.static_wrapper if self.serve_static else None,
+            static_wrapper=cls.static_wrapper if cls.serve_static else None,
         )
-        self._server_process = self.ProtocolServerProcess(self.host, get_application)
-        self._server_process.start()
-        self._server_process.ready.wait()
-        self._port = self._server_process.port.value
-
-    def _post_teardown(self):
-        self._server_process.terminate()
-        self._server_process.join()
-        self._live_server_modified_settings.disable()
-        super(ChannelsLiveServerTestCase, self)._post_teardown()
-
-    @staticmethod
-    def _is_in_memory_db(connection):
+        cls._server_process = cls.ProtocolServerProcess(cls.host, get_application)
+        cls._server_process.start()
+        while True:
+            if not cls._server_process.ready.wait(timeout=1):
+                if cls._server_process.is_alive():
+                    continue
+                raise RuntimeError("Server stopped") from None
+            break
+        cls._port = cls._server_process.port.value
+
+    @classmethod
+    def tearDownClass(cls):
+        cls._server_process.terminate()
+        cls._server_process.join()
+        cls._live_server_modified_settings.disable()
+        super().tearDownClass()
+
+    @classmethod
+    def _is_in_memory_db(cls, connection):
         """
         Check if DatabaseWrapper holds in memory database.
         """
         if connection.vendor == "sqlite":
             return connection.is_in_memory_db()
-
-
-# Workaround for Django 5.2: _pre_setup became a classmethod.
-# TODO: Remove this workaround once support for Django <5.2 is dropped.
-if VERSION >= (5, 2):
-    ChannelsLiveServerTestCase._pre_setup = classmethod(
-        ChannelsLiveServerTestCase._pre_setup
-    )

tests/conftest.py

@@ -1,53 +1,12 @@
+import os
+
 import pytest
 from django.conf import settings
 
 
 def pytest_configure():
-    settings.configure(
-        DATABASES={
-            "default": {
-                "ENGINE": "django.db.backends.sqlite3",
-                # Override Django’s default behaviour of using an in-memory database
-                # in tests for SQLite, since that avoids connection.close() working.
-                "TEST": {"NAME": "test_db.sqlite3"},
-            }
-        },
-        INSTALLED_APPS=[
-            "daphne",
-            "django.contrib.auth",
-            "django.contrib.contenttypes",
-            "django.contrib.sessions",
-            "django.contrib.admin",
-            "django.contrib.staticfiles",
-            "tests.sample_project.sampleapp",
-            "channels",
-        ],
-        STATIC_URL="static/",
-        ASGI_APPLICATION="tests.sample_project.config.asgi.application",
-        MIDDLEWARE=[
-            "django.contrib.sessions.middleware.SessionMiddleware",
-            "django.contrib.auth.middleware.AuthenticationMiddleware",
-        ],
-        ROOT_URLCONF="tests.sample_project.config.urls",
-        CHANNEL_LAYERS={
-            "default": {
-                "BACKEND": "channels.layers.InMemoryChannelLayer",
-            },
-        },
-        TEMPLATES=[
-            {
-                "BACKEND": "django.template.backends.django.DjangoTemplates",
-                "APP_DIRS": True,
-                "OPTIONS": {
-                    "context_processors": [
-                        "django.template.context_processors.request",
-                        "django.contrib.auth.context_processors.auth",
-                    ],
-                },
-            },
-        ],
-        SECRET_KEY="Not_a_secret_key",
-    )
+    os.environ["DJANGO_SETTINGS_MODULE"] = "tests.sample_project.config.settings"
+    settings._setup()
 
 
 def pytest_generate_tests(metafunc):

tests/sample_project/config/settings.py

@@ -1,35 +1,13 @@
-"""
-Django settings for sample_project project.
-
-Generated by 'django-admin startproject' using Django 5.2.
-
-For more information on this file, see
-https://docs.djangoproject.com/en/5.2/topics/settings/
-
-For the full list of settings and their values, see
-https://docs.djangoproject.com/en/5.2/ref/settings/
-"""
-
 from pathlib import Path
 
-# Build paths inside the project like this: BASE_DIR / 'subdir'.
 BASE_DIR = Path(__file__).resolve().parent.parent
 
+SECRET_KEY = "Not_a_secret_key"
 
-# Quick-start development settings - unsuitable for production
-# See https://docs.djangoproject.com/en/5.2/howto/deployment/checklist/
-
-# SECURITY WARNING: keep the secret key used in production secret!
-SECRET_KEY = "django-insecure-w%kkd-b39(9uvz68x!-9+xt=&9q&^j@#uc_&=g%-s@bcsz*qbu"
-
-# SECURITY WARNING: don't run with debug turned on in production!
 DEBUG = True
 
 ALLOWED_HOSTS = []
 
-
-# Application definition
-
 INSTALLED_APPS = [
     "daphne",
     "django.contrib.admin",
@@ -38,7 +16,7 @@
     "django.contrib.sessions",
     "django.contrib.messages",
     "django.contrib.staticfiles",
-    "sampleapp",
+    "tests.sample_project.sampleapp",
     "channels",
 ]
 
@@ -52,7 +30,7 @@
     "django.middleware.clickjacking.XFrameOptionsMiddleware",
 ]
 
-ROOT_URLCONF = "config.urls"
+ROOT_URLCONF = "tests.sample_project.config.urls"
 
 TEMPLATES = [
     {
@@ -70,32 +48,26 @@
     },
 ]
 
-WSGI_APPLICATION = "config.wsgi.application"
-ASGI_APPLICATION = "config.asgi.application"
+WSGI_APPLICATION = "tests.sample_project.config.wsgi.application"
+ASGI_APPLICATION = "tests.sample_project.config.asgi.application"
 
 CHANNEL_LAYERS = {
     "default": {
         "BACKEND": "channels.layers.InMemoryChannelLayer",
     },
 }
 
-# Database
-# https://docs.djangoproject.com/en/5.2/ref/settings/#databases
-
 DATABASES = {
     "default": {
         "ENGINE": "django.db.backends.sqlite3",
         "NAME": BASE_DIR / "sampleapp/sampleapp.sqlite3",
-        "TEST": {
-            "NAME": BASE_DIR / "sampleapp/test_sampleapp.sqlite3",
-        },
+        # Override Django’s default behaviour of using an in-memory database
+        # in tests for SQLite, since that avoids connection.close() working.
+        "TEST": {"NAME": "test_db.sqlite3"},
     }
 }
 
 
-# Password validation
-# https://docs.djangoproject.com/en/5.2/ref/settings/#auth-password-validators
-
 AUTH_PASSWORD_VALIDATORS = [
     {
         "NAME": (
@@ -114,10 +86,6 @@
     },
 ]
 
-
-# Internationalization
-# https://docs.djangoproject.com/en/5.2/topics/i18n/
-
 LANGUAGE_CODE = "en-us"
 
 TIME_ZONE = "UTC"
@@ -126,13 +94,6 @@
 
 USE_TZ = True
 
-
-# Static files (CSS, JavaScript, Images)
-# https://docs.djangoproject.com/en/5.2/howto/static-files/
-
 STATIC_URL = "static/"
 
-# Default primary key field type
-# https://docs.djangoproject.com/en/5.2/ref/settings/#default-auto-field
-
 DEFAULT_AUTO_FIELD = "django.db.models.BigAutoField"