brighttestUnified BrightScript testing

Write a test once in Rooibos syntax. Run it headless — fast CI, coverage, even SceneGraph nodes, no device — or on a real Roku to confirm fidelity.

Quick start

Writing tests guide

Why it exists

View on GitHub

CI without devices

The default lane runs your specs headlessly on a BrightScript simulator in Node — no Roku hardware required.

Mocking & coverage

Full Rooibos assertions and mocks headless; real code coverage + LCOV headless too, no device.

Fast feedback

Sub-second local runs (--no-sgnode). No more package → sideload → ECP → telnet cycle.

One spec, every lane

The exact same .spec.bs runs headless and on-device — including @SGNode node suites headless.

On-device E2E

Deterministic UI tests on a real Roku — launch, drive the D-pad, type, and assert on the live SceneGraph. YAML flows, focus path-finding, screenshots & video.

What is brighttest?

A thin, config-driven CLI over a mature stack — BrighterScript + Rooibos + brs-node — for testing plain BrightScript Roku projects. You write tests once in Rooibos syntax; brighttest runs them in whichever lane you need.

bash

npm i -D brighttest
npx brighttest                                              # headless (no device) — default
npx brighttest --coverage --lcov coverage/lcov.info        # headless + coverage (no device)
npx brighttest --device --host <roku-ip> --password <dev-pw>          # on real hardware (fidelity)

New to testing on Roku? Start with the Writing tests guide — it assumes no prior experience with any of these tools.

Two kinds of testing

Logic — Rooibos unit/integration specs, run headless (fast CI, coverage) or on device. This is the bulk of your tests. Start at the Writing tests guide.
UI journeys — the on-device E2E lane drives a real Roku like a user (launch, D-pad, text) and asserts on the live screen. Additive — for the critical flows only a real device can prove.