Ribosome.Test.SocketTmux

Socket tmux tests start a tmux server, then run a regular Neovim session in a pane and connect to Neovim over a socket.

Documentation

type TmuxHandlerStack = SocketHandlerEffects ++ (Reader (CustomConfig ()) ': (Reader NvimSocket ': TmuxStack))

The stack of internal effects for socket tmux tests.

type SocketTmuxWith r = TestEffects ++ (r ++ TmuxHandlerStack)

The socket tmux test stack with additional effects.

type SocketTmux = SocketTmuxWith '[]

The socket tmux test stack with no additional effects.

nvimCmdline :: Path Abs File -> Text

withSocketTmuxNvim :: Members [Test, Hedgehog IO, ChronosTime, Error Failure, Race, Embed IO] r => Members [NativeTmux, NativeCommandCodecE, Stop CodecError] r => InterpreterFor (Reader NvimSocket) r

Create a socket for Neovim to listen on and run a Reader with it.

runSocketTmuxTestConf :: HasCallStack => TmuxTestConfig -> Sem TmuxHandlerStack () -> UnitTest

Run the tmux test stack.

runSocketTmuxTest :: HasCallStack => Sem TmuxHandlerStack () -> UnitTest

Run the tmux test stack, using a pty to host tmux.

runSocketTmuxGuiTest :: HasCallStack => Sem TmuxHandlerStack () -> UnitTest

Run the tmux test stack, using a terminal to tmux tmux.

testPluginSocketTmuxConf

Arguments

:: forall r. HasCallStack

=> Members TmuxHandlerStack (r ++ TmuxHandlerStack)

=> TmuxTestConfig

Regular test config combined with tmux config

-> InterpretersFor r TmuxHandlerStack

Interpreter for custom effects

-> [RpcHandler (r ++ TmuxHandlerStack)]

RPC handlers

-> Sem (SocketTmuxWith r) ()

-> UnitTest

Run a plugin test against a Neovim process running in a fresh tmux session, connected over a socket.

testPluginSocketTmux

Arguments

:: forall r. HasCallStack

=> Members TmuxHandlerStack (r ++ TmuxHandlerStack)

=> InterpretersFor r TmuxHandlerStack

Interpreter for custom effects

-> [RpcHandler (r ++ TmuxHandlerStack)]

RPC handlers

-> Sem (SocketTmuxWith r) ()

-> UnitTest

Run a plugin test against a Neovim process running in a fresh tmux session, connected over a socket.

testHandlersSocketTmux

Arguments

:: HasCallStack

=> [RpcHandler TmuxHandlerStack]

RPC handlers

-> Sem SocketTmux ()

-> UnitTest

Run a plugin test against a Neovim process running in a fresh tmux session, connected over a socket.

testSocketTmux :: HasCallStack => Sem SocketTmux () -> UnitTest

Run a plugin test against a Neovim process running in a fresh tmux session, connected over a socket.

testPluginSocketTmuxGui

Arguments

:: forall r. HasCallStack

=> Members TmuxHandlerStack (r ++ TmuxHandlerStack)

=> InterpretersFor r TmuxHandlerStack

Interpreter for custom effects

-> [RpcHandler (r ++ TmuxHandlerStack)]

RPC handlers

-> Sem (SocketTmuxWith r) ()

-> UnitTest

Run a plugin test against a Neovim process running in a fresh tmux session displayed in a terminal, connected over a socket.

testHandlersSocketTmuxGui

Arguments

:: HasCallStack

=> [RpcHandler TmuxHandlerStack]

RPC handlers

-> Sem SocketTmux ()

-> UnitTest

Run a plugin test against a Neovim process running in a fresh tmux session displayed in a terminal, connected over a socket.

testSocketTmuxGui :: HasCallStack => Sem SocketTmux () -> UnitTest

Run a plugin test against a Neovim process running in a fresh tmux session displayed in a terminal, connected over a socket.