Source file test_echo.ml

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
open Core
open Async
open Vcaml
open Vcaml_test_helpers

let run_echo_tests ~f ~message =
  let tests =
    [ ( "native_echo"
      , fun ~(here : [%call_pos]) client ->
          Command.exec ~here client "echo" ~args:[ [%string "'%{message}'"] ] )
    ; ( "api_out_write"
      , fun ~(here : [%call_pos]) client -> Nvim.out_writeln ~here client message )
    ; ( "api_echo"
      , fun ~(here : [%call_pos]) client ->
          Nvim.echo
            ~here
            client
            [ { text = message; hl_group = None } ]
            ~add_to_history:false )
    ]
  in
  Deferred.List.map tests ~how:`Sequential ~f:(fun (name, echo) ->
    let%map output = f ~echo in
    output, name)
  >>| String.Map.of_alist_multi
  >>| Map.iteri ~f:(fun ~key:output ~data:names ->
    let names = String.concat names ~sep:", " in
    print_endline [%string "Output for: %{names}\n%{output}\n"])
;;

let%expect_test "Show echoed content in command line" =
  let%bind () =
    run_echo_tests ~message:"Hello, world!" ~f:(fun ~echo ->
      with_ui_client (fun client ui ->
        let open Deferred.Or_error.Let_syntax in
        let%bind () = echo client in
        get_screen_contents ui))
  in
  [%expect
    {|
    Output for: native_echo, api_out_write, api_echo
    ╭────────────────────────────────────────────────────────────────────────────────╮
    │                                                                                │
    │~                                                                               │
    │~                                                                               │
    │~                                                                               │
    │~                                                                               │
    │~                                                                               │
    │~                                                                               │
    │~                                                                               │
    │~                                                                               │
    │~                                                                               │
    │~                                                                               │
    │~                                                                               │
    │~                                                                               │
    │~                                                                               │
    │~                                                                               │
    │~                                                                               │
    │~                                                                               │
    │~                                                                               │
    │~                                                                               │
    │~                                                                               │
    │~                                                                               │
    │~                                                                               │
    │~                                                                               │
    │~                                                                               │
    │~                                                                               │
    │~                                                                               │
    │~                                                                               │
    │~                                                                               │
    │[No Name]                                                     0,0-1          All│
    │Hello, world!                                                                   │
    ╰────────────────────────────────────────────────────────────────────────────────╯
    |}];
  return ()
;;

let%expect_test "Test sending errors" =
  let%bind () =
    with_ui_client (fun client ui ->
      let open Deferred.Or_error.Let_syntax in
      let%bind () = Nvim.err_writeln client "This error should be displayed on-screen." in
      let%bind screen = get_screen_contents ui in
      print_endline screen;
      let%bind () = Nvim.err_writeln client "Then this one should replace it." in
      let%bind screen = get_screen_contents ui in
      print_endline screen;
      return ())
  in
  [%expect
    {|
    ╭────────────────────────────────────────────────────────────────────────────────╮
    │                                                                                │
    │~                                                                               │
    │~                                                                               │
    │~                                                                               │
    │~                                                                               │
    │~                                                                               │
    │~                                                                               │
    │~                                                                               │
    │~                                                                               │
    │~                                                                               │
    │~                                                                               │
    │~                                                                               │
    │~                                                                               │
    │~                                                                               │
    │~                                                                               │
    │~                                                                               │
    │~                                                                               │
    │~                                                                               │
    │~                                                                               │
    │~                                                                               │
    │~                                                                               │
    │~                                                                               │
    │~                                                                               │
    │~                                                                               │
    │~                                                                               │
    │~                                                                               │
    │~                                                                               │
    │~                                                                               │
    │[No Name]                                                     0,0-1          All│
    │This error should be displayed on-screen.                                       │
    ╰────────────────────────────────────────────────────────────────────────────────╯
    ╭────────────────────────────────────────────────────────────────────────────────╮
    │                                                                                │
    │~                                                                               │
    │~                                                                               │
    │~                                                                               │
    │~                                                                               │
    │~                                                                               │
    │~                                                                               │
    │~                                                                               │
    │~                                                                               │
    │~                                                                               │
    │~                                                                               │
    │~                                                                               │
    │~                                                                               │
    │~                                                                               │
    │~                                                                               │
    │~                                                                               │
    │~                                                                               │
    │~                                                                               │
    │~                                                                               │
    │~                                                                               │
    │~                                                                               │
    │~                                                                               │
    │~                                                                               │
    │~                                                                               │
    │~                                                                               │
    │~                                                                               │
    │~                                                                               │
    │~                                                                               │
    │[No Name]                                                     0,0-1          All│
    │Then this one should replace it.                                                │
    ╰────────────────────────────────────────────────────────────────────────────────╯
    |}];
  return ()
;;

let%expect_test "Naively calling [echo] from inside [rpcrequest] fails" =
  let%bind () =
    run_echo_tests
      ~message:"If this message appears we should get rid of [echo_in_rpcrequest]"
      ~f:(fun ~echo ->
        let open Deferred.Or_error.Let_syntax in
        let rpc ~run_in_background:_ ~client ui =
          let%bind () = echo client in
          get_screen_contents ui
        in
        with_ui_client (fun client ui ->
          let () =
            Ocaml_from_nvim.register_request_blocking
              (Connected client)
              ~name:"rpc"
              ~type_:Ocaml_from_nvim.Blocking.(return String)
              ~f:(rpc ui)
          in
          let channel = Client.channel client in
          Nvim.eval_viml_expression
            client
            (sprintf "rpcrequest(%d, 'rpc')" channel)
            ~result_type:String))
  in
  [%expect
    {|
    Output for: native_echo, api_out_write, api_echo
    ╭────────────────────────────────────────────────────────────────────────────────╮
    │                                                                                │
    │~                                                                               │
    │~                                                                               │
    │~                                                                               │
    │~                                                                               │
    │~                                                                               │
    │~                                                                               │
    │~                                                                               │
    │~                                                                               │
    │~                                                                               │
    │~                                                                               │
    │~                                                                               │
    │~                                                                               │
    │~                                                                               │
    │~                                                                               │
    │~                                                                               │
    │~                                                                               │
    │~                                                                               │
    │~                                                                               │
    │~                                                                               │
    │~                                                                               │
    │~                                                                               │
    │~                                                                               │
    │~                                                                               │
    │~                                                                               │
    │~                                                                               │
    │~                                                                               │
    │~                                                                               │
    │[No Name]                                                     0,0-1          All│
    │                                                                                │
    ╰────────────────────────────────────────────────────────────────────────────────╯
    |}];
  return ()
;;

let%expect_test "[echo_in_rpcrequest] hack" =
  let%bind () =
    let open Deferred.Or_error.Let_syntax in
    let rpc ~run_in_background:_ ~client ui =
      let%bind () =
        Nvim.echo_in_rpcrequest client "Hello, world! 'Quotes' \"work\" too."
      in
      let%bind screen = get_screen_contents ui in
      print_endline screen;
      return ()
    in
    with_ui_client (fun client ui ->
      let () =
        Ocaml_from_nvim.register_request_blocking
          (Connected client)
          ~name:"rpc"
          ~type_:Ocaml_from_nvim.Blocking.(return Nil)
          ~f:(rpc ui)
      in
      let channel = Client.channel client in
      Nvim.exec_viml client [%string "call rpcrequest(%{channel#Int}, 'rpc')"])
  in
  [%expect
    {|
    ╭────────────────────────────────────────────────────────────────────────────────╮
    │                                                                                │
    │~                                                                               │
    │~                                                                               │
    │~                                                                               │
    │~                                                                               │
    │~                                                                               │
    │~                                                                               │
    │~                                                                               │
    │~                                                                               │
    │~                                                                               │
    │~                                                                               │
    │~                                                                               │
    │~                                                                               │
    │~                                                                               │
    │~                                                                               │
    │~                                                                               │
    │~                                                                               │
    │~                                                                               │
    │~                                                                               │
    │~                                                                               │
    │~                                                                               │
    │~                                                                               │
    │~                                                                               │
    │~                                                                               │
    │~                                                                               │
    │~                                                                               │
    │~                                                                               │
    │~                                                                               │
    │[No Name]                                                     0,0-1          All│
    │Hello, world! 'Quotes' "work" too.                                              │
    ╰────────────────────────────────────────────────────────────────────────────────╯
    |}];
  return ()
;;