Modulesandwich-0.3.1.0Haskell2010

Test.Sandwich.Formatters.Socket

The socket formatter creates a Unix domain socket that accepts interactive, line-based commands to query the live test tree state.

This is a "secondary formatter," i.e. one that can run in the background while a "primary formatter" (such as the TerminalUI or Print formatters) runs in the foreground.

The socket server stays alive for the entire duration of the test executable, so you can query it even after tests have completed (until finalizeFormatter cleans it up).

Connect with socat - UNIX-CONNECT:<run-root>/socket.sock and type help to see available commands.

1 type
1 value

Packagesandwich-0.3.1.0
Exports2
LanguageHaskell2010
LicenceBSD-3-Clause
SourceSocket.hs

valuedefaultSocketFormatter :: IO SocketFormatter

datadata SocketFormatter

Constructors

SocketFormatter
- socketFormatterPath :: Maybe FilePath
  Socket path. Nothing = <run-root>/socket.sock
- socketFormatterServerAsync :: IORef (Maybe (Async ()))
  Internal: handle to the running server thread, used for cleanup.
- socketFormatterLogBroadcast :: TChan (Int, String, LogEntry)
  Broadcast channel for streaming logs to connected clients.
- socketFormatterEventBroadcast :: TChan NodeEvent
  Broadcast channel for streaming node lifecycle events to connected clients.

Instances2Show, Formatter

Show SocketFormatterDefined in sandwich-0.3.1.0 · Test.Sandwich.Formatters.Socket
Formatter SocketFormatterDefined in sandwich-0.3.1.0 · Test.Sandwich.Formatters.Socket