First pass at Playwright testing

Author: cpsievert

shiny/playwright/controller/__init__.py

@@ -32,6 +32,7 @@
     InputDateRange,
     InputNumeric,
     InputPassword,
+    InputSubmitTextarea,
     InputText,
     InputTextArea,
 )
@@ -83,6 +84,7 @@
     "InputSelectize",
     "InputSlider",
     "InputSliderRange",
+    "InputSubmitTextarea",
     "InputSwitch",
     "InputTaskButton",
     "InputText",

shiny/playwright/controller/_input_fields.py

@@ -966,3 +966,110 @@ def expect_autoclose(
         # TODO-future; Composable expectations
         self.date_start.expect_autoclose(value, timeout=timeout)
         self.date_end.expect_autoclose(value, timeout=timeout)
+
+
+class InputSubmitTextarea(
+    _SetTextM,
+    WidthContainerStyleM,
+    _ExpectTextInputValueM,
+    _ExpectPlaceholderAttrM,
+    UiWithLabel,
+):
+    """Controller for :func:`shiny.ui.input_submit_textarea`."""
+
+    loc_button: Locator
+    """Playwright `Locator` for the submit button."""
+
+    def __init__(self, page: Page, id: str) -> None:
+        """
+        Initializes the input submit textarea.
+
+        Parameters
+        ----------
+        page
+            The page where the input submit textarea is located.
+        id
+            The id of the input submit textarea.
+        """
+        super().__init__(
+            page,
+            id=id,
+            loc=f"textarea#{id}.form-control",
+        )
+        self.loc_button = self.loc_container.locator(".bslib-submit-textarea-btn")
+
+    def set(self, value: str, *, submit: bool = False, timeout: Timeout = None) -> None:
+        """
+        Sets the text value in the textarea.
+
+        Parameters
+        ----------
+        value
+            The text to set.
+        submit
+            Whether to click the submit button after setting the text. Defaults to `False`.
+        timeout
+            The maximum time to wait for the text to be set. Defaults to `None`.
+        """
+        set_text(self.loc, value, timeout=timeout)
+        if submit:
+            self.loc_button.click(timeout=timeout)
+
+    def submit(self, *, timeout: Timeout = None) -> None:
+        """
+        Clicks the submit button.
+
+        Parameters
+        ----------
+        timeout
+            The maximum time to wait for the click. Defaults to `None`.
+        """
+        self.loc_button.click(timeout=timeout)
+
+    def expect_rows(self, value: AttrValue, *, timeout: Timeout = None) -> None:
+        """
+        Expect the `rows` attribute of the input submit textarea to have a specific value.
+
+        Parameters
+        ----------
+        value
+            The expected value of the `rows` attribute.
+        timeout
+            The maximum time to wait for the expectation to be fulfilled. Defaults to `None`.
+        """
+        _expect_attribute_to_have_value(self.loc, "rows", value=value, timeout=timeout)
+
+    def expect_data_needs_modifier(
+        self, value: bool, *, timeout: Timeout = None
+    ) -> None:
+        """
+        Expect the `data-needs-modifier` attribute to be present or absent.
+
+        Parameters
+        ----------
+        value
+            If `True`, expects the attribute to be present. If `False`, expects it to be absent.
+        timeout
+            The maximum time to wait for the expectation to be fulfilled. Defaults to `None`.
+        """
+        _expect_attribute_to_have_value(
+            self.loc,
+            "data-needs-modifier",
+            value="" if value else None,
+            timeout=timeout,
+        )
+
+    def expect_button_label(
+        self, value: PatternOrStr, *, timeout: Timeout = None
+    ) -> None:
+        """
+        Expect the submit button to have a specific label.
+
+        Parameters
+        ----------
+        value
+            The expected label text.
+        timeout
+            The maximum time to wait for the expectation to be fulfilled. Defaults to `None`.
+        """
+        playwright_expect(self.loc_button).to_contain_text(value, timeout=timeout)

tests/playwright/shiny/inputs/input_submit_textarea/app.py

@@ -0,0 +1,87 @@
+"""
+Test app for input_submit_textarea
+"""
+
+from shiny import App, Inputs, Outputs, Session, reactive, render, ui
+
+app_ui = ui.page_fluid(
+    ui.h3("Basic submit textarea"),
+    ui.input_submit_textarea(
+        "basic",
+        label="Enter text",
+        placeholder="Type something here...",
+        value="Initial value",
+        rows=3,
+        width="400px",
+    ),
+    ui.output_code("basic_value", placeholder=True),
+    ui.hr(),
+    ui.h3("Submit textarea with enter key (no modifier)"),
+    ui.input_submit_textarea(
+        "no_modifier",
+        label="Press Enter to submit",
+        placeholder="Press Enter to submit",
+        rows=2,
+        submit_key="enter",
+    ),
+    ui.output_code("no_modifier_value", placeholder=True),
+    ui.hr(),
+    ui.h3("Submit textarea with custom button"),
+    ui.input_submit_textarea(
+        "custom_button",
+        label="Custom button",
+        placeholder="Type and click submit",
+        button=ui.input_task_button("custom_submit", "Send", class_="btn-success"),
+        rows=1,
+    ),
+    ui.output_code("custom_button_value", placeholder=True),
+    ui.hr(),
+    ui.h3("Update controls"),
+    ui.input_action_button("update_value", "Set to 'Updated value'"),
+    ui.input_action_button("update_placeholder", "Update placeholder"),
+    ui.input_action_button("submit_programmatic", "Submit programmatically"),
+)
+
+
+def server(input: Inputs, output: Outputs, session: Session):
+
+    @render.text
+    def basic_value():
+        if "basic" in input:
+            return f"Submitted: {input.basic()}"
+        else:
+            return "No value submitted yet"
+
+    @render.text
+    def no_modifier_value():
+        if "no_modifier" in input:
+            return f"Submitted: {input.no_modifier()}"
+        else:
+            return "No value submitted yet"
+
+    @render.text
+    def custom_button_value():
+        if "custom_button" in input:
+            return f"Submitted: {input.custom_button()}"
+        else:
+            return "No value submitted yet"
+
+    @reactive.effect
+    @reactive.event(input.update_value)
+    def _():
+        ui.update_submit_textarea("basic", value="Updated value")
+
+    @reactive.effect
+    @reactive.event(input.update_placeholder)
+    def _():
+        ui.update_submit_textarea("basic", placeholder="New placeholder text")
+
+    @reactive.effect
+    @reactive.event(input.submit_programmatic)
+    def _():
+        ui.update_submit_textarea(
+            "basic", value="Programmatically submitted", submit=True
+        )
+
+
+app = App(app_ui, server)

tests/playwright/shiny/inputs/input_submit_textarea/test_input_submit_textarea.py

@@ -0,0 +1,134 @@
+from playwright.sync_api import Page
+
+from shiny.playwright import controller
+from shiny.run import ShinyAppProc
+
+
+def test_input_submit_textarea_initial_state(page: Page, local_app: ShinyAppProc):
+    page.goto(local_app.url)
+
+    basic = controller.InputSubmitTextarea(page, "basic")
+    basic.expect_label("Enter text")
+    basic.expect_placeholder("Type something here...")
+    basic.expect_value("Initial value")
+    basic.expect_rows("3")
+    basic.expect_width("400px")
+    basic.expect_data_needs_modifier(True)
+    basic.expect_button_label("Submit")
+
+    value_output = controller.OutputCode(page, "basic_value")
+    value_output.expect_value("No value submitted yet")
+
+
+def test_input_submit_textarea_submit_with_button(page: Page, local_app: ShinyAppProc):
+    page.goto(local_app.url)
+
+    basic = controller.InputSubmitTextarea(page, "basic")
+    value_output = controller.OutputCode(page, "basic_value")
+    value_output.expect_value("No value submitted yet")
+
+    basic.submit()
+    value_output.expect_value("Submitted: Initial value")
+
+    basic.set("New text content")
+    basic.expect_value("New text content")
+    value_output.expect_value("Submitted: Initial value")
+
+    basic.submit()
+    basic.expect_value("")
+    value_output.expect_value("Submitted: New text content")
+
+
+def test_input_submit_textarea_set_and_submit(page: Page, local_app: ShinyAppProc):
+    page.goto(local_app.url)
+
+    basic = controller.InputSubmitTextarea(page, "basic")
+    value_output = controller.OutputCode(page, "basic_value")
+
+    # Set and submit in one call
+    basic.set("One-step submission", submit=True)
+    basic.expect_value("")
+    value_output.expect_value("Submitted: One-step submission")
+
+
+def test_input_submit_textarea_no_modifier_key(page: Page, local_app: ShinyAppProc):
+    page.goto(local_app.url)
+
+    no_modifier = controller.InputSubmitTextarea(page, "no_modifier")
+    value_output = controller.OutputCode(page, "no_modifier_value")
+    no_modifier.expect_data_needs_modifier(False)
+
+    no_modifier.set("Enter key test")
+    no_modifier.submit()
+    value_output.expect_value("Submitted: Enter key test")
+
+
+def test_input_submit_textarea_custom_button(page: Page, local_app: ShinyAppProc):
+    page.goto(local_app.url)
+
+    custom = controller.InputSubmitTextarea(page, "custom_button")
+    value_output = controller.OutputCode(page, "custom_button_value")
+    custom.expect_button_label("Send")
+
+    custom.set("Custom button test", submit=True)
+    value_output.expect_value("Submitted: Custom button test")
+
+
+def test_input_submit_textarea_update_value(page: Page, local_app: ShinyAppProc):
+    """Test updating value from server"""
+    page.goto(local_app.url)
+
+    basic = controller.InputSubmitTextarea(page, "basic")
+    value_output = controller.OutputCode(page, "basic_value")
+    update_btn = controller.InputActionButton(page, "update_value")
+
+    update_btn.click()
+    basic.expect_value("Updated value")
+    value_output.expect_value("No value submitted yet")
+
+    basic.submit()
+    value_output.expect_value("Submitted: Updated value")
+
+
+def test_input_submit_textarea_update_placeholder(page: Page, local_app: ShinyAppProc):
+    page.goto(local_app.url)
+
+    basic = controller.InputSubmitTextarea(page, "basic")
+    update_btn = controller.InputActionButton(page, "update_placeholder")
+    basic.expect_placeholder("Type something here...")
+
+    update_btn.click()
+    basic.expect_placeholder("New placeholder text")
+
+
+def test_input_submit_textarea_programmatic_submit(page: Page, local_app: ShinyAppProc):
+    page.goto(local_app.url)
+
+    basic = controller.InputSubmitTextarea(page, "basic")
+    value_output = controller.OutputCode(page, "basic_value")
+    submit_btn = controller.InputActionButton(page, "submit_programmatic")
+
+    basic.set("Programmatically submitted")
+    submit_btn.click()
+    value_output.expect_value("Submitted: Programmatically submitted")
+
+
+def test_input_submit_textarea_multiple_submissions(
+    page: Page, local_app: ShinyAppProc
+):
+    page.goto(local_app.url)
+
+    basic = controller.InputSubmitTextarea(page, "basic")
+    value_output = controller.OutputCode(page, "basic_value")
+
+    # First submission
+    basic.set("First", submit=True)
+    value_output.expect_value("Submitted: First")
+
+    # Second submission
+    basic.set("Second", submit=True)
+    value_output.expect_value("Submitted: Second")
+
+    # Third submission
+    basic.set("Third", submit=True)
+    value_output.expect_value("Submitted: Third")