Feat: set up Playwright (#2554)

.github/dependabot.yml

@@ -25,3 +25,21 @@ updates:
       include: "scope"
     labels:
       - "dependencies"
+  - package-ecosystem: "docker"
+    directory: "/tests/playwright" # Playwright Docker image
+    schedule:
+      interval: "daily"
+    commit-message:
+      prefix: "chore"
+      include: "scope"
+    labels:
+      - "dependencies"
+  - package-ecosystem: "pip"
+    directory: "/tests/playwright" # Playwright pytest plugin
+    schedule:
+      interval: "daily"
+    commit-message:
+      prefix: "chore"
+      include: "scope"
+    labels:
+      - "dependencies"

compose.yml

@@ -41,3 +41,12 @@ services:
       - "8000"
     volumes:
       - ./.devcontainer:/.devcontainer
+
+  playwright:
+    build:
+      context: .
+      dockerfile: tests/playwright/Dockerfile
+    image: benefits_client:playwright
+    volumes:
+      - ./tests/playwright:/playwright
+    command: ./run.sh

docs/tests/automated-tests.md

@@ -23,3 +23,13 @@ The report files include a local `.gitignore` file, so the entire directory is h
 ### Latest coverage report
 
 We also make the latest (from `main`) coverage report available online here: [Coverage report](../coverage)
+
+## Playwright
+
+For testing the app flows from beginning to end, we use Playwright.
+
+To run all Playwright tests locally, open a terminal outside the devcontainer and run:
+
+```bash
+docker compose run --rm playwright
+```

pyproject.toml

@@ -39,6 +39,7 @@ test = [
     "pytest",
     "pytest-django",
     "pytest-mock",
+    "pytest-playwright", # only for writing tests. run tests using playwright Docker Compose service
     "pytest-socket",
 ]
 

tests/playwright/.gitignore

@@ -0,0 +1,3 @@
+__pycache__
+.pytest_cache
+test-results

tests/playwright/Dockerfile

@@ -0,0 +1,11 @@
+# https://playwright.dev/docs/docker
+FROM mcr.microsoft.com/playwright/python:v1.48.0-jammy
+
+WORKDIR /playwright
+
+COPY tests/playwright/requirements.txt requirements.txt
+
+RUN python -m pip install --upgrade pip && \
+   pip install -r requirements.txt
+
+USER pwuser

tests/playwright/pytest.ini

@@ -0,0 +1,2 @@
+[pytest]
+addopts = --tracing on -v --template=html1/index.html --report=test-results/report.html --video on

tests/playwright/requirements.txt

@@ -0,0 +1,4 @@
+playwright==1.48.0 # needs to match version on Docker image
+pytest
+pytest-playwright
+pytest-reporter-html1

tests/playwright/run.sh

@@ -0,0 +1,5 @@
+#!/bin/bash
+
+set -e
+
+pytest

tests/playwright/test_healthcheck.py

@@ -0,0 +1,7 @@
+from playwright.sync_api import Page, expect
+
+
+def test_dev_healthcheck(page: Page):
+    page.goto("https://dev-benefits.calitp.org/healthcheck")
+
+    expect(page.get_by_text("Healthy")).to_be_visible()

tests/pytest/run.sh

@@ -2,7 +2,7 @@
 set -eu
 
 # run normal pytests
-coverage run -m pytest
+coverage run -m pytest tests/pytest
 
 # clean out old coverage results
 rm -rf benefits/static/coverage