Add download button and link kitchen sink tests

Introduces comprehensive kitchen sink apps and Playwright tests for both download_button and download_link Shiny components.

Author: karangattu

shiny/playwright/controller/_file.py

@@ -1,11 +1,13 @@
 from __future__ import annotations
 
 from playwright.sync_api import Page
+from playwright.sync_api import expect as playwright_expect
 
-from ._base import InputActionBase, WidthLocM
+from .._types import PatternOrStr, Timeout
+from ._base import InputActionBase, WidthLocStlyeM
 
 
-class _DownloadMixin(WidthLocM, InputActionBase):
+class _DownloadMixin(WidthLocStlyeM, InputActionBase):
     """Mixin for download controls."""
 
     def __init__(self, page: Page, id: str, *, loc_suffix: str) -> None:
@@ -15,6 +17,16 @@ def __init__(self, page: Page, id: str, *, loc_suffix: str) -> None:
             loc=f"#{id}.shiny-download-link{loc_suffix}",
         )
 
+    def expect_label(
+        self,
+        value: PatternOrStr,
+        *,
+        timeout: Timeout = None,
+    ) -> None:
+        """Expect the anchor itself to contain the provided label text."""
+
+        playwright_expect(self.loc).to_have_text(value, timeout=timeout)
+
 
 class DownloadLink(_DownloadMixin):
     """

tests/playwright/shiny/components/download_button/app.py

@@ -0,0 +1,64 @@
+from __future__ import annotations
+
+import faicons
+
+from shiny import App, Inputs, Outputs, Session, reactive, render, ui
+
+app_ui = ui.page_fluid(
+    ui.h2("Download button kitchen sink"),
+    ui.layout_columns(
+        ui.card(
+            ui.h6("Click the button below to increment the counter"),
+            ui.input_action_button("increment", "Add to counter", class_="mb-2"),
+        ),
+        ui.card(
+            ui.h4("Buttons"),
+            ui.download_button(
+                "plain_csv",
+                "Plain CSV",
+            ),
+            ui.download_button(
+                "styled_csv",
+                "Styled CSV",
+                icon=faicons.icon_svg("file-csv"),
+                width="560px",
+            ),
+        ),
+    ),
+)
+
+
+def server(input: Inputs, output: Outputs, session: Session) -> None:
+    inventory_total = 0
+    plain_total = 0
+    styled_total = 0
+
+    @reactive.effect
+    @reactive.event(input.increment)
+    def _() -> None:
+        nonlocal inventory_total
+        inventory_total += 1
+
+    @render.download(filename=lambda: f"plain-{plain_total + 1}.csv")
+    async def plain_csv():
+        nonlocal plain_total
+        plain_total += 1
+        current_plain = plain_total
+        current_inventory = inventory_total
+        yield "kind,inventory,count\n"
+        yield f"plain,{current_inventory},{current_plain}\n"
+
+    @render.download(
+        filename=lambda: f"styled-{inventory_total}-{styled_total + 1}.csv"
+    )
+    async def styled_csv():
+        nonlocal styled_total
+        styled_total += 1
+        current_styled = styled_total
+        current_inventory = inventory_total
+        yield "metric,value\n"
+        yield f"inventory,{current_inventory}\n"
+        yield f"download_number,{current_styled}\n"
+
+
+app = App(app_ui, server)

tests/playwright/shiny/components/download_button/test_download_button_kitchensink.py

@@ -0,0 +1,50 @@
+from __future__ import annotations
+
+from pathlib import Path
+
+from playwright.sync_api import Page
+
+from shiny.playwright import controller
+from shiny.run import ShinyAppProc
+
+
+def test_download_button_kitchensink(page: Page, local_app: ShinyAppProc) -> None:
+    page.goto(local_app.url)
+
+    increment = controller.InputActionButton(page, "increment")
+    plain_button = controller.DownloadButton(page, "plain_csv")
+    styled_button = controller.DownloadButton(page, "styled_csv")
+    plain_button.expect_label("Plain CSV")
+    styled_button.expect_label("Styled CSV")
+    styled_button.expect_width("560px")
+
+    with page.expect_download() as plain_info:
+        plain_button.click()
+    plain_download = plain_info.value
+    plain_path_str = plain_download.path()
+    assert plain_download.suggested_filename == "plain-1.csv"
+    assert plain_path_str is not None
+    assert Path(plain_path_str).read_text() == "kind,inventory,count\nplain,0,1\n"
+
+    increment.click()
+
+    with page.expect_download() as styled_info:
+        styled_button.click()
+    styled_download = styled_info.value
+    styled_path_str = styled_download.path()
+    assert styled_path_str is not None
+    assert styled_download.suggested_filename == "styled-1-1.csv"
+    assert (
+        Path(styled_path_str).read_text()
+        == "metric,value\ninventory,1\ndownload_number,1\n"
+    )
+
+    increment.click()
+
+    with page.expect_download() as plain_info_2:
+        plain_button.click()
+    plain_download_2 = plain_info_2.value
+    plain_path_str_2 = plain_download_2.path()
+    assert plain_path_str_2 is not None
+    assert plain_download_2.suggested_filename == "plain-2.csv"
+    assert Path(plain_path_str_2).read_text() == "kind,inventory,count\nplain,2,2\n"

tests/playwright/shiny/components/download_link/app.py

@@ -0,0 +1,99 @@
+from __future__ import annotations
+
+import faicons
+
+from shiny import App, Inputs, Outputs, Session, reactive, render, ui
+
+
+def _title(text: str) -> ui.Tag:
+    return ui.tags.h4(text, class_="mb-3")
+
+
+def _action_label(text: str) -> ui.Tag:
+    return ui.tags.span(text, class_="action-label")
+
+
+def _action_icon(text: str) -> ui.Tag:
+    return ui.tags.span(text, class_="action-icon")
+
+
+app_ui = ui.page_fluid(
+    ui.h2("Download link kitchen sink"),
+    ui.layout_columns(
+        ui.card(
+            _title("Controls"),
+            ui.input_text("prefix", "Filename prefix", value="report"),
+            ui.input_checkbox("include_summary", "Include summary footer", value=True),
+        ),
+        ui.card(
+            _title("Links"),
+            ui.download_link(
+                "plain_link",
+                _action_label("Plain report"),
+            ),
+            ui.download_link(
+                "styled_link",
+                "Styled report",
+                icon=faicons.icon_svg("file-arrow-down"),
+                width="560px",
+            ),
+        ),
+    ),
+)
+
+
+def server(input: Inputs, output: Outputs, session: Session) -> None:
+    plain_total = 0
+    styled_total = 0
+    current_prefix = "report"
+    summary_enabled = True
+
+    @reactive.calc
+    def prefix_value() -> str:
+        value = input.prefix()
+        return value.strip() or "report"
+
+    @reactive.calc
+    def include_summary() -> bool:
+        return bool(input.include_summary())
+
+    def sync_controls() -> None:
+        nonlocal current_prefix, summary_enabled
+        with reactive.isolate():
+            current_prefix = prefix_value()
+            summary_enabled = include_summary()
+
+    sync_controls()
+
+    @reactive.effect
+    def _() -> None:
+        prefix_value()
+        include_summary()
+        sync_controls()
+
+    @render.download(filename=lambda: f"{current_prefix}-plain.txt")
+    async def plain_link():
+        nonlocal plain_total
+        plain_total += 1
+        current_count = plain_total
+        prefix = current_prefix
+        include_footer = summary_enabled
+        yield f"{prefix} plain download #{current_count}\n"
+        if include_footer:
+            yield "Summary: plain link\n"
+
+    @render.download(filename=lambda: f"{current_prefix}-styled.csv")
+    async def styled_link():
+        nonlocal styled_total
+        styled_total += 1
+        current_count = styled_total
+        prefix = current_prefix
+        include_footer = summary_enabled
+        yield "metric,value\n"
+        yield f"prefix,{prefix}\n"
+        yield f"download_count,{current_count}\n"
+        if include_footer:
+            yield "footer,enabled\n"
+
+
+app = App(app_ui, server)

tests/playwright/shiny/components/download_link/test_download_link_kitchensink.py

@@ -0,0 +1,58 @@
+from __future__ import annotations
+
+from pathlib import Path
+
+from playwright.sync_api import Page
+
+from shiny.playwright import controller
+from shiny.run import ShinyAppProc
+
+
+def test_download_link_kitchensink(page: Page, local_app: ShinyAppProc) -> None:
+    page.goto(local_app.url)
+
+    prefix_input = controller.InputText(page, "prefix")
+    summary_toggle = controller.InputCheckbox(page, "include_summary")
+    plain_link = controller.DownloadLink(page, "plain_link")
+    styled_link = controller.DownloadLink(page, "styled_link")
+
+    plain_link.expect_label("Plain report")
+    styled_link.expect_label("Styled report")
+    styled_link.expect_width("560px")
+
+    with page.expect_download() as plain_info:
+        plain_link.click()
+    plain_download = plain_info.value
+    plain_path_str = plain_download.path()
+    assert plain_path_str is not None
+    assert plain_download.suggested_filename == "report-plain.txt"
+    plain_content = Path(plain_path_str).read_text()
+    assert "report plain download #1" in plain_content
+    assert "Summary: plain link" in plain_content
+
+    prefix_input.set("custom")
+    summary_toggle.set(False)
+
+    with page.expect_download() as styled_info:
+        styled_link.click()
+    styled_download = styled_info.value
+    styled_path_str = styled_download.path()
+    assert styled_path_str is not None
+    assert styled_download.suggested_filename == "custom-styled.csv"
+    styled_content = Path(styled_path_str).read_text()
+    assert "metric,value" in styled_content
+    assert "prefix,custom" in styled_content
+    assert "download_count,1" in styled_content
+    assert "footer,enabled" not in styled_content
+
+    summary_toggle.set(True)
+
+    with page.expect_download() as plain_info_2:
+        plain_link.click()
+    plain_download_2 = plain_info_2.value
+    plain_path_str_2 = plain_download_2.path()
+    assert plain_path_str_2 is not None
+    assert plain_download_2.suggested_filename == "custom-plain.txt"
+    plain_content_2 = Path(plain_path_str_2).read_text()
+    assert "custom plain download #2" in plain_content_2
+    assert "Summary: plain link" in plain_content_2