Vcaml_test_helpers (p.vcaml.v0.16.0.doc.vcaml.test_helpers.Vcaml_test

Sourceval neovim_path : string

val with_client : 
  ?args:string list ->
  ?env:([> `Tmpdir of string ] -> Core_unix.env) ->
  ?links:(string * [ `In_path_as | `In_temp_as ] * string) list ->
  ?time_source:Async.Time_source.t ->
  ?on_error:[ `Raise | `Call of Vcaml.Vcaml_error.t -> unit ] ->
  ?before_connecting:([ `not_connected ] Vcaml.Client.t -> unit) ->
  ([ `connected ] Vcaml.Client.t -> 'a Async.Deferred.Or_error.t) ->
  'a Async.Deferred.t

Source

val simple : 
  Core.Source_code_position.t ->
  'a Vcaml.Api_call.Or_error.t ->
  ('a -> Async.Sexp.t) ->
  unit Async.Deferred.t

Sourceval print_s : ?mach:unit -> Async.Sexp.t -> unit

Sourcemodule Test_ui : sig ... end

Source

val get_screen_contents : 
  Core.Source_code_position.t ->
  Test_ui.t ->
  string Async.Deferred.Or_error.t

Source

val wait_until_text : 
  ?timeout:Core.Time_ns.Span.t ->
  Core.Source_code_position.t ->
  Test_ui.t ->
  f:(string -> bool) ->
  string Async.Deferred.Or_error.t

Source

val with_ui_client : 
  ?width:int ->
  ?height:int ->
  ?time_source:Async.Time_source.t ->
  ?on_error:[ `Raise | `Call of Vcaml.Vcaml_error.t -> unit ] ->
  ?before_connecting:([ `not_connected ] Vcaml.Client.t -> unit) ->
  ([ `connected ] Vcaml.Client.t -> Test_ui.t -> 'a Async.Deferred.Or_error.t) ->
  'a Async.Deferred.t

Source

val socket_client : 
  ?time_source:Async.Time_source.t ->
  ?on_error:[ `Raise | `Call of Vcaml.Vcaml_error.t -> unit ] ->
  ?before_connecting:([ `not_connected ] Vcaml.Client.t -> unit) ->
  string ->
  [ `connected ] Vcaml.Client.t Async.Deferred.Or_error.t

Sourcemodule For_debugging : sig ... end

If a test is behaving in a way that is especially surprising, use this module to attach it to an Neovim instance you are running so you can observe the effect. Note that the client detaching at the end of the test may be too rapid for you to view the effects - you may want to add a delay before returning.