blob: da263f455876e2b14e43958bd01a21b2677a8fa0 [file] [log] [blame]
Bram Moolenaarc6df10e2017-07-29 20:15:08 +02001" Tests for the terminal window.
Bram Moolenaar1112c0f2020-07-01 21:53:50 +02002" This is split in two, because it can take a lot of time.
Bram Moolenaar18aa13d2020-07-11 13:09:36 +02003" See test_terminal2.vim and test_terminal3.vim for further tests.
Bram Moolenaarc6df10e2017-07-29 20:15:08 +02004
Bram Moolenaarb46fecd2019-06-15 17:58:09 +02005source check.vim
6CheckFeature terminal
Bram Moolenaarc6df10e2017-07-29 20:15:08 +02007
8source shared.vim
Bram Moolenaar25cdd9c2018-03-10 20:28:12 +01009source screendump.vim
Bram Moolenaar91689ea2020-05-11 22:04:53 +020010source mouse.vim
Bram Moolenaar1112c0f2020-07-01 21:53:50 +020011source term_util.vim
Bram Moolenaarc6df10e2017-07-29 20:15:08 +020012
Bram Moolenaarb81bc772017-08-11 22:45:01 +020013let s:python = PythonProg()
Bram Moolenaarddd33082019-06-03 23:07:25 +020014let $PROMPT_COMMAND=''
Bram Moolenaarb81bc772017-08-11 22:45:01 +020015
Bram Moolenaar20e6cd02017-08-01 20:25:22 +020016func Test_terminal_basic()
ichizokae1bd872022-01-20 14:57:29 +000017 call test_override('vterm_title', 1)
Bram Moolenaar606cb8b2018-05-03 20:40:20 +020018 au TerminalOpen * let b:done = 'yes'
Bram Moolenaar05aafed2017-08-11 19:12:11 +020019 let buf = Run_shell_in_terminal({})
Bram Moolenaarb00fdf62017-09-21 22:16:21 +020020
Bram Moolenaar2bb7b6b2017-08-13 20:58:33 +020021 call assert_equal('t', mode())
Bram Moolenaarb00fdf62017-09-21 22:16:21 +020022 call assert_equal('yes', b:done)
Bram Moolenaar2bb7b6b2017-08-13 20:58:33 +020023 call assert_match('%aR[^\n]*running]', execute('ls'))
Bram Moolenaar0751f512018-03-29 16:37:16 +020024 call assert_match('%aR[^\n]*running]', execute('ls R'))
25 call assert_notmatch('%[^\n]*running]', execute('ls F'))
26 call assert_notmatch('%[^\n]*running]', execute('ls ?'))
Bram Moolenaar004a6782020-04-11 17:09:31 +020027 call assert_fails('set modifiable', 'E946:')
Bram Moolenaar2bb7b6b2017-08-13 20:58:33 +020028
Bram Moolenaar7a39dd72019-06-23 00:50:15 +020029 call StopShellInTerminal(buf)
Bram Moolenaar2bb7b6b2017-08-13 20:58:33 +020030 call assert_equal('n', mode())
31 call assert_match('%aF[^\n]*finished]', execute('ls'))
Bram Moolenaar0751f512018-03-29 16:37:16 +020032 call assert_match('%aF[^\n]*finished]', execute('ls F'))
33 call assert_notmatch('%[^\n]*finished]', execute('ls R'))
34 call assert_notmatch('%[^\n]*finished]', execute('ls ?'))
Bram Moolenaar20e6cd02017-08-01 20:25:22 +020035
Bram Moolenaar94053a52017-08-01 21:44:33 +020036 " closing window wipes out the terminal buffer a with finished job
37 close
38 call assert_equal("", bufname(buf))
39
Bram Moolenaar606cb8b2018-05-03 20:40:20 +020040 au! TerminalOpen
ichizokae1bd872022-01-20 14:57:29 +000041 call test_override('ALL', 0)
Bram Moolenaar20e6cd02017-08-01 20:25:22 +020042 unlet g:job
43endfunc
44
Bram Moolenaar00806bc2020-11-05 19:36:38 +010045func Test_terminal_no_name()
46 let buf = Run_shell_in_terminal({})
47 call assert_match('^!', bufname(buf))
48 0file
49 call assert_equal("", bufname(buf))
50 call assert_match('\[No Name\]', execute('file'))
51 call StopShellInTerminal(buf)
Bram Moolenaar00806bc2020-11-05 19:36:38 +010052endfunc
53
Bram Moolenaar28ed4df2019-10-26 16:21:40 +020054func Test_terminal_TerminalWinOpen()
55 au TerminalWinOpen * let b:done = 'yes'
56 let buf = Run_shell_in_terminal({})
57 call assert_equal('yes', b:done)
58 call StopShellInTerminal(buf)
59 " closing window wipes out the terminal buffer with the finished job
60 close
61
62 if has("unix")
63 terminal ++hidden ++open sleep 1
64 sleep 1
65 call assert_fails("echo b:done", 'E121:')
66 endif
67
68 au! TerminalWinOpen
69endfunc
70
Bram Moolenaar20e6cd02017-08-01 20:25:22 +020071func Test_terminal_make_change()
Bram Moolenaar05aafed2017-08-11 19:12:11 +020072 let buf = Run_shell_in_terminal({})
Bram Moolenaar7a39dd72019-06-23 00:50:15 +020073 call StopShellInTerminal(buf)
Bram Moolenaar20e6cd02017-08-01 20:25:22 +020074
75 setlocal modifiable
76 exe "normal Axxx\<Esc>"
Bram Moolenaar28ee8922020-10-28 20:20:00 +010077 call assert_fails(buf . 'bwipe', 'E89:')
Bram Moolenaar20e6cd02017-08-01 20:25:22 +020078 undo
79
Bram Moolenaarc6df10e2017-07-29 20:15:08 +020080 exe buf . 'bwipe'
81 unlet g:job
82endfunc
83
Bram Moolenaar5b868a82019-02-25 06:11:53 +010084func Test_terminal_paste_register()
85 let @" = "text to paste"
86
87 let buf = Run_shell_in_terminal({})
88 " Wait for the shell to display a prompt
89 call WaitForAssert({-> assert_notequal('', term_getline(buf, 1))})
90
91 call feedkeys("echo \<C-W>\"\" \<C-W>\"=37 + 5\<CR>\<CR>", 'xt')
92 call WaitForAssert({-> assert_match("echo text to paste 42$", getline(1))})
Bram Moolenaar7ee80f72019-09-08 20:55:06 +020093 call WaitForAssert({-> assert_equal('text to paste 42', 2->getline())})
Bram Moolenaar5b868a82019-02-25 06:11:53 +010094
95 exe buf . 'bwipe!'
96 unlet g:job
97endfunc
98
Yee Cheng Chin42826332022-10-10 11:46:16 +010099func Test_terminal_unload_buffer()
100 let buf = Run_shell_in_terminal({})
101 call assert_fails(buf . 'bunload', 'E948:')
102 exe buf . 'bunload!'
103 call WaitForAssert({-> assert_equal('dead', job_status(g:job))})
104 call assert_equal("", bufname(buf))
105
106 unlet g:job
107endfunc
108
Bram Moolenaar94053a52017-08-01 21:44:33 +0200109func Test_terminal_wipe_buffer()
Bram Moolenaar05aafed2017-08-11 19:12:11 +0200110 let buf = Run_shell_in_terminal({})
Yee Cheng Chin15b314f2022-10-09 18:53:32 +0100111 call assert_fails(buf . 'bwipe', 'E948:')
Bram Moolenaareb44a682017-08-03 22:44:55 +0200112 exe buf . 'bwipe!'
Bram Moolenaar50182fa2018-04-28 21:34:40 +0200113 call WaitForAssert({-> assert_equal('dead', job_status(g:job))})
Bram Moolenaar94053a52017-08-01 21:44:33 +0200114 call assert_equal("", bufname(buf))
115
116 unlet g:job
117endfunc
118
Yee Cheng Chin15b314f2022-10-09 18:53:32 +0100119" Test that using ':confirm bwipe' on terminal works
120func Test_terminal_confirm_wipe_buffer()
121 CheckUnix
122 CheckNotGui
123 CheckFeature dialog_con
124 let buf = Run_shell_in_terminal({})
125 call assert_fails(buf . 'bwipe', 'E948:')
126 call feedkeys('n', 'L')
127 call assert_fails('confirm ' .. buf .. 'bwipe', 'E517:')
128 call assert_equal(buf, bufnr())
129 call assert_equal(1, &modified)
130 call feedkeys('y', 'L')
131 exe 'confirm ' .. buf .. 'bwipe'
132 call assert_notequal(buf, bufnr())
133 call WaitForAssert({-> assert_equal('dead', job_status(g:job))})
134 call assert_equal("", bufname(buf))
135
136 unlet g:job
137endfunc
138
139" Test that using :b! will hide the terminal
140func Test_terminal_goto_buffer()
141 let buf_mod = bufnr()
142 let buf_term = Run_shell_in_terminal({})
143 call assert_equal(buf_term, bufnr())
144 call assert_fails(buf_mod . 'b', 'E948:')
145 exe buf_mod . 'b!'
146 call assert_equal(buf_mod, bufnr())
147 call assert_equal('run', job_status(g:job))
148 call assert_notequal('', bufname(buf_term))
149 exec buf_mod .. 'bwipe!'
150 exec buf_term .. 'bwipe!'
151
152 unlet g:job
153endfunc
154
155" Test that using ':confirm :b' will kill terminal
156func Test_terminal_confirm_goto_buffer()
157 CheckUnix
158 CheckNotGui
159 CheckFeature dialog_con
160 let buf_mod = bufnr()
161 let buf_term = Run_shell_in_terminal({})
162 call feedkeys('n', 'L')
163 exe 'confirm ' .. buf_mod .. 'b'
164 call assert_equal(buf_term, bufnr())
165 call feedkeys('y', 'L')
166 exec 'confirm ' .. buf_mod .. 'b'
167 call assert_equal(buf_mod, bufnr())
168 call WaitForAssert({-> assert_equal('dead', job_status(g:job))})
169 call assert_equal("", bufname(buf_term))
170 exec buf_mod .. 'bwipe!'
171
172 unlet g:job
173endfunc
174
175" Test that using :close! will hide the terminal
176func Test_terminal_close_win()
177 let buf = Run_shell_in_terminal({})
178 call assert_equal(buf, bufnr())
179 call assert_fails('close', 'E948:')
180 close!
181 call assert_notequal(buf, bufnr())
182 call assert_equal('run', job_status(g:job))
183 call assert_notequal('', bufname(buf))
184 exec buf .. 'bwipe!'
185
186 unlet g:job
187endfunc
188
189" Test that using ':confirm close' will kill terminal
190func Test_terminal_confirm_close_win()
191 CheckUnix
192 CheckNotGui
193 CheckFeature dialog_con
194 let buf = Run_shell_in_terminal({})
195 call feedkeys('n', 'L')
196 confirm close
197 call assert_equal(buf, bufnr())
198 call feedkeys('y', 'L')
199 confirm close
200 call assert_notequal(buf, bufnr())
201 call WaitForAssert({-> assert_equal('dead', job_status(g:job))})
202 call assert_equal("", bufname(buf))
203
204 unlet g:job
205endfunc
206
207" Test that using :quit! will kill the terminal
208func Test_terminal_quit()
209 let buf = Run_shell_in_terminal({})
210 call assert_equal(buf, bufnr())
211 call assert_fails('quit', 'E948:')
212 quit!
213 call assert_notequal(buf, bufnr())
214 call WaitForAssert({-> assert_equal('dead', job_status(g:job))})
Yee Cheng Chin42826332022-10-10 11:46:16 +0100215 call assert_equal("", bufname(buf))
Yee Cheng Chin15b314f2022-10-09 18:53:32 +0100216
217 unlet g:job
218endfunc
219
220" Test that using ':confirm quit' will kill terminal
221func Test_terminal_confirm_quit()
222 CheckUnix
223 CheckNotGui
224 CheckFeature dialog_con
225 let buf = Run_shell_in_terminal({})
226 call feedkeys('n', 'L')
227 confirm quit
228 call assert_equal(buf, bufnr())
229 call feedkeys('y', 'L')
230 confirm quit
231 call assert_notequal(buf, bufnr())
232 call WaitForAssert({-> assert_equal('dead', job_status(g:job))})
233
234 unlet g:job
235endfunc
236
237" Test :q or :next
238
Bram Moolenaar8adb0d02017-09-17 19:08:02 +0200239func Test_terminal_split_quit()
240 let buf = Run_shell_in_terminal({})
Bram Moolenaar8adb0d02017-09-17 19:08:02 +0200241 split
242 quit!
Bram Moolenaar6a2c5a72020-04-08 21:50:25 +0200243 call TermWait(buf)
Bram Moolenaar8adb0d02017-09-17 19:08:02 +0200244 sleep 50m
245 call assert_equal('run', job_status(g:job))
246
247 quit!
Bram Moolenaar50182fa2018-04-28 21:34:40 +0200248 call WaitForAssert({-> assert_equal('dead', job_status(g:job))})
Bram Moolenaar8adb0d02017-09-17 19:08:02 +0200249
Yee Cheng Chin42826332022-10-10 11:46:16 +0100250 call assert_equal("", bufname(buf))
Bram Moolenaar8adb0d02017-09-17 19:08:02 +0200251 unlet g:job
252endfunc
253
Bram Moolenaarc9f8b842020-11-24 19:36:16 +0100254func Test_terminal_hide_buffer_job_running()
Bram Moolenaar05aafed2017-08-11 19:12:11 +0200255 let buf = Run_shell_in_terminal({})
Bram Moolenaar97a80e42017-08-30 13:31:49 +0200256 setlocal bufhidden=hide
Bram Moolenaar94053a52017-08-01 21:44:33 +0200257 quit
258 for nr in range(1, winnr('$'))
259 call assert_notequal(winbufnr(nr), buf)
260 endfor
261 call assert_true(bufloaded(buf))
262 call assert_true(buflisted(buf))
263
264 exe 'split ' . buf . 'buf'
Bram Moolenaar7a39dd72019-06-23 00:50:15 +0200265 call StopShellInTerminal(buf)
Bram Moolenaar94053a52017-08-01 21:44:33 +0200266 exe buf . 'bwipe'
267
268 unlet g:job
269endfunc
270
Bram Moolenaarc9f8b842020-11-24 19:36:16 +0100271func Test_terminal_hide_buffer_job_finished()
272 term echo hello
273 let buf = bufnr()
Bram Moolenaarc9f8b842020-11-24 19:36:16 +0100274 call WaitForAssert({-> assert_equal('finished', term_getstatus(buf))})
Yee Cheng Chin42826332022-10-10 11:46:16 +0100275
Bram Moolenaarc9f8b842020-11-24 19:36:16 +0100276 call assert_true(bufloaded(buf))
277 call assert_true(buflisted(buf))
Yee Cheng Chin42826332022-10-10 11:46:16 +0100278
279 " Test :hide
280 hide
281 call assert_true(bufloaded(buf))
282 call assert_true(buflisted(buf))
283 split
284 exe buf .. 'buf'
285 call assert_equal(buf, bufnr())
286
287 " Test bufhidden, which exercises a different code path
288 setlocal bufhidden=hide
Bram Moolenaarc9f8b842020-11-24 19:36:16 +0100289 edit Xasdfasdf
290 call assert_true(bufloaded(buf))
291 call assert_true(buflisted(buf))
292 exe buf .. 'buf'
293 call assert_equal(buf, bufnr())
294 setlocal bufhidden=
Yee Cheng Chin42826332022-10-10 11:46:16 +0100295
Bram Moolenaarc9f8b842020-11-24 19:36:16 +0100296 edit Xasdfasdf
297 call assert_false(bufloaded(buf))
298 call assert_false(buflisted(buf))
299 bwipe Xasdfasdf
300endfunc
301
Bram Moolenaar3ad69532021-11-19 17:01:08 +0000302func Test_terminal_rename_buffer()
303 let cmd = Get_cat_123_cmd()
304 let buf = term_start(cmd, {'term_name': 'foo'})
305 call WaitForAssert({-> assert_equal('finished', term_getstatus(buf))})
306 call assert_equal('foo', bufname())
307 call assert_match('foo.*finished', execute('ls'))
308 file bar
309 call assert_equal('bar', bufname())
310 call assert_match('bar.*finished', execute('ls'))
311 exe 'bwipe! ' .. buf
312endfunc
313
Bram Moolenaar1e115362019-01-09 23:01:02 +0100314func s:Nasty_exit_cb(job, st)
Bram Moolenaar3c3a80d2017-08-03 17:06:45 +0200315 exe g:buf . 'bwipe!'
316 let g:buf = 0
317endfunc
318
Bram Moolenaar9d189612017-09-09 18:11:00 +0200319func Get_cat_123_cmd()
320 if has('win32')
Bram Moolenaaraa5df7e2019-02-03 14:53:10 +0100321 if !has('conpty')
322 return 'cmd /c "cls && color 2 && echo 123"'
323 else
324 " When clearing twice, extra sequence is not output.
325 return 'cmd /c "cls && cls && color 2 && echo 123"'
326 endif
Bram Moolenaar9d189612017-09-09 18:11:00 +0200327 else
328 call writefile(["\<Esc>[32m123"], 'Xtext')
329 return "cat Xtext"
330 endif
331endfunc
332
Bram Moolenaar3c3a80d2017-08-03 17:06:45 +0200333func Test_terminal_nasty_cb()
Bram Moolenaar33a43be2017-08-06 21:36:22 +0200334 let cmd = Get_cat_123_cmd()
Bram Moolenaar3c3a80d2017-08-03 17:06:45 +0200335 let g:buf = term_start(cmd, {'exit_cb': function('s:Nasty_exit_cb')})
336 let g:job = term_getjob(g:buf)
337
Bram Moolenaar0e9d1ae2018-04-30 14:28:24 +0200338 call WaitForAssert({-> assert_equal("dead", job_status(g:job))})
339 call WaitForAssert({-> assert_equal(0, g:buf)})
Bram Moolenaar3c3a80d2017-08-03 17:06:45 +0200340 unlet g:job
Bram Moolenaaraa5df7e2019-02-03 14:53:10 +0100341 unlet g:buf
Bram Moolenaar3c3a80d2017-08-03 17:06:45 +0200342 call delete('Xtext')
343endfunc
344
Bram Moolenaarc6df10e2017-07-29 20:15:08 +0200345func Check_123(buf)
Bram Moolenaar5c838a32017-08-02 22:10:34 +0200346 let l = term_scrape(a:buf, 0)
347 call assert_true(len(l) == 0)
348 let l = term_scrape(a:buf, 999)
349 call assert_true(len(l) == 0)
Bram Moolenaar7ee80f72019-09-08 20:55:06 +0200350 let l = a:buf->term_scrape(1)
Bram Moolenaarc6df10e2017-07-29 20:15:08 +0200351 call assert_true(len(l) > 0)
352 call assert_equal('1', l[0].chars)
353 call assert_equal('2', l[1].chars)
354 call assert_equal('3', l[2].chars)
355 call assert_equal('#00e000', l[0].fg)
Bram Moolenaar7ee80f72019-09-08 20:55:06 +0200356 call assert_equal(0, term_getattr(l[0].attr, 'bold'))
357 call assert_equal(0, l[0].attr->term_getattr('italic'))
Bram Moolenaar81df6352018-12-22 18:25:30 +0100358 if has('win32')
359 " On Windows 'background' always defaults to dark, even though the terminal
360 " may use a light background. Therefore accept both white and black.
361 call assert_match('#ffffff\|#000000', l[0].bg)
Bram Moolenaarc6df10e2017-07-29 20:15:08 +0200362 else
Bram Moolenaar81df6352018-12-22 18:25:30 +0100363 if &background == 'light'
364 call assert_equal('#ffffff', l[0].bg)
365 else
366 call assert_equal('#000000', l[0].bg)
367 endif
Bram Moolenaarc6df10e2017-07-29 20:15:08 +0200368 endif
369
Bram Moolenaar5c838a32017-08-02 22:10:34 +0200370 let l = term_getline(a:buf, -1)
371 call assert_equal('', l)
372 let l = term_getline(a:buf, 0)
373 call assert_equal('', l)
374 let l = term_getline(a:buf, 999)
375 call assert_equal('', l)
Bram Moolenaar9c844842017-08-01 18:41:21 +0200376 let l = term_getline(a:buf, 1)
Bram Moolenaarc6df10e2017-07-29 20:15:08 +0200377 call assert_equal('123', l)
378endfunc
379
Bram Moolenaar33a43be2017-08-06 21:36:22 +0200380func Test_terminal_scrape_123()
381 let cmd = Get_cat_123_cmd()
Bram Moolenaarc6df10e2017-07-29 20:15:08 +0200382 let buf = term_start(cmd)
383
384 let termlist = term_list()
385 call assert_equal(1, len(termlist))
386 call assert_equal(buf, termlist[0])
387
Bram Moolenaarf144a3f2017-07-30 18:02:12 +0200388 " Nothing happens with invalid buffer number
389 call term_wait(1234)
390
Bram Moolenaar6a2c5a72020-04-08 21:50:25 +0200391 call TermWait(buf)
Bram Moolenaar17833372017-09-04 22:23:19 +0200392 " On MS-Windows we first get a startup message of two lines, wait for the
Bram Moolenaar1bfdc072017-09-05 20:19:42 +0200393 " "cls" to happen, after that we have one line with three characters.
Bram Moolenaar0e9d1ae2018-04-30 14:28:24 +0200394 call WaitForAssert({-> assert_equal(3, len(term_scrape(buf, 1)))})
Bram Moolenaarc6df10e2017-07-29 20:15:08 +0200395 call Check_123(buf)
396
397 " Must still work after the job ended.
Bram Moolenaarab8b1c12017-11-04 19:24:31 +0100398 let job = term_getjob(buf)
Bram Moolenaar0e9d1ae2018-04-30 14:28:24 +0200399 call WaitForAssert({-> assert_equal("dead", job_status(job))})
Bram Moolenaar6a2c5a72020-04-08 21:50:25 +0200400 call TermWait(buf)
Bram Moolenaarc6df10e2017-07-29 20:15:08 +0200401 call Check_123(buf)
402
403 exe buf . 'bwipe'
Bram Moolenaarf144a3f2017-07-30 18:02:12 +0200404 call delete('Xtext')
Bram Moolenaarc6df10e2017-07-29 20:15:08 +0200405endfunc
Bram Moolenaarcfcc0222017-08-05 17:13:48 +0200406
Bram Moolenaar33a43be2017-08-06 21:36:22 +0200407func Test_terminal_scrape_multibyte()
Bram Moolenaarc4860bd2022-10-15 20:52:26 +0100408 call writefile(["léttまrs"], 'Xtext', 'D')
Bram Moolenaar33a43be2017-08-06 21:36:22 +0200409 if has('win32')
Bram Moolenaar36783932017-08-14 23:07:30 +0200410 " Run cmd with UTF-8 codepage to make the type command print the expected
411 " multibyte characters.
Bram Moolenaarab8b1c12017-11-04 19:24:31 +0100412 let buf = term_start("cmd /K chcp 65001")
413 call term_sendkeys(buf, "type Xtext\<CR>")
Bram Moolenaar7ee80f72019-09-08 20:55:06 +0200414 eval buf->term_sendkeys("exit\<CR>")
Bram Moolenaarab8b1c12017-11-04 19:24:31 +0100415 let line = 4
Bram Moolenaar33a43be2017-08-06 21:36:22 +0200416 else
Bram Moolenaarab8b1c12017-11-04 19:24:31 +0100417 let buf = term_start("cat Xtext")
418 let line = 1
Bram Moolenaar33a43be2017-08-06 21:36:22 +0200419 endif
Bram Moolenaar33a43be2017-08-06 21:36:22 +0200420
Bram Moolenaarab8b1c12017-11-04 19:24:31 +0100421 call WaitFor({-> len(term_scrape(buf, line)) >= 7 && term_scrape(buf, line)[0].chars == "l"})
422 let l = term_scrape(buf, line)
Bram Moolenaar33a43be2017-08-06 21:36:22 +0200423 call assert_true(len(l) >= 7)
424 call assert_equal('l', l[0].chars)
425 call assert_equal('é', l[1].chars)
426 call assert_equal(1, l[1].width)
427 call assert_equal('t', l[2].chars)
428 call assert_equal('t', l[3].chars)
429 call assert_equal('ま', l[4].chars)
430 call assert_equal(2, l[4].width)
431 call assert_equal('r', l[5].chars)
432 call assert_equal('s', l[6].chars)
433
Bram Moolenaarab8b1c12017-11-04 19:24:31 +0100434 let job = term_getjob(buf)
Bram Moolenaar0e9d1ae2018-04-30 14:28:24 +0200435 call WaitForAssert({-> assert_equal("dead", job_status(job))})
Bram Moolenaar6a2c5a72020-04-08 21:50:25 +0200436 call TermWait(buf)
Bram Moolenaar33a43be2017-08-06 21:36:22 +0200437
Bram Moolenaarab8b1c12017-11-04 19:24:31 +0100438 exe buf . 'bwipe'
Bram Moolenaar33a43be2017-08-06 21:36:22 +0200439endfunc
440
Bram Moolenaar8b896142020-08-02 15:05:05 +0200441func Test_terminal_one_column()
442 " This creates a terminal, displays a double-wide character and makes the
443 " window one column wide. This used to cause a crash.
444 let width = &columns
445 botright vert term
446 let buf = bufnr('$')
Bram Moolenaar733d2592020-08-20 18:59:06 +0200447 call TermWait(buf, 100)
Bram Moolenaar8b896142020-08-02 15:05:05 +0200448 exe "set columns=" .. (width / 2)
449 redraw
450 call term_sendkeys(buf, "キ")
Bram Moolenaar733d2592020-08-20 18:59:06 +0200451 call TermWait(buf, 10)
Bram Moolenaar8b896142020-08-02 15:05:05 +0200452 exe "set columns=" .. width
453 exe buf . 'bwipe!'
454endfunc
455
Bram Moolenaarf8d57a52017-08-07 20:38:42 +0200456func Test_terminal_scroll()
Bram Moolenaarc4860bd2022-10-15 20:52:26 +0100457 call writefile(range(1, 200), 'Xtext', 'D')
Bram Moolenaarf8d57a52017-08-07 20:38:42 +0200458 if has('win32')
459 let cmd = 'cmd /c "type Xtext"'
460 else
461 let cmd = "cat Xtext"
462 endif
463 let buf = term_start(cmd)
464
Bram Moolenaarab8b1c12017-11-04 19:24:31 +0100465 let job = term_getjob(buf)
Bram Moolenaar0e9d1ae2018-04-30 14:28:24 +0200466 call WaitForAssert({-> assert_equal("dead", job_status(job))})
Bram Moolenaar6a2c5a72020-04-08 21:50:25 +0200467 call TermWait(buf)
Bram Moolenaarf8d57a52017-08-07 20:38:42 +0200468
Bram Moolenaarbfcfd572020-03-25 21:27:22 +0100469 " wait until the scrolling stops
470 while 1
471 let scrolled = buf->term_getscrolled()
472 sleep 20m
473 if scrolled == buf->term_getscrolled()
474 break
475 endif
476 endwhile
477
Bram Moolenaarf8d57a52017-08-07 20:38:42 +0200478 call assert_equal('1', getline(1))
Bram Moolenaar82b9ca02017-08-08 23:06:46 +0200479 call assert_equal('1', term_getline(buf, 1 - scrolled))
Bram Moolenaarf8d57a52017-08-07 20:38:42 +0200480 call assert_equal('49', getline(49))
Bram Moolenaar82b9ca02017-08-08 23:06:46 +0200481 call assert_equal('49', term_getline(buf, 49 - scrolled))
Bram Moolenaarf8d57a52017-08-07 20:38:42 +0200482 call assert_equal('200', getline(200))
Bram Moolenaar82b9ca02017-08-08 23:06:46 +0200483 call assert_equal('200', term_getline(buf, 200 - scrolled))
Bram Moolenaarf8d57a52017-08-07 20:38:42 +0200484
485 exe buf . 'bwipe'
Bram Moolenaarf8d57a52017-08-07 20:38:42 +0200486endfunc
487
Bram Moolenaar6e72cd02018-04-14 21:31:35 +0200488func Test_terminal_scrollback()
Bram Moolenaar33c5e9f2018-05-26 18:58:51 +0200489 let buf = Run_shell_in_terminal({'term_rows': 15})
Bram Moolenaar6d150f72018-04-21 20:03:20 +0200490 set termwinscroll=100
Bram Moolenaarc4860bd2022-10-15 20:52:26 +0100491 call writefile(range(150), 'Xtext', 'D')
Bram Moolenaar6e72cd02018-04-14 21:31:35 +0200492 if has('win32')
493 call term_sendkeys(buf, "type Xtext\<CR>")
494 else
495 call term_sendkeys(buf, "cat Xtext\<CR>")
496 endif
497 let rows = term_getsize(buf)[0]
Bram Moolenaar6c672192018-04-15 13:28:42 +0200498 " On MS-Windows there is an empty line, check both last line and above it.
Bram Moolenaar0e9d1ae2018-04-30 14:28:24 +0200499 call WaitForAssert({-> assert_match( '149', term_getline(buf, rows - 1) . term_getline(buf, rows - 2))})
Bram Moolenaar6e72cd02018-04-14 21:31:35 +0200500 let lines = line('$')
Bram Moolenaarac3e8302018-04-15 13:10:44 +0200501 call assert_inrange(91, 100, lines)
Bram Moolenaar6e72cd02018-04-14 21:31:35 +0200502
Bram Moolenaar7a39dd72019-06-23 00:50:15 +0200503 call StopShellInTerminal(buf)
Bram Moolenaar6e72cd02018-04-14 21:31:35 +0200504 exe buf . 'bwipe'
Bram Moolenaar6d150f72018-04-21 20:03:20 +0200505 set termwinscroll&
Bram Moolenaar29ae2232019-02-14 21:22:01 +0100506endfunc
507
508func Test_terminal_postponed_scrollback()
Bram Moolenaaradbde3f2019-09-08 22:57:14 +0200509 " tail -f only works on Unix
510 CheckUnix
Bram Moolenaar29ae2232019-02-14 21:22:01 +0100511
Bram Moolenaarc4860bd2022-10-15 20:52:26 +0100512 call writefile(range(50), 'Xtext', 'D')
Bram Moolenaar29ae2232019-02-14 21:22:01 +0100513 call writefile([
Bram Moolenaar5ff7df52019-02-15 01:06:13 +0100514 \ 'set shell=/bin/sh noruler',
Bram Moolenaar29ae2232019-02-14 21:22:01 +0100515 \ 'terminal',
Bram Moolenaar7e841e32019-02-15 00:26:14 +0100516 \ 'sleep 200m',
Bram Moolenaar5ff7df52019-02-15 01:06:13 +0100517 \ 'call feedkeys("tail -n 100 -f Xtext\<CR>", "xt")',
518 \ 'sleep 100m',
Bram Moolenaar29ae2232019-02-14 21:22:01 +0100519 \ 'call feedkeys("\<C-W>N", "xt")',
Bram Moolenaarc4860bd2022-10-15 20:52:26 +0100520 \ ], 'XTest_postponed', 'D')
Bram Moolenaar29ae2232019-02-14 21:22:01 +0100521 let buf = RunVimInTerminal('-S XTest_postponed', {})
522 " Check that the Xtext lines are displayed and in Terminal-Normal mode
Bram Moolenaarddbfe232020-03-15 20:33:40 +0100523 call VerifyScreenDump(buf, 'Test_terminal_scrollback_1', {})
Bram Moolenaar29ae2232019-02-14 21:22:01 +0100524
525 silent !echo 'one more line' >>Xtext
Bram Moolenaar700dfaa2019-04-13 14:21:19 +0200526 " Screen will not change, move cursor to get a different dump
Bram Moolenaar29ae2232019-02-14 21:22:01 +0100527 call term_sendkeys(buf, "k")
Bram Moolenaarddbfe232020-03-15 20:33:40 +0100528 call VerifyScreenDump(buf, 'Test_terminal_scrollback_2', {})
Bram Moolenaar29ae2232019-02-14 21:22:01 +0100529
530 " Back to Terminal-Job mode, text will scroll and show the extra line.
531 call term_sendkeys(buf, "a")
Bram Moolenaarddbfe232020-03-15 20:33:40 +0100532 call VerifyScreenDump(buf, 'Test_terminal_scrollback_3', {})
Bram Moolenaar29ae2232019-02-14 21:22:01 +0100533
Bram Moolenaarddbfe232020-03-15 20:33:40 +0100534 " stop "tail -f"
Bram Moolenaar29ae2232019-02-14 21:22:01 +0100535 call term_sendkeys(buf, "\<C-C>")
Bram Moolenaar6a2c5a72020-04-08 21:50:25 +0200536 call TermWait(buf, 25)
Bram Moolenaarddbfe232020-03-15 20:33:40 +0100537 " stop shell
Bram Moolenaar29ae2232019-02-14 21:22:01 +0100538 call term_sendkeys(buf, "exit\<CR>")
Bram Moolenaar6a2c5a72020-04-08 21:50:25 +0200539 call TermWait(buf, 50)
Bram Moolenaarddbfe232020-03-15 20:33:40 +0100540 " close terminal window
Bram Moolenaar3a05ce62020-03-11 19:30:01 +0100541 let tsk_ret = term_sendkeys(buf, ":q\<CR>")
542
543 " check type of term_sendkeys() return value
544 echo type(tsk_ret)
545
Bram Moolenaar29ae2232019-02-14 21:22:01 +0100546 call StopVimInTerminal(buf)
Bram Moolenaar6e72cd02018-04-14 21:31:35 +0200547endfunc
548
Bram Moolenaar81aa0f52019-02-14 23:23:19 +0100549" Run diff on two dumps with different size.
550func Test_terminal_dumpdiff_size()
551 call assert_equal(1, winnr('$'))
552 call term_dumpdiff('dumps/Test_incsearch_search_01.dump', 'dumps/Test_popup_command_01.dump')
553 call assert_equal(2, winnr('$'))
554 call assert_match('Test_incsearch_search_01.dump', getline(10))
555 call assert_match(' +++++$', getline(11))
556 call assert_match('Test_popup_command_01.dump', getline(31))
557 call assert_equal(repeat('+', 75), getline(30))
558 quit
559endfunc
560
Bram Moolenaarcfcc0222017-08-05 17:13:48 +0200561func Test_terminal_size()
Bram Moolenaar33a43be2017-08-06 21:36:22 +0200562 let cmd = Get_cat_123_cmd()
Bram Moolenaarcfcc0222017-08-05 17:13:48 +0200563
Bram Moolenaarb2412082017-08-20 18:09:14 +0200564 exe 'terminal ++rows=5 ' . cmd
Bram Moolenaarcfcc0222017-08-05 17:13:48 +0200565 let size = term_getsize('')
566 bwipe!
567 call assert_equal(5, size[0])
568
Bram Moolenaar08d384f2017-08-11 21:51:23 +0200569 call term_start(cmd, {'term_rows': 6})
570 let size = term_getsize('')
571 bwipe!
572 call assert_equal(6, size[0])
573
Bram Moolenaarcfcc0222017-08-05 17:13:48 +0200574 vsplit
Bram Moolenaarb2412082017-08-20 18:09:14 +0200575 exe 'terminal ++rows=5 ++cols=33 ' . cmd
Bram Moolenaar7ee80f72019-09-08 20:55:06 +0200576 call assert_equal([5, 33], ''->term_getsize())
Bram Moolenaara42d3632018-04-14 17:05:38 +0200577
578 call term_setsize('', 6, 0)
579 call assert_equal([6, 33], term_getsize(''))
580
Bram Moolenaar7ee80f72019-09-08 20:55:06 +0200581 eval ''->term_setsize(0, 35)
Bram Moolenaara42d3632018-04-14 17:05:38 +0200582 call assert_equal([6, 35], term_getsize(''))
583
584 call term_setsize('', 7, 30)
585 call assert_equal([7, 30], term_getsize(''))
586
Bram Moolenaarcfcc0222017-08-05 17:13:48 +0200587 bwipe!
Bram Moolenaar6e72cd02018-04-14 21:31:35 +0200588 call assert_fails("call term_setsize('', 7, 30)", "E955:")
Bram Moolenaarcfcc0222017-08-05 17:13:48 +0200589
Bram Moolenaar08d384f2017-08-11 21:51:23 +0200590 call term_start(cmd, {'term_rows': 6, 'term_cols': 36})
591 let size = term_getsize('')
592 bwipe!
593 call assert_equal([6, 36], size)
594
Bram Moolenaarb2412082017-08-20 18:09:14 +0200595 exe 'vertical terminal ++cols=20 ' . cmd
Bram Moolenaarcfcc0222017-08-05 17:13:48 +0200596 let size = term_getsize('')
597 bwipe!
598 call assert_equal(20, size[1])
599
Bram Moolenaar7ee80f72019-09-08 20:55:06 +0200600 eval cmd->term_start({'vertical': 1, 'term_cols': 26})
Bram Moolenaar08d384f2017-08-11 21:51:23 +0200601 let size = term_getsize('')
602 bwipe!
603 call assert_equal(26, size[1])
604
Bram Moolenaarcfcc0222017-08-05 17:13:48 +0200605 split
Bram Moolenaarb2412082017-08-20 18:09:14 +0200606 exe 'vertical terminal ++rows=6 ++cols=20 ' . cmd
Bram Moolenaarcfcc0222017-08-05 17:13:48 +0200607 let size = term_getsize('')
608 bwipe!
609 call assert_equal([6, 20], size)
Bram Moolenaar08d384f2017-08-11 21:51:23 +0200610
611 call term_start(cmd, {'vertical': 1, 'term_rows': 7, 'term_cols': 27})
612 let size = term_getsize('')
613 bwipe!
614 call assert_equal([7, 27], size)
Bram Moolenaar9d654a82017-09-03 19:52:17 +0200615
Bram Moolenaar5300be62021-11-13 10:27:40 +0000616 call assert_fails("call term_start(cmd, {'term_rows': -1})", 'E475:')
617 call assert_fails("call term_start(cmd, {'term_rows': 1001})", 'E475:')
Bram Moolenaar73e28dc2022-09-17 21:08:33 +0100618 call assert_fails("call term_start(cmd, {'term_rows': 10.0})", 'E805:')
Bram Moolenaar88137392021-11-12 16:01:15 +0000619
Kenta Satoc28e7a22023-05-08 18:26:03 +0100620 call assert_fails("call term_start(cmd, {'term_cols': -1})", 'E475:')
621 call assert_fails("call term_start(cmd, {'term_cols': 1001})", 'E475:')
622 call assert_fails("call term_start(cmd, {'term_cols': 10.0})", 'E805:')
623
Bram Moolenaar9d654a82017-09-03 19:52:17 +0200624 call delete('Xtext')
Bram Moolenaarda43b612017-08-11 22:27:50 +0200625endfunc
626
Bram Moolenaareba13e42021-02-23 17:47:23 +0100627func Test_terminal_zero_height()
628 split
629 wincmd j
630 anoremenu 1.1 WinBar.test :
631 terminal ++curwin
632 wincmd k
633 wincmd _
634 redraw
635
636 call term_sendkeys(bufnr(), "exit\r")
637 bwipe!
638endfunc
639
Bram Moolenaarda43b612017-08-11 22:27:50 +0200640func Test_terminal_curwin()
641 let cmd = Get_cat_123_cmd()
642 call assert_equal(1, winnr('$'))
643
Bram Moolenaarb1009092020-05-31 16:04:42 +0200644 split Xdummy
645 call setline(1, 'dummy')
646 write
647 call assert_equal(1, getbufinfo('Xdummy')[0].loaded)
Bram Moolenaarda43b612017-08-11 22:27:50 +0200648 exe 'terminal ++curwin ' . cmd
649 call assert_equal(2, winnr('$'))
Bram Moolenaarb1009092020-05-31 16:04:42 +0200650 call assert_equal(0, getbufinfo('Xdummy')[0].loaded)
Bram Moolenaarda43b612017-08-11 22:27:50 +0200651 bwipe!
652
Bram Moolenaarb1009092020-05-31 16:04:42 +0200653 split Xdummy
Bram Moolenaarda43b612017-08-11 22:27:50 +0200654 call term_start(cmd, {'curwin': 1})
655 call assert_equal(2, winnr('$'))
656 bwipe!
657
Bram Moolenaarb1009092020-05-31 16:04:42 +0200658 split Xdummy
Bram Moolenaarda43b612017-08-11 22:27:50 +0200659 call setline(1, 'change')
660 call assert_fails('terminal ++curwin ' . cmd, 'E37:')
661 call assert_equal(2, winnr('$'))
662 exe 'terminal! ++curwin ' . cmd
663 call assert_equal(2, winnr('$'))
664 bwipe!
665
Bram Moolenaarb1009092020-05-31 16:04:42 +0200666 split Xdummy
Bram Moolenaarda43b612017-08-11 22:27:50 +0200667 call setline(1, 'change')
668 call assert_fails("call term_start(cmd, {'curwin': 1})", 'E37:')
669 call assert_equal(2, winnr('$'))
670 bwipe!
671
Bram Moolenaarb1009092020-05-31 16:04:42 +0200672 split Xdummy
Bram Moolenaarda43b612017-08-11 22:27:50 +0200673 bwipe!
Bram Moolenaar9d654a82017-09-03 19:52:17 +0200674 call delete('Xtext')
Bram Moolenaarb1009092020-05-31 16:04:42 +0200675 call delete('Xdummy')
Bram Moolenaarcfcc0222017-08-05 17:13:48 +0200676endfunc
Bram Moolenaardd693ce2017-08-10 23:15:19 +0200677
Bram Moolenaarff546792017-11-21 14:47:57 +0100678func s:get_sleep_cmd()
Bram Moolenaarb81bc772017-08-11 22:45:01 +0200679 if s:python != ''
680 let cmd = s:python . " test_short_sleep.py"
Bram Moolenaarc8523e22018-06-03 18:22:02 +0200681 " 500 was not enough for Travis
682 let waittime = 900
Bram Moolenaardd693ce2017-08-10 23:15:19 +0200683 else
Bram Moolenaarb81bc772017-08-11 22:45:01 +0200684 echo 'This will take five seconds...'
685 let waittime = 2000
686 if has('win32')
687 let cmd = $windir . '\system32\timeout.exe 1'
688 else
689 let cmd = 'sleep 1'
690 endif
Bram Moolenaardd693ce2017-08-10 23:15:19 +0200691 endif
Bram Moolenaarff546792017-11-21 14:47:57 +0100692 return [cmd, waittime]
693endfunc
694
695func Test_terminal_finish_open_close()
696 call assert_equal(1, winnr('$'))
697
698 let [cmd, waittime] = s:get_sleep_cmd()
Bram Moolenaarb81bc772017-08-11 22:45:01 +0200699
Bram Moolenaar1dd98332018-03-16 22:54:53 +0100700 " shell terminal closes automatically
701 terminal
702 let buf = bufnr('%')
703 call assert_equal(2, winnr('$'))
704 " Wait for the shell to display a prompt
Bram Moolenaar0e9d1ae2018-04-30 14:28:24 +0200705 call WaitForAssert({-> assert_notequal('', term_getline(buf, 1))})
Bram Moolenaar7a39dd72019-06-23 00:50:15 +0200706 call StopShellInTerminal(buf)
Bram Moolenaar0e9d1ae2018-04-30 14:28:24 +0200707 call WaitForAssert({-> assert_equal(1, winnr('$'))}, waittime)
Bram Moolenaar1dd98332018-03-16 22:54:53 +0100708
709 " shell terminal that does not close automatically
710 terminal ++noclose
711 let buf = bufnr('%')
712 call assert_equal(2, winnr('$'))
713 " Wait for the shell to display a prompt
Bram Moolenaar0e9d1ae2018-04-30 14:28:24 +0200714 call WaitForAssert({-> assert_notequal('', term_getline(buf, 1))})
Bram Moolenaar7a39dd72019-06-23 00:50:15 +0200715 call StopShellInTerminal(buf)
Bram Moolenaar1dd98332018-03-16 22:54:53 +0100716 call assert_equal(2, winnr('$'))
717 quit
718 call assert_equal(1, winnr('$'))
719
Bram Moolenaardd693ce2017-08-10 23:15:19 +0200720 exe 'terminal ++close ' . cmd
Bram Moolenaardd693ce2017-08-10 23:15:19 +0200721 call assert_equal(2, winnr('$'))
Bram Moolenaardd693ce2017-08-10 23:15:19 +0200722 wincmd p
Bram Moolenaar0e9d1ae2018-04-30 14:28:24 +0200723 call WaitForAssert({-> assert_equal(1, winnr('$'))}, waittime)
Bram Moolenaardd693ce2017-08-10 23:15:19 +0200724
725 call term_start(cmd, {'term_finish': 'close'})
726 call assert_equal(2, winnr('$'))
Bram Moolenaardd693ce2017-08-10 23:15:19 +0200727 wincmd p
Bram Moolenaar0e9d1ae2018-04-30 14:28:24 +0200728 call WaitForAssert({-> assert_equal(1, winnr('$'))}, waittime)
Bram Moolenaardd693ce2017-08-10 23:15:19 +0200729 call assert_equal(1, winnr('$'))
730
731 exe 'terminal ++open ' . cmd
Bram Moolenaar97a80e42017-08-30 13:31:49 +0200732 close!
Bram Moolenaar0e9d1ae2018-04-30 14:28:24 +0200733 call WaitForAssert({-> assert_equal(2, winnr('$'))}, waittime)
Bram Moolenaardd693ce2017-08-10 23:15:19 +0200734 bwipe
735
736 call term_start(cmd, {'term_finish': 'open'})
Bram Moolenaar97a80e42017-08-30 13:31:49 +0200737 close!
Bram Moolenaar0e9d1ae2018-04-30 14:28:24 +0200738 call WaitForAssert({-> assert_equal(2, winnr('$'))}, waittime)
Bram Moolenaar8cad9302017-08-12 14:32:32 +0200739 bwipe
Bram Moolenaardd693ce2017-08-10 23:15:19 +0200740
Bram Moolenaar8cad9302017-08-12 14:32:32 +0200741 exe 'terminal ++hidden ++open ' . cmd
742 call assert_equal(1, winnr('$'))
Bram Moolenaar0e9d1ae2018-04-30 14:28:24 +0200743 call WaitForAssert({-> assert_equal(2, winnr('$'))}, waittime)
Bram Moolenaar8cad9302017-08-12 14:32:32 +0200744 bwipe
745
746 call term_start(cmd, {'term_finish': 'open', 'hidden': 1})
747 call assert_equal(1, winnr('$'))
Bram Moolenaar0e9d1ae2018-04-30 14:28:24 +0200748 call WaitForAssert({-> assert_equal(2, winnr('$'))}, waittime)
Bram Moolenaardd693ce2017-08-10 23:15:19 +0200749 bwipe
Bram Moolenaar37c45832017-08-12 16:01:04 +0200750
751 call assert_fails("call term_start(cmd, {'term_opencmd': 'open'})", 'E475:')
752 call assert_fails("call term_start(cmd, {'term_opencmd': 'split %x'})", 'E475:')
753 call assert_fails("call term_start(cmd, {'term_opencmd': 'split %d and %s'})", 'E475:')
754 call assert_fails("call term_start(cmd, {'term_opencmd': 'split % and %d'})", 'E475:')
755
Bram Moolenaar47c5ea42020-11-12 15:12:15 +0100756 call term_start(cmd, {'term_finish': 'open', 'term_opencmd': '4split | buffer %d | let g:result = "opened the buffer in a window"'})
Bram Moolenaar97a80e42017-08-30 13:31:49 +0200757 close!
Bram Moolenaar0e9d1ae2018-04-30 14:28:24 +0200758 call WaitForAssert({-> assert_equal(2, winnr('$'))}, waittime)
Bram Moolenaar37c45832017-08-12 16:01:04 +0200759 call assert_equal(4, winheight(0))
Bram Moolenaar47c5ea42020-11-12 15:12:15 +0100760 call assert_equal('opened the buffer in a window', g:result)
761 unlet g:result
Bram Moolenaar37c45832017-08-12 16:01:04 +0200762 bwipe
Bram Moolenaardd693ce2017-08-10 23:15:19 +0200763endfunc
Bram Moolenaar05aafed2017-08-11 19:12:11 +0200764
765func Test_terminal_cwd()
Bram Moolenaar077ff432019-10-28 00:42:21 +0100766 if has('win32')
767 let cmd = 'cmd /c cd'
768 else
769 CheckExecutable pwd
770 let cmd = 'pwd'
Bram Moolenaar05aafed2017-08-11 19:12:11 +0200771 endif
Bram Moolenaar3b0d70f2022-08-29 22:31:20 +0100772 call mkdir('Xtermdir')
773 let buf = term_start(cmd, {'cwd': 'Xtermdir'})
Bram Moolenaaree7c8d92022-09-22 12:57:06 +0100774 " if the path is very long it may be split over two lines, join them
775 " together
776 call WaitForAssert({-> assert_equal('Xtermdir', fnamemodify(getline(1) .. getline(2), ":t"))})
Bram Moolenaar05aafed2017-08-11 19:12:11 +0200777
778 exe buf . 'bwipe'
Bram Moolenaar3b0d70f2022-08-29 22:31:20 +0100779 call delete('Xtermdir', 'rf')
Bram Moolenaar05aafed2017-08-11 19:12:11 +0200780endfunc
781
Bram Moolenaar839e81e2018-10-19 16:53:39 +0200782func Test_terminal_cwd_failure()
783 " Case 1: Provided directory is not actually a directory. Attempt to make
784 " the file executable as well.
Bram Moolenaarc4860bd2022-10-15 20:52:26 +0100785 call writefile([], 'Xtcfile', 'D')
Dominique Pelle91a874e2022-09-03 10:59:32 +0100786 call setfperm('Xtcfile', 'rwx------')
787 call assert_fails("call term_start(&shell, {'cwd': 'Xtcfile'})", 'E475:')
Bram Moolenaar839e81e2018-10-19 16:53:39 +0200788
789 " Case 2: Directory does not exist.
790 call assert_fails("call term_start(&shell, {'cwd': 'Xdir'})", 'E475:')
791
792 " Case 3: Directory exists but is not accessible.
Bram Moolenaar0b38f542018-11-03 21:47:16 +0100793 " Skip this for root, it will be accessible anyway.
Bram Moolenaar07282f02019-10-10 16:46:17 +0200794 if !IsRoot()
Bram Moolenaar0b38f542018-11-03 21:47:16 +0100795 call mkdir('XdirNoAccess', '', '0600')
796 " return early if the directory permissions could not be set properly
797 if getfperm('XdirNoAccess')[2] == 'x'
798 call delete('XdirNoAccess', 'rf')
799 return
800 endif
801 call assert_fails("call term_start(&shell, {'cwd': 'XdirNoAccess'})", 'E475:')
802 call delete('XdirNoAccess', 'rf')
Bram Moolenaar839e81e2018-10-19 16:53:39 +0200803 endif
Bram Moolenaar839e81e2018-10-19 16:53:39 +0200804endfunc
805
Bram Moolenaar52dbb5e2017-11-21 18:11:27 +0100806func Test_terminal_servername()
Bram Moolenaar6d91bcb2020-08-12 18:50:36 +0200807 CheckFeature clientserver
Bram Moolenaard7a137f2018-06-12 18:05:24 +0200808 call s:test_environment("VIM_SERVERNAME", v:servername)
809endfunc
810
811func Test_terminal_version()
812 call s:test_environment("VIM_TERMINAL", string(v:version))
813endfunc
814
815func s:test_environment(name, value)
Bram Moolenaar012eb662018-03-13 17:55:27 +0100816 let buf = Run_shell_in_terminal({})
Bram Moolenaar52dbb5e2017-11-21 18:11:27 +0100817 " Wait for the shell to display a prompt
Bram Moolenaar0e9d1ae2018-04-30 14:28:24 +0200818 call WaitForAssert({-> assert_notequal('', term_getline(buf, 1))})
Bram Moolenaar52dbb5e2017-11-21 18:11:27 +0100819 if has('win32')
Bram Moolenaard7a137f2018-06-12 18:05:24 +0200820 call term_sendkeys(buf, "echo %" . a:name . "%\r")
Bram Moolenaar52dbb5e2017-11-21 18:11:27 +0100821 else
Bram Moolenaard7a137f2018-06-12 18:05:24 +0200822 call term_sendkeys(buf, "echo $" . a:name . "\r")
Bram Moolenaar52dbb5e2017-11-21 18:11:27 +0100823 endif
Bram Moolenaar6a2c5a72020-04-08 21:50:25 +0200824 call TermWait(buf)
Bram Moolenaar7a39dd72019-06-23 00:50:15 +0200825 call StopShellInTerminal(buf)
Bram Moolenaard7a137f2018-06-12 18:05:24 +0200826 call WaitForAssert({-> assert_equal(a:value, getline(2))})
Bram Moolenaar52dbb5e2017-11-21 18:11:27 +0100827
Bram Moolenaar012eb662018-03-13 17:55:27 +0100828 exe buf . 'bwipe'
829 unlet buf
Bram Moolenaar52dbb5e2017-11-21 18:11:27 +0100830endfunc
831
Bram Moolenaar05aafed2017-08-11 19:12:11 +0200832func Test_terminal_env()
Bram Moolenaar012eb662018-03-13 17:55:27 +0100833 let buf = Run_shell_in_terminal({'env': {'TESTENV': 'correct'}})
Bram Moolenaar51c23682017-08-14 21:45:00 +0200834 " Wait for the shell to display a prompt
Bram Moolenaar0e9d1ae2018-04-30 14:28:24 +0200835 call WaitForAssert({-> assert_notequal('', term_getline(buf, 1))})
Bram Moolenaarba6febd2017-10-30 21:56:23 +0100836 if has('win32')
Bram Moolenaar012eb662018-03-13 17:55:27 +0100837 call term_sendkeys(buf, "echo %TESTENV%\r")
Bram Moolenaarba6febd2017-10-30 21:56:23 +0100838 else
Bram Moolenaar012eb662018-03-13 17:55:27 +0100839 call term_sendkeys(buf, "echo $TESTENV\r")
Bram Moolenaarba6febd2017-10-30 21:56:23 +0100840 endif
Bram Moolenaar6a2c5a72020-04-08 21:50:25 +0200841 eval buf->TermWait()
Bram Moolenaar7a39dd72019-06-23 00:50:15 +0200842 call StopShellInTerminal(buf)
Bram Moolenaar0e9d1ae2018-04-30 14:28:24 +0200843 call WaitForAssert({-> assert_equal('correct', getline(2))})
Bram Moolenaar05aafed2017-08-11 19:12:11 +0200844
Bram Moolenaar012eb662018-03-13 17:55:27 +0100845 exe buf . 'bwipe'
Bram Moolenaar05aafed2017-08-11 19:12:11 +0200846endfunc
Bram Moolenaar679653e2017-08-13 14:13:19 +0200847
Bram Moolenaardcaa6132017-08-13 17:13:09 +0200848func Test_terminal_list_args()
849 let buf = term_start([&shell, &shellcmdflag, 'echo "123"'])
Yee Cheng Chin15b314f2022-10-09 18:53:32 +0100850 call assert_fails(buf . 'bwipe', 'E948:')
Bram Moolenaardcaa6132017-08-13 17:13:09 +0200851 exe buf . 'bwipe!'
852 call assert_equal("", bufname(buf))
853endfunction
Bram Moolenaar97bd5e62017-08-18 20:50:30 +0200854
855func Test_terminal_noblock()
Bram Moolenaarf08b0eb2021-10-16 13:00:14 +0100856 let g:test_is_flaky = 1
Bram Moolenaarab8b1c12017-11-04 19:24:31 +0100857 let buf = term_start(&shell)
Zdenek Dohnaldd2dfb32022-02-23 14:25:17 +0000858 " Starting a terminal can be slow, esp. on busy CI machines.
859 let wait_time = 7500
Bram Moolenaarf3710ee2020-03-24 12:12:30 +0100860 let letters = 'abcdefghijklmnopqrstuvwxyz'
Bram Moolenaar39536dd2019-01-29 22:58:21 +0100861 if has('bsd') || has('mac') || has('sun')
Bram Moolenaard8d85bf2017-09-03 18:08:00 +0200862 " The shell or something else has a problem dealing with more than 1000
Bram Moolenaarf3710ee2020-03-24 12:12:30 +0100863 " characters at the same time. It's very slow too.
Bram Moolenaard8d85bf2017-09-03 18:08:00 +0200864 let len = 1000
Bram Moolenaard06dbf32020-03-24 10:33:00 +0100865 let wait_time = 15000
Bram Moolenaarf3710ee2020-03-24 12:12:30 +0100866 let letters = 'abcdefghijklm'
Bram Moolenaaraa5df7e2019-02-03 14:53:10 +0100867 " NPFS is used in Windows, nonblocking mode does not work properly.
868 elseif has('win32')
869 let len = 1
Bram Moolenaard8d85bf2017-09-03 18:08:00 +0200870 else
871 let len = 5000
872 endif
Bram Moolenaar97bd5e62017-08-18 20:50:30 +0200873
Bram Moolenaard06dbf32020-03-24 10:33:00 +0100874 " Send a lot of text lines, should be buffered properly.
Bram Moolenaarf3710ee2020-03-24 12:12:30 +0100875 for c in split(letters, '\zs')
Bram Moolenaarab8b1c12017-11-04 19:24:31 +0100876 call term_sendkeys(buf, 'echo ' . repeat(c, len) . "\<cr>")
Bram Moolenaar97bd5e62017-08-18 20:50:30 +0200877 endfor
Bram Moolenaarab8b1c12017-11-04 19:24:31 +0100878 call term_sendkeys(buf, "echo done\<cr>")
Bram Moolenaareef05312017-08-20 20:21:23 +0200879
880 " On MS-Windows there is an extra empty line below "done". Find "done" in
881 " the last-but-one or the last-but-two line.
Bram Moolenaarab8b1c12017-11-04 19:24:31 +0100882 let lnum = term_getsize(buf)[0] - 1
Bram Moolenaard06dbf32020-03-24 10:33:00 +0100883 call WaitForAssert({-> assert_match('done', term_getline(buf, lnum - 1) .. '//' .. term_getline(buf, lnum))}, wait_time)
Bram Moolenaarab8b1c12017-11-04 19:24:31 +0100884 let line = term_getline(buf, lnum)
Bram Moolenaareef05312017-08-20 20:21:23 +0200885 if line !~ 'done'
Bram Moolenaarab8b1c12017-11-04 19:24:31 +0100886 let line = term_getline(buf, lnum - 1)
Bram Moolenaareef05312017-08-20 20:21:23 +0200887 endif
888 call assert_match('done', line)
Bram Moolenaar97bd5e62017-08-18 20:50:30 +0200889
Bram Moolenaarab8b1c12017-11-04 19:24:31 +0100890 let g:job = term_getjob(buf)
Bram Moolenaar7a39dd72019-06-23 00:50:15 +0200891 call StopShellInTerminal(buf)
Bram Moolenaard21f8b52017-08-19 15:40:01 +0200892 unlet g:job
Bram Moolenaar97bd5e62017-08-18 20:50:30 +0200893 bwipe
894endfunc
Bram Moolenaar37819ed2017-08-20 19:33:47 +0200895
896func Test_terminal_write_stdin()
Bram Moolenaar21109272020-01-30 16:27:20 +0100897 " TODO: enable once writing to stdin works on MS-Windows
898 CheckNotMSWindows
899 CheckExecutable wc
Bram Moolenaar62eb2392022-06-15 17:52:44 +0100900 let g:test_is_flaky = 1
Bram Moolenaar21109272020-01-30 16:27:20 +0100901
Bram Moolenaar37819ed2017-08-20 19:33:47 +0200902 call setline(1, ['one', 'two', 'three'])
903 %term wc
Bram Moolenaar0e9d1ae2018-04-30 14:28:24 +0200904 call WaitForAssert({-> assert_match('3', getline("$"))})
Bram Moolenaar3346cc42017-09-02 14:54:21 +0200905 let nrs = split(getline('$'))
Bram Moolenaar37819ed2017-08-20 19:33:47 +0200906 call assert_equal(['3', '3', '14'], nrs)
Bram Moolenaar21109272020-01-30 16:27:20 +0100907 %bwipe!
Bram Moolenaar37819ed2017-08-20 19:33:47 +0200908
909 call setline(1, ['one', 'two', 'three', 'four'])
910 2,3term wc
Bram Moolenaar0e9d1ae2018-04-30 14:28:24 +0200911 call WaitForAssert({-> assert_match('2', getline("$"))})
Bram Moolenaar3346cc42017-09-02 14:54:21 +0200912 let nrs = split(getline('$'))
Bram Moolenaar37819ed2017-08-20 19:33:47 +0200913 call assert_equal(['2', '2', '10'], nrs)
Bram Moolenaar21109272020-01-30 16:27:20 +0100914 %bwipe!
915endfunc
Bram Moolenaar37819ed2017-08-20 19:33:47 +0200916
Bram Moolenaar21109272020-01-30 16:27:20 +0100917func Test_terminal_eof_arg()
Bram Moolenaara161cb52020-04-30 19:09:35 +0200918 call CheckPython(s:python)
Bram Moolenaar62eb2392022-06-15 17:52:44 +0100919 let g:test_is_flaky = 1
Bram Moolenaardada6d22017-09-02 17:18:35 +0200920
Bram Moolenaar21109272020-01-30 16:27:20 +0100921 call setline(1, ['print("hello")'])
Bram Moolenaara161cb52020-04-30 19:09:35 +0200922 exe '1term ++eof=exit(123) ' .. s:python
Bram Moolenaar21109272020-01-30 16:27:20 +0100923 " MS-Windows echoes the input, Unix doesn't.
924 if has('win32')
925 call WaitFor({-> getline('$') =~ 'exit(123)'})
926 call assert_equal('hello', getline(line('$') - 1))
927 else
928 call WaitFor({-> getline('$') =~ 'hello'})
929 call assert_equal('hello', getline('$'))
Bram Moolenaardada6d22017-09-02 17:18:35 +0200930 endif
Bram Moolenaar21109272020-01-30 16:27:20 +0100931 call assert_equal(123, bufnr()->term_getjob()->job_info().exitval)
932 %bwipe!
933endfunc
Bram Moolenaardada6d22017-09-02 17:18:35 +0200934
Bram Moolenaar21109272020-01-30 16:27:20 +0100935func Test_terminal_eof_arg_win32_ctrl_z()
936 CheckMSWindows
Bram Moolenaara161cb52020-04-30 19:09:35 +0200937 call CheckPython(s:python)
Bram Moolenaar62eb2392022-06-15 17:52:44 +0100938 let g:test_is_flaky = 1
Bram Moolenaar21109272020-01-30 16:27:20 +0100939
940 call setline(1, ['print("hello")'])
Bram Moolenaara161cb52020-04-30 19:09:35 +0200941 exe '1term ++eof=<C-Z> ' .. s:python
Bram Moolenaar21109272020-01-30 16:27:20 +0100942 call WaitForAssert({-> assert_match('\^Z', getline(line('$') - 1))})
943 call assert_match('\^Z', getline(line('$') - 1))
944 %bwipe!
945endfunc
946
947func Test_terminal_duplicate_eof_arg()
Bram Moolenaara161cb52020-04-30 19:09:35 +0200948 call CheckPython(s:python)
Bram Moolenaar62eb2392022-06-15 17:52:44 +0100949 let g:test_is_flaky = 1
Bram Moolenaar21109272020-01-30 16:27:20 +0100950
Bram Moolenaar62eb2392022-06-15 17:52:44 +0100951 " Check the last specified ++eof arg is used and does not leak memory.
Bram Moolenaar21109272020-01-30 16:27:20 +0100952 new
953 call setline(1, ['print("hello")'])
Bram Moolenaara161cb52020-04-30 19:09:35 +0200954 exe '1term ++eof=<C-Z> ++eof=exit(123) ' .. s:python
Bram Moolenaar21109272020-01-30 16:27:20 +0100955 " MS-Windows echoes the input, Unix doesn't.
956 if has('win32')
957 call WaitFor({-> getline('$') =~ 'exit(123)'})
958 call assert_equal('hello', getline(line('$') - 1))
959 else
960 call WaitFor({-> getline('$') =~ 'hello'})
961 call assert_equal('hello', getline('$'))
962 endif
963 call assert_equal(123, bufnr()->term_getjob()->job_info().exitval)
964 %bwipe!
Bram Moolenaar37819ed2017-08-20 19:33:47 +0200965endfunc
Bram Moolenaar13ebb032017-08-26 22:02:51 +0200966
967func Test_terminal_no_cmd()
Bram Moolenaarf08b0eb2021-10-16 13:00:14 +0100968 let g:test_is_flaky = 1
Bram Moolenaar13ebb032017-08-26 22:02:51 +0200969 let buf = term_start('NONE', {})
970 call assert_notequal(0, buf)
971
Bram Moolenaar2dc9d262017-09-08 14:39:30 +0200972 let pty = job_info(term_getjob(buf))['tty_out']
Bram Moolenaar13ebb032017-08-26 22:02:51 +0200973 call assert_notequal('', pty)
Bram Moolenaarcfc15232019-01-23 22:33:18 +0100974 if has('gui_running') && !has('win32')
975 " In the GUI job_start() doesn't work, it does not read from the pty.
Bram Moolenaar2dc9d262017-09-08 14:39:30 +0200976 call system('echo "look here" > ' . pty)
Bram Moolenaarcfc15232019-01-23 22:33:18 +0100977 else
978 " Otherwise using a job works on all systems.
979 call job_start([&shell, &shellcmdflag, 'echo "look here" > ' . pty])
Bram Moolenaar2dc9d262017-09-08 14:39:30 +0200980 endif
Bram Moolenaar0e9d1ae2018-04-30 14:28:24 +0200981 call WaitForAssert({-> assert_match('look here', term_getline(buf, 1))})
Bram Moolenaar2dc9d262017-09-08 14:39:30 +0200982
Bram Moolenaar13ebb032017-08-26 22:02:51 +0200983 bwipe!
984endfunc
Bram Moolenaar9d654a82017-09-03 19:52:17 +0200985
986func Test_terminal_special_chars()
987 " this file name only works on Unix
Bram Moolenaaradbde3f2019-09-08 22:57:14 +0200988 CheckUnix
989
Bram Moolenaarc4860bd2022-10-15 20:52:26 +0100990 call mkdir('Xdir with spaces', 'R')
Bram Moolenaar9d654a82017-09-03 19:52:17 +0200991 call writefile(['x'], 'Xdir with spaces/quoted"file')
992 term ls Xdir\ with\ spaces/quoted\"file
Bram Moolenaar0e9d1ae2018-04-30 14:28:24 +0200993 call WaitForAssert({-> assert_match('quoted"file', term_getline('', 1))})
Bram Moolenaar95ffd432020-02-23 13:29:31 +0100994 " make sure the job has finished
995 call WaitForAssert({-> assert_match('finish', term_getstatus(bufnr()))})
Bram Moolenaar9d654a82017-09-03 19:52:17 +0200996
Bram Moolenaar9d654a82017-09-03 19:52:17 +0200997 bwipe
998endfunc
Bram Moolenaare88fc7a2017-09-03 20:59:40 +0200999
1000func Test_terminal_wrong_options()
1001 call assert_fails('call term_start(&shell, {
1002 \ "in_io": "file",
1003 \ "in_name": "xxx",
1004 \ "out_io": "file",
1005 \ "out_name": "xxx",
1006 \ "err_io": "file",
1007 \ "err_name": "xxx"
1008 \ })', 'E474:')
1009 call assert_fails('call term_start(&shell, {
1010 \ "out_buf": bufnr("%")
1011 \ })', 'E474:')
1012 call assert_fails('call term_start(&shell, {
1013 \ "err_buf": bufnr("%")
1014 \ })', 'E474:')
1015endfunc
1016
1017func Test_terminal_redir_file()
Bram Moolenaarf08b0eb2021-10-16 13:00:14 +01001018 let g:test_is_flaky = 1
Bram Moolenaarf25329c2018-05-06 21:49:32 +02001019 let cmd = Get_cat_123_cmd()
Bram Moolenaarb18b4962022-09-02 21:55:50 +01001020 let buf = term_start(cmd, {'out_io': 'file', 'out_name': 'Xtrfile'})
Bram Moolenaar6a2c5a72020-04-08 21:50:25 +02001021 call TermWait(buf)
Bram Moolenaaraa5df7e2019-02-03 14:53:10 +01001022 " ConPTY may precede escape sequence. There are things that are not so.
1023 if !has('conpty')
Bram Moolenaarb18b4962022-09-02 21:55:50 +01001024 call WaitForAssert({-> assert_notequal(0, len(readfile("Xtrfile")))})
1025 call assert_match('123', readfile('Xtrfile')[0])
Bram Moolenaaraa5df7e2019-02-03 14:53:10 +01001026 endif
Bram Moolenaarf25329c2018-05-06 21:49:32 +02001027 let g:job = term_getjob(buf)
1028 call WaitForAssert({-> assert_equal("dead", job_status(g:job))})
Bram Moolenaarc69950a2020-07-22 22:23:40 +02001029
1030 if has('win32')
1031 " On Windows we cannot delete a file being used by a process. When
1032 " job_status() returns "dead", the process remains for a short time.
1033 " Just wait for a moment.
1034 sleep 50m
1035 endif
Bram Moolenaarb18b4962022-09-02 21:55:50 +01001036 call delete('Xtrfile')
Bram Moolenaarf25329c2018-05-06 21:49:32 +02001037 bwipe
Bram Moolenaare88fc7a2017-09-03 20:59:40 +02001038
1039 if has('unix')
Bram Moolenaarc4860bd2022-10-15 20:52:26 +01001040 call writefile(['one line'], 'Xtrfile', 'D')
Bram Moolenaarb18b4962022-09-02 21:55:50 +01001041 let buf = term_start('cat', {'in_io': 'file', 'in_name': 'Xtrfile'})
Bram Moolenaar6a2c5a72020-04-08 21:50:25 +02001042 call TermWait(buf)
Bram Moolenaar0e9d1ae2018-04-30 14:28:24 +02001043 call WaitForAssert({-> assert_equal('one line', term_getline(buf, 1))})
Bram Moolenaar8b53b792017-09-05 20:29:25 +02001044 let g:job = term_getjob(buf)
Bram Moolenaar0e9d1ae2018-04-30 14:28:24 +02001045 call WaitForAssert({-> assert_equal('dead', job_status(g:job))})
Bram Moolenaare88fc7a2017-09-03 20:59:40 +02001046 bwipe
Bram Moolenaare88fc7a2017-09-03 20:59:40 +02001047 endif
1048endfunc
Bram Moolenaar69fbc9e2017-09-14 20:37:57 +02001049
1050func TerminalTmap(remap)
1051 let buf = Run_shell_in_terminal({})
Bram Moolenaarf4a2ed02021-03-23 16:25:09 +01001052 " Wait for the shell to display a prompt
1053 call WaitForAssert({-> assert_notequal('', term_getline(buf, 1))})
Bram Moolenaar69fbc9e2017-09-14 20:37:57 +02001054 call assert_equal('t', mode())
1055
1056 if a:remap
1057 tmap 123 456
1058 else
1059 tnoremap 123 456
1060 endif
Bram Moolenaar461fe502017-12-05 12:30:03 +01001061 " don't use abcde, it's an existing command
1062 tmap 456 abxde
Bram Moolenaar69fbc9e2017-09-14 20:37:57 +02001063 call assert_equal('456', maparg('123', 't'))
Bram Moolenaar461fe502017-12-05 12:30:03 +01001064 call assert_equal('abxde', maparg('456', 't'))
Bram Moolenaar69fbc9e2017-09-14 20:37:57 +02001065 call feedkeys("123", 'tx')
Bram Moolenaar0e9d1ae2018-04-30 14:28:24 +02001066 call WaitForAssert({-> assert_match('abxde\|456', term_getline(buf, term_getcursor(buf)[0]))})
Bram Moolenaar69fbc9e2017-09-14 20:37:57 +02001067 let lnum = term_getcursor(buf)[0]
1068 if a:remap
Bram Moolenaar461fe502017-12-05 12:30:03 +01001069 call assert_match('abxde', term_getline(buf, lnum))
Bram Moolenaar69fbc9e2017-09-14 20:37:57 +02001070 else
1071 call assert_match('456', term_getline(buf, lnum))
1072 endif
1073
1074 call term_sendkeys(buf, "\r")
Bram Moolenaar7a39dd72019-06-23 00:50:15 +02001075 call StopShellInTerminal(buf)
Bram Moolenaar69fbc9e2017-09-14 20:37:57 +02001076
1077 tunmap 123
1078 tunmap 456
1079 call assert_equal('', maparg('123', 't'))
Yegappan Lakshmanan1104a6d2022-03-31 12:34:15 +01001080 exe buf . 'bwipe'
Bram Moolenaar69fbc9e2017-09-14 20:37:57 +02001081 unlet g:job
1082endfunc
1083
1084func Test_terminal_tmap()
1085 call TerminalTmap(1)
1086 call TerminalTmap(0)
1087endfunc
Bram Moolenaar059db5c2017-10-15 22:42:23 +02001088
1089func Test_terminal_wall()
1090 let buf = Run_shell_in_terminal({})
1091 wall
Bram Moolenaar7a39dd72019-06-23 00:50:15 +02001092 call StopShellInTerminal(buf)
Bram Moolenaar059db5c2017-10-15 22:42:23 +02001093 exe buf . 'bwipe'
1094 unlet g:job
1095endfunc
Bram Moolenaar6daeef12017-10-15 22:56:49 +02001096
Bram Moolenaar7a760922018-02-19 23:10:02 +01001097func Test_terminal_wqall()
1098 let buf = Run_shell_in_terminal({})
Bram Moolenaare2e40752020-09-04 21:18:46 +02001099 call assert_fails('wqall', 'E948:')
Bram Moolenaar7a39dd72019-06-23 00:50:15 +02001100 call StopShellInTerminal(buf)
Bram Moolenaar7a760922018-02-19 23:10:02 +01001101 exe buf . 'bwipe'
1102 unlet g:job
1103endfunc
1104
Bram Moolenaar6daeef12017-10-15 22:56:49 +02001105func Test_terminal_composing_unicode()
Bram Moolenaarf08b0eb2021-10-16 13:00:14 +01001106 let g:test_is_flaky = 1
Bram Moolenaar6daeef12017-10-15 22:56:49 +02001107 let save_enc = &encoding
1108 set encoding=utf-8
1109
1110 if has('win32')
1111 let cmd = "cmd /K chcp 65001"
1112 let lnum = [3, 6, 9]
1113 else
1114 let cmd = &shell
1115 let lnum = [1, 3, 5]
1116 endif
1117
1118 enew
Bram Moolenaarc98cdb32020-09-06 21:13:00 +02001119 let buf = term_start(cmd, {'curwin': 1})
Bram Moolenaar3e1c6172017-11-02 16:58:00 +01001120 let g:job = term_getjob(buf)
Bram Moolenaar41d42992020-05-03 16:29:50 +02001121 call WaitFor({-> term_getline(buf, 1) !=# ''}, 1000)
Bram Moolenaar6daeef12017-10-15 22:56:49 +02001122
Bram Moolenaarebe74b72018-04-21 23:34:43 +02001123 if has('win32')
1124 call assert_equal('cmd', job_info(g:job).cmd[0])
1125 else
1126 call assert_equal(&shell, job_info(g:job).cmd[0])
1127 endif
1128
Bram Moolenaar6daeef12017-10-15 22:56:49 +02001129 " ascii + composing
1130 let txt = "a\u0308bc"
Bram Moolenaar41d42992020-05-03 16:29:50 +02001131 call term_sendkeys(buf, "echo " . txt)
Bram Moolenaar6a2c5a72020-04-08 21:50:25 +02001132 call TermWait(buf, 25)
Bram Moolenaar6daeef12017-10-15 22:56:49 +02001133 call assert_match("echo " . txt, term_getline(buf, lnum[0]))
Bram Moolenaar41d42992020-05-03 16:29:50 +02001134 call term_sendkeys(buf, "\<cr>")
1135 call WaitForAssert({-> assert_equal(txt, term_getline(buf, lnum[0] + 1))}, 1000)
Bram Moolenaar6daeef12017-10-15 22:56:49 +02001136 let l = term_scrape(buf, lnum[0] + 1)
1137 call assert_equal("a\u0308", l[0].chars)
1138 call assert_equal("b", l[1].chars)
1139 call assert_equal("c", l[2].chars)
1140
Bram Moolenaar4549dad2021-02-08 21:29:48 +01001141 " multibyte + composing: がぎぐげご
Bram Moolenaar6daeef12017-10-15 22:56:49 +02001142 let txt = "\u304b\u3099\u304e\u304f\u3099\u3052\u3053\u3099"
Bram Moolenaar41d42992020-05-03 16:29:50 +02001143 call term_sendkeys(buf, "echo " . txt)
Bram Moolenaar6a2c5a72020-04-08 21:50:25 +02001144 call TermWait(buf, 25)
Bram Moolenaar6daeef12017-10-15 22:56:49 +02001145 call assert_match("echo " . txt, term_getline(buf, lnum[1]))
Bram Moolenaar41d42992020-05-03 16:29:50 +02001146 call term_sendkeys(buf, "\<cr>")
1147 call WaitForAssert({-> assert_equal(txt, term_getline(buf, lnum[1] + 1))}, 1000)
Bram Moolenaar6daeef12017-10-15 22:56:49 +02001148 let l = term_scrape(buf, lnum[1] + 1)
1149 call assert_equal("\u304b\u3099", l[0].chars)
Bram Moolenaar4549dad2021-02-08 21:29:48 +01001150 call assert_equal(2, l[0].width)
1151 call assert_equal("\u304e", l[1].chars)
1152 call assert_equal(2, l[1].width)
1153 call assert_equal("\u304f\u3099", l[2].chars)
1154 call assert_equal(2, l[2].width)
1155 call assert_equal("\u3052", l[3].chars)
1156 call assert_equal(2, l[3].width)
1157 call assert_equal("\u3053\u3099", l[4].chars)
1158 call assert_equal(2, l[4].width)
Bram Moolenaar6daeef12017-10-15 22:56:49 +02001159
1160 " \u00a0 + composing
1161 let txt = "abc\u00a0\u0308"
Bram Moolenaar41d42992020-05-03 16:29:50 +02001162 call term_sendkeys(buf, "echo " . txt)
Bram Moolenaar6a2c5a72020-04-08 21:50:25 +02001163 call TermWait(buf, 25)
Bram Moolenaar6daeef12017-10-15 22:56:49 +02001164 call assert_match("echo " . txt, term_getline(buf, lnum[2]))
Bram Moolenaar41d42992020-05-03 16:29:50 +02001165 call term_sendkeys(buf, "\<cr>")
1166 call WaitForAssert({-> assert_equal(txt, term_getline(buf, lnum[2] + 1))}, 1000)
Bram Moolenaar6daeef12017-10-15 22:56:49 +02001167 let l = term_scrape(buf, lnum[2] + 1)
1168 call assert_equal("\u00a0\u0308", l[3].chars)
1169
1170 call term_sendkeys(buf, "exit\r")
Bram Moolenaar0e9d1ae2018-04-30 14:28:24 +02001171 call WaitForAssert({-> assert_equal('dead', job_status(g:job))})
Bram Moolenaar6daeef12017-10-15 22:56:49 +02001172 bwipe!
Bram Moolenaar3e1c6172017-11-02 16:58:00 +01001173 unlet g:job
Bram Moolenaar6daeef12017-10-15 22:56:49 +02001174 let &encoding = save_enc
1175endfunc
Bram Moolenaarff546792017-11-21 14:47:57 +01001176
1177func Test_terminal_aucmd_on_close()
1178 fun Nop()
1179 let s:called = 1
1180 endfun
1181
1182 aug repro
1183 au!
1184 au BufWinLeave * call Nop()
1185 aug END
1186
1187 let [cmd, waittime] = s:get_sleep_cmd()
1188
1189 call assert_equal(1, winnr('$'))
1190 new
1191 call setline(1, ['one', 'two'])
1192 exe 'term ++close ' . cmd
1193 wincmd p
Bram Moolenaar0e9d1ae2018-04-30 14:28:24 +02001194 call WaitForAssert({-> assert_equal(2, winnr('$'))}, waittime)
Bram Moolenaarff546792017-11-21 14:47:57 +01001195 call assert_equal(1, s:called)
1196 bwipe!
1197
1198 unlet s:called
1199 au! repro
1200 delfunc Nop
1201endfunc
Bram Moolenaarede35bb2018-01-26 20:05:18 +01001202
1203func Test_terminal_term_start_empty_command()
1204 let cmd = "call term_start('', {'curwin' : 1, 'term_finish' : 'close'})"
Bram Moolenaare2e40752020-09-04 21:18:46 +02001205 call assert_fails(cmd, 'E474:')
Bram Moolenaarede35bb2018-01-26 20:05:18 +01001206 let cmd = "call term_start('', {'curwin' : 1, 'term_finish' : 'close'})"
Bram Moolenaare2e40752020-09-04 21:18:46 +02001207 call assert_fails(cmd, 'E474:')
Bram Moolenaarede35bb2018-01-26 20:05:18 +01001208 let cmd = "call term_start({}, {'curwin' : 1, 'term_finish' : 'close'})"
Bram Moolenaare2e40752020-09-04 21:18:46 +02001209 call assert_fails(cmd, 'E474:')
Bram Moolenaarede35bb2018-01-26 20:05:18 +01001210 let cmd = "call term_start(0, {'curwin' : 1, 'term_finish' : 'close'})"
Bram Moolenaare2e40752020-09-04 21:18:46 +02001211 call assert_fails(cmd, 'E474:')
Bram Moolenaarca68ae12020-03-30 19:32:53 +02001212 let cmd = "call term_start('', {'term_name' : []})"
Bram Moolenaare2e40752020-09-04 21:18:46 +02001213 call assert_fails(cmd, 'E730:')
Bram Moolenaarca68ae12020-03-30 19:32:53 +02001214 let cmd = "call term_start('', {'term_finish' : 'axby'})"
Bram Moolenaare2e40752020-09-04 21:18:46 +02001215 call assert_fails(cmd, 'E475:')
Bram Moolenaarca68ae12020-03-30 19:32:53 +02001216 let cmd = "call term_start('', {'eof_chars' : []})"
Bram Moolenaar9b7bf9e2020-07-11 22:14:59 +02001217 call assert_fails(cmd, 'E730:')
Bram Moolenaarca68ae12020-03-30 19:32:53 +02001218 let cmd = "call term_start('', {'term_kill' : []})"
Bram Moolenaar9b7bf9e2020-07-11 22:14:59 +02001219 call assert_fails(cmd, 'E730:')
Bram Moolenaarca68ae12020-03-30 19:32:53 +02001220 let cmd = "call term_start('', {'tty_type' : []})"
Bram Moolenaar9b7bf9e2020-07-11 22:14:59 +02001221 call assert_fails(cmd, 'E730:')
Bram Moolenaarca68ae12020-03-30 19:32:53 +02001222 let cmd = "call term_start('', {'tty_type' : 'abc'})"
1223 call assert_fails(cmd, 'E475:')
1224 let cmd = "call term_start('', {'term_highlight' : []})"
Bram Moolenaar9b7bf9e2020-07-11 22:14:59 +02001225 call assert_fails(cmd, 'E730:')
Bram Moolenaar87202262020-05-24 17:23:45 +02001226 if has('gui') || has('termguicolors')
Bram Moolenaarca68ae12020-03-30 19:32:53 +02001227 let cmd = "call term_start('', {'ansi_colors' : 'abc'})"
1228 call assert_fails(cmd, 'E475:')
1229 let cmd = "call term_start('', {'ansi_colors' : [[]]})"
1230 call assert_fails(cmd, 'E730:')
1231 let cmd = "call term_start('', {'ansi_colors' : repeat(['blue'], 18)})"
Bram Moolenaar87202262020-05-24 17:23:45 +02001232 if has('gui_running') || has('termguicolors')
1233 call assert_fails(cmd, 'E475:')
1234 else
1235 call assert_fails(cmd, 'E254:')
1236 endif
Bram Moolenaarca68ae12020-03-30 19:32:53 +02001237 endif
Bram Moolenaarede35bb2018-01-26 20:05:18 +01001238endfunc
Bram Moolenaarb50773c2018-01-30 22:31:19 +01001239
1240func Test_terminal_response_to_control_sequence()
Bram Moolenaaradbde3f2019-09-08 22:57:14 +02001241 CheckUnix
Bram Moolenaarb50773c2018-01-30 22:31:19 +01001242
1243 let buf = Run_shell_in_terminal({})
Bram Moolenaar0e9d1ae2018-04-30 14:28:24 +02001244 call WaitForAssert({-> assert_notequal('', term_getline(buf, 1))})
Bram Moolenaarb50773c2018-01-30 22:31:19 +01001245
Bram Moolenaar086eb872018-03-25 21:24:12 +02001246 call term_sendkeys(buf, "cat\<CR>")
Bram Moolenaar0e9d1ae2018-04-30 14:28:24 +02001247 call WaitForAssert({-> assert_match('cat', term_getline(buf, 1))})
Bram Moolenaard4a282f2018-02-02 18:22:31 +01001248
Bram Moolenaar086eb872018-03-25 21:24:12 +02001249 " Request the cursor position.
1250 call term_sendkeys(buf, "\x1b[6n\<CR>")
Bram Moolenaard4a282f2018-02-02 18:22:31 +01001251
1252 " Wait for output from tty to display, below an empty line.
Bram Moolenaar0e9d1ae2018-04-30 14:28:24 +02001253 call WaitForAssert({-> assert_match('3;1R', term_getline(buf, 4))})
Bram Moolenaarb50773c2018-01-30 22:31:19 +01001254
Bram Moolenaar086eb872018-03-25 21:24:12 +02001255 " End "cat" gently.
1256 call term_sendkeys(buf, "\<CR>\<C-D>")
1257
Bram Moolenaar7a39dd72019-06-23 00:50:15 +02001258 call StopShellInTerminal(buf)
Bram Moolenaarb50773c2018-01-30 22:31:19 +01001259 exe buf . 'bwipe'
1260 unlet g:job
1261endfunc
Bram Moolenaar25cdd9c2018-03-10 20:28:12 +01001262
Bram Moolenaarc2958582021-12-14 11:16:31 +00001263" Run this first, it fails when run after other tests.
1264func Test_aa_terminal_focus_events()
Bram Moolenaara48d4e42021-12-08 22:13:38 +00001265 CheckNotGui
1266 CheckUnix
1267 CheckRunVimInTerminal
1268
1269 let save_term = &term
1270 let save_ttymouse = &ttymouse
1271 set term=xterm ttymouse=xterm2
1272
1273 let lines =<< trim END
1274 set term=xterm ttymouse=xterm2
Bram Moolenaare5050712021-12-09 10:51:05 +00001275 au FocusLost * call setline(1, 'I am lost') | set nomod
1276 au FocusGained * call setline(1, 'I am back') | set nomod
Bram Moolenaara48d4e42021-12-08 22:13:38 +00001277 END
Bram Moolenaarc4860bd2022-10-15 20:52:26 +01001278 call writefile(lines, 'XtermFocus', 'D')
Bram Moolenaara48d4e42021-12-08 22:13:38 +00001279 let buf = RunVimInTerminal('-S XtermFocus', #{rows: 6})
1280
1281 " Send a focus event to ourselves, it should be forwarded to the terminal
1282 call feedkeys("\<Esc>[O", "Lx!")
Bram Moolenaara48d4e42021-12-08 22:13:38 +00001283 call VerifyScreenDump(buf, 'Test_terminal_focus_1', {})
1284
1285 call feedkeys("\<Esc>[I", "Lx!")
Bram Moolenaara48d4e42021-12-08 22:13:38 +00001286 call VerifyScreenDump(buf, 'Test_terminal_focus_2', {})
1287
Bram Moolenaare5050712021-12-09 10:51:05 +00001288 " check that a command line being edited is redrawn in place
1289 call term_sendkeys(buf, ":" .. repeat('x', 80))
1290 call TermWait(buf)
1291 call feedkeys("\<Esc>[O", "Lx!")
Bram Moolenaare5050712021-12-09 10:51:05 +00001292 call VerifyScreenDump(buf, 'Test_terminal_focus_3', {})
1293 call term_sendkeys(buf, "\<Esc>")
1294
Bram Moolenaara48d4e42021-12-08 22:13:38 +00001295 call StopVimInTerminal(buf)
Bram Moolenaara48d4e42021-12-08 22:13:38 +00001296 let &term = save_term
1297 let &ttymouse = save_ttymouse
1298endfunc
1299
Bram Moolenaar3e8d3852018-03-20 17:43:01 +01001300" Run Vim, start a terminal in that Vim with the kill argument,
1301" :qall works.
1302func Run_terminal_qall_kill(line1, line2)
1303 " 1. Open a terminal window and wait for the prompt to appear
1304 " 2. set kill using term_setkill()
1305 " 3. make Vim exit, it will kill the shell
1306 let after = [
1307 \ a:line1,
1308 \ 'let buf = bufnr("%")',
1309 \ 'while term_getline(buf, 1) =~ "^\\s*$"',
1310 \ ' sleep 10m',
1311 \ 'endwhile',
1312 \ a:line2,
1313 \ 'au VimLeavePre * call writefile(["done"], "Xdone")',
1314 \ 'qall',
1315 \ ]
1316 if !RunVim([], after, '')
Bram Moolenaar25cdd9c2018-03-10 20:28:12 +01001317 return
1318 endif
Bram Moolenaar3e8d3852018-03-20 17:43:01 +01001319 call assert_equal("done", readfile("Xdone")[0])
1320 call delete("Xdone")
Bram Moolenaar25cdd9c2018-03-10 20:28:12 +01001321endfunc
1322
1323" Run Vim in a terminal, then start a terminal in that Vim with a kill
1324" argument, check that :qall works.
Bram Moolenaar3e8d3852018-03-20 17:43:01 +01001325func Test_terminal_qall_kill_arg()
1326 call Run_terminal_qall_kill('term ++kill=kill', '')
1327endfunc
1328
1329" Run Vim, start a terminal in that Vim, set the kill argument with
1330" term_setkill(), check that :qall works.
Bram Moolenaar25cdd9c2018-03-10 20:28:12 +01001331func Test_terminal_qall_kill_func()
Bram Moolenaar7ee80f72019-09-08 20:55:06 +02001332 call Run_terminal_qall_kill('term', 'eval buf->term_setkill("kill")')
Bram Moolenaar3e8d3852018-03-20 17:43:01 +01001333endfunc
1334
1335" Run Vim, start a terminal in that Vim without the kill argument,
1336" check that :qall does not exit, :qall! does.
1337func Test_terminal_qall_exit()
Bram Moolenaarc79745a2019-05-20 22:12:34 +02001338 let after =<< trim [CODE]
1339 term
1340 let buf = bufnr("%")
1341 while term_getline(buf, 1) =~ "^\\s*$"
1342 sleep 10m
1343 endwhile
1344 set nomore
1345 au VimLeavePre * call writefile(["too early"], "Xdone")
1346 qall
1347 au! VimLeavePre * exe buf . "bwipe!" | call writefile(["done"], "Xdone")
1348 cquit
1349 [CODE]
1350
Bram Moolenaar3e8d3852018-03-20 17:43:01 +01001351 if !RunVim([], after, '')
Bram Moolenaar25cdd9c2018-03-10 20:28:12 +01001352 return
1353 endif
Bram Moolenaar3e8d3852018-03-20 17:43:01 +01001354 call assert_equal("done", readfile("Xdone")[0])
1355 call delete("Xdone")
Bram Moolenaar25cdd9c2018-03-10 20:28:12 +01001356endfunc
Bram Moolenaar435acdb2018-03-10 20:51:25 +01001357
1358" Run Vim in a terminal, then start a terminal in that Vim without a kill
1359" argument, check that :confirm qall works.
1360func Test_terminal_qall_prompt()
Bram Moolenaarc2585492019-09-22 21:29:53 +02001361 CheckRunVimInTerminal
Bram Moolenaare564c702022-06-14 15:00:28 +01001362
Bram Moolenaar435acdb2018-03-10 20:51:25 +01001363 let buf = RunVimInTerminal('', {})
1364
Bram Moolenaar99f4b6e2022-06-14 19:52:16 +01001365 " the shell may set the window title, we don't want that here
Bram Moolenaar377d92a2022-06-14 21:22:12 +01001366 call term_sendkeys(buf, ":call test_override('vterm_title', 1)\<CR>")
Bram Moolenaar99f4b6e2022-06-14 19:52:16 +01001367
Bram Moolenaar435acdb2018-03-10 20:51:25 +01001368 " Open a terminal window and wait for the prompt to appear
1369 call term_sendkeys(buf, ":term\<CR>")
Bram Moolenaar0e9d1ae2018-04-30 14:28:24 +02001370 call WaitForAssert({-> assert_match('\[running]', term_getline(buf, 10))})
1371 call WaitForAssert({-> assert_notmatch('^\s*$', term_getline(buf, 1))})
Bram Moolenaar435acdb2018-03-10 20:51:25 +01001372
1373 " make Vim exit, it will prompt to kill the shell
1374 call term_sendkeys(buf, "\<C-W>:confirm qall\<CR>")
Yee Cheng Chin15b314f2022-10-09 18:53:32 +01001375 call WaitForAssert({-> assert_match('\[Y\]es, (N)o:', term_getline(buf, 20))})
Bram Moolenaar435acdb2018-03-10 20:51:25 +01001376 call term_sendkeys(buf, "y")
Bram Moolenaar0e9d1ae2018-04-30 14:28:24 +02001377 call WaitForAssert({-> assert_equal('finished', term_getstatus(buf))})
Bram Moolenaar435acdb2018-03-10 20:51:25 +01001378
1379 " close the terminal window where Vim was running
1380 quit
1381endfunc
Bram Moolenaarb852c3e2018-03-11 16:55:36 +01001382
Bram Moolenaar4d14bac2019-10-20 21:15:15 +02001383" Run Vim in a terminal, then start a terminal window with a shell and check
1384" that Vim exits if it is closed.
1385func Test_terminal_exit()
1386 CheckRunVimInTerminal
1387
1388 let lines =<< trim END
1389 let winid = win_getid()
1390 help
1391 term
1392 let termid = win_getid()
1393 call win_gotoid(winid)
1394 close
1395 call win_gotoid(termid)
1396 END
Bram Moolenaarc4860bd2022-10-15 20:52:26 +01001397 call writefile(lines, 'XtermExit', 'D')
Bram Moolenaar4d14bac2019-10-20 21:15:15 +02001398 let buf = RunVimInTerminal('-S XtermExit', #{rows: 10})
1399 let job = term_getjob(buf)
1400 call WaitForAssert({-> assert_equal("run", job_status(job))})
1401
1402 " quit the shell, it will make Vim exit
1403 call term_sendkeys(buf, "exit\<CR>")
1404 call WaitForAssert({-> assert_equal("dead", job_status(job))})
Bram Moolenaar4d14bac2019-10-20 21:15:15 +02001405endfunc
1406
Bram Moolenaar012eb662018-03-13 17:55:27 +01001407func Test_terminal_open_autocmd()
Bram Moolenaarb852c3e2018-03-11 16:55:36 +01001408 augroup repro
1409 au!
1410 au TerminalOpen * let s:called += 1
1411 augroup END
1412
1413 let s:called = 0
1414
1415 " Open a terminal window with :terminal
1416 terminal
1417 call assert_equal(1, s:called)
1418 bwipe!
1419
1420 " Open a terminal window with term_start()
1421 call term_start(&shell)
1422 call assert_equal(2, s:called)
1423 bwipe!
1424
1425 " Open a hidden terminal buffer with :terminal
1426 terminal ++hidden
1427 call assert_equal(3, s:called)
1428 for buf in term_list()
1429 exe buf . "bwipe!"
1430 endfor
1431
1432 " Open a hidden terminal buffer with term_start()
1433 let buf = term_start(&shell, {'hidden': 1})
1434 call assert_equal(4, s:called)
1435 exe buf . "bwipe!"
1436
1437 unlet s:called
1438 au! repro
Bram Moolenaarf4d61bc2020-11-14 14:22:28 +01001439endfunc
1440
1441func Test_open_term_from_cmd()
1442 CheckUnix
1443 CheckRunVimInTerminal
1444
1445 let lines =<< trim END
1446 call setline(1, ['a', 'b', 'c'])
1447 3
1448 set incsearch
1449 cnoremap <F3> <Cmd>call term_start(['/bin/sh', '-c', ':'])<CR>
1450 END
Bram Moolenaarc4860bd2022-10-15 20:52:26 +01001451 call writefile(lines, 'Xopenterm', 'D')
Bram Moolenaarf4d61bc2020-11-14 14:22:28 +01001452 let buf = RunVimInTerminal('-S Xopenterm', {})
1453
1454 " this opens a window, incsearch should not use the old cursor position
1455 call term_sendkeys(buf, "/\<F3>")
1456 call VerifyScreenDump(buf, 'Test_terminal_from_cmd', {})
1457 call term_sendkeys(buf, "\<Esc>")
1458 call term_sendkeys(buf, ":q\<CR>")
1459
1460 call StopVimInTerminal(buf)
Bram Moolenaarf4d61bc2020-11-14 14:22:28 +01001461endfunc
Bram Moolenaar45d2a642018-03-24 14:30:32 +01001462
Bram Moolenaar4549dad2021-02-08 21:29:48 +01001463func Test_combining_double_width()
1464 CheckUnix
1465 CheckRunVimInTerminal
1466
Bram Moolenaarc4860bd2022-10-15 20:52:26 +01001467 call writefile(["\xe3\x83\x9b\xe3\x82\x9a"], 'Xonedouble', 'D')
Bram Moolenaar4549dad2021-02-08 21:29:48 +01001468 let lines =<< trim END
1469 call term_start(['/bin/sh', '-c', 'cat Xonedouble'])
1470 END
Bram Moolenaarc4860bd2022-10-15 20:52:26 +01001471 call writefile(lines, 'Xcombining', 'D')
Bram Moolenaar4549dad2021-02-08 21:29:48 +01001472 let buf = RunVimInTerminal('-S Xcombining', #{rows: 9})
1473
1474 " this opens a window, incsearch should not use the old cursor position
1475 call VerifyScreenDump(buf, 'Test_terminal_combining', {})
1476 call term_sendkeys(buf, ":q\<CR>")
1477
1478 call StopVimInTerminal(buf)
Bram Moolenaar4549dad2021-02-08 21:29:48 +01001479endfunc
1480
Bram Moolenaar02764712020-11-14 20:21:55 +01001481func Test_terminal_popup_with_cmd()
1482 " this was crashing
1483 let buf = term_start(&shell, #{hidden: v:true})
1484 let s:winid = popup_create(buf, {})
1485 tnoremap <F3> <Cmd>call popup_close(s:winid)<CR>
1486 call feedkeys("\<F3>", 'xt')
1487
1488 tunmap <F3>
1489 exe 'bwipe! ' .. buf
1490 unlet s:winid
1491endfunc
1492
Bram Moolenaar8adc8d92020-11-16 20:47:31 +01001493func Test_terminal_popup_bufload()
1494 let termbuf = term_start(&shell, #{hidden: v:true, term_finish: 'close'})
1495 let winid = popup_create(termbuf, {})
1496 sleep 50m
1497
1498 let newbuf = bufadd('')
1499 call bufload(newbuf)
1500 call setbufline(newbuf, 1, 'foobar')
1501
1502 " must not have switched to another window
1503 call assert_equal(winid, win_getid())
1504
Bram Moolenaare6329e42020-11-16 21:10:34 +01001505 call StopShellInTerminal(termbuf)
1506 call WaitFor({-> win_getid() != winid})
Bram Moolenaar8adc8d92020-11-16 20:47:31 +01001507 exe 'bwipe! ' .. newbuf
1508endfunc
1509
Bram Moolenaar3194e5b2021-12-13 21:59:09 +00001510func Test_terminal_popup_two_windows()
Bram Moolenaar0407d272021-12-13 22:17:44 +00001511 CheckRunVimInTerminal
Bram Moolenaar3194e5b2021-12-13 21:59:09 +00001512 CheckUnix
1513
1514 " use "sh" instead of "&shell" in the hope it will use a short prompt
1515 let lines =<< trim END
1516 let termbuf = term_start('sh', #{hidden: v:true, term_finish: 'close'})
1517 exe 'buffer ' .. termbuf
1518
1519 let winid = popup_create(termbuf, #{line: 2, minwidth: 30, border: []})
1520 sleep 50m
1521
1522 call term_sendkeys(termbuf, "echo 'test'")
1523 END
Bram Moolenaarc4860bd2022-10-15 20:52:26 +01001524 call writefile(lines, 'XpopupScript', 'D')
Bram Moolenaar3194e5b2021-12-13 21:59:09 +00001525 let buf = RunVimInTerminal('-S XpopupScript', {})
1526
1527 " typed text appears both in normal window and in popup
1528 call WaitForAssert({-> assert_match("echo 'test'", term_getline(buf, 1))})
1529 call WaitForAssert({-> assert_match("echo 'test'", term_getline(buf, 3))})
1530
Bram Moolenaar0407d272021-12-13 22:17:44 +00001531 call term_sendkeys(buf, "\<CR>\<CR>exit\<CR>")
1532 call TermWait(buf)
1533 call term_sendkeys(buf, ":q\<CR>")
Bram Moolenaar3194e5b2021-12-13 21:59:09 +00001534 call StopVimInTerminal(buf)
Bram Moolenaar3194e5b2021-12-13 21:59:09 +00001535endfunc
1536
Bram Moolenaare41decc2020-11-14 21:34:59 +01001537func Test_terminal_popup_insert_cmd()
1538 CheckUnix
1539
1540 inoremap <F3> <Cmd>call StartTermInPopup()<CR>
1541 func StartTermInPopup()
Bram Moolenaar27f4f6b2020-11-16 21:02:28 +01001542 call term_start(['/bin/sh', '-c', 'cat'], #{hidden: v:true, term_finish: 'close'})->popup_create(#{highlight: 'Pmenu'})
Bram Moolenaare41decc2020-11-14 21:34:59 +01001543 endfunc
1544 call feedkeys("i\<F3>")
1545 sleep 10m
1546 call assert_equal('n', mode())
1547
1548 call feedkeys("\<C-D>", 'xt')
Bram Moolenaar17ab28d2020-11-18 12:24:01 +01001549 call WaitFor({-> popup_list() == []})
Bram Moolenaare41decc2020-11-14 21:34:59 +01001550 delfunc StartTermInPopup
1551 iunmap <F3>
1552endfunc
1553
Bram Moolenaar45d2a642018-03-24 14:30:32 +01001554func Check_dump01(off)
1555 call assert_equal('one two three four five', trim(getline(a:off + 1)))
1556 call assert_equal('~ Select Word', trim(getline(a:off + 7)))
Bram Moolenaar1834d372018-03-29 17:40:46 +02001557 call assert_equal(':popup PopUp', trim(getline(a:off + 20)))
Bram Moolenaar45d2a642018-03-24 14:30:32 +01001558endfunc
1559
Bram Moolenaarf06b0b62018-03-29 17:22:24 +02001560func Test_terminal_dumpwrite_composing()
Bram Moolenaarc2585492019-09-22 21:29:53 +02001561 CheckRunVimInTerminal
Bram Moolenaar3194e5b2021-12-13 21:59:09 +00001562
Bram Moolenaarf06b0b62018-03-29 17:22:24 +02001563 let save_enc = &encoding
1564 set encoding=utf-8
1565 call assert_equal(1, winnr('$'))
1566
1567 let text = " a\u0300 e\u0302 o\u0308"
Bram Moolenaarc4860bd2022-10-15 20:52:26 +01001568 call writefile([text], 'Xcomposing', 'D')
Bram Moolenaar77bfd752018-04-30 18:03:10 +02001569 let buf = RunVimInTerminal('--cmd "set encoding=utf-8" Xcomposing', {})
Bram Moolenaar0e9d1ae2018-04-30 14:28:24 +02001570 call WaitForAssert({-> assert_match(text, term_getline(buf, 1))})
Bram Moolenaar7ee80f72019-09-08 20:55:06 +02001571 eval 'Xdump'->term_dumpwrite(buf)
Bram Moolenaarf06b0b62018-03-29 17:22:24 +02001572 let dumpline = readfile('Xdump')[0]
1573 call assert_match('|à| |ê| |ö', dumpline)
1574
1575 call StopVimInTerminal(buf)
Bram Moolenaarf06b0b62018-03-29 17:22:24 +02001576 call delete('Xdump')
1577 let &encoding = save_enc
1578endfunc
1579
Bram Moolenaar91689ea2020-05-11 22:04:53 +02001580" Tests for failures in the term_dumpwrite() function
1581func Test_terminal_dumpwrite_errors()
1582 CheckRunVimInTerminal
1583 call assert_fails("call term_dumpwrite({}, 'Xtest.dump')", 'E728:')
1584 let buf = RunVimInTerminal('', {})
Bram Moolenaar733d2592020-08-20 18:59:06 +02001585 call TermWait(buf)
Yegappan Lakshmanan04c4c572022-08-30 19:48:24 +01001586 call assert_fails("call term_dumpwrite(buf, 'Xtest.dump', '')", 'E1206:')
Bram Moolenaar91689ea2020-05-11 22:04:53 +02001587 call assert_fails("call term_dumpwrite(buf, [])", 'E730:')
1588 call writefile([], 'Xtest.dump')
1589 call assert_fails("call term_dumpwrite(buf, 'Xtest.dump')", 'E953:')
1590 call delete('Xtest.dump')
1591 call assert_fails("call term_dumpwrite(buf, '')", 'E482:')
1592 call assert_fails("call term_dumpwrite(buf, test_null_string())", 'E482:')
Bram Moolenaar98f16712020-05-22 13:34:01 +02001593 call test_garbagecollect_now()
Bram Moolenaara46765a2020-11-01 20:58:26 +01001594 call StopVimInTerminal(buf, 0)
Bram Moolenaar733d2592020-08-20 18:59:06 +02001595 call TermWait(buf)
Bram Moolenaar91689ea2020-05-11 22:04:53 +02001596 call assert_fails("call term_dumpwrite(buf, 'Xtest.dump')", 'E958:')
1597 call assert_fails('call term_sendkeys([], ":q\<CR>")', 'E745:')
1598 call assert_equal(0, term_sendkeys(buf, ":q\<CR>"))
1599endfunc
1600
Bram Moolenaar45d2a642018-03-24 14:30:32 +01001601" just testing basic functionality.
1602func Test_terminal_dumpload()
Bram Moolenaar87abab92019-06-03 21:14:59 +02001603 let curbuf = winbufnr('')
Bram Moolenaar45d2a642018-03-24 14:30:32 +01001604 call assert_equal(1, winnr('$'))
Bram Moolenaar87abab92019-06-03 21:14:59 +02001605 let buf = term_dumpload('dumps/Test_popup_command_01.dump')
Bram Moolenaar45d2a642018-03-24 14:30:32 +01001606 call assert_equal(2, winnr('$'))
1607 call assert_equal(20, line('$'))
1608 call Check_dump01(0)
Bram Moolenaar87abab92019-06-03 21:14:59 +02001609
1610 " Load another dump in the same window
Bram Moolenaar7ee80f72019-09-08 20:55:06 +02001611 let buf2 = 'dumps/Test_diff_01.dump'->term_dumpload({'bufnr': buf})
Bram Moolenaar87abab92019-06-03 21:14:59 +02001612 call assert_equal(buf, buf2)
1613 call assert_notequal('one two three four five', trim(getline(1)))
1614
1615 " Load the first dump again in the same window
1616 let buf2 = term_dumpload('dumps/Test_popup_command_01.dump', {'bufnr': buf})
1617 call assert_equal(buf, buf2)
1618 call Check_dump01(0)
1619
1620 call assert_fails("call term_dumpload('dumps/Test_popup_command_01.dump', {'bufnr': curbuf})", 'E475:')
1621 call assert_fails("call term_dumpload('dumps/Test_popup_command_01.dump', {'bufnr': 9999})", 'E86:')
1622 new
1623 let closedbuf = winbufnr('')
1624 quit
1625 call assert_fails("call term_dumpload('dumps/Test_popup_command_01.dump', {'bufnr': closedbuf})", 'E475:')
Bram Moolenaar9b7bf9e2020-07-11 22:14:59 +02001626 call assert_fails('call term_dumpload([])', 'E730:')
Bram Moolenaar91689ea2020-05-11 22:04:53 +02001627 call assert_fails('call term_dumpload("xabcy.dump")', 'E485:')
Bram Moolenaar87abab92019-06-03 21:14:59 +02001628
Bram Moolenaar45d2a642018-03-24 14:30:32 +01001629 quit
1630endfunc
1631
Bram Moolenaar17efc7f2019-10-16 18:11:31 +02001632func Test_terminal_dumpload_dump()
1633 CheckRunVimInTerminal
1634
1635 let lines =<< trim END
1636 call term_dumpload('dumps/Test_popupwin_22.dump', #{term_rows: 12})
1637 END
Bram Moolenaarc4860bd2022-10-15 20:52:26 +01001638 call writefile(lines, 'XtermDumpload', 'D')
Bram Moolenaar17efc7f2019-10-16 18:11:31 +02001639 let buf = RunVimInTerminal('-S XtermDumpload', #{rows: 15})
1640 call VerifyScreenDump(buf, 'Test_terminal_dumpload', {})
1641
1642 call StopVimInTerminal(buf)
Bram Moolenaar17efc7f2019-10-16 18:11:31 +02001643endfunc
1644
Bram Moolenaar45d2a642018-03-24 14:30:32 +01001645func Test_terminal_dumpdiff()
1646 call assert_equal(1, winnr('$'))
Bram Moolenaar7ee80f72019-09-08 20:55:06 +02001647 eval 'dumps/Test_popup_command_01.dump'->term_dumpdiff('dumps/Test_popup_command_02.dump')
Bram Moolenaar45d2a642018-03-24 14:30:32 +01001648 call assert_equal(2, winnr('$'))
1649 call assert_equal(62, line('$'))
1650 call Check_dump01(0)
1651 call Check_dump01(42)
1652 call assert_equal(' bbbbbbbbbbbbbbbbbb ', getline(26)[0:29])
1653 quit
Bram Moolenaar91689ea2020-05-11 22:04:53 +02001654
Bram Moolenaar9b7bf9e2020-07-11 22:14:59 +02001655 call assert_fails('call term_dumpdiff("X1.dump", [])', 'E730:')
Bram Moolenaar91689ea2020-05-11 22:04:53 +02001656 call assert_fails('call term_dumpdiff("X1.dump", "X2.dump")', 'E485:')
Bram Moolenaarc4860bd2022-10-15 20:52:26 +01001657 call writefile([], 'X1.dump', 'D')
Bram Moolenaar91689ea2020-05-11 22:04:53 +02001658 call assert_fails('call term_dumpdiff("X1.dump", "X2.dump")', 'E485:')
Bram Moolenaar45d2a642018-03-24 14:30:32 +01001659endfunc
Bram Moolenaar897e63c2018-03-24 17:16:33 +01001660
Bram Moolenaarc3ef8962019-02-15 00:16:13 +01001661func Test_terminal_dumpdiff_swap()
1662 call assert_equal(1, winnr('$'))
1663 call term_dumpdiff('dumps/Test_popup_command_01.dump', 'dumps/Test_popup_command_03.dump')
1664 call assert_equal(2, winnr('$'))
1665 call assert_equal(62, line('$'))
1666 call assert_match('Test_popup_command_01.dump', getline(21))
1667 call assert_match('Test_popup_command_03.dump', getline(42))
1668 call assert_match('Undo', getline(3))
1669 call assert_match('three four five', getline(45))
1670
1671 normal s
1672 call assert_match('Test_popup_command_03.dump', getline(21))
1673 call assert_match('Test_popup_command_01.dump', getline(42))
1674 call assert_match('three four five', getline(3))
1675 call assert_match('Undo', getline(45))
1676 quit
Bram Moolenaar98f16712020-05-22 13:34:01 +02001677
1678 " Diff two terminal dump files with different number of rows
1679 " Swap the diffs
1680 call term_dumpdiff('dumps/Test_popup_command_01.dump', 'dumps/Test_winline_rnu.dump')
1681 call assert_match('Test_popup_command_01.dump', getline(21))
1682 call assert_match('Test_winline_rnu.dump', getline(42))
1683 normal s
1684 call assert_match('Test_winline_rnu.dump', getline(6))
1685 call assert_match('Test_popup_command_01.dump', getline(27))
1686 quit
Bram Moolenaarc3ef8962019-02-15 00:16:13 +01001687endfunc
1688
Bram Moolenaar897e63c2018-03-24 17:16:33 +01001689func Test_terminal_dumpdiff_options()
1690 set laststatus=0
1691 call assert_equal(1, winnr('$'))
1692 let height = winheight(0)
1693 call term_dumpdiff('dumps/Test_popup_command_01.dump', 'dumps/Test_popup_command_02.dump', {'vertical': 1, 'term_cols': 33})
1694 call assert_equal(2, winnr('$'))
1695 call assert_equal(height, winheight(winnr()))
1696 call assert_equal(33, winwidth(winnr()))
1697 call assert_equal('dump diff dumps/Test_popup_command_01.dump', bufname('%'))
1698 quit
1699
1700 call assert_equal(1, winnr('$'))
Bram Moolenaar897e63c2018-03-24 17:16:33 +01001701 call term_dumpdiff('dumps/Test_popup_command_01.dump', 'dumps/Test_popup_command_02.dump', {'vertical': 0, 'term_rows': 13, 'term_name': 'something else'})
1702 call assert_equal(2, winnr('$'))
Bram Moolenaare809a4e2019-07-04 17:35:05 +02001703 call assert_equal(&columns, winwidth(0))
1704 call assert_equal(13, winheight(0))
Bram Moolenaar897e63c2018-03-24 17:16:33 +01001705 call assert_equal('something else', bufname('%'))
1706 quit
1707
1708 call assert_equal(1, winnr('$'))
1709 call term_dumpdiff('dumps/Test_popup_command_01.dump', 'dumps/Test_popup_command_02.dump', {'curwin': 1})
1710 call assert_equal(1, winnr('$'))
Bram Moolenaarca68ae12020-03-30 19:32:53 +02001711 call assert_fails("call term_dumpdiff('dumps/Test_popup_command_01.dump', 'dumps/Test_popup_command_02.dump', {'bufnr': -1})", 'E475:')
Bram Moolenaar897e63c2018-03-24 17:16:33 +01001712 bwipe
1713
1714 set laststatus&
1715endfunc
Bram Moolenaar8fbaeb12018-03-25 18:20:17 +02001716
Bram Moolenaar10772302019-01-20 18:25:54 +01001717" When drawing the statusline the cursor position may not have been updated
1718" yet.
1719" 1. create a terminal, make it show 2 lines
1720" 2. 0.5 sec later: leave terminal window, execute "i"
1721" 3. 0.5 sec later: clear terminal window, now it's 1 line
1722" 4. 0.5 sec later: redraw, including statusline (used to trigger bug)
1723" 4. 0.5 sec later: should be done, clean up
1724func Test_terminal_statusline()
Bram Moolenaaradbde3f2019-09-08 22:57:14 +02001725 CheckUnix
Bram Moolenaar81035272021-12-16 18:02:07 +00001726 CheckFeature timers
Bram Moolenaaradbde3f2019-09-08 22:57:14 +02001727
Bram Moolenaar10772302019-01-20 18:25:54 +01001728 set statusline=x
1729 terminal
1730 let tbuf = bufnr('')
1731 call term_sendkeys(tbuf, "clear; echo a; echo b; sleep 1; clear\n")
1732 call timer_start(500, { tid -> feedkeys("\<C-w>j", 'tx') })
1733 call timer_start(1500, { tid -> feedkeys("\<C-l>", 'tx') })
1734 au BufLeave * if &buftype == 'terminal' | silent! normal i | endif
1735
1736 sleep 2
1737 exe tbuf . 'bwipe!'
1738 au! BufLeave
1739 set statusline=
1740endfunc
Bram Moolenaarfa1e90c2019-04-06 17:47:40 +02001741
Bram Moolenaar81035272021-12-16 18:02:07 +00001742func CheckTerminalWindowWorks(buf)
1743 call WaitForAssert({-> assert_match('!sh \[running\]', term_getline(a:buf, 10))})
1744 call term_sendkeys(a:buf, "exit\<CR>")
1745 call WaitForAssert({-> assert_match('!sh \[finished\]', term_getline(a:buf, 10))})
1746 call term_sendkeys(a:buf, ":q\<CR>")
1747 call WaitForAssert({-> assert_match('^\~', term_getline(a:buf, 10))})
1748endfunc
1749
1750func Test_start_terminal_from_timer()
1751 CheckUnix
1752 CheckFeature timers
1753
1754 " Open a terminal window from a timer, typed text goes to the terminal
Bram Moolenaarc4860bd2022-10-15 20:52:26 +01001755 call writefile(["call timer_start(100, { -> term_start('sh') })"], 'XtimerTerm', 'D')
Bram Moolenaar81035272021-12-16 18:02:07 +00001756 let buf = RunVimInTerminal('-S XtimerTerm', {})
1757 call CheckTerminalWindowWorks(buf)
1758
1759 " do the same in Insert mode
1760 call term_sendkeys(buf, ":call timer_start(200, { -> term_start('sh') })\<CR>a")
1761 call CheckTerminalWindowWorks(buf)
1762
1763 call StopVimInTerminal(buf)
Bram Moolenaar81035272021-12-16 18:02:07 +00001764endfunc
1765
Bram Moolenaarf43e7ac2020-09-29 21:23:25 +02001766func Test_terminal_window_focus()
1767 let winid1 = win_getid()
1768 terminal
1769 let winid2 = win_getid()
1770 call feedkeys("\<C-W>j", 'xt')
1771 call assert_equal(winid1, win_getid())
1772 call feedkeys("\<C-W>k", 'xt')
1773 call assert_equal(winid2, win_getid())
1774 " can use a cursor key here
1775 call feedkeys("\<C-W>\<Down>", 'xt')
1776 call assert_equal(winid1, win_getid())
1777 call feedkeys("\<C-W>\<Up>", 'xt')
1778 call assert_equal(winid2, win_getid())
1779
1780 bwipe!
1781endfunc
1782
Bram Moolenaar18aa13d2020-07-11 13:09:36 +02001783func Api_drop_common(options)
1784 call assert_equal(1, winnr('$'))
1785
1786 " Use the title termcap entries to output the escape sequence.
1787 call writefile([
1788 \ 'set title',
1789 \ 'exe "set t_ts=\<Esc>]51; t_fs=\x07"',
1790 \ 'let &titlestring = ''["drop","Xtextfile"' . a:options . ']''',
1791 \ 'redraw',
1792 \ "set t_ts=",
1793 \ ], 'Xscript')
1794 let buf = RunVimInTerminal('-S Xscript', {})
1795 call WaitFor({-> bufnr('Xtextfile') > 0})
1796 call assert_equal('Xtextfile', expand('%:t'))
1797 call assert_true(winnr('$') >= 3)
1798 return buf
1799endfunc
1800
1801func Test_terminal_api_drop_newwin()
1802 CheckRunVimInTerminal
1803 let buf = Api_drop_common('')
1804 call assert_equal(0, &bin)
1805 call assert_equal('', &fenc)
1806
1807 call StopVimInTerminal(buf)
1808 call delete('Xscript')
1809 bwipe Xtextfile
1810endfunc
1811
1812func Test_terminal_api_drop_newwin_bin()
1813 CheckRunVimInTerminal
1814 let buf = Api_drop_common(',{"bin":1}')
1815 call assert_equal(1, &bin)
1816
1817 call StopVimInTerminal(buf)
1818 call delete('Xscript')
1819 bwipe Xtextfile
1820endfunc
1821
1822func Test_terminal_api_drop_newwin_binary()
1823 CheckRunVimInTerminal
1824 let buf = Api_drop_common(',{"binary":1}')
1825 call assert_equal(1, &bin)
1826
1827 call StopVimInTerminal(buf)
1828 call delete('Xscript')
1829 bwipe Xtextfile
1830endfunc
1831
1832func Test_terminal_api_drop_newwin_nobin()
1833 CheckRunVimInTerminal
1834 set binary
1835 let buf = Api_drop_common(',{"nobin":1}')
1836 call assert_equal(0, &bin)
1837
1838 call StopVimInTerminal(buf)
1839 call delete('Xscript')
1840 bwipe Xtextfile
1841 set nobinary
1842endfunc
1843
1844func Test_terminal_api_drop_newwin_nobinary()
1845 CheckRunVimInTerminal
1846 set binary
1847 let buf = Api_drop_common(',{"nobinary":1}')
1848 call assert_equal(0, &bin)
1849
1850 call StopVimInTerminal(buf)
1851 call delete('Xscript')
1852 bwipe Xtextfile
1853 set nobinary
1854endfunc
1855
1856func Test_terminal_api_drop_newwin_ff()
1857 CheckRunVimInTerminal
1858 let buf = Api_drop_common(',{"ff":"dos"}')
1859 call assert_equal("dos", &ff)
1860
1861 call StopVimInTerminal(buf)
1862 call delete('Xscript')
1863 bwipe Xtextfile
1864endfunc
1865
1866func Test_terminal_api_drop_newwin_fileformat()
1867 CheckRunVimInTerminal
1868 let buf = Api_drop_common(',{"fileformat":"dos"}')
1869 call assert_equal("dos", &ff)
1870
1871 call StopVimInTerminal(buf)
1872 call delete('Xscript')
1873 bwipe Xtextfile
1874endfunc
1875
1876func Test_terminal_api_drop_newwin_enc()
1877 CheckRunVimInTerminal
1878 let buf = Api_drop_common(',{"enc":"utf-16"}')
1879 call assert_equal("utf-16", &fenc)
1880
1881 call StopVimInTerminal(buf)
1882 call delete('Xscript')
1883 bwipe Xtextfile
1884endfunc
1885
1886func Test_terminal_api_drop_newwin_encoding()
1887 CheckRunVimInTerminal
1888 let buf = Api_drop_common(',{"encoding":"utf-16"}')
1889 call assert_equal("utf-16", &fenc)
1890
1891 call StopVimInTerminal(buf)
1892 call delete('Xscript')
1893 bwipe Xtextfile
1894endfunc
1895
1896func Test_terminal_api_drop_oldwin()
1897 CheckRunVimInTerminal
1898 let firstwinid = win_getid()
1899 split Xtextfile
1900 let textfile_winid = win_getid()
1901 call assert_equal(2, winnr('$'))
1902 call win_gotoid(firstwinid)
1903
1904 " Use the title termcap entries to output the escape sequence.
1905 call writefile([
1906 \ 'set title',
1907 \ 'exe "set t_ts=\<Esc>]51; t_fs=\x07"',
1908 \ 'let &titlestring = ''["drop","Xtextfile"]''',
1909 \ 'redraw',
1910 \ "set t_ts=",
Bram Moolenaarc4860bd2022-10-15 20:52:26 +01001911 \ ], 'Xscript', 'D')
Bram Moolenaar18aa13d2020-07-11 13:09:36 +02001912 let buf = RunVimInTerminal('-S Xscript', {'rows': 10})
1913 call WaitForAssert({-> assert_equal('Xtextfile', expand('%:t'))})
1914 call assert_equal(textfile_winid, win_getid())
1915
1916 call StopVimInTerminal(buf)
Bram Moolenaar18aa13d2020-07-11 13:09:36 +02001917 bwipe Xtextfile
1918endfunc
1919
1920func Tapi_TryThis(bufnum, arg)
1921 let g:called_bufnum = a:bufnum
1922 let g:called_arg = a:arg
1923endfunc
1924
1925func WriteApiCall(funcname)
1926 " Use the title termcap entries to output the escape sequence.
1927 call writefile([
1928 \ 'set title',
1929 \ 'exe "set t_ts=\<Esc>]51; t_fs=\x07"',
1930 \ 'let &titlestring = ''["call","' . a:funcname . '",["hello",123]]''',
1931 \ 'redraw',
1932 \ "set t_ts=",
1933 \ ], 'Xscript')
1934endfunc
1935
1936func Test_terminal_api_call()
1937 CheckRunVimInTerminal
1938
1939 unlet! g:called_bufnum
1940 unlet! g:called_arg
1941
1942 call WriteApiCall('Tapi_TryThis')
1943
1944 " Default
1945 let buf = RunVimInTerminal('-S Xscript', {})
1946 call WaitFor({-> exists('g:called_bufnum')})
1947 call assert_equal(buf, g:called_bufnum)
1948 call assert_equal(['hello', 123], g:called_arg)
1949 call StopVimInTerminal(buf)
1950
1951 unlet! g:called_bufnum
1952 unlet! g:called_arg
1953
1954 " Enable explicitly
1955 let buf = RunVimInTerminal('-S Xscript', {'term_api': 'Tapi_Try'})
1956 call WaitFor({-> exists('g:called_bufnum')})
1957 call assert_equal(buf, g:called_bufnum)
1958 call assert_equal(['hello', 123], g:called_arg)
1959 call StopVimInTerminal(buf)
1960
1961 unlet! g:called_bufnum
1962 unlet! g:called_arg
1963
1964 func! ApiCall_TryThis(bufnum, arg)
1965 let g:called_bufnum2 = a:bufnum
1966 let g:called_arg2 = a:arg
1967 endfunc
1968
1969 call WriteApiCall('ApiCall_TryThis')
1970
1971 " Use prefix match
1972 let buf = RunVimInTerminal('-S Xscript', {'term_api': 'ApiCall_'})
1973 call WaitFor({-> exists('g:called_bufnum2')})
1974 call assert_equal(buf, g:called_bufnum2)
1975 call assert_equal(['hello', 123], g:called_arg2)
1976 call StopVimInTerminal(buf)
1977
Bram Moolenaar9b7bf9e2020-07-11 22:14:59 +02001978 call assert_fails("call term_start('ls', {'term_api' : []})", 'E730:')
Bram Moolenaar18aa13d2020-07-11 13:09:36 +02001979
1980 unlet! g:called_bufnum2
1981 unlet! g:called_arg2
1982
1983 call delete('Xscript')
1984 delfunction! ApiCall_TryThis
1985 unlet! g:called_bufnum2
1986 unlet! g:called_arg2
1987endfunc
1988
1989func Test_terminal_api_call_fails()
1990 CheckRunVimInTerminal
1991
1992 func! TryThis(bufnum, arg)
1993 let g:called_bufnum3 = a:bufnum
1994 let g:called_arg3 = a:arg
1995 endfunc
1996
1997 call WriteApiCall('TryThis')
1998
1999 unlet! g:called_bufnum3
2000 unlet! g:called_arg3
2001
2002 " Not permitted
2003 call ch_logfile('Xlog', 'w')
2004 let buf = RunVimInTerminal('-S Xscript', {'term_api': ''})
2005 call WaitForAssert({-> assert_match('Unpermitted function: TryThis', string(readfile('Xlog')))})
2006 call assert_false(exists('g:called_bufnum3'))
2007 call assert_false(exists('g:called_arg3'))
2008 call StopVimInTerminal(buf)
2009
2010 " No match
2011 call ch_logfile('Xlog', 'w')
2012 let buf = RunVimInTerminal('-S Xscript', {'term_api': 'TryThat'})
2013 call WaitFor({-> string(readfile('Xlog')) =~ 'Unpermitted function: TryThis'})
2014 call assert_false(exists('g:called_bufnum3'))
2015 call assert_false(exists('g:called_arg3'))
2016 call StopVimInTerminal(buf)
2017
2018 call delete('Xscript')
2019 call ch_logfile('')
2020 call delete('Xlog')
2021 delfunction! TryThis
2022 unlet! g:called_bufnum3
2023 unlet! g:called_arg3
2024endfunc
2025
2026let s:caught_e937 = 0
2027
2028func Tapi_Delete(bufnum, arg)
2029 try
2030 execute 'bdelete!' a:bufnum
2031 catch /E937:/
2032 let s:caught_e937 = 1
2033 endtry
2034endfunc
2035
2036func Test_terminal_api_call_fail_delete()
2037 CheckRunVimInTerminal
2038
2039 call WriteApiCall('Tapi_Delete')
2040 let buf = RunVimInTerminal('-S Xscript', {})
2041 call WaitForAssert({-> assert_equal(1, s:caught_e937)})
2042
2043 call StopVimInTerminal(buf)
2044 call delete('Xscript')
2045 call ch_logfile('', '')
2046endfunc
2047
2048func Test_terminal_setapi_and_call()
2049 CheckRunVimInTerminal
2050
2051 call WriteApiCall('Tapi_TryThis')
2052 call ch_logfile('Xlog', 'w')
2053
2054 unlet! g:called_bufnum
2055 unlet! g:called_arg
2056
2057 let buf = RunVimInTerminal('-S Xscript', {'term_api': ''})
2058 call WaitForAssert({-> assert_match('Unpermitted function: Tapi_TryThis', string(readfile('Xlog')))})
2059 call assert_false(exists('g:called_bufnum'))
2060 call assert_false(exists('g:called_arg'))
2061
2062 eval buf->term_setapi('Tapi_')
2063 call term_sendkeys(buf, ":set notitle\<CR>")
2064 call term_sendkeys(buf, ":source Xscript\<CR>")
2065 call WaitFor({-> exists('g:called_bufnum')})
2066 call assert_equal(buf, g:called_bufnum)
2067 call assert_equal(['hello', 123], g:called_arg)
2068
2069 call StopVimInTerminal(buf)
2070
2071 call delete('Xscript')
2072 call ch_logfile('')
2073 call delete('Xlog')
2074 unlet! g:called_bufnum
2075 unlet! g:called_arg
2076endfunc
2077
2078func Test_terminal_api_arg()
2079 CheckRunVimInTerminal
2080
2081 call WriteApiCall('Tapi_TryThis')
2082 call ch_logfile('Xlog', 'w')
2083
2084 unlet! g:called_bufnum
2085 unlet! g:called_arg
2086
2087 execute 'term ++api= ' .. GetVimCommandCleanTerm() .. '-S Xscript'
2088 let buf = bufnr('%')
2089 call WaitForAssert({-> assert_match('Unpermitted function: Tapi_TryThis', string(readfile('Xlog')))})
2090 call assert_false(exists('g:called_bufnum'))
2091 call assert_false(exists('g:called_arg'))
2092
2093 call StopVimInTerminal(buf)
2094
2095 call ch_logfile('Xlog', 'w')
2096
2097 execute 'term ++api=Tapi_ ' .. GetVimCommandCleanTerm() .. '-S Xscript'
2098 let buf = bufnr('%')
2099 call WaitFor({-> exists('g:called_bufnum')})
2100 call assert_equal(buf, g:called_bufnum)
2101 call assert_equal(['hello', 123], g:called_arg)
2102
2103 call StopVimInTerminal(buf)
2104
2105 call delete('Xscript')
2106 call ch_logfile('')
2107 call delete('Xlog')
2108 unlet! g:called_bufnum
2109 unlet! g:called_arg
2110endfunc
2111
2112func Test_terminal_ansicolors_default()
2113 CheckFunction term_getansicolors
2114
2115 let colors = [
2116 \ '#000000', '#e00000',
2117 \ '#00e000', '#e0e000',
2118 \ '#0000e0', '#e000e0',
2119 \ '#00e0e0', '#e0e0e0',
2120 \ '#808080', '#ff4040',
2121 \ '#40ff40', '#ffff40',
2122 \ '#4040ff', '#ff40ff',
2123 \ '#40ffff', '#ffffff',
2124 \]
2125
2126 let buf = Run_shell_in_terminal({})
2127 call assert_equal(colors, term_getansicolors(buf))
2128 call StopShellInTerminal(buf)
Bram Moolenaar18aa13d2020-07-11 13:09:36 +02002129 call assert_equal([], term_getansicolors(buf))
2130
2131 exe buf . 'bwipe'
2132endfunc
2133
2134let s:test_colors = [
2135 \ '#616e64', '#0d0a79',
2136 \ '#6d610d', '#0a7373',
2137 \ '#690d0a', '#6d696e',
2138 \ '#0d0a6f', '#616e0d',
2139 \ '#0a6479', '#6d0d0a',
2140 \ '#617373', '#0d0a69',
2141 \ '#6d690d', '#0a6e6f',
2142 \ '#610d0a', '#6e6479',
2143 \]
2144
2145func Test_terminal_ansicolors_global()
2146 CheckFeature termguicolors
2147 CheckFunction term_getansicolors
2148
LemonBoyb2b3acb2022-05-20 10:10:34 +01002149 if has('vtp') && !has('vcon') && !has('gui_running')
2150 throw 'Skipped: does not support termguicolors'
2151 endif
2152
2153 set tgc
Bram Moolenaar18aa13d2020-07-11 13:09:36 +02002154 let g:terminal_ansi_colors = reverse(copy(s:test_colors))
2155 let buf = Run_shell_in_terminal({})
2156 call assert_equal(g:terminal_ansi_colors, term_getansicolors(buf))
2157 call StopShellInTerminal(buf)
LemonBoyb2b3acb2022-05-20 10:10:34 +01002158 set tgc&
Bram Moolenaar18aa13d2020-07-11 13:09:36 +02002159
2160 exe buf . 'bwipe'
2161 unlet g:terminal_ansi_colors
2162endfunc
2163
2164func Test_terminal_ansicolors_func()
2165 CheckFeature termguicolors
2166 CheckFunction term_getansicolors
2167
LemonBoyb2b3acb2022-05-20 10:10:34 +01002168 if has('vtp') && !has('vcon') && !has('gui_running')
2169 throw 'Skipped: does not support termguicolors'
2170 endif
2171
2172 set tgc
Bram Moolenaar18aa13d2020-07-11 13:09:36 +02002173 let g:terminal_ansi_colors = reverse(copy(s:test_colors))
2174 let buf = Run_shell_in_terminal({'ansi_colors': s:test_colors})
2175 call assert_equal(s:test_colors, term_getansicolors(buf))
2176
2177 call term_setansicolors(buf, g:terminal_ansi_colors)
2178 call assert_equal(g:terminal_ansi_colors, buf->term_getansicolors())
2179
2180 let colors = [
2181 \ 'ivory', 'AliceBlue',
2182 \ 'grey67', 'dark goldenrod',
2183 \ 'SteelBlue3', 'PaleVioletRed4',
2184 \ 'MediumPurple2', 'yellow2',
2185 \ 'RosyBrown3', 'OrangeRed2',
2186 \ 'white smoke', 'navy blue',
2187 \ 'grey47', 'gray97',
2188 \ 'MistyRose2', 'DodgerBlue4',
2189 \]
2190 eval buf->term_setansicolors(colors)
2191
2192 let colors[4] = 'Invalid'
Bram Moolenaar9b7bf9e2020-07-11 22:14:59 +02002193 call assert_fails('call term_setansicolors(buf, colors)', 'E254:')
Bram Moolenaard83392a2022-09-01 12:22:46 +01002194 call assert_fails('call term_setansicolors(buf, {})', 'E1211:')
Bram Moolenaar23919542023-05-05 22:12:22 +01002195 call assert_fails('call term_setansicolors(buf, [])', 'E475: Invalid value for argument "colors"')
LemonBoyb2b3acb2022-05-20 10:10:34 +01002196 set tgc&
Bram Moolenaar18aa13d2020-07-11 13:09:36 +02002197
2198 call StopShellInTerminal(buf)
Bram Moolenaar18aa13d2020-07-11 13:09:36 +02002199 call assert_equal(0, term_setansicolors(buf, []))
2200 exe buf . 'bwipe'
2201endfunc
2202
2203func Test_terminal_all_ansi_colors()
2204 CheckRunVimInTerminal
2205
2206 " Use all the ANSI colors.
2207 call writefile([
2208 \ 'call setline(1, "AABBCCDDEEFFGGHHIIJJKKLLMMNNOOPP XXYYZZ")',
2209 \ 'hi Tblack ctermfg=0 ctermbg=8',
2210 \ 'hi Tdarkred ctermfg=1 ctermbg=9',
2211 \ 'hi Tdarkgreen ctermfg=2 ctermbg=10',
2212 \ 'hi Tbrown ctermfg=3 ctermbg=11',
2213 \ 'hi Tdarkblue ctermfg=4 ctermbg=12',
2214 \ 'hi Tdarkmagenta ctermfg=5 ctermbg=13',
2215 \ 'hi Tdarkcyan ctermfg=6 ctermbg=14',
2216 \ 'hi Tlightgrey ctermfg=7 ctermbg=15',
2217 \ 'hi Tdarkgrey ctermfg=8 ctermbg=0',
2218 \ 'hi Tred ctermfg=9 ctermbg=1',
2219 \ 'hi Tgreen ctermfg=10 ctermbg=2',
2220 \ 'hi Tyellow ctermfg=11 ctermbg=3',
2221 \ 'hi Tblue ctermfg=12 ctermbg=4',
2222 \ 'hi Tmagenta ctermfg=13 ctermbg=5',
2223 \ 'hi Tcyan ctermfg=14 ctermbg=6',
2224 \ 'hi Twhite ctermfg=15 ctermbg=7',
2225 \ 'hi TdarkredBold ctermfg=1 cterm=bold',
2226 \ 'hi TgreenBold ctermfg=10 cterm=bold',
2227 \ 'hi TmagentaBold ctermfg=13 cterm=bold ctermbg=5',
2228 \ '',
2229 \ 'call matchadd("Tblack", "A")',
2230 \ 'call matchadd("Tdarkred", "B")',
2231 \ 'call matchadd("Tdarkgreen", "C")',
2232 \ 'call matchadd("Tbrown", "D")',
2233 \ 'call matchadd("Tdarkblue", "E")',
2234 \ 'call matchadd("Tdarkmagenta", "F")',
2235 \ 'call matchadd("Tdarkcyan", "G")',
2236 \ 'call matchadd("Tlightgrey", "H")',
2237 \ 'call matchadd("Tdarkgrey", "I")',
2238 \ 'call matchadd("Tred", "J")',
2239 \ 'call matchadd("Tgreen", "K")',
2240 \ 'call matchadd("Tyellow", "L")',
2241 \ 'call matchadd("Tblue", "M")',
2242 \ 'call matchadd("Tmagenta", "N")',
2243 \ 'call matchadd("Tcyan", "O")',
2244 \ 'call matchadd("Twhite", "P")',
2245 \ 'call matchadd("TdarkredBold", "X")',
2246 \ 'call matchadd("TgreenBold", "Y")',
2247 \ 'call matchadd("TmagentaBold", "Z")',
2248 \ 'redraw',
Bram Moolenaarc4860bd2022-10-15 20:52:26 +01002249 \ ], 'Xcolorscript', 'D')
Bram Moolenaar18aa13d2020-07-11 13:09:36 +02002250 let buf = RunVimInTerminal('-S Xcolorscript', {'rows': 10})
2251 call VerifyScreenDump(buf, 'Test_terminal_all_ansi_colors', {})
2252
2253 call term_sendkeys(buf, ":q\<CR>")
2254 call StopVimInTerminal(buf)
Bram Moolenaar18aa13d2020-07-11 13:09:36 +02002255endfunc
2256
Bram Moolenaar1e6bbfb2021-04-03 13:19:26 +02002257function On_BufFilePost()
2258 doautocmd <nomodeline> User UserEvent
2259endfunction
2260
2261func Test_terminal_nested_autocmd()
2262 new
2263 call setline(1, range(500))
2264 $
2265 let lastline = line('.')
2266
2267 augroup TermTest
2268 autocmd BufFilePost * call On_BufFilePost()
2269 autocmd User UserEvent silent
2270 augroup END
2271
2272 let cmd = Get_cat_123_cmd()
2273 let buf = term_start(cmd, #{term_finish: 'close', hidden: 1})
2274 call assert_equal(lastline, line('.'))
2275
Bram Moolenaar64374752021-04-03 17:22:29 +02002276 let job = term_getjob(buf)
2277 call WaitForAssert({-> assert_equal("dead", job_status(job))})
Bram Moolenaar1e6bbfb2021-04-03 13:19:26 +02002278 call delete('Xtext')
2279 augroup TermTest
2280 au!
2281 augroup END
2282endfunc
2283
Bram Moolenaaraeed2a62021-04-29 20:18:45 +02002284func Test_terminal_adds_jump()
2285 clearjumps
2286 call term_start("ls", #{curwin: 1})
2287 call assert_equal(1, getjumplist()[0]->len())
2288 bwipe!
2289endfunc
2290
Bram Moolenaareea32af2021-11-21 14:51:13 +00002291func Close_cb(ch, ctx)
2292 call term_wait(a:ctx.bufnr)
2293 let g:close_done = 'done'
2294endfunc
2295
2296func Test_term_wait_in_close_cb()
2297 let g:close_done = ''
2298 let ctx = {}
2299 let ctx.bufnr = term_start('echo "HELLO WORLD"',
2300 \ {'close_cb': {ch -> Close_cb(ch, ctx)}})
2301
2302 call WaitForAssert({-> assert_equal("done", g:close_done)})
2303
2304 unlet g:close_done
2305 bwipe!
2306endfunc
2307
Shougo Matsushita4ccaedf2022-10-15 11:48:00 +01002308func Test_term_TextChangedT()
2309 augroup TermTest
2310 autocmd TextChangedT * ++once
2311 \ execute expand('<abuf>') . 'buffer' |
2312 \ let b:called = 1 |
2313 \ split |
2314 \ enew
2315 augroup END
2316
2317 terminal
2318
2319 let term_buf = bufnr()
2320
2321 let b:called = 0
2322
2323 call term_sendkeys(term_buf, "aaabbc\r")
2324 call TermWait(term_buf)
2325
2326 call assert_equal(1, getbufvar(term_buf, 'called'))
2327
2328 " Current buffer will be restored
2329 call assert_equal(bufnr(), term_buf)
2330
2331 bwipe!
2332 augroup TermTest
2333 au!
2334 augroup END
2335endfunc
2336
2337func Test_term_TextChangedT_close()
2338 augroup TermTest
2339 autocmd TextChangedT * ++once split | enew | 1close!
2340 augroup END
2341
2342 terminal
2343
2344 let term_buf = bufnr()
2345
2346 call term_sendkeys(term_buf, "aaabbc\r")
2347 call TermWait(term_buf)
2348
2349 " Current buffer will be restored
2350 call assert_equal(bufnr(), term_buf)
2351
2352 bwipe!
2353 augroup TermTest
2354 au!
2355 augroup END
2356endfunc
Bram Moolenaar91689ea2020-05-11 22:04:53 +02002357
Bram Moolenaarca68ae12020-03-30 19:32:53 +02002358" vim: shiftwidth=2 sts=2 expandtab