tuispec-0.3.1.0: src/TuiSpec.hs

{- |
Module      : TuiSpec
Description : Public API for black-box TUI testing over PTY.

This is the primary entry point for test programs. Import this module
to get the full testing DSL:

@
import TuiSpec

main :: IO ()
main =
  defaultMain $ testGroup "demo"
    [ tuiTest defaultRunOptions "my test" $ \\tui -> do
        launch tui (app "my-app" [])
        waitForText tui (Exact "Ready")
        press tui Enter
    ]
@

For advanced integrations (JSON-RPC server, session management), import
"TuiSpec.Runner" and "TuiSpec.Types" directly.
-}
module TuiSpec (
    -- * Test entry point
    tuiTest,
    withTuiSession,

    -- * Actions
    launch,
    launchAndWait,
    launchAndWaitWith,
    press,
    pressCombo,
    click,
    clickWith,
    clickSelector,
    clickSelectorWith,
    typeText,
    sendLine,
    loadEnvFile,
    prependPathEntry,

    -- * Numbered choices
    selectNumberedChoice,
    selectNumberedChoiceWith,
    trySelectNumberedChoice,
    trySelectNumberedChoiceWith,
    parseNumberedChoices,
    NumberedChoice (..),
    ChoiceSelectionError (..),

    -- * Waits and assertions
    waitFor,
    waitForStable,
    waitForText,
    waitForSelector,
    expectVisible,
    expectNotVisible,

    -- * Snapshots
    expectSnapshot,
    dumpView,
    artifactRoot,
    artifactFile,
    writeArtifactFile,
    dumpFailureBundle,
    withFailureBundle,
    writeRecording,
    currentView,
    currentViewRect,

    -- * Steps
    step,

    -- * Rendering
    renderAnsiViewportText,
    renderAnsiSnapshotTextFile,

    -- * Configuration types
    RunOptions (..),
    defaultRunOptions,
    defaultWaitOptions,
    defaultWaitOptionsFor,
    App (..),
    app,
    haskellApp,
    Key (..),
    Modifier (..),
    MouseButton (..),
    MouseEncoding (..),
    ClickOptions (..),
    defaultClickOptions,
    Selector (..),
    Rect (..),
    SnapshotName (..),
    AmbiguityMode (..),
    WaitOptions (..),
    StepOptions (..),
    defaultStepOptions,
    Viewport (..),

    -- * Runtime handle (opaque)
    Tui,
) where

import TuiSpec.Choice
import TuiSpec.Render (renderAnsiSnapshotTextFile)
import TuiSpec.Runner
import TuiSpec.Types