Improve test fixtures

Author: Brandon Duffany

codebender_testing/utils.py

@@ -1,5 +1,4 @@
 import re
-import sys
 
 from selenium import webdriver
 from selenium.common.exceptions import NoSuchElementException
@@ -12,17 +11,23 @@
 from codebender_testing.config import WEBDRIVERS
 
 
+
 class SeleniumTestCase(object):
     """Base class for all Selenium tests."""
 
     @classmethod
-    @pytest.fixture(scope="class", autouse=True, params=WEBDRIVERS.keys())
-    def setup(self, request):
-        """Sets up attributes that should be accessible to all test cases."""
+    @pytest.fixture(scope="class", autouse=True)
+    def _testcase_attrs(cls, webdriver):
+        """Sets up any class attributes to be used by any SeleniumTestCase.
+        Here, we just store fixtures as class attributes. This allows us to avoid
+        the pytest boilerplate of getting a fixture value, and instead just
+        refer to the fixture as `self.<fixture>`.
+        """
+        cls.driver = webdriver
 
-        # Repeat each test for each webdriver configuration
-        webdriver_cls = WEBDRIVERS[request.param]
-        self.driver = webdriver_cls()
+    @pytest.fixture(scope="class")
+    def tester_login(self): 
+        self.login()
 
     def open(self, url=None):
         """Open the resource specified by `url`.
@@ -49,26 +54,20 @@ def open_project(self, project_name=None):
         project_link = self.driver.find_element_by_link_text(project_name)
         project_link.send_keys(Keys.ENTER)
 
-
-def logged_in(func):
-    """Decorator to ensure the user is logged in before performing a test.
-    If not logged in, a login will be performed."""
-    def inner(*args, **kwargs):
-        test = args[0]
+    def login(self):
+        """Performs a login."""
         try:
-            test.open()
-            login_button = test.driver.find_element_by_id('login_btn')
+            self.open()
+            login_button = self.driver.find_element_by_id('login_btn')
             login_button.send_keys(Keys.ENTER)
             # Enter credentials and log in
-            user_field = test.driver.find_element_by_id('username')
+            user_field = self.driver.find_element_by_id('username')
             user_field.send_keys(TEST_CREDENTIALS['username'])
-            pass_field = test.driver.find_element_by_id('password')
+            pass_field = self.driver.find_element_by_id('password')
             pass_field.send_keys(TEST_CREDENTIALS['password'])
-            do_login = test.driver.find_element_by_id('_submit')
+            do_login = self.driver.find_element_by_id('_submit')
             do_login.send_keys(Keys.ENTER)
         except NoSuchElementException:
             # 'Log In' is not displayed, so we're already logged in.
             pass
-        return func(*args, **kwargs)
-    return inner
 

requirements-dev.txt

@@ -1,4 +1,4 @@
-tox
+flake8
 pytest
+tox
 virtualenv
-

tests/conftest.py

@@ -0,0 +1,15 @@
+import pytest
+
+from codebender_testing.config import WEBDRIVERS
+
+
+@pytest.fixture(scope="session", params=WEBDRIVERS.keys())
+def webdriver(request):
+    """Returns a webdriver that persists across the entire test session,
+    and registers a finalizer to close the browser once the session is
+    complete. The entire test session is repeated once per driver.
+    """
+    driver = WEBDRIVERS[request.param]()
+    request.addfinalizer(lambda: driver.quit())
+    return driver
+

tests/sketch/test_sketch.py

@@ -4,9 +4,10 @@
 from selenium.webdriver.common.by import By
 from selenium.webdriver.common.keys import Keys
 from selenium.webdriver.support import expected_conditions
+from selenium.webdriver.support.select import Select
 from selenium.webdriver.support.ui import WebDriverWait
+import pytest
 
-from codebender_testing.utils import logged_in
 from codebender_testing.utils import SeleniumTestCase
 
 
@@ -16,17 +17,24 @@
 # How long to wait before we give up on finding an element on the page.
 ELEMENT_FIND_TIMEOUT = 5
 
+# Board to test for the dropdown selector.
+TEST_BOARD = "Arduino Fio"
+
 
 class TestSketch(SeleniumTestCase):
+    """Tests various functions of the /sketch view."""
 
-    @logged_in
-    def test_verify_code(self):
+    @pytest.fixture(scope="class", autouse=True)
+    def open_test_project(self, tester_login):
+        """Makes sure we are logged in and have a project open before
+        performing any of these tests."""
         self.open_project()
-
         # I get a StaleElementReferenceException without
         # this wait. TODO: figure out how to get around this.
         time.sleep(3)
-
+    
+    def test_verify_code(self):
+        """Ensures that we can compile code and see the success message."""
         compile_button = self.driver.find_element_by_id("compile")
         compile_button.click()
 
@@ -35,19 +43,18 @@ def test_verify_code(self):
                 (By.ID, "operation_output"), "Verification Successful!")
         )
 
-    @logged_in
     def test_boards_dropdown(self):
-        self.open_project()
-
+        """Tests that the boards dropdown is present, and that we can change
+        the board successfully."""
         WebDriverWait(self.driver, ELEMENT_FIND_TIMEOUT).until(
             expected_conditions.presence_of_element_located(
             (By.ID, "boards"))
         )
 
-        boards_dropdown = self.driver.find_element_by_id("boards")
-        options = boards_dropdown.find_elements_by_tag_name("option")
+        boards_dropdown = Select(self.driver.find_element_by_id("boards"))
 
         # Click something other than the first option
-        test_option = options[3]
-        test_option.click()
+        boards_dropdown.select_by_visible_text(TEST_BOARD)
+
+        assert boards_dropdown.first_selected_option.text == TEST_BOARD