Allow integration tests to access the toolbar

Add a mechanism for integration tests to access the toolbar used for a
particular request:  Update DebugToolbar to emit a signal on creation
referencing itself.  Then create and use a custom Django test client
that connects to this signal to capture the toolbar that was created
while the request was being processed, and to store the toolbar on the
response for use by tests.

Author: living180

debug_toolbar/toolbar.py

@@ -8,6 +8,7 @@
 
 from django.apps import apps
 from django.core.exceptions import ImproperlyConfigured
+from django.dispatch import Signal
 from django.template import TemplateSyntaxError
 from django.template.loader import render_to_string
 from django.urls import path, resolve
@@ -18,6 +19,9 @@
 
 
 class DebugToolbar:
+    # for internal testing use only
+    _created = Signal()
+
     def __init__(self, request, get_response):
         self.request = request
         self.config = dt_settings.get_config().copy()
@@ -38,6 +42,7 @@ def __init__(self, request, get_response):
         self.stats = {}
         self.server_timing_stats = {}
         self.store_id = None
+        self._created.send(request, toolbar=self)
 
     # Manage panels
 

tests/base.py

@@ -1,13 +1,37 @@
 import html5lib
+from asgiref.local import Local
 from django.http import HttpResponse
-from django.test import RequestFactory, TestCase
+from django.test import Client, RequestFactory, TestCase
 
 from debug_toolbar.toolbar import DebugToolbar
 
+
+class ToolbarTestClient(Client):
+    def request(self, **request):
+        # Use a thread/async task context-local variable to guard against a
+        # concurrent _created signal from a different thread/task.
+        data = Local()
+        data.toolbar = None
+
+        def handle_toolbar_created(sender, toolbar=None, **kwargs):
+            data.toolbar = toolbar
+
+        DebugToolbar._created.connect(handle_toolbar_created)
+        try:
+            response = super().request(**request)
+        finally:
+            DebugToolbar._created.disconnect(handle_toolbar_created)
+        response.toolbar = data.toolbar
+
+        return response
+
+
 rf = RequestFactory()
 
 
 class BaseTestCase(TestCase):
+    client_class = ToolbarTestClient
+
     panel_id = None
 
     def setUp(self):