e2e_playwright/st_link_button_test.py - develop - vshmidt/streamlit

e2e_playwright/st_link_button_test.py
112 строк5 KB
Ken McGrady
Update copyright header to 2026 (#13491)
02 янв 2026, 16:21
02 янв 2026, 16:21374540a
# Copyright (c) Streamlit Inc. (2018-2022) Snowflake Inc. (2022-2026)
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.


import re

import pytest
from playwright.sync_api import Page, expect

from e2e_playwright.conftest import ImageCompareFunction
from e2e_playwright.shared.app_utils import check_top_level_class, get_expander

LINK_BUTTON_ELEMENTS = 17


def test_link_button_display(themed_app: Page, assert_snapshot: ImageCompareFunction):
    """Test that st.link_button renders correctly."""
    link_elements = themed_app.get_by_test_id("stLinkButton")
    expect(link_elements).to_have_count(LINK_BUTTON_ELEMENTS)

    assert_snapshot(link_elements.nth(0), name="st_link_button-default")
    assert_snapshot(link_elements.nth(1), name="st_link_button-disabled")
    assert_snapshot(link_elements.nth(2), name="st_link_button-primary")
    assert_snapshot(link_elements.nth(3), name="st_link_button-primary_disabled")
    assert_snapshot(link_elements.nth(4), name="st_link_button-container_width")
    assert_snapshot(link_elements.nth(5), name="st_link_button-primary_container_width")
    assert_snapshot(link_elements.nth(6), name="st_link_button-emoji_icon")
    assert_snapshot(link_elements.nth(7), name="st_link_button-material_icon")
    assert_snapshot(link_elements.nth(8), name="st_link_button-tertiary")
    assert_snapshot(link_elements.nth(9), name="st_link_button-tertiary_disabled")
    assert_snapshot(
        link_elements.nth(10), name="st_link_button-tertiary_container_width"
    )
    assert_snapshot(link_elements.nth(11), name="st_link_button-help")
    assert_snapshot(link_elements.nth(12), name="st_link_button-shortcut")
    assert_snapshot(
        link_elements.filter(has_text="Icon Right").first,
        name="st_link_button-icon_position_right_material",
    )


def test_link_button_hover(themed_app: Page, assert_snapshot: ImageCompareFunction):
    link_elements = themed_app.get_by_test_id("stLinkButton")
    expect(link_elements).to_have_count(LINK_BUTTON_ELEMENTS)

    default_link_button = themed_app.get_by_test_id("stLinkButton").nth(0)
    themed_app.get_by_text("Default Link").hover()
    assert_snapshot(default_link_button, name="st_link_button-default_hover")

    primary_link_button = themed_app.get_by_test_id("stLinkButton").nth(2)
    themed_app.get_by_text("Primary Link").hover()
    assert_snapshot(primary_link_button, name="st_link_button-primary_hover")

    tertiary_link_button = themed_app.get_by_test_id("stLinkButton").nth(8)
    themed_app.get_by_text("Tertiary link button").hover()
    assert_snapshot(tertiary_link_button, name="st_link_button-tertiary_hover")


def test_check_top_level_class(app: Page):
    """Check that the top level class is correctly set."""
    check_top_level_class(app, "stLinkButton")


def test_link_button_width_examples(app: Page, assert_snapshot: ImageCompareFunction):
    """Test link button width examples via screenshot matching."""
    link_expander = get_expander(app, "Link Button Width Examples")

    link_elements = link_expander.get_by_test_id("stLinkButton")

    assert_snapshot(link_elements.nth(0), name="st_link_button-width_content")
    assert_snapshot(link_elements.nth(1), name="st_link_button-width_stretch")
    assert_snapshot(link_elements.nth(2), name="st_link_button-width_400px")


@pytest.mark.only_browser(
    "webkit"  # Firefox and Chromium are a bit flaky on the expect_popup.
)
def test_link_button_shortcut_triggers(app: Page):
    """Ensure pressing the shortcut opens the link in a new tab."""
    shortcut_button = (
        app.get_by_test_id("stLinkButton")
        .filter(has_text="Link Button with shortcut")
        .first
    )
    expect(shortcut_button).to_be_visible()
    # Ensure shortcut labels are rendered for link buttons:
    expect(shortcut_button.locator("kbd")).to_have_text(
        re.compile(r"(Ctrl|⌘) \+ (Alt|Option|⌥) \+ Z")
    )
    expect(shortcut_button).to_be_enabled()
    shortcut_button.scroll_into_view_if_needed()
    # This test seems a bit flaky without a timeout:
    app.wait_for_timeout(3000)

    # Press hotkey to trigger the button:
    with app.expect_popup() as popup_info:
        app.keyboard.press("ControlOrMeta+Alt+KeyZ")

    popup = popup_info.value
    expect(popup).to_have_url(re.compile(r"https://streamlit\.io/?"))
    popup.close()