Safe Haskell	None
Language	Haskell2010

Ribosome.Test.Embed

Synopsis

type Runner m = forall a. TestConfig -> m a -> m a
newtype Vars = Vars (Map Text Object)
varsUnion :: Vars -> Vars -> Vars
varsFromList :: [(Text, Object)] -> Vars
data TestConfig = TestConfig {
- tcPluginName :: Text
- tcExtraRtp :: Text
- tcLogPath :: FilePath
- tcTimeout :: Word
- tcCmdline :: Maybe [Text]
- tcCmdArgs :: [Text]
- tcVariables :: Vars
}
defaultTestConfigWith :: Text -> Vars -> TestConfig
defaultTestConfig :: Text -> TestConfig
setVars :: forall m e. NvimE e m => Vars -> m ()
setupPluginEnv :: MonadIO m => NvimE e m => TestConfig -> m ()
killPid :: Integral a => a -> IO ()
killProcess :: Process i o e -> IO ()
testNvimProcessConfig :: TestConfig -> ProcessConfig Handle Handle ()
startHandlers :: MonadIO m => Handle -> Handle -> TestConfig -> Config RPCConfig -> m (IO ())
startStdioHandlers :: MonadIO m => NvimProc -> TestConfig -> Config RPCConfig -> m (IO ())
runNeovimThunk :: Config e -> Neovim e a -> IO a
type NvimProc = Process Handle Handle ()
waitQuit :: NvimProc -> IO (Maybe ExitCode)
quitNvim :: Config e -> NvimProc -> IO ()
shutdownNvim :: Config e -> NvimProc -> IO () -> IO ()
runTest :: MonadIO m => MonadFail m => ReportError e => RpcHandler e env n => MonadBaseControl IO m => TestConfig -> Config env -> n a -> m a
runEmbeddedNvim :: MonadIO m => MonadFail m => MonadBaseControl IO m => RpcHandler e env n => ReportError e => TestConfig -> env -> n a -> NvimProc -> m a
withProcessTerm :: MonadIO m => MonadBaseControl IO m => ProcessConfig stdin stdout stderr -> (Process stdin stdout stderr -> m a) -> m a
runEmbedded :: MonadIO m => MonadFail m => MonadBaseControl IO m => RpcHandler e env n => ReportError e => TestConfig -> env -> n a -> m a
unsafeEmbeddedSpec :: MonadIO m => MonadFail m => MonadBaseControl IO m => RpcHandler e env n => ReportError e => Runner n -> TestConfig -> env -> n a -> m a
unsafeEmbeddedSpecR :: MonadIO m => MonadFail m => ReportError e => MonadBaseControl IO m => RpcHandler e (Ribosome env) n => Runner n -> TestConfig -> env -> n a -> m a
runPlugin :: MonadIO m => MonadBaseControl IO m => Handle -> Handle -> [Neovim () NeovimPlugin] -> Config c -> m (MVar StateTransition)
inTestT :: forall n m a. TestT n a -> (forall x. n x -> m x) -> TestT m a
integrationSpec :: forall n m e env a. NvimE e n => MonadIO n => MonadIO m => MonadFail m => ReportError e => RpcHandler e env n => MonadBaseControl IO m => TestConfig -> Plugin env -> TestT n a -> TestT m a
integrationSpecDef :: NvimE e n => MonadIO m => MonadIO n => MonadFail m => ReportError e => RpcHandler e env n => MonadBaseControl IO m => Plugin env -> TestT n a -> TestT m a

Documentation

type Runner m = forall a. TestConfig -> m a -> m a Source #

newtype Vars Source #

Constructors

Vars (Map Text Object)

Instances

Instances details

Eq Vars Source #
Instance details Defined in Ribosome.Test.Embed Methods (==) :: Vars -> Vars -> Bool # (/=) :: Vars -> Vars -> Bool #
Show Vars Source #
Instance details Defined in Ribosome.Test.Embed Methods showsPrec :: Int -> Vars -> ShowS # show :: Vars -> String # showList :: [Vars] -> ShowS #
Semigroup Vars Source #
Instance details Defined in Ribosome.Test.Embed Methods (<>) :: Vars -> Vars -> Vars # sconcat :: NonEmpty Vars -> Vars # stimes :: Integral b => b -> Vars -> Vars #
Monoid Vars Source #
Instance details Defined in Ribosome.Test.Embed Methods mempty :: Vars # mappend :: Vars -> Vars -> Vars # mconcat :: [Vars] -> Vars #
Default Vars Source #
Instance details Defined in Ribosome.Test.Embed Methods def :: Vars #

varsUnion :: Vars -> Vars -> Vars Source #

left biased

varsFromList :: [(Text, Object)] -> Vars Source #

data TestConfig Source #

Constructors

TestConfig
Fields tcPluginName :: Text tcExtraRtp :: Text tcLogPath :: FilePath tcTimeout :: Word tcCmdline :: Maybe [Text] tcCmdArgs :: [Text] tcVariables :: Vars

Instances

Instances details

Default TestConfig Source #
Instance details Defined in Ribosome.Test.Embed Methods def :: TestConfig #

defaultTestConfigWith :: Text -> Vars -> TestConfig Source #

defaultTestConfig :: Text -> TestConfig Source #

setVars :: forall m e. NvimE e m => Vars -> m () Source #

setupPluginEnv :: MonadIO m => NvimE e m => TestConfig -> m () Source #

killPid :: Integral a => a -> IO () Source #

killProcess :: Process i o e -> IO () Source #

testNvimProcessConfig :: TestConfig -> ProcessConfig Handle Handle () Source #

startHandlers :: MonadIO m => Handle -> Handle -> TestConfig -> Config RPCConfig -> m (IO ()) Source #

startStdioHandlers :: MonadIO m => NvimProc -> TestConfig -> Config RPCConfig -> m (IO ()) Source #

runNeovimThunk :: Config e -> Neovim e a -> IO a Source #

type NvimProc = Process Handle Handle () Source #

waitQuit :: NvimProc -> IO (Maybe ExitCode) Source #

quitNvim :: Config e -> NvimProc -> IO () Source #

shutdownNvim :: Config e -> NvimProc -> IO () -> IO () Source #

runTest :: MonadIO m => MonadFail m => ReportError e => RpcHandler e env n => MonadBaseControl IO m => TestConfig -> Config env -> n a -> m a Source #

runEmbeddedNvim :: MonadIO m => MonadFail m => MonadBaseControl IO m => RpcHandler e env n => ReportError e => TestConfig -> env -> n a -> NvimProc -> m a Source #

withProcessTerm :: MonadIO m => MonadBaseControl IO m => ProcessConfig stdin stdout stderr -> (Process stdin stdout stderr -> m a) -> m a Source #

runEmbedded :: MonadIO m => MonadFail m => MonadBaseControl IO m => RpcHandler e env n => ReportError e => TestConfig -> env -> n a -> m a Source #

unsafeEmbeddedSpec :: MonadIO m => MonadFail m => MonadBaseControl IO m => RpcHandler e env n => ReportError e => Runner n -> TestConfig -> env -> n a -> m a Source #

unsafeEmbeddedSpecR :: MonadIO m => MonadFail m => ReportError e => MonadBaseControl IO m => RpcHandler e (Ribosome env) n => Runner n -> TestConfig -> env -> n a -> m a Source #

runPlugin :: MonadIO m => MonadBaseControl IO m => Handle -> Handle -> [Neovim () NeovimPlugin] -> Config c -> m (MVar StateTransition) Source #

inTestT :: forall n m a. TestT n a -> (forall x. n x -> m x) -> TestT m a Source #

integrationSpec :: forall n m e env a. NvimE e n => MonadIO n => MonadIO m => MonadFail m => ReportError e => RpcHandler e env n => MonadBaseControl IO m => TestConfig -> Plugin env -> TestT n a -> TestT m a Source #

integrationSpecDef :: NvimE e n => MonadIO m => MonadIO n => MonadFail m => ReportError e => RpcHandler e env n => MonadBaseControl IO m => Plugin env -> TestT n a -> TestT m a Source #