e2e_playwright/st_pydeck_chart_test.py - develop - vshmidt/streamlit

e2e_playwright/st_pydeck_chart_test.py
222 строки8 KB
Bob Nisco
[fix] Assert Snapshot pixel_threshold must be meaningful (#13896)
11 фев 2026, 02:10
11 фев 2026, 02:10d55cd7d
# 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 pytest
from playwright.sync_api import Locator, Page, expect

from e2e_playwright.conftest import ImageCompareFunction, wait_for_app_run
from e2e_playwright.shared.app_utils import (
    check_top_level_class,
    select_selectbox_option,
)
from e2e_playwright.shared.toolbar_utils import (
    assert_fullscreen_toolbar_button_interactions,
)

PIXEL_THRESHOLD = 0.1


def test_check_top_level_class(app: Page):
    """Check that the top level class is correctly set."""
    # The pydeck chart takes a while to load so check that
    # it gets attached with an increased timeout.
    pydeck_charts = app.get_by_test_id("stDeckGlJsonChart")
    expect(pydeck_charts.first).to_be_attached(timeout=15000)

    check_top_level_class(app, "stDeckGlJsonChart")


# Pydeck snapshots behavior is inconsistent for non-Chromium browsers in CI.
@pytest.mark.only_browser("chromium")
def test_st_pydeck_clicking_on_fullscreen_toolbar_button(
    themed_app: Page, assert_snapshot: ImageCompareFunction
):
    """Test that clicking on fullscreen toolbar button expands the map into fullscreen."""

    # wait for mapbox to load
    wait_for_app_run(themed_app, 15000)

    assert_fullscreen_toolbar_button_interactions(
        themed_app,
        assert_snapshot=assert_snapshot,
        widget_test_id="stDeckGlJsonChart",
        filename_prefix="st_pydeck_chart",
        # The pydeck tests are a lot flakier than need be so increase the pixel threshold
        pixel_threshold=PIXEL_THRESHOLD,
    )


# Pydeck snapshots behavior is inconsistent for non-Chromium browsers in CI.
@pytest.mark.only_browser("chromium")
def test_empty_chart(themed_app: Page, assert_snapshot: ImageCompareFunction) -> None:
    pydeck_charts = select_subtest(themed_app, "empty_chart_subtest")

    # The pydeck tests are a lot flakier than need be so increase the pixel threshold
    assert_snapshot(
        pydeck_charts.nth(0),
        name="st_pydeck_chart-empty",
        pixel_threshold=PIXEL_THRESHOLD,
    )


# Pydeck snapshots behavior is inconsistent for non-Chromium browsers in CI.
@pytest.mark.only_browser("chromium")
def test_basic_chart(themed_app: Page, assert_snapshot: ImageCompareFunction) -> None:
    pydeck_charts = select_subtest(themed_app, "basic_chart_subtest")

    # The pydeck tests are a lot flakier than need be so increase the pixel threshold
    assert_snapshot(
        pydeck_charts.nth(0).locator("canvas").nth(0),
        name="st_pydeck_chart-san_francisco_overridden_light_theme",
        pixel_threshold=PIXEL_THRESHOLD,
    )


# Pydeck snapshots behavior is inconsistent for non-Chromium browsers in CI.
@pytest.mark.only_browser("chromium")
def test_invalid_prop(themed_app: Page, assert_snapshot: ImageCompareFunction) -> None:
    pydeck_charts = select_subtest(themed_app, "invalid_prop_subtest")

    # The pydeck tests are a lot flakier than need be so increase the pixel threshold
    assert_snapshot(
        pydeck_charts.nth(0).locator("canvas").nth(1),
        name="st_pydeck_chart-invalid_prop",
        pixel_threshold=PIXEL_THRESHOLD,
    )


# Pydeck snapshots behavior is inconsistent for non-Chromium browsers in CI.
@pytest.mark.only_browser("chromium")
def test_map_styles(themed_app: Page, assert_snapshot: ImageCompareFunction) -> None:
    pydeck_charts = select_subtest(themed_app, "map_styles_subtest")

    # The pydeck tests are a lot flakier than need be so increase the pixel threshold
    assert_snapshot(
        pydeck_charts.nth(0).locator("canvas").nth(1),
        name="st_pydeck_chart-style",
        pixel_threshold=PIXEL_THRESHOLD,
    )


# Pydeck snapshots behavior is inconsistent for non-Chromium browsers in CI.
@pytest.mark.only_browser("chromium")
def test_light_style(themed_app: Page, assert_snapshot: ImageCompareFunction) -> None:
    pydeck_charts = select_subtest(themed_app, "light_style_subtest")

    # The pydeck tests are a lot flakier than need be so increase the pixel threshold
    assert_snapshot(
        pydeck_charts.nth(0),
        name="st_pydeck_chart-light",
        pixel_threshold=PIXEL_THRESHOLD,
    )


# Pydeck snapshots behavior is inconsistent for non-Chromium browsers in CI.
@pytest.mark.only_browser("chromium")
def test_dark_style(themed_app: Page, assert_snapshot: ImageCompareFunction) -> None:
    pydeck_charts = select_subtest(themed_app, "dark_style_subtest")

    # The pydeck tests are a lot flakier than need be so increase the pixel threshold
    assert_snapshot(
        pydeck_charts.nth(0).locator("canvas").nth(0),
        name="st_pydeck_chart-dark",
        pixel_threshold=PIXEL_THRESHOLD,
    )


# Pydeck snapshots behavior is inconsistent for non-Chromium browsers in CI.
@pytest.mark.only_browser("chromium")
def test_mapbox(themed_app: Page, assert_snapshot: ImageCompareFunction) -> None:
    pydeck_charts = select_subtest(themed_app, "mapbox_subtest")

    # The pydeck tests are a lot flakier than need be so increase the pixel threshold
    assert_snapshot(
        pydeck_charts.nth(0).locator("canvas").nth(0),
        name="st_pydeck_chart-mapbox_provider",
        pixel_threshold=PIXEL_THRESHOLD,
    )


# Pydeck snapshots behavior is inconsistent for non-Chromium browsers in CI.
@pytest.mark.only_browser("chromium")
def test_width_parameter(app: Page, assert_snapshot: ImageCompareFunction) -> None:
    """Tests that width parameter works correctly."""
    pydeck_charts = select_subtest(app, "width_parameter_subtest")

    expect(pydeck_charts).to_have_count(2, timeout=15000)

    assert_snapshot(
        pydeck_charts.nth(0),
        name="st_pydeck_chart-width_stretch",
        pixel_threshold=PIXEL_THRESHOLD,
    )
    assert_snapshot(
        pydeck_charts.nth(1),
        name="st_pydeck_chart-width_200_height_250",
        pixel_threshold=PIXEL_THRESHOLD,
    )


# Pydeck snapshots behavior is inconsistent for non-Chromium browsers in CI.
@pytest.mark.only_browser("chromium")
def test_height_parameter(app: Page, assert_snapshot: ImageCompareFunction) -> None:
    """Tests that height parameter works correctly."""
    pydeck_charts = select_subtest(app, "height_parameter_subtest")

    expect(pydeck_charts).to_have_count(4, timeout=15000)

    # Test different height values with snapshots
    assert_snapshot(
        pydeck_charts.nth(0),
        name="st_pydeck_chart-height_default",
        pixel_threshold=PIXEL_THRESHOLD,
    )

    assert_snapshot(
        pydeck_charts.nth(1),
        name="st_pydeck_chart-height_stretch_outside_container",
        pixel_threshold=PIXEL_THRESHOLD,
    )

    # For height="stretch", snapshot the entire container to verify stretching
    from e2e_playwright.shared.app_utils import get_element_by_key

    stretch_container = get_element_by_key(app, "test_height_stretch")
    assert_snapshot(
        stretch_container,
        name="st_pydeck_chart-height_stretch",
        pixel_threshold=PIXEL_THRESHOLD,
    )

    assert_snapshot(
        pydeck_charts.nth(3),
        name="st_pydeck_chart-height_50px",
        pixel_threshold=PIXEL_THRESHOLD,
    )


def select_subtest(app: Page, name: str) -> Locator:
    # Select the text in the UI:
    select_selectbox_option(app, "Test to run", name)

    # The pydeck chart takes a while to load so check that
    # at least one gets attached with an increased timeout.
    pydeck_charts = app.get_by_test_id("stDeckGlJsonChart")
    expect(pydeck_charts.first).to_be_attached(timeout=15000)

    # The map assets can take more time to load, add an extra timeout
    # to prevent flakiness.
    app.wait_for_timeout(10000)

    return pydeck_charts