yoja-selenium

Browser enum

Supported browsers. Each value maps to a Selenium WebDriver implementation.

Browser.Mode.DEBUGGER mode flips three switches at browser-launch time:

The 1-hour timeouts matter most: without them, pausing at a Java breakpoint for more than the default 10 s would make Selenium abort the in-flight script and break the session. They give you room to inspect state at length without losing the browser context.

Browser.Mode.DEBUGGER mode does not pause on its own — it only prepares the environment. To actually pause, set a Java breakpoint in your IDE on the line of interest, or insert selenium.debugger() / builder.debugger() as a marker; the auto-opened DevTools then let you inspect the live DOM in parallel.

Which exception to break on. debugger() works by throwing — and immediately swallowing — a com.easygoingapi.yoja.selenium.Debugger exception (a RuntimeException). It never propagates, so it can never fail your test; its only purpose is to be a stable target for the IDE. To make debugger() pause, add an exception breakpoint on com.easygoingapi.yoja.selenium.Debugger (IntelliJ: Run ▸ View Breakpoints ▸ + ▸ Java Exception Breakpoint; Eclipse: Add Java Exception Breakpoint, keep "Caught" since the throw is caught inline) — every debugger() call then suspends the JVM at that throw while the browser stays alive thanks to the 1-hour timeouts.

SeleniumService class (AutoCloseable)

High-level wrapper around a WebDriver, tailored to driving Yoja-Web pages.

TestBuilder class

Fluent orchestrator. Builds a list of test steps, then runs them via execute() or exposes them as JUnit dynamic nodes via stream().

ScriptOption class

Controls which helpers are injected after page navigation.

TestContext class (AutoCloseable)

Per-test handle injected into every Consumer<TestContext> step. Closing it shuts down both the embedded server and the WebDriver.

HttpServerContext · HttpUrlBuilder classes

Embedded Yoja HTTP server serving test fixtures. Port auto-assigned from a monotonically-increasing sequence starting at 8888.

ywAssert browser-side assertions

ywAssert.js injects a small JUnit-style assertion library into the page as the global window.ywAssert. Call it from JS test modules run via testModule / testAsyncModule / testJsUnit — every failed assertion throws a JavaScript Error that Selenium propagates back to Java and surfaces as a failing test step.

It is not injected by default. Make it available three equivalent ways:

// 1. as a script option when starting the page
builder.startYojaWeb(ScriptOption.apply().loadYwAssert());
// 2. as a dedicated TestBuilder step (before any test that needs it)
builder.loadYwAssert();
// 3. on demand from inside a test step
builder.test("...", ctx -> ctx.seleniumService().loadYwAssert());

The optional message is prepended to the error with " -> " for context.

// /test/checkUserList.js
export default async function(args, resolve, reject) {
    try {
        const res   = await fetch('/api/users')
        const users = await res.json()

        ywAssert.assertEquals(200, res.status, 'wrong HTTP status')
        ywAssert.assertTrue(Array.isArray(users), 'response should be an array')
        ywAssert.assertArrayEquals(
            [{ id: 1, name: 'Alice' }, { id: 2, name: 'Bob' }],
            users,
            'user list payload')
        resolve()
    }
    catch (e) {
        reject(e.message)
    }
}

Log · Log.Level classes

Browser-side log entry collected by ywLogger.js and surfaced via SeleniumService.logs().

DateUtil · Debugger · SeleniumException helpers