rules_web_e2e

Build app. Compile specs. Bazel runs Playwright E2E, component interactions, and visual regression tests (VRT). Rules handle execution, reports, and screenshot updates.

Choose a setup

Path	Use it for	You configure
Basic: presets	Isolated Linux amd64 tests	One browser release and worker launcher
Advanced: custom	Custom browsers, fonts, ARM64, or worker infrastructure	Runtime inputs and/or worker execution settings
Local Linux	Declared browsers without VM, x64 or ARM64	execution = "local" and Linux namespace support
Host tests	Live services, component interactions, or process-owned tests	Caller-provisioned browsers/executables and execution policy
Host VRT	Screenshot tests on controlled Linux amd64 host without VM	host_vrt = True, declared browser runtime, and host environment parity

Preset supplies Chromium, Node, libraries, and fonts. Its worker supervisor handles download, startup, execution flags, logs, and cleanup. You still own app/spec builds, matching Playwright packages, and Linux runner with KVM/vsock. Runtime and worker customization independent.

Start with Getting started or runnable React example.

API

load("@rules_web_e2e//component:defs.bzl", "browser_shell", "component_browser_test")
load("@rules_web_e2e//e2e:defs.bzl", "web_e2e_test")
load("@rules_web_e2e//vrt:defs.bzl", "component_visual_test")

browser_shell(name = "gallery", assets = ":built_gallery", entry_point = "gallery.html")

web_e2e_test(
    name = "e2e_test",
    browser = "@web_browser//:browser",
    tests = ":compiled_specs",
    server = ":compiled_server",
)

component_browser_test(
    name = "component_test",
    browser = "@web_browser//:browser",
    tests = ":compiled_component_specs",
    shell = ":gallery",
)

component_visual_test(
    name = "visual_test",
    browser = "@web_browser//:browser",
    shell = ":gallery",
    baselines = glob(["__screenshots__/*.png"], allow_empty = True),
)

Use visual_test(tests = ":compiled_specs", ...) for native Playwright toHaveScreenshot assertions. Gallery VRT generates captures from registered .visual.tsx modules. Each visual target owns its baseline directory and explicit .update target; review PNG changes before committing.

See API reference, documentation index, and development guide.

Host suites can own snapshots and run .update. Host suites use normal Bazel result caching; callers control cache restrictions. Use browser_process_test for Electron/browser executables owned by specs, or web_e2e_ui to debug aggregate compiled E2E suites.