mirror of
https://github.com/GSA/notifications-admin.git
synced 2026-07-25 10:29:14 -04:00
e71351d949
This changeset adds additional documentation for how to write new E2E tests and cleans up the two existing tests slightly to make better use of the fixtures that are defined. Signed-off-by: Carlo Costino <carlo.costino@gsa.gov>
119 lines
3.8 KiB
Python
119 lines
3.8 KiB
Python
import os
|
|
import re
|
|
|
|
import pytest
|
|
|
|
E2E_TEST_URI = os.getenv("NOTIFY_E2E_TEST_URI")
|
|
|
|
|
|
def login_for_end_to_end_testing(browser):
|
|
# Open a new page and go to the staging site.
|
|
context = browser.new_context()
|
|
page = context.new_page()
|
|
page.goto(f"{E2E_TEST_URI}/")
|
|
|
|
sign_in_button = page.get_by_role("link", name="Sign in")
|
|
|
|
# Test trying to sign in.
|
|
sign_in_button.click()
|
|
|
|
# Wait for the next page to fully load.
|
|
page.wait_for_load_state("domcontentloaded")
|
|
|
|
# Check for the sign in form elements.
|
|
# NOTE: Playwright cannot find input elements by role and recommends using
|
|
# get_by_label() instead; however, hidden form elements do not have
|
|
# labels associated with them, hence the XPath!
|
|
# See https://playwright.dev/python/docs/api/class-page#page-get-by-label
|
|
# and https://playwright.dev/python/docs/locators#locate-by-css-or-xpath
|
|
# for more information.
|
|
email_address_input = page.get_by_label("Email address")
|
|
password_input = page.get_by_label("Password")
|
|
continue_button = page.get_by_role("button", name=re.compile("Continue"))
|
|
|
|
# Sign in to the site.
|
|
email_address_input.fill(os.getenv("NOTIFY_E2E_TEST_EMAIL"))
|
|
password_input.fill(os.getenv("NOTIFY_E2E_TEST_PASSWORD"))
|
|
continue_button.click()
|
|
|
|
# Wait for the next page to fully load.
|
|
page.wait_for_load_state("domcontentloaded")
|
|
|
|
# Check for the sign in form elements.
|
|
# NOTE: Playwright cannot find input elements by role and recommends using
|
|
# get_by_label() instead; however, hidden form elements do not have
|
|
# labels associated with them, hence the XPath!
|
|
# See https://playwright.dev/python/docs/api/class-page#page-get-by-label
|
|
# and https://playwright.dev/python/docs/locators#locate-by-css-or-xpath
|
|
# for more information.
|
|
# mfa_input = page.get_by_label('Text message code')
|
|
# continue_button = page.get_by_role('button', name=re.compile('Continue'))
|
|
|
|
# # Enter MFA code and continue.
|
|
# TODO: Revisit this at a later point in time.
|
|
# totp = pyotp.TOTP(
|
|
# os.getenv('MFA_TOTP_SECRET'),
|
|
# digits=int(os.getenv('MFA_TOTP_LENGTH'))
|
|
# )
|
|
|
|
# mfa_input.fill(totp.now())
|
|
# continue_button.click()
|
|
|
|
# page.wait_for_load_state('domcontentloaded')
|
|
|
|
# Save storage state into the file.
|
|
auth_state_path = os.path.join(
|
|
os.getenv("NOTIFY_E2E_AUTH_STATE_PATH"), "state.json"
|
|
)
|
|
context.storage_state(path=auth_state_path)
|
|
|
|
|
|
@pytest.fixture(scope="session")
|
|
def end_to_end_context(browser):
|
|
context = browser.new_context()
|
|
return context
|
|
|
|
|
|
@pytest.fixture(scope="session")
|
|
def end_to_end_authenticated_context(browser):
|
|
# Create and load a previously authenticated context for Playwright E2E
|
|
# tests.
|
|
# login_for_end_to_end_testing(browser)
|
|
|
|
auth_state_path = os.path.join(
|
|
os.getenv("NOTIFY_E2E_AUTH_STATE_PATH"), "state.json"
|
|
)
|
|
context = browser.new_context(storage_state=auth_state_path)
|
|
|
|
return context
|
|
|
|
|
|
@pytest.fixture(scope="session")
|
|
def unauthenticated_page(end_to_end_context):
|
|
page = end_to_end_context.new_page()
|
|
page.goto(f"{E2E_TEST_URI}/")
|
|
|
|
# Wait for the next page to fully load.
|
|
page.wait_for_load_state("domcontentloaded")
|
|
|
|
return page
|
|
|
|
|
|
@pytest.fixture(scope="session")
|
|
def authenticated_page(end_to_end_context):
|
|
# Open a new page and go to the site.
|
|
page = end_to_end_context.new_page()
|
|
page.goto(f"{E2E_TEST_URI}/")
|
|
|
|
# Wait for the next page to fully load.
|
|
page.wait_for_load_state("domcontentloaded")
|
|
|
|
# Sign in to the site - E2E test accounts are set to flow through.
|
|
sign_in_button = page.get_by_role("link", name="Sign in")
|
|
sign_in_button.click()
|
|
|
|
# Wait for the next page to fully load.
|
|
page.wait_for_load_state("domcontentloaded")
|
|
|
|
return page
|