Skip to content

TESTING.md

Latest commit

 

History

History
102 lines (64 loc) · 1.94 KB

TESTING.md

File metadata and controls

102 lines (64 loc) · 1.94 KB
Raw

Testing (BAR Lobby)

This document describes how automated testing is set up in bar-lobby, and how to run tests locally and in CI.

  • Unit / integration tests: Vitest
  • End-to-end (E2E) tests: Playwright launching the Electron app

Quick start

npm ci
npm run test
npm run test:e2e

Unit tests (Vitest)

What these tests are for

Use unit tests for:

  • Pure functions and business logic
  • Modules with well-defined boundaries (mock IO/network as needed)
  • Renderer logic that can be exercised without a full Electron runtime

Run unit tests

npm run test

Run a subset:

npx vitest run tests/some.test.ts

E2E tests (Playwright + Electron)

What these tests do

E2E tests launch the Electron app and interact with the real browser window(s) via Playwright. This exercises:

  • Electron main process startup
  • Window creation / BrowserWindow lifecycle
  • Renderer load + DOM availability

E2E is a good place for:

  • “App boots” / “critical views render” checks
  • High-value workflows that cross main/renderer boundaries
  • Regression coverage for production-only issues (packaging, preload wiring, navigation, etc.)

Running E2E locally

npm run test:e2e

Debug mode:

PWDEBUG=1 npm run test:e2e

Troubleshooting

Electron launch failures

If Electron fails immediately, check:

  • Are you hitting Linux sandbox errors? In CI, add --no-sandbox for Electron.

__dirname is not defined

This repo is ESM ("type": "module"), so __dirname and __filename are not defined in tests.

To resolve paths relative to the current test file, use import.meta.url:

const __dirname = path.dirname(fileURLToPath(import.meta.url));

“Cannot open display” / X server errors (Linux)

Run E2E with Xvfb:

xvfb-run -a npm run test:e2e