Add a11y tests for Registration Files Pages

Author: DougCorell

pages/registrations.py

@@ -34,6 +34,7 @@ class MyRegistrationsPage(OSFBasePage):
     draft_registration_cards = GroupLocator(
         By.CSS_SELECTOR, 'div[data-test-draft-registration-card]'
     )
+    registration_cards = GroupLocator(By.CSS_SELECTOR, 'div[data-test-node-card]')
 
     def get_first_draft_id_by_template(self, template_name):
         for draft_card in self.draft_registration_cards:
@@ -44,3 +45,13 @@ def get_first_draft_id_by_template(self, template_name):
                 ).get_attribute('href')
                 draft_id = url.split('drafts/', 1)[1]
                 return draft_id
+
+    def get_node_id_by_title(self, title):
+        for registration_card in self.registration_cards:
+            node_title = registration_card.find_element_by_css_selector(
+                '[data-test-node-title]'
+            )
+            if title in node_title.text:
+                url = node_title.get_attribute('href')
+                node_id = url.split('osf.io/', 1)[1]
+                return node_id

pages/registries.py

@@ -65,11 +65,34 @@ def get_first_non_withdrawn_registration(self):
                 )
 
 
-class RegistrationDetailPage(GuidBasePage):
+class BaseSubmittedRegistrationPage(GuidBasePage):
+    base_url = settings.OSF_HOME
+    url_addition = ''
+
+    @property
+    def url(self):
+        return self.base_url + '/' + self.guid + '/' + self.url_addition
+
+
+class RegistrationDetailPage(BaseSubmittedRegistrationPage):
+    """This is the Registration Overview Page"""
+
     identity = Locator(By.CSS_SELECTOR, '[data-test-registration-title]')
     loading_indicator = Locator(By.CSS_SELECTOR, '.ball-scale', settings.LONG_TIMEOUT)
 
 
+class RegistrationFileListPage(BaseSubmittedRegistrationPage):
+    url_addition = 'files'
+    identity = Locator(By.CSS_SELECTOR, '[data-test-file-providers-list]')
+    file_list_button = Locator(By.CSS_SELECTOR, '[data-test-file-list-link]')
+    loading_indicator = Locator(By.CSS_SELECTOR, '.ball-scale')
+    first_file_link = Locator(By.CSS_SELECTOR, '[data-analytics-name="Open file"]')
+
+
+class RegistrationFileDetailPage(GuidBasePage):
+    identity = Locator(By.CSS_SELECTOR, '[data-test-file-renderer')
+
+
 class RegistrationAddNewPage(BaseRegistriesPage):
     url_addition = 'new'
     identity = Locator(

tests/test_a11y_registries.py

@@ -16,6 +16,8 @@
     DraftRegistrationReviewPage,
     RegistrationAddNewPage,
     RegistrationDetailPage,
+    RegistrationFileDetailPage,
+    RegistrationFileListPage,
     RegistriesDiscoverPage,
     RegistriesLandingPage,
     RegistriesModerationModeratorsPage,
@@ -155,6 +157,111 @@ def log_in_as_user_with_draft_registrations(driver):
     )
 
 
+# User with registrations is not setup in production
+@markers.dont_run_on_prod
+class TestSubmittedRegistrationPages:
+    @pytest.fixture()
+    def my_registrations_page(self, driver, log_in_as_user_with_draft_registrations):
+        """Fixture that logs in as a user that already has submitted registrations
+        and navigates to the My Registrations page from which the desired registration
+        can be selected.
+        """
+        my_registrations_page = MyRegistrationsPage(driver)
+        my_registrations_page.goto()
+        # Wait for registration cards to load on page
+        WebDriverWait(driver, 5).until(
+            EC.presence_of_element_located((By.CSS_SELECTOR, '[data-test-node-card]'))
+        )
+        registration_cards = my_registrations_page.registration_cards
+        assert registration_cards
+        return my_registrations_page
+
+    @markers.ember_page
+    def test_accessibility_files_list_page(
+        self, driver, session, write_files, exclude_best_practice, my_registrations_page
+    ):
+        """This test is for checking the accessibility of the Registration File List
+        Page of a submitted registration.  First search through the registration cards
+        on the Submitted tab of the My Registration Page for the registration that has
+        files (searching by registration title).  When you find the desired registration
+        get the registration node id from its link and then use the node id to navigate
+        to the Files List page for this registration.
+        """
+        registration_node = my_registrations_page.get_node_id_by_title(
+            'Registration With Files for A11y Testing'
+        )
+        registration_file_list_page = RegistrationFileListPage(
+            driver, guid=registration_node
+        )
+        registration_file_list_page.goto()
+        assert RegistrationFileListPage(driver, verify=True)
+        # Click the 'Archive of OSF Storage' button to expand the list of files
+        registration_file_list_page.file_list_button.click()
+        # Wait for file list items to load on page
+        WebDriverWait(driver, 5).until(
+            EC.presence_of_element_located(
+                (By.CSS_SELECTOR, '[data-test-file-list-item]')
+            )
+        )
+        a11y.run_axe(
+            driver,
+            session,
+            'regfilelist',
+            write_files=write_files,
+            exclude_best_practice=exclude_best_practice,
+        )
+
+    @markers.ember_page
+    def test_accessibility_file_detail_page(
+        self, driver, session, write_files, exclude_best_practice, my_registrations_page
+    ):
+        """This test is for checking the accessibility of the Registration File Detail
+        Page of a submitted registration.  First search through the registration cards
+        on the Submitted tab of the My Registration Page for the registration that has
+        files (searching by registration title).  When you find the desired registration
+        get the registration node id from its link and then use the node id to navigate
+        to the Files List page for this registration.  Then click the first file link
+        to open the File Detail page for that file.
+        """
+        registration_node = my_registrations_page.get_node_id_by_title(
+            'Registration With Files for A11y Testing'
+        )
+        registration_file_list_page = RegistrationFileListPage(
+            driver, guid=registration_node
+        )
+        registration_file_list_page.goto()
+        assert RegistrationFileListPage(driver, verify=True)
+        # Click the 'Archive of OSF Storage' button to expand the list of files
+        registration_file_list_page.file_list_button.click()
+        # Wait for file list items to load on page
+        WebDriverWait(driver, 5).until(
+            EC.presence_of_element_located(
+                (By.CSS_SELECTOR, '[data-test-file-list-item]')
+            )
+        )
+        # Click the first file from the list to open the File Detail page in a new tab
+        registration_file_list_page.scroll_into_view(
+            registration_file_list_page.first_file_link.element
+        )
+        registration_file_list_page.first_file_link.click()
+        # Wait for the new tab to open - window count should then = 2
+        WebDriverWait(driver, 5).until(EC.number_of_windows_to_be(2))
+        # Switch focus to the new tab
+        driver.switch_to.window(driver.window_handles[1])
+        assert RegistrationFileDetailPage(driver)
+        # Wait for File Renderer to load
+        WebDriverWait(driver, 5).until(
+            EC.visibility_of_element_located((By.CSS_SELECTOR, 'iframe'))
+        )
+        a11y.run_axe(
+            driver,
+            session,
+            'regfiledet',
+            write_files=write_files,
+            exclude_best_practice=exclude_best_practice,
+        )
+
+
 # User with registrations is not setup in production
 @markers.dont_run_on_prod
 class TestDraftRegistrationPages:

utils.py

@@ -63,6 +63,7 @@ def launch_driver(driver_name=settings.DRIVER, desired_capabilities=None):
         driver = driver_cls(chrome_options=chrome_options)
     elif driver_name == 'Firefox' and not settings.HEADLESS:
         from selenium.webdriver import FirefoxProfile
+        from selenium.webdriver.firefox.options import Options
 
         ffp = FirefoxProfile()
         # Set the default download location [0=Desktop, 1=Downloads, 2=Specified location]
@@ -74,7 +75,12 @@ def launch_driver(driver_name=settings.DRIVER, desired_capabilities=None):
             'text/plain, application/octet-stream, application/binary, text/csv, application/csv, '
             'application/excel, text/comma-separated-values, text/xml, application/xml',
         )
-        driver = driver_cls(firefox_profile=ffp)
+        # Force Firefox to open links in new tab instead of new browser window. Have to
+        # use Options instead of Firefox Profile because the profile preference doesn't
+        # work.
+        ffo = Options()
+        ffo.set_preference('browser.link.open_newwindow', 3)
+        driver = driver_cls(firefox_profile=ffp, options=ffo)
     elif driver_name == 'Edge' and not settings.HEADLESS:
         from msedge.selenium_tools import Edge