Function poll_assert_event_order

tests/integration/utils.py:114–138

Poll until the actual event order matches the expected event order, accounting for sets in the expected order. Args: driver: WebDriver instance. exp_event_order: the expected events recorded in the State, where some entries may be sets of events that can occur in any order.

(
    driver: WebDriver,
    exp_event_order: Sequence[str | set[str]],
    xpath: str = '//*[@id="event_order"]/p',
)

def poll_assert_event_order(
    driver: WebDriver,
    exp_event_order: Sequence[str | set[str]],
    xpath: str = '//*[@id="event_order"]/p',
) -> None:
    """Poll until the actual event order matches the expected event order, accounting for sets in the expected order.

    Args:
        driver: WebDriver instance.
        exp_event_order: the expected events recorded in the State, where some entries may be sets of events that can occur in any order.
        xpath: The XPath to the event order elements.

    Raises:
        AssertionError: if the actual event order does not match the expected event order after polling.
    """
    n_exp_events = n_expected_events(exp_event_order)

    def _has_number_of_expected_events():
        event_elements = driver.find_elements(By.XPATH, xpath)
        return len(event_elements) == n_exp_events

    AppHarness._poll_for(_has_number_of_expected_events)

    event_elements = driver.find_elements(By.XPATH, xpath)
    assert_event_order([elem.text for elem in event_elements], exp_event_order)


# Type alias for an ordering rule: ((event_a, occurrence_a), (event_b, occurrence_b)).