GPUI.Test (gpui v0.2.0-rc.1)

ExUnit helpers for renderer-independent application tests and deterministic GPUI interaction tests.

Ordinary tests use a lightweight GPUI.Test.Display:

use GPUI.Test, async: true

Tests that exercise real operating-system windows opt in to an owned desktop session:

use GPUI.Test, desktop: true

Deterministic tests that need GPUI layout, focus, hit testing, or keyboard dispatch opt in to a supervised native UI:

use GPUI.Test, native: [size: {640, 480}]

Native UI cases are skipped by ordinary ExUnit runs. Use the dedicated deterministic native-test Mix task so the package is compiled for the native_test target.

Both modes import one concise helper vocabulary; the first argument identifies whether an interaction targets a runtime or an interactive UI.

defmodule FocusTimerTest do
  use GPUI.Test, async: true

  test "advances from an OTP message" do
    runtime = start_runtime!(FocusTimerApp, args: %{seconds: 2})

    click(runtime, "start")
    send_view(runtime, :tick)
    assert %{remaining: 1, status: :running} = assigns(runtime)
  end
end

Events are dispatched through GPUI.Test.Display, so the same GPUI.Runtime polling boundary used by a real display is exercised without loading GPUI or requiring desktop libraries.

Summary

Functions

advance(ui, milliseconds)

Advances GPUI's deterministic clock by the given milliseconds.

assigns(source, selector \\ :first)

Returns root-view assigns for a selected window.

bounds(ui, target)

Returns the rendered bounds for a stable element ID.

change(runtime, event, value, opts \\ [])

Dispatches a change event and returns the updated snapshot.

click(ui, target)

Clicks a stable element ID or logical point in an interactive deterministic UI.

click(runtime, event, opts \\ [])

Dispatches a click event and returns the updated snapshot.

command(runtime, event, opts \\ [])

Dispatches an application command and returns the updated snapshot.

copy_selected_line(runtime, event, opts \\ [])

Acknowledges deterministic copying of a selected code-viewer line.

dispatch(runtime, event)

Dispatches a normalized display event and returns handled events plus the new snapshot.

file_cancel(runtime, event, opts \\ [])

Cancels a deterministic display-side button file read.

file_select(runtime, event, name, data, opts \\ [])

Selects deterministic file bytes for a display-side button file read.

focus(ui, target)

Moves native keyboard focus to a stable element ID.

press(ui, key)

Presses a semantic key in an interactive deterministic UI.

range(runtime, event, first, last, opts \\ [])

Delivers a deterministic source-backed virtual-list range request.

release(runtime, event, value, opts \\ [])

Dispatches a slider release event and returns the updated snapshot.

render(view, assigns \\ %{})

Renders a view directly with map or keyword assigns.

render(ui, view, assigns)

Renders a view into an interactive deterministic native UI.

resize(ui, size)

Resizes the deterministic native viewport.

scroll(ui, target, opts)

Scrolls a stable target by a bounded logical-pixel delta.

search(runtime, event, query, opts \\ [])

Dispatches a combobox search event and returns the updated snapshot.

select(runtime, event, value, opts \\ [])

Selects a controlled form value and returns the updated snapshot.

send_view(runtime, message, opts \\ [])

Delivers an OTP message to a root view and returns the updated snapshot.

settle(ui)

Runs native UI work until GPUI is parked.

snapshot(snapshot)

Returns a runtime snapshot, or passes an existing snapshot through.

start_runtime!(app, opts \\ [])

Starts a supervised runtime backed by GPUI.Test.Display.

submit(runtime, event, value, opts \\ [])

Dispatches an input submission with its current string value.

table_cell_select(runtime, event, row_id, column_id, opts \\ [])

Dispatches a deterministic data-table cell selection.

table_sort(runtime, event, column_id, opts \\ [])

Dispatches a deterministic sortable data-table header selection.

tree(source, selector \\ :first)

Returns the rendered tree for a selected window.

type(ui, text)

Types text into the focused native input.

window_snapshot(source, selector \\ :first)

Returns a window snapshot from a runtime or full snapshot.