Refactor institutions login test

Author: jh27539

pages/login.py

@@ -102,10 +102,16 @@ class GenericInstitutionEmailLoginPage(BasePage):
 class GenericInstitutionUsernameLoginPage(BasePage):
  # This is for institution login pages that first ask for a Username or User ID to
  # initiate the login process before asking for a password. The page has a form
- # element and a usenrname or user id text input box.
+ # element and a username or user id text input box.
  identity = Locator(By.CSS_SELECTOR, 'form[method="post"]')
 
 
+class GenericInstitutionIDLoginPage(BasePage):
+ # This is for institution login pages that first ask for a User ID to
+ # initiate the login process before asking for a password.
+ identity = Locator(By.CSS_SELECTOR, 'input[autocomplete="username"]')
+
+
 class ForgotPasswordPage(BasePage):
  url = settings.OSF_HOME + '/forgotpassword/'
 

tests/test_login.py

@@ -15,6 +15,7 @@
  ForgotPasswordPage,
  GenericCASPage,
  GenericInstitutionEmailLoginPage,
+ GenericInstitutionIDLoginPage,
  GenericInstitutionLoginPage,
  GenericInstitutionUsernameLoginPage,
  InstitutionalLoginPage,
@@ -330,6 +331,17 @@ def test_account_disabled_page(self, driver):
  assert exception_page.status_message.text == 'Account disabled'
 
 
+def try_login_page(driver, page_class):
+ """
+ Helper function to try and verify a login page.
+ Returns True if successful, otherwise False.
+ """
+ try:
+ return page_class(driver, verify=True)
+ except (PageException, NoSuchElementException):
+ return False
+
+
 @markers.smoke_test
 @markers.core_functionality
 class TestInstitutionLoginPage:
@@ -415,40 +427,50 @@ def test_individual_institution_login_pages(
  not have working testing environments.
  """
  failed_list = []
+
  for institution in institution_list:
- if institution != '-- select an institution --':
- institution_select = Select(institution_login_page.institution_dropdown)
- institution_select.select_by_visible_text(institution)
- institution_login_page.sign_in_button.click()
+ # This value represents a placeholder or default option in the dropdown list,
+ # which isn't a valid institution for testing. Avoid wrapping the rest of the loop's logic
+ # in an additional if statement by using an early continue
+ if institution == '-- select an institution --':
+ continue
+
+ # Select institution and click sign in
+ Select(institution_login_page.institution_dropdown).select_by_visible_text(
+ institution
+ )
+ institution_login_page.sign_in_button.click()
+
+ try:
+ # Verify that we get to a valid login page by checking for a
+ # password input field
+ assert GenericInstitutionLoginPage(driver, verify=True)
+ except PageException:
  try:
- # Verify that we get to a valid login page by checking for a
- # password input field
- assert GenericInstitutionLoginPage(driver, verify=True)
- except PageException:
- try:
- # For a small number of institutions the initial login page
- # first asks for just an email without the passord field.
- assert GenericInstitutionEmailLoginPage(driver, verify=True)
- except PageException:
- try:
+ # Try different login page verifications
+ if not any(
+ [
+ # For a small number of institutions the initial login page
+ # first asks for just an email without the password field.
+ try_login_page(driver, GenericInstitutionEmailLoginPage),
  # A few institutions use a login page with a generic username
- # or user id text input field. The page definition checks for
- # a form element with methdo="post". Then check that the page
- # also has an input box.
- assert GenericInstitutionUsernameLoginPage(
-  driver, verify=True
-  )
-  driver.find_element(By.CSS_SELECTOR, 'input[type="text"]')
-  except (PageException, NoSuchElementException):
-  # if there is a failure add the name of the institution to the
- # failed list
-  failed_list.append(institution)
-  # Need to go back to the original OSF Institution Login page
- institution_login_page.goto()
- # If there are any failed institutions then fail the test and print the list
- assert len(failed_list) == 0, 'The following Institutions Failed: ' + str(
- failed_list
- )
+ # or user id text input field.
+ try_login_page(driver, GenericInstitutionUsernameLoginPage),
+ # Chicago University has autocomplete="username"
+ try_login_page(driver, GenericInstitutionIDLoginPage),
+ ]
+ ):
+ failed_list.append(institution)
+ except Exception as e:
+ failed_list.append(institution)
+
+ # Return to the original OSF Institution Login page
+ institution_login_page.goto()
+
+ # Fail the test if there are any failed institutions and print the list
+ assert (
+ len(failed_list) == 0
+ ), f'The following Institutions Failed: {failed_list}'
 
 
 @markers.dont_run_on_prod