Chapter 8: Organizing tests into batches

Change log:

1. Added a wrapper class called EyesManager which wraps eyes selenium's convenience methods
2. Updated conftest.py file to expose this class as a manager fixture (module level)
3. Added tests and page objects for tables webpage in elemental selenium
4. Added a setup_suite and setup_eyes fixture to set batch info for all the tests in the module and take care of setup/teardown of eyes.

Author: Gaurav Singh

automation/core/__init__.py

@@ -0,0 +1,44 @@
+from applitools.common import BatchInfo
+from applitools.selenium import Eyes
+
+from automation.config.base import APPLITOOLS_API_KEY
+
+
+class EyesManager:
+    def __init__(self, driver):
+        self.app_name = None
+        self.driver = driver
+        self.eyes = self.initialize_eyes()
+
+    @staticmethod
+    def initialize_eyes():
+        eyes = Eyes()
+        eyes.api_key = APPLITOOLS_API_KEY
+        return eyes
+
+    def set_app_name(self, app_name):
+        self.app_name = app_name
+
+    def set_batch(self, batch_name):
+        if batch_name:
+            batch_info = BatchInfo(batch_name)
+            self.eyes.batch = batch_info
+
+    def validate_window(self, tag=None, full_page=False):
+        if full_page:
+            self.eyes.force_full_page_screenshot = True
+
+        self.eyes.check_window(tag=tag)
+
+    def validate_element(self, element, tag=None):
+        self.eyes.check_region(element, tag=tag)
+
+    def validate_frame(self, frame_reference, region, tag=None):
+        self.eyes.check_region_in_frame(frame_reference, region, tag=tag)
+
+    def open_eyes(self, test_name):
+        self.eyes.open(self.driver, self.app_name,
+                       test_name=test_name)
+
+    def close_eyes(self):
+        self.eyes.close()

automation/core/eyes_manager.py

@@ -0,0 +1,23 @@
+from time import sleep
+from selenium.webdriver.common.by import By
+
+
+class SortableTablePage:
+    BASE_HEADER = '//table[@id="table1"]/descendant::span[text()="{}"]/parent::th'
+    FIRST_NAME = (
+        By.XPATH, BASE_HEADER.format('First Name'))
+    LAST_NAME = (
+        By.XPATH, BASE_HEADER.format("Last Name"))
+
+    def __init__(self, driver):
+        self.driver = driver
+
+    def sort_by_first_name(self):
+        locator = self.FIRST_NAME
+        self.driver.find_element(*locator).click()
+        sleep(5)
+
+    def sort_by_last_name(self):
+        locator = self.LAST_NAME
+        self.driver.find_element(*locator).click()
+        sleep(5)

automation/page_objects/the_internet/__init__.py

@@ -0,0 +1,38 @@
+import pytest
+
+from automation.page_objects.the_internet.tables.sortable_tables import \
+    SortableTablePage
+
+
+@pytest.fixture(scope='module')
+def setup_suite(manager, driver):
+    app_name = 'the-internet'
+    app_under_test = 'https://the-internet.herokuapp.com/tables'
+
+    manager.set_batch('sortable table test suite')
+    manager.set_app_name(app_name)
+
+    driver.get(app_under_test)
+    driver.maximize_window()
+
+
+@pytest.fixture(scope='function', autouse=True)
+def setup_eyes(request, setup_suite, manager):
+    test_name = request.function.__name__
+    manager.open_eyes(test_name)
+    yield setup_eyes
+    manager.close_eyes()
+
+
+def test_sort_by_first_name(manager):
+    page = SortableTablePage(manager.driver)
+    page.sort_by_first_name()
+
+    manager.validate_window(tag='by_first_name')
+
+
+def test_sort_by_last_name(manager):
+    page = SortableTablePage(manager.driver)
+    page.sort_by_last_name()
+
+    manager.validate_window(tag='by_last_name')

automation/page_objects/the_internet/tables/__init__.py

@@ -1,60 +1,17 @@
 import pytest
-from applitools.selenium import Eyes
 from selenium import webdriver
 
-from automation.config.base import APPLITOOLS_API_KEY
+from automation.core.eyes_manager import EyesManager
 
-APP_NAME = 'the-internet'
-APP_UNDER_TEST = 'https://the-internet.herokuapp.com/iframe'
 
+@pytest.fixture(scope='module')
+def manager(driver):
+    eyes_manager = EyesManager(driver)
+    yield eyes_manager
 
-@pytest.fixture(scope='function')
+
+@pytest.fixture(scope='module')
 def driver():
     driver = webdriver.Chrome()
-    driver.get(APP_UNDER_TEST)
     yield driver
     driver.quit()
-
-
-@pytest.fixture(scope='function')
-def eyes():
-    eyes = initialize_eyes()
-    yield eyes
-
-
-def initialize_eyes():
-    eyes = Eyes()
-    eyes.api_key = APPLITOOLS_API_KEY
-    return eyes
-
-
-def validate_window(driver, eyes, tag=None):
-    open_eyes(driver, eyes)
-    eyes.force_full_page_screenshot = True
-    eyes.check_window(tag=tag)
-    close_eyes(eyes)
-
-
-def validate_element(driver, eyes, element, tag=None):
-    open_eyes(driver, eyes)
-    eyes.check_region(element, tag=tag)
-    close_eyes(eyes)
-
-
-def validate_frame(driver, eyes, frame_reference, region, tag=None):
-    open_eyes(driver, eyes)
-    eyes.check_region_in_frame(frame_reference, region, tag=tag)
-    close_eyes(eyes)
-
-
-def open_eyes(driver, eyes):
-    eyes.open(driver, APP_NAME, test_name=get_test_name())
-
-
-def get_test_name():
-    import inspect
-    return inspect.stack()[3].function
-
-
-def close_eyes(eyes):
-    eyes.close()