Refactor JS testing logic to be a bit cleaner.

Author: tim-schilling

tests/test_javascript.py

@@ -10,7 +10,6 @@
     from selenium import webdriver
     from selenium.common.exceptions import NoSuchElementException
     from selenium.webdriver.support.wait import WebDriverWait
-    from selenium.webdriver.common.by import By
     from selenium.webdriver.common.keys import Keys
     from selenium.webdriver.common.action_chains import ActionChains
 except ImportError:
@@ -24,79 +23,99 @@
 from debug_toolbar.settings import PANELS_DEFAULTS
 
 
-@skipIf(webdriver is None, "selenium isn't installed")
-@skipUnless('DJANGO_SELENIUM_TESTS' in os.environ, "selenium tests not requested")
-@override_settings(DEBUG=True, DEBUG_TOOLBAR_PANELS=PANELS_DEFAULTS+[
-    'debug_toolbar.panels.profiling.ProfilingPanel',
-])
-class InitTestCase(LiveServerTestCase):
-
+class ToolbarTestCase(LiveServerTestCase):
+    """Helper class that provides a few methods for fetching elements."""
     @classmethod
     def setUpClass(cls):
-        super(InitTestCase, cls).setUpClass()
+        super(ToolbarTestCase, cls).setUpClass()
         cls.selenium = webdriver.Firefox()
 
     @classmethod
     def tearDownClass(cls):
         cls.selenium.quit()
-        super(InitTestCase, cls).tearDownClass()
+        super(ToolbarTestCase, cls).tearDownClass()
 
     def setUp(self):
         self.selenium.delete_all_cookies()
         self.selenium.get(self.live_server_url + '/execute_sql/')
-        self.panel_class = "HeadersPanel"
-        self.panel_trigger = self.selenium.find_element(
-            By.CSS_SELECTOR,
-            "#djDebugPanelList li a.{}".format(self.panel_class)
+        self.get_web_driver_wait().until(
+            lambda selenium:
+            self.get_panel_trigger("HeadersPanel").is_displayed()
         )
-        self.panel = self.selenium.find_element_by_id(self.panel_class)
-        WebDriverWait(self.selenium, timeout=10).until(
-            lambda selenium: self.panel_trigger.is_displayed())
+
+    def get_panel_trigger(self, name):
+        return self.selenium.find_element_by_class_name(name)
+
+    def get_panel(self, name):
+        return self.selenium.find_element_by_id(name)
+
+    def get_web_driver_wait(self):
+        return WebDriverWait(self.selenium, timeout=10)
+
+
+@skipIf(webdriver is None, "selenium isn't installed")
+@skipUnless(
+    'DJANGO_SELENIUM_TESTS' in os.environ, "selenium tests not requested")
+@override_settings(DEBUG=True, DEBUG_TOOLBAR_PANELS=PANELS_DEFAULTS + [
+    'debug_toolbar.panels.profiling.ProfilingPanel',
+])
+class InitTestCase(ToolbarTestCase):
 
     def test_show_toolbar(self):
         toolbar = self.selenium.find_element_by_id('djDebug')
         self.assertTrue(toolbar.is_displayed())
 
     def test_panel_li_a_click_once(self):
-        self.assertFalse(self.panel.is_displayed())
-        self.panel_trigger.click()
-        self.assertTrue(self.panel.is_displayed())
+        panel_name = "HeadersPanel"
+        panel_trigger = self.get_panel_trigger(panel_name)
+        panel = self.get_panel(panel_name)
+        self.assertFalse(panel.is_displayed())
+        panel_trigger.click()
+        self.assertTrue(panel.is_displayed())
 
         # Verify that the panels parent had the djdt-active class added
         trigger_count = self.selenium.execute_script(
             "return djdt.jQuery('#djDebugToolbar').find('.djdt-active')"
-            ".find('.{}').length".format(self.panel_class)
+            ".find('.{}').length".format(panel_name)
         )
         self.assertEquals(trigger_count, 1)
 
     def test_panel_li_a_click_twice(self):
+        panel_name = "HeadersPanel"
+        panel_trigger = self.get_panel_trigger(panel_name)
+        panel = self.get_panel(panel_name)
         # Click the trigger twice
-        self.panel_trigger.click()
-        self.panel_trigger.click()
+        panel_trigger.click()
+        panel_trigger.click()
         # Verify that the panels parent had the djdt-active class removed
         trigger_count = self.selenium.execute_script(
             "return djdt.jQuery('#djDebugToolbar').find('.djdt-active')"
-            ".find('.{}').length".format(self.panel_class)
+            ".find('.{}').length".format(panel_name)
         )
         self.assertEquals(trigger_count, 0)
-        self.assertFalse(self.panel.is_displayed())
+        self.assertFalse(panel.is_displayed())
 
     def test_ajax_fail(self):
+        panel_name = "HeadersPanel"
+        panel_trigger = self.get_panel_trigger(panel_name)
         self.selenium.execute_script(
             "djdt.jQuery('#djDebug').data('render-panel-url', '/test_fail/')"
         )
         debug_window = self.selenium.find_element_by_id("djDebugWindow")
         self.assertFalse(debug_window.is_displayed())
-        self.panel_trigger.click()
+        panel_trigger.click()
         self.assertTrue(debug_window.is_displayed())
 
     def test_dj_debug_close(self):
+        panel_name = "HeadersPanel"
+        panel_trigger = self.get_panel_trigger(panel_name)
+        panel = self.get_panel(panel_name)
         # Click a panel to set a djdt-active class
-        self.panel_trigger.click()
+        panel_trigger.click()
         active_panel_items = self.selenium.find_element_by_css_selector(
             "#djDebugToolbar li.djdt-active")
         self.assertTrue(active_panel_items.is_displayed())
-        self.panel.find_element_by_css_selector(
+        panel.find_element_by_css_selector(
             "#djDebug a.djDebugClose").click()
         self.assertRaises(
             NoSuchElementException,
@@ -105,10 +124,12 @@ def test_dj_debug_close(self):
         )
 
     def test_click_panel_button_checkbox(self):
-        checkbox = self.panel_trigger.find_element_by_xpath('..')\
+        panel_name = "HeadersPanel"
+        panel_trigger = self.get_panel_trigger(panel_name)
+        checkbox = panel_trigger.find_element_by_xpath('..')\
             .find_element_by_css_selector("input[type=checkbox]")
         cookie_name = checkbox.get_attribute("data-cookie")
-        self.assertEquals(cookie_name, "djdt{}".format(self.panel_class))
+        self.assertEquals(cookie_name, "djdt{}".format(panel_name))
         cookie = self.selenium.get_cookie(cookie_name)
         self.assertIsNone(cookie)
         # Click on the checkbox to turn off
@@ -127,20 +148,25 @@ def test_remote_class_click(self):
             self.selenium.find_element_by_class_name(panel_name).click()
             panel = self.selenium.find_element_by_id(panel_name)
 
-            remote_call_trigger = WebDriverWait(self.selenium, timeout=10).until(
-                lambda selenium: panel.find_element_by_class_name('remoteCall'))
+            remote_call_trigger = self.get_web_driver_wait().until(
+                lambda selenium: panel.find_element_by_class_name('remoteCall')
+            )
 
             remote_call_trigger.click()
             debug_window = self.selenium.find_element_by_id('djDebugWindow')
             if panel_name == 'TemplatesPanel':
-                code_section = WebDriverWait(self.selenium, timeout=10).until(
-                    lambda selenium: debug_window.find_element_by_tag_name('code'))
+                code_section = self.get_web_driver_wait().until(
+                    lambda selenium:
+                    debug_window.find_element_by_tag_name('code')
+                )
                 self.assertEquals(
                     "basic.html", code_section.get_attribute('innerHTML')
                 )
             elif panel_name == 'SQLPanel':
-                sql_select = WebDriverWait(self.selenium, timeout=10).until(
-                    lambda selenium: debug_window.find_element_by_class_name('djdt-scroll'))
+                sql_select = self.get_web_driver_wait().until(
+                    lambda selenium:
+                    debug_window.find_element_by_class_name('djdt-scroll')
+                )
                 self.assertIn(
                     "<dt>Executed SQL</dt>",
                     sql_select.get_attribute('innerHTML')
@@ -159,7 +185,8 @@ def test_toggle_switch_click(self):
             self.selenium.find_element_by_class_name(panel_name).click()
             panel = self.selenium.find_element_by_id(panel_name)
             toggle_switch = panel.find_element_by_class_name('djToggleSwitch')
-            id_javascript_selector = "return djdt.jQuery('#{}').find('.djToggleSwitch').attr('{}')"
+            id_javascript_selector = (
+                "return djdt.jQuery('#{}').find('.djToggleSwitch').attr('{}')")
             target_id = self.selenium.execute_script(
                 id_javascript_selector.format(panel_name, 'data-toggle-id')
             )
@@ -191,21 +218,25 @@ def test_toggle_switch_click(self):
             )
 
     def test_hide_toolbar_button(self):
-        self.assertTrue(self.panel_trigger.is_displayed())
+        panel_name = "HeadersPanel"
+        panel_trigger = self.get_panel_trigger(panel_name)
+        self.assertTrue(panel_trigger.is_displayed())
         self.selenium.find_element_by_id("djHideToolBarButton").click()
-        WebDriverWait(self.selenium, timeout=10).until(
-            lambda selenium: not self.panel_trigger.is_displayed())
+        self.get_web_driver_wait().until(
+            lambda selenium: not panel_trigger.is_displayed())
 
     def test_show_toolbar_button(self):
+        panel_name = "HeadersPanel"
+        panel_trigger = self.get_panel_trigger(panel_name)
         self.selenium.find_element_by_id("djHideToolBarButton").click()
         show_button = self.selenium.find_element_by_id('djShowToolBarButton')
         self.assertTrue(show_button.is_displayed())
-        self.assertFalse(self.panel_trigger.is_displayed())
+        self.assertFalse(panel_trigger.is_displayed())
         # Verify when the show button is clicked and held that it's not hidden.
         ActionChains(self.selenium).click_and_hold(show_button).perform()
         self.assertTrue(show_button.is_displayed())
         show_button.click()
-        self.assertTrue(self.panel_trigger.is_displayed())
+        self.assertTrue(panel_trigger.is_displayed())
 
     def test_move_show_toolbar_button(self):
         self.selenium.find_element_by_id("djHideToolBarButton").click()
@@ -225,8 +256,10 @@ def test_close_binding(self):
         toolbar = self.selenium.find_element_by_id('djDebugToolbar')
         self.selenium.find_element_by_class_name('remoteCall').click()
         debug_window = self.selenium.find_element_by_id('djDebugWindow')
-        WebDriverWait(self.selenium, timeout=10).until(
-            lambda selenium: debug_window.find_element_by_class_name('djdt-scroll'))
+        self.get_web_driver_wait().until(
+            lambda selenium:
+            debug_window.find_element_by_class_name('djdt-scroll')
+        )
         self.assertTrue(debug_window.is_displayed())
         # Verify the sql debug window is hidden on close
         self.selenium.execute_script('djdt.close()')
@@ -240,7 +273,7 @@ def test_close_binding(self):
 
         # Verify the sql debug window is hidden on click
         self.selenium.execute_script('djdt.close()')
-        WebDriverWait(self.selenium, timeout=10).until(
+        self.get_web_driver_wait().until(
             lambda selenium: not toolbar.is_displayed())
         self.assertFalse(sql_panel.is_displayed())
 
@@ -252,66 +285,48 @@ def test_hidden_via_cookie(self):
         self.assertTrue(
             self.selenium.find_element_by_id('djDebugToolbar').is_displayed())
         self.selenium.execute_script('djdt.close()')
-        WebDriverWait(self.selenium, timeout=10).until(
+        self.get_web_driver_wait().until(
             lambda selenium:
             selenium.find_element_by_id('djShowToolBarButton').is_displayed())
         # Verify that when the page reloads that the toolbar is still closed.
         self.selenium.refresh()
         self.assertFalse(
             self.selenium.find_element_by_id('djDebugToolbar').is_displayed())
-        self.assertTrue(
-            self.selenium.find_element_by_id('djShowToolBarButton').is_displayed())
+        show_button = self.selenium.find_element_by_id('djShowToolBarButton')
+        self.assertTrue(show_button.is_displayed())
 
 
 @skipIf(webdriver is None, "selenium isn't installed")
-@skipUnless('DJANGO_SELENIUM_TESTS' in os.environ, "selenium tests not requested")
+@skipUnless(
+    'DJANGO_SELENIUM_TESTS' in os.environ, "selenium tests not requested")
 @override_settings(DEBUG=True)
-class APITestCase(LiveServerTestCase):
-
-    @classmethod
-    def setUpClass(cls):
-        super(APITestCase, cls).setUpClass()
-        cls.selenium = webdriver.Firefox()
-
-    @classmethod
-    def tearDownClass(cls):
-        cls.selenium.quit()
-        super(APITestCase, cls).tearDownClass()
-
-    def setUp(self):
-        self.selenium.delete_all_cookies()
-        self.selenium.get(self.live_server_url + '/execute_sql/')
-        self.panel_class = "HeadersPanel"
-        self.panel_trigger = self.selenium.find_element(
-            By.CSS_SELECTOR,
-            "#djDebugPanelList li a.{}".format(self.panel_class)
-        )
-        WebDriverWait(self.selenium, timeout=10).until(
-            lambda selenium: self.panel_trigger.is_displayed())
+class APITestCase(ToolbarTestCase):
 
     def test_show_toolbar(self):
         self.selenium.execute_script("djdt.hide_toolbar(false)")
         # Verify that it closes the toolbar.
-        self.assertTrue(WebDriverWait(self.selenium, timeout=10).until(
+        self.assertTrue(self.get_web_driver_wait().until(
             lambda selenium:
             selenium.find_element_by_id('djDebugToolbarHandle').is_displayed())
         )
         self.selenium.execute_script("djdt.show_toolbar(true)")
-        self.assertFalse(
-            self.selenium.find_element_by_id('djDebugToolbarHandle').is_displayed()
-        )
-        self.assertTrue(WebDriverWait(self.selenium, timeout=10).until(
+        handle = self.selenium.find_element_by_id('djDebugToolbarHandle')
+        self.assertFalse(handle.is_displayed())
+        self.assertTrue(self.get_web_driver_wait().until(
             lambda selenium:
             selenium.find_element_by_id('djDebugToolbar').is_displayed())
         )
         cookie = self.selenium.get_cookie('djdt')
         self.assertEquals(cookie['name'], 'djdt')
         self.assertEquals(cookie['value'], 'show')
         action = ActionChains(self.selenium)
-        action.key_down(Keys.ESCAPE, self.selenium.find_element_by_tag_name('body'))
+        action.key_down(
+            Keys.ESCAPE,
+            self.selenium.find_element_by_tag_name('body')
+        )
         action.perform()
         # Verify that it closes the toolbar.
-        self.assertTrue(WebDriverWait(self.selenium, timeout=10).until(
+        self.assertTrue(self.get_web_driver_wait().until(
             lambda selenium:
             selenium.find_element_by_id('djDebugToolbarHandle').is_displayed())
         )
@@ -322,16 +337,18 @@ def test_hide_toolbar(self):
         toolbar = self.selenium.find_element_by_id('djDebugToolbar')
         self.selenium.find_element_by_class_name('remoteCall').click()
         debug_window = self.selenium.find_element_by_id('djDebugWindow')
-        WebDriverWait(self.selenium, timeout=10).until(
-            lambda selenium: debug_window.find_element_by_class_name('djdt-scroll'))
+        self.get_web_driver_wait().until(
+            lambda selenium:
+            debug_window.find_element_by_class_name('djdt-scroll')
+        )
         self.assertTrue(debug_window.is_displayed())
 
         # Hide the toolbar
         self.selenium.execute_script('djdt.hide_toolbar(false)')
-        self.assertTrue(WebDriverWait(self.selenium, timeout=10).until(
+        self.assertTrue(self.get_web_driver_wait().until(
             lambda selenium: not debug_window.is_displayed())
         )
-        self.assertTrue(WebDriverWait(self.selenium, timeout=10).until(
+        self.assertTrue(self.get_web_driver_wait().until(
             lambda selenium: not toolbar.is_displayed())
         )
         self.assertFalse(sql_panel.is_displayed())
@@ -378,7 +395,8 @@ def test_cookie_set(self):
         expires_lower_bound = timezone.now().date() + timedelta(days=expires)
         expires_upper_bound = expires_lower_bound + timedelta(days=1)
         self.selenium.execute_script(
-            "djdt.cookie.set('{}','{}',{{'path':'{}','expires':{},'domain':'{}'}})"
+            "djdt.cookie.set('{}','{}',"
+            "{{'path':'{}','expires':{},'domain':'{}'}})"
             .format(key, value, path, expires, domain)
         )
         cookie = self.selenium.get_cookie(key)