Merge pull request #203 from benjeffery/playwright

Interface testing with Playwright

.github/workflows/post.yml

@@ -25,16 +25,23 @@ jobs:
           cache: 'pip'
 
       - name: Install deps
-        run: pip install -r requirements.txt
+        run: |
+          pip install -r requirements.txt
+          playwright install
+
 
-      - name: Create Screenshots
+      - name: Create Screenshots - CLI
         run: |
           msp simulate --length 1000 --recombination-rate 0.01 --mutation-rate 0.01 100 out.trees
           python -m tsbrowse preprocess out.trees
           python -m tsbrowse screenshot out.tsbrowse mutations
           python -m tsbrowse screenshot out.tsbrowse edges
           python -m tsbrowse screenshot out.tsbrowse nodes
 
+      - name: Create Screenshots - WEB
+        run: |
+          python -m pytest --save-screenshots tests/test_ui.py
+
       - name: Commit Screenshots
         run: |
           git config --global user.name 'GitHub Action'

.github/workflows/tests.yml

@@ -46,7 +46,9 @@ jobs:
           cache: 'pip'
 
       - name: Install deps
-        run: pip install -r requirements.txt
+        run: |
+          pip install -r requirements.txt
+          playwright install
 
       - name: Tests with numba
         run: coverage run --source=tsbrowse -m pytest -x tests

README.md

@@ -33,3 +33,15 @@ tsbrowse is currently in development. To install the latest dev version from git
 ```
 python -m pip install git+https://github.com/tskit-dev/tsbrowse
 ```
+
+## Development
+
+Test are run with pytest:
+
+`python -m pytest`
+
+To run the UI tests so you can see what the browser is doing use
+
+`python -m pytest --headed --slowmo 1000 tests/test_ui.py`
+
+`playwright codegen` is also useful for writing UI test code.

requirements.txt

@@ -9,6 +9,7 @@ msprime
 panel
 pre-commit
 pytest
+pytest-playwright
 selenium
 tskit
 tszip

tests/conftest.py

@@ -0,0 +1,30 @@
+import panel as pn
+import pytest
+
+PORT = [6000]
+
+
+@pytest.fixture
+def port():
+    PORT[0] += 1
+    return PORT[0]
+
+
+@pytest.fixture(autouse=True)
+def server_cleanup():
+    """
+    Clean up server state after each test.
+    """
+    try:
+        yield
+    finally:
+        pn.state.reset()
+
+
+def pytest_addoption(parser):
+    parser.addoption(
+        "--save-screenshots",
+        action="store_true",
+        default=False,
+        help="Save screenshots during tests",
+    )

tests/test_ui.py

@@ -0,0 +1,82 @@
+import time
+
+import msprime
+import panel as pn
+import pytest
+from playwright.sync_api import expect
+
+from tsbrowse import app
+from tsbrowse import model
+from tsbrowse import preprocess
+
+
+@pytest.fixture
+def save_screenshots(request):
+    return request.config.getoption("--save-screenshots")
+
+
+def test_component(page, port, tmpdir, save_screenshots):
+    ts = msprime.sim_ancestry(
+        10, sequence_length=1000, recombination_rate=1e-2, random_seed=1
+    )
+    ts = msprime.sim_mutations(ts, rate=1e-2, random_seed=1)
+    ts.dump(tmpdir / "test.trees")
+    preprocess.preprocess(tmpdir / "test.trees", tmpdir / "test.tsbrowse")
+
+    tsm = model.TSModel(tmpdir / "test.tsbrowse")
+    component = app.App(tsm)
+
+    url = f"http://localhost:{port}"
+    server = pn.serve(component.view(), port=port, threaded=True, show=False)
+    time.sleep(2)
+    page.goto(url)
+
+    page.set_viewport_size({"width": 1920, "height": 1080})
+    expect(page.get_by_role("link", name="Tree Sequence")).to_be_visible()
+    # needs tskit 0.5.9
+    # expect(page.get_by_role("cell", name="Provenance Timestamp")).to_be_visible()
+    if save_screenshots:
+        page.screenshot(path="overview.png")
+
+    page.get_by_role("button", name="Tables").click()
+    expect(page.get_by_label("Select Table")).to_be_visible()
+    expect(page.get_by_placeholder("Enter query expression (e.g")).to_be_visible()
+    page.get_by_label("Select Table").select_option("trees")
+    expect(page.get_by_text("total_branch_length")).to_be_visible()
+    if save_screenshots:
+        page.screenshot(path="tables.png")
+
+    page.get_by_role("button", name="Mutations").click()
+    expect(page.get_by_text("Log y-axis")).to_be_visible()
+    expect(page.get_by_title("Reset").locator("div")).to_be_visible()
+    if save_screenshots:
+        page.screenshot(path="mutations.png")
+    # This horrendous selector is needed because the click event is not
+    # handled be the canvas, but by a floating div on top.
+    page.locator("div:nth-child(6) > .bk-Canvas > div:nth-child(12)").click(
+        position={"x": 558, "y": 478}
+    )
+    expect(page.get_by_text("Mutation information")).to_be_visible()
+    expect(page.get_by_text("0.52")).to_be_visible()
+    if save_screenshots:
+        page.screenshot(path="mutations-popup.png")
+
+    page.get_by_role("button", name="Edges").click()
+    expect(page.get_by_text("Parent node")).to_be_visible()
+    expect(page.get_by_title("Reset").locator("div")).to_be_visible()
+    if save_screenshots:
+        page.screenshot(path="edges.png")
+
+    page.get_by_role("button", name="Trees").click()
+    expect(page.get_by_text("log y-axis")).to_be_visible()
+    expect(page.locator(".bk-Canvas > div:nth-child(12)").first).to_be_visible()
+    if save_screenshots:
+        page.screenshot(path="trees.png")
+
+    page.get_by_role("button", name="Nodes").click()
+    expect(page.get_by_role("heading", name="Node Flags")).to_be_visible()
+    expect(page.get_by_title("Reset").locator("div")).to_be_visible()
+    if save_screenshots:
+        page.screenshot(path="nodes.png")
+
+    server.stop()