Fix tests for serializable changes with selenium.

The majority were difficulities with caching and settings.

Author: Tim Schilling

tests/panels/test_history.py

@@ -8,7 +8,6 @@
 from debug_toolbar.store import get_store
 from debug_toolbar.toolbar import DebugToolbar
 
-from .. import settings as test_settings
 from ..base import BaseTestCase, IntegrationTestCase
 
 rf = RequestFactory()
@@ -110,14 +109,17 @@ def test_history_headers(self):
         request_id = list(get_store().request_ids())[0]
         self.assertEqual(response.headers["djdt-request-id"], request_id)
 
-    @override_settings(
-        DEBUG_TOOLBAR_CONFIG={"OBSERVE_REQUEST_CALLBACK": lambda request: False}
-    )
     def test_history_headers_unobserved(self):
         """Validate the headers aren't injected from the history panel."""
+        with self.settings(
+            DEBUG_TOOLBAR_CONFIG={"OBSERVE_REQUEST_CALLBACK": lambda request: False}
+        ):
+            DebugToolbar.get_observe_request.cache_clear()
+            response = self.client.get("/json_view/")
+            self.assertNotIn("djdt-request-id", response.headers)
+        # Clear it again to avoid conflicting with another test
+        # Specifically, DebugToolbarLiveTestCase.test_ajax_refresh
         DebugToolbar.get_observe_request.cache_clear()
-        response = self.client.get("/json_view/")
-        self.assertNotIn("djdt-request-id", response.headers)
 
     def test_history_sidebar(self):
         """Validate the history sidebar view."""
@@ -145,7 +147,9 @@ def test_history_sidebar_includes_history(self):
             panel_keys,
         )
 
-    @override_settings(DEBUG_TOOLBAR_CONFIG={"RENDER_PANELS": False})
+    @override_settings(
+        DEBUG_TOOLBAR_CONFIG={"RENDER_PANELS": False, "RESULTS_CACHE_SIZE": 1}
+    )
     def test_history_sidebar_expired_request_id(self):
         """Validate the history sidebar view."""
         self.client.get("/json_view/")
@@ -158,8 +162,7 @@ def test_history_sidebar_expired_request_id(self):
             self.PANEL_KEYS,
         )
         # Make enough requests to unset the original
-        for _i in range(test_settings.DEBUG_TOOLBAR_CONFIG["RESULTS_CACHE_SIZE"]):
-            self.client.get("/json_view/")
+        self.client.get("/json_view/")
 
         # Querying old request_id should return in empty response
         data = {"request_id": request_id, "exclude_history": True}

tests/test_integration.py

@@ -1,6 +1,5 @@
 import os
 import re
-import time
 import unittest
 from unittest.mock import patch
 
@@ -648,7 +647,7 @@ def test_basic_jinja(self):
         # This should be 2 templates rendered, including base.html See
         # JinjaTemplateTestCase.test_django_jinja2_parent_template_instrumented
         self.assertIn("Templates (1 rendered)", template_panel.text)
-        self.assertIn("base.html", template_panel.text)
+        self.assertIn("basic.jinja", template_panel.text)
 
     @override_settings(
         DEBUG_TOOLBAR_CONFIG={
@@ -831,10 +830,13 @@ def test_ajax_refresh(self):
         make_ajax = self.selenium.find_element(By.ID, "click_for_ajax")
         make_ajax.click()
         # Need to wait until the ajax request is over and json_view is displayed on the toolbar
-        time.sleep(2)
-        history_panel = self.wait.until(
-            lambda selenium: self.selenium.find_element(By.ID, "djdt-HistoryPanel")
+        self.wait.until(
+            lambda selenium: self.selenium.find_element(
+                By.CSS_SELECTOR, "#djdt-HistoryPanel a.HistoryPanel small"
+            ).text
+            == "/json_view/"
         )
+        history_panel = self.selenium.find_element(By.ID, "djdt-HistoryPanel")
         self.assertNotIn("/ajax/", history_panel.text)
         self.assertIn("/json_view/", history_panel.text)
 

tests/test_store.py

@@ -64,15 +64,12 @@ def test_set(self):
         self.assertEqual(list(self.store.request_ids()), ["foo"])
 
     def test_set_max_size(self):
-        existing = self.store._config["RESULTS_CACHE_SIZE"]
-        self.store._config["RESULTS_CACHE_SIZE"] = 1
-        self.store.save_panel("foo", "foo.panel", "foo.value")
-        self.store.save_panel("bar", "bar.panel", {"a": 1})
-        self.assertEqual(list(self.store.request_ids()), ["bar"])
-        self.assertEqual(self.store.panel("foo", "foo.panel"), {})
-        self.assertEqual(self.store.panel("bar", "bar.panel"), {"a": 1})
-        # Restore the existing config setting since this config is shared.
-        self.store._config["RESULTS_CACHE_SIZE"] = existing
+        with self.settings(DEBUG_TOOLBAR_CONFIG={"RESULTS_CACHE_SIZE": 1}):
+            self.store.save_panel("foo", "foo.panel", "foo.value")
+            self.store.save_panel("bar", "bar.panel", {"a": 1})
+            self.assertEqual(list(self.store.request_ids()), ["bar"])
+            self.assertEqual(self.store.panel("foo", "foo.panel"), {})
+            self.assertEqual(self.store.panel("bar", "bar.panel"), {"a": 1})
 
     def test_clear(self):
         self.store.save_panel("bar", "bar.panel", {"a": 1})