Merge branch 'main' into df-style-cell

* main:
  tests(controls): Change API from controls to controller (#1481)
  fix(docs): Update path to reflect correct one (#1478)
  docs(testing): Add quarto page for testing (#1461)
  fix(test): Remove unused testrail reporting from nightly builds (#1476)
  chore(pyright): Remove version restriction and fix appropriate pyright errors (#1473)

Author: schloerke

.github/workflows/pytest.yaml

@@ -244,58 +244,3 @@ jobs:
         with:
           user: __token__
           password: ${{ secrets.PYPI_API_TOKEN }}
-
-  testrail-reporting-nightly:
-    runs-on: ${{ matrix.os }}
-    if: ${{ github.event_name == 'schedule' || startsWith(github.head_ref, 'testrail') }}
-    strategy:
-      matrix:
-        python-version:
-          - "3.12"
-          - "3.11"
-          - "3.10"
-          - "3.9"
-          # - "3.8" # Testrail has errors when running on python 3.8; Skipping
-        os: [ubuntu-latest]
-      fail-fast: false
-
-    steps:
-      - uses: actions/checkout@v4
-      - name: Setup py-shiny
-        uses: ./.github/py-shiny/setup
-        with:
-          python-version: ${{ matrix.python-version }}
-
-      - name: Install node.js
-        uses: actions/setup-node@v4
-        with:
-          node-version: "18"
-          cache: npm
-          cache-dependency-path: examples/brownian/shinymediapipe/package-lock.json
-      - name: Install node.js package
-        working-directory: examples/brownian/shinymediapipe
-        run: |
-          npm ci
-
-      - name: Run End-to-End tests
-        timeout-minutes: 20
-        run: |
-          make testrail-junit
-      - name: Report results to Testrail
-        env:
-          TESTRAIL_URL: "https://posit.testrail.io"
-          TESTRAIL_PROJECT: "Shiny-Python"
-          TESTRAIL_USER: "${{ secrets.TESTRAIL_USER }}"
-          TESTRAIL_PASSWORD: "${{ secrets.TESTRAIL_PASSWORD }}"
-        run: |
-          CURRENT_DATE="$(date +'%Y-%m-%d %H:%M:%S') Nightly tests"
-          trcli \
-            --yes \
-            --host "$TESTRAIL_URL" \
-            --project "$TESTRAIL_PROJECT" \
-            --username "$TESTRAIL_USER" \
-            --password "$TESTRAIL_PASSWORD" \
-            parse_junit \
-            --file "report.xml" \
-            --title "$CURRENT_DATE"  \
-            --close-run

CHANGELOG.md

@@ -19,6 +19,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### New features
 
+* Expose `shiny.playwright`, `shiny.run`, and `shiny.pytest` modules that allow users to testing their Shiny apps.  (#1448, #1456, #1481)
+  * `shiny.playwright` contains `controller` and `expect` submodules. `controller` will contain many classes to interact with (and verify!) your Shiny app using Playwright. `expect` contains expectation functions that enhance standard Playwright expectation methods.
+  * `shiny.run` contains the `run_shiny_app` command and the return type `ShinyAppProc`. `ShinyAppProc` can be used to type the Shiny app pytest fixtures.
+  * `shiny.pytest` contains pytest test fixtures. The `local_app` pytest fixture is automatically available and runs a sibling `app.py` file. Where as `create_app_fixture(PATH_TO_APP)` allows for a Shiny app to be instantiated from a different folder.
+
+* Added CLI command `shiny add test` to add a test file to an existing Shiny app. (#1461)
+
 * `@render.data_frame` has added a few new methods:
   * `.data_view_rows()` is a reactive value representing the sorted and filtered row numbers. This value wraps `input.<ID>_data_view_rows()`(#1374)
   * `.sort()` is a reactive value representing the sorted column information (dictionaries containing `col: int` and `desc: bool`). This value wraps `input.<ID>_sort()`. (#1374)
@@ -60,8 +67,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### New features
 
-* Expose shiny.pytest, shiny.run and shiny.playwright modules that allow users to testing their Shiny apps. (#1448, #1456)
-
 * Added busy indicators to provide users with a visual cue when the server is busy calculating outputs or otherwise serving requests to the client. More specifically, a spinner is shown on each calculating/recalculating output, and a pulsing banner is shown at the top of the page when the app is otherwise busy. Use the new `ui.busy_indicator.options()` function to customize the appearance of the busy indicators and `ui.busy_indicator.use()` to disable/enable them. (#918)
 
 * Added support for creating modules using Shiny Express syntax, and using modules in Shiny Express apps. (#1220)

Makefile

@@ -1,6 +1,6 @@
 # https://www.gnu.org/software/make/manual/make.html#Phony-Targets
 # Prerequisites of .PHONY are always interpreted as literal target names, never as patterns (even if they contain ‘%’ characters).
-# # .PHONY: help clean% check% format% docs% lint test pyright playwright% install% testrail% coverage release js-*
+# # .PHONY: help clean% check% format% docs% lint test pyright playwright% install% coverage release js-*
 # Using `FORCE` as prerequisite to _force_ the target to always run; https://www.gnu.org/software/make/manual/make.html#index-FORCE
 FORCE: ;
 
@@ -152,9 +152,6 @@ PYTEST_DEPLOYS_BROWSERS:= --browser chromium
 install-playwright: FORCE
 	playwright install --with-deps
 
-install-trcli: FORCE
-	$(if $(shell which trcli), @echo -n, $(shell pip install trcli))
-
 install-rsconnect: FORCE
 	pip install git+https://github.com/rstudio/rsconnect-python.git#egg=rsconnect-python
 
@@ -182,10 +179,6 @@ playwright-deploys: install-rsconnect
 playwright-examples: FORCE
 	$(MAKE) playwright TEST_FILE="tests/playwright/examples/$(SUB_FILE)"
 
-# end-to-end tests with playwright and generate junit report
-testrail-junit: install-playwright install-trcli
-	pytest tests/playwright/shiny/$(SUB_FILE) --junitxml=report.xml $(PYTEST_BROWSERS)
-
 coverage: FORCE ## check combined code coverage (must run e2e last)
 	pytest --cov-report term-missing --cov=shiny tests/pytest/ tests/playwright/shiny/$(SUB_FILE) $(PYTEST_BROWSERS)
 	coverage html

docs/.gitignore

@@ -5,5 +5,4 @@ _sidebar.yml
 /.quarto/
 objects.json
 site_libs/
-_objects_core.json
-_objects_express.json
+_objects_*.json

docs/Makefile

@@ -49,7 +49,7 @@ deps: $(PYBIN) dev-htmltools dev-shinylive ## Install build dependencies
 	$(PYBIN)/pip install pip --upgrade
 	$(PYBIN)/pip install ..[doc]
 
-quartodoc: quartodoc_build_core quartodoc_build_express quartodoc_post ## Build quartodocs for express and core
+quartodoc: quartodoc_build_core quartodoc_build_express quartodoc_build_test quartodoc_post ## Build quartodocs for express and core
 
 ## Build interlinks for API docs
 quartodoc_interlinks: $(PYBIN)
@@ -78,6 +78,14 @@ quartodoc_build_express: $(PYBIN) quartodoc_interlinks
 	  && mv objects.json _objects_express.json \
 	  && echo "::endgroup::"
 
+## Build test API docs
+quartodoc_build_test: $(PYBIN) quartodoc_interlinks
+	. $(PYBIN)/activate \
+	  && echo "::group::quartodoc build testing docs" \
+	  && quartodoc build --config _quartodoc-testing.yml --verbose \
+	  && mv objects.json _objects_test.json \
+	  && echo "::endgroup::"
+
 ## Clean up after quartodoc build
 quartodoc_post: $(PYBIN)
 	. $(PYBIN)/activate \

docs/_combine_objects_json.py

@@ -40,10 +40,11 @@ def write_objects_file(objects: QuartodocObject, path: str) -> None:
 print("\nCombining objects json files...")
 objects_core = read_objects_file("_objects_core.json")
 objects_express = read_objects_file("_objects_express.json")
+objects_test = read_objects_file("_objects_test.json")
 
 items_map: dict[str, QuartodocObjectItem] = {}
 
-for item in [*objects_core.items, *objects_express.items]:
+for item in [*objects_core.items, *objects_express.items, *objects_test.items]:
     if item.name in items_map:
         continue
     items_map[item.name] = item
@@ -58,6 +59,7 @@ def write_objects_file(objects: QuartodocObject, path: str) -> None:
 
 print("Core:", objects_core.count)
 print("Express:", objects_express.count)
+print("Testing:", objects_test.count)
 print("Combined:", objects_ret.count)
 
 # Save combined objects file info

docs/_quarto.yml

@@ -22,6 +22,8 @@ website:
         file: api/express/index.qmd
       - text: "Core API"
         file: api/core/index.qmd
+      - text: "Testing API"
+        file: api/testing/index.qmd
     right:
       - icon: github
         href: https://github.com/posit-dev/py-shiny

docs/_quartodoc-testing.yml

@@ -0,0 +1,93 @@
+quartodoc:
+  style: pkgdown
+  dir: api/testing
+  out_index: index.qmd
+  package: shiny
+  rewrite_all_pages: false
+  sidebar: api/testing/_sidebar.yml
+  dynamic: false
+  renderer:
+    style: _renderer.py
+    show_signature_annotations: false
+  sections:
+    - title: UI Layouts
+      desc: Methods for interacting with Shiny app multiple UI component controller.
+      contents:
+        - playwright.controller.Accordion
+        - playwright.controller.AccordionPanel
+        - playwright.controller.Card
+        - playwright.controller.Popover
+        - playwright.controller.Sidebar
+        - playwright.controller.Tooltip
+    - title: UI Inputs
+      desc: Methods for interacting with Shiny app input value controller.
+      contents:
+        - playwright.controller.InputActionLink
+        - playwright.controller.InputCheckbox
+        - playwright.controller.InputCheckboxGroup
+        - playwright.controller.InputDarkMode
+        - playwright.controller.InputDate
+        - playwright.controller.InputDateRange
+        - playwright.controller.InputFile
+        - playwright.controller.InputNumeric
+        - playwright.controller.InputPassword
+        - playwright.controller.InputRadioButtons
+        - playwright.controller.InputSelect
+        - playwright.controller.InputSelectize
+        - playwright.controller.InputSlider
+        - playwright.controller.InputSliderRange
+        - playwright.controller.InputSwitch
+        - playwright.controller.InputTaskButton
+        - playwright.controller.InputText
+        - playwright.controller.InputTextArea
+    - title: Value boxes
+      desc: Methods for interacting with Shiny app valuebox controller.
+      contents:
+        - playwright.controller.ValueBox
+    - title: Navigation (tab) panels
+      desc: Methods for interacting with Shiny app UI content controller.
+      contents:
+        - playwright.controller.NavItem
+        - playwright.controller.NavsetBar
+        - playwright.controller.NavsetCardPill
+        - playwright.controller.NavsetCardTab
+        - playwright.controller.NavsetCardUnderline
+        - playwright.controller.NavsetHidden
+        - playwright.controller.NavsetPill
+        - playwright.controller.NavsetPillList
+        - playwright.controller.NavsetTab
+        - playwright.controller.NavsetUnderline
+    - title: Upload and download
+      desc: Methods for interacting with Shiny app uploading and downloading controller.
+      contents:
+        - playwright.controller.DownloadButton
+        - playwright.controller.DownloadLink
+    - title: Rendering outputs
+      desc: Render output in a variety of ways.
+      contents:
+        - playwright.controller.OutputCode
+        - playwright.controller.OutputDataFrame
+        - playwright.controller.OutputImage
+        - playwright.controller.OutputPlot
+        - playwright.controller.OutputTable
+        - playwright.controller.OutputText
+        - playwright.controller.OutputTextVerbatim
+        - playwright.controller.OutputUi
+    - title: "Playwright Expect"
+      desc: "Methods for testing the state of a locator within a Shiny app."
+      contents:
+        - playwright.expect.expect_to_change
+        - playwright.expect.expect_attribute_to_have_value
+        - playwright.expect.expect_to_have_class
+        - playwright.expect.expect_not_to_have_class
+        - playwright.expect.expect_to_have_style
+    - title: "Pytest"
+      desc: "Fixtures used for testing Shiny apps with Pytest."
+      contents:
+        - pytest.create_app_fixture
+        - pytest.ScopeName
+    - title: "Run"
+      desc: "Methods for starting a local Shiny app in the background"
+      contents:
+        - run.run_shiny_app
+        - run.ShinyAppProc

setup.cfg

@@ -103,7 +103,7 @@ dev =
     flake8>=6.0.0
     flake8-bugbear>=23.2.13
     isort>=5.10.1
-    pyright==1.1.365 # must be larger than 1.1.366; https://github.com/microsoft/pyright/issues/8087
+    pyright>=1.1.367
     pre-commit>=2.15.0
     wheel
     matplotlib

shiny/_main.py

@@ -503,6 +503,45 @@ def try_import_module(module: str) -> Optional[types.ModuleType]:
 }
 
 
+@main.group(help="""Add files to enhance your Shiny app.""")
+def add() -> None:
+    pass
+
+
+@add.command(
+    help="""Add a test file for a specified Shiny app.
+
+Add an empty test file for a specified app. You will be prompted with a destination
+folder. If you don't provide a destination folder, it will be added in the current
+working directory based on the app name.
+
+After creating the shiny app file, you can use `pytest` to run the tests:
+
+        pytest TEST_FILE
+"""
+)
+@click.option(
+    "--app",
+    "-a",
+    type=str,
+    help="Please provide the path to the app file for which you want to create a test file.",
+)
+@click.option(
+    "--test-file",
+    "-t",
+    type=str,
+    help="Please provide the name of the test file you want to create. The basename of the test file should start with `test_` and be unique across all test files.",
+)
+# Param for app.py, param for test_name
+def test(
+    app: Path | None,
+    test_file: Path | None,
+) -> None:
+    from ._template_utils import add_test_file
+
+    add_test_file(app_file=app, test_file=test_file)
+
+
 @main.command(
     help="""Create a Shiny application from a template.