Async integration tests

tests/base.py

@@ -1,13 +1,23 @@
+import contextvars
 from typing import Optional
 
 import html5lib
 from asgiref.local import Local
 from django.http import HttpResponse
-from django.test import Client, RequestFactory, TestCase, TransactionTestCase
+from django.test import (
+ AsyncClient,
+ AsyncRequestFactory,
+ Client,
+ RequestFactory,
+ TestCase,
+ TransactionTestCase,
+)
 
 from debug_toolbar.panels import Panel
 from debug_toolbar.toolbar import DebugToolbar
 
+data_contextvar = contextvars.ContextVar("djdt_toolbar_test_client")
+
 
 class ToolbarTestClient(Client):
  def request(self, **request):
@@ -29,11 +39,35 @@ def handle_toolbar_created(sender, toolbar=None, **kwargs):
  return response
 
 
+class AsyncToolbarTestClient(AsyncClient):
+ async def request(self, **request):
+ # Use a thread/async task context-local variable to guard against a
+ # concurrent _created signal from a different thread/task.
+ # In cases testsuite will have both regular and async tests or
+ # multiple async tests running in an eventloop making async_client calls.
+ data_contextvar.set(None)
+
+ def handle_toolbar_created(sender, toolbar=None, **kwargs):
+ data_contextvar.set(toolbar)
+
+ DebugToolbar._created.connect(handle_toolbar_created)
+ try:
+ response = await super().request(**request)
+ finally:
+ DebugToolbar._created.disconnect(handle_toolbar_created)
+ response.toolbar = data_contextvar.get()
+
+ return response
+
+
 rf = RequestFactory()
+arf = AsyncRequestFactory()
 
 
 class BaseMixin:
+ _is_async = False
  client_class = ToolbarTestClient
+ async_client_class = AsyncToolbarTestClient
 
  panel: Optional[Panel] = None
  panel_id = None
@@ -42,7 +76,11 @@ def setUp(self):
  super().setUp()
  self._get_response = lambda request: HttpResponse()
  self.request = rf.get("/")
- self.toolbar = DebugToolbar(self.request, self.get_response)
+ if self._is_async:
+ self.request = arf.get("/")
+ self.toolbar = DebugToolbar(self.request, self.get_response_async)
+ else:
+ self.toolbar = DebugToolbar(self.request, self.get_response)
  self.toolbar.stats = {}
 
  if self.panel_id:
@@ -59,6 +97,9 @@ def tearDown(self):
  def get_response(self, request):
  return self._get_response(request)
 
+ async def get_response_async(self, request):
+ return self._get_response(request)
+
  def assertValidHTML(self, content):
  parser = html5lib.HTMLParser()
  parser.parseFragment(content)

tests/settings.py

@@ -30,6 +30,7 @@
  "tests",
 ]
 
+
 USE_GIS = os.getenv("DB_BACKEND") == "postgis"
 
 if USE_GIS:

tests/test_integration.py

@@ -288,7 +288,7 @@ def test_sql_page(self):
  def test_async_sql_page(self):
  response = self.client.get("/async_execute_sql/")
  self.assertEqual(
- len(response.toolbar.get_panel_by_id("SQLPanel").get_stats()["queries"]), 1
+ len(response.toolbar.get_panel_by_id("SQLPanel").get_stats()["queries"]), 2
  )
 
  def test_concurrent_async_sql_page(self):