Draft/toga-web-testing

positron/src/positron/django_templates/manage.py.tmpl

@@ -1,5 +1,6 @@
 #!/usr/bin/env python
 """Django's command-line utility for administrative tasks."""
+
 import os
 import sys
 

travertino/pyproject.toml

@@ -41,6 +41,10 @@ classifiers = [
     "Topic :: Software Development :: User Interfaces",
 ]
 
+dependencies = [
+    "packaging",
+]
+
 [project.urls]
 Homepage = "https://beeware.org/travertino"
 Funding = "https://beeware.org/contributing/membership/"

web-testbed/README.md

@@ -0,0 +1,15 @@
+This repository is dedicated to development, testing, and proof-of-concept work related to issue [3545](https://github.com/beeware/toga/issues/3545), which focuses on implementing testing for the web platform.
+
+## How We Run this Test Suite
+1. Open this directory.
+2. Create a Python 3.12 virtual environment and install test requirements:
+   - `python3.12 -m venv venv`
+   - `source venv/bin/activate`
+   - `pip install -U pip`
+   - `pip install --group test`
+   - `playwright install chromium`
+3. Run your Toga app as a web app.
+   - `briefcase run web`
+4. In a separate terminal, run the test suite:
+   - `source venv/bin/activate`
+   - `pytest tests`

web-testbed/pyproject.toml

@@ -0,0 +1,49 @@
+[project]
+name = "testbed"
+version = "0.0.1"
+
+[dependency-groups]
+test = [
+    "briefcase",
+    "playwright == 1.51.0",
+    # "pytest==8.4.1",
+    "pytest==8.3.5",
+    # "pytest-asyncio==1.1.0",
+    "pytest-asyncio==0.26.0",
+    "pytest-playwright==0.7.0",
+]
+
+[tool.briefcase]
+project_name = "Toga Web Testbed"
+bundle = "org.beeware.toga"
+url = "https://beeware.org"
+license = "BSD-3-Clause"
+license-files = [
+    "LICENSE",
+]
+author = "Tiberius Yak"
+author_email = "[email protected]"
+
+[tool.briefcase.app.testbed]
+formal_name = "Toga Testbed"
+description = "A testbed for Toga visual tests"
+icon = "icons/testbed"
+sources = [
+    "src/testbed",
+]
+test_sources = [
+    "tests",
+]
+requires = [
+    "../travertino",
+    "../core",
+]
+
+[tool.briefcase.app.testbed.web]
+requires = [
+    "../web"
+]
+style_framework = "Shoelace v2.3"
+
+[tool.pytest.ini_options]
+asyncio_mode = "auto"

web-testbed/run_tests.py

@@ -0,0 +1,69 @@
+import os
+import signal
+import subprocess
+import sys
+import time
+from shutil import which
+
+SERVER_CMD = ["briefcase", "run", "web", "--no-browser"]
+TEST_CMD = ["pytest", "tests"]
+STARTUP_WAIT_SECS = float(os.getenv("SERVER_STARTUP_SECS", "5.0"))
+
+IS_WINDOWS = os.name == "nt"
+CREATE_NEW_PROCESS_GROUP = 0x00000200 if IS_WINDOWS else 0
+
+
+def start_server():
+    if which(SERVER_CMD[0]) is None:
+        print(f"Error: '{SERVER_CMD[0]}' not found on PATH.", file=sys.stderr)
+        sys.exit(127)
+    kwargs = {}
+    if IS_WINDOWS:
+        kwargs["creationflags"] = CREATE_NEW_PROCESS_GROUP
+    kwargs["stdout"] = subprocess.PIPE
+    kwargs["stderr"] = subprocess.STDOUT
+    return subprocess.Popen(SERVER_CMD, **kwargs)
+
+
+def stop_server(proc, timeout=10):
+    if proc.poll() is not None:
+        return
+    try:
+        if IS_WINDOWS:
+            # Try to be gentle first
+            try:
+                proc.send_signal(signal.CTRL_BREAK_EVENT)
+            except Exception:
+                proc.terminate()
+        else:
+            proc.send_signal(signal.SIGINT)
+        proc.wait(timeout=timeout)
+    except subprocess.TimeoutExpired:
+        try:
+            proc.terminate()
+            proc.wait(timeout=3)
+        except Exception:
+            proc.kill()
+
+
+def main():
+    print("> Starting web server:", " ".join(SERVER_CMD))
+    server = start_server()
+
+    try:
+        time.sleep(STARTUP_WAIT_SECS)
+        print("> Running tests:", " ".join(TEST_CMD))
+        result = subprocess.run(TEST_CMD)
+        exit_code = result.returncode
+    except KeyboardInterrupt:
+        print("\n> Interrupted by user.", file=sys.stderr)
+        exit_code = 130
+    finally:
+        print("> Shutting down web server…")
+        stop_server(server)
+
+    sys.exit(exit_code)
+
+
+if __name__ == "__main__":
+    main()

web-testbed/src/testbed/__main__.py

@@ -0,0 +1,4 @@
+from testbed.app import main
+
+if __name__ == "__main__":
+    main().main_loop()

web-testbed/src/testbed/app.py

@@ -0,0 +1,22 @@
+import toga
+from toga.style import Pack
+from toga.style.pack import COLUMN
+
+from .web_test_harness import WebTestHarness
+
+
+class HelloWorld(toga.App):
+    def startup(self):
+        main_box = toga.Box(style=Pack(direction=COLUMN))
+        self.label = toga.Label(id="myLabel", text="Test App - Toga Web Testing")
+
+        self.web_test = WebTestHarness(self)
+
+        main_box.add(self.label)
+        self.main_window = toga.MainWindow(title=self.formal_name)
+        self.main_window.content = main_box
+        self.main_window.show()
+
+
+def main():
+    return HelloWorld()