class Termisu::Testing::Terminal

• Termisu::Testing::Terminal
• Reference
• Object

Overview

High-level E2E harness: spawns a program on a PTY, continuously emulates its output into a Screen, and exposes assertion helpers that mirror JS terminal test runners (#get_by_text, get_cursor, snapshot) — with auto-retrying waits so tests don't sprinkle fixed sleeps.

Prefer the block form which guarantees cleanup:

Termisu::Testing.terminal("./bin/app", cols: 100, rows: 50) do |t|
  t.get_by_text("Ready").should be_true
  t.write("q")
end

Defined in:

termisu/testing/terminal.cr

Constant Summary

KEYS = { up: "\e[A", down: "\e[B", right: "\e[C", left: "\e[D", enter: "\r", esc: "\e", tab: "\t", backspace: "\u007F", space: " ", home: "\e[H", end: "\e[F", page_up: "\e[5~", page_down: "\e[6~", }

Byte sequences for common special keys (xterm/standard).

Constructors

• .new(program : String, args : Array(String) = [] of String, *, cols : Int32 = 100, rows : Int32 = 50, env : Hash(String, String) | Nil = nil)

Class Method Summary

• .terminal(program : String, args : Array(String) = [] of String, *, cols : Int32 = 100, rows : Int32 = 50, env : Hash(String, String) | Nil = nil, &)

  Spawns program, yields the harness, and always cleans up.

Instance Method Summary

• #close : Nil

  Stops the program and releases the PTY.

• #cols : Int32
• #ctrl(char : Char) : Nil

  Sends a Ctrl+ combination (e.g.

• #cursor : Tuple(Int32, Int32)

  Cursor position once the screen settles.

• #cursor_visible? : Bool

  Whether the cursor is currently visible (waits for the screen to settle).

• #exited? : Bool

  Whether the program has exited.

• #find(pattern : String | Regex) : Tuple(Int32, Int32) | Nil

  Current {x, y} of pattern right now, without waiting (returns nil if absent).

• #get_by_text(pattern : String | Regex, timeout : Time::Span = 3.seconds) : Bool

  Waits (up to timeout) until pattern appears on screen.

• #key(name : Symbol) : Nil

  Sends a named special key (see KEYS).

• #key_press(char : Char) : Nil

  Sends a single character.

• #locate(pattern : String | Regex, timeout : Time::Span = 3.seconds) : Tuple(Int32, Int32) | Nil

  Waits for pattern to appear, then returns its first {x, y} (or nil).

• #resize(cols : Int32, rows : Int32) : Nil

  Resizes the terminal (delivers SIGWINCH to the child).

• #row(y : Int32) : String

  The text of screen row y once the screen settles.

• #rows : Int32
• #screen : Screen
• #snapshot(mask : Array(Regex) = [] of Regex) : String

  Styled snapshot of the rendered screen (glyph grid + per-cell fg/bg/attr).

• #wait_stable(quiet_for : Time::Span = 80.milliseconds, timeout : Time::Span = 3.seconds) : Bool

  Blocks until the program has produced no new output for quiet_for (render-stable), or timeout elapses.

• #wait_until(timeout : Time::Span = 3.seconds, &) : Bool

  Blocks until block returns true, or timeout elapses.

• #write(data : String) : Nil

  Sends raw text to the program.

Constructor Detail

Class Method Detail

Instance Method Detail