blob: e77be352f6cc9d3b8ae42aae08d95cc6f7754a09 [file] [log] [blame]
Bram Moolenaarc6df10e2017-07-29 20:15:08 +02001" Tests for the terminal window.
2
3if !exists('*term_start')
4 finish
5endif
6
7source shared.vim
8
Bram Moolenaarb81bc772017-08-11 22:45:01 +02009let s:python = PythonProg()
10
Bram Moolenaar94053a52017-08-01 21:44:33 +020011" Open a terminal with a shell, assign the job to g:job and return the buffer
12" number.
Bram Moolenaar05aafed2017-08-11 19:12:11 +020013func Run_shell_in_terminal(options)
14 let buf = term_start(&shell, a:options)
Bram Moolenaarc6df10e2017-07-29 20:15:08 +020015
16 let termlist = term_list()
17 call assert_equal(1, len(termlist))
18 call assert_equal(buf, termlist[0])
19
20 let g:job = term_getjob(buf)
21 call assert_equal(v:t_job, type(g:job))
22
Bram Moolenaar35422f42017-08-05 16:33:56 +020023 let string = string({'job': term_getjob(buf)})
24 call assert_match("{'job': 'process \\d\\+ run'}", string)
25
Bram Moolenaar94053a52017-08-01 21:44:33 +020026 return buf
27endfunc
28
29" Stops the shell started by Run_shell_in_terminal().
30func Stop_shell_in_terminal(buf)
31 call term_sendkeys(a:buf, "exit\r")
Bram Moolenaarc6df10e2017-07-29 20:15:08 +020032 call WaitFor('job_status(g:job) == "dead"')
33 call assert_equal('dead', job_status(g:job))
Bram Moolenaar20e6cd02017-08-01 20:25:22 +020034endfunc
35
36func Test_terminal_basic()
Bram Moolenaar05aafed2017-08-11 19:12:11 +020037 let buf = Run_shell_in_terminal({})
Bram Moolenaar7c9aec42017-08-03 13:51:25 +020038 if has("unix")
39 call assert_match("^/dev/", job_info(g:job).tty)
40 call assert_match("^/dev/", term_gettty(''))
41 else
Bram Moolenaar5be8dd02017-08-03 20:52:19 +020042 call assert_match("^winpty://", job_info(g:job).tty)
43 call assert_match("^winpty://", term_gettty(''))
Bram Moolenaar7c9aec42017-08-03 13:51:25 +020044 endif
Bram Moolenaar2bb7b6b2017-08-13 20:58:33 +020045 call assert_equal('t', mode())
46 call assert_match('%aR[^\n]*running]', execute('ls'))
47
Bram Moolenaar94053a52017-08-01 21:44:33 +020048 call Stop_shell_in_terminal(buf)
49 call term_wait(buf)
Bram Moolenaar2bb7b6b2017-08-13 20:58:33 +020050 call assert_equal('n', mode())
51 call assert_match('%aF[^\n]*finished]', execute('ls'))
Bram Moolenaar20e6cd02017-08-01 20:25:22 +020052
Bram Moolenaar94053a52017-08-01 21:44:33 +020053 " closing window wipes out the terminal buffer a with finished job
54 close
55 call assert_equal("", bufname(buf))
56
Bram Moolenaar20e6cd02017-08-01 20:25:22 +020057 unlet g:job
58endfunc
59
60func Test_terminal_make_change()
Bram Moolenaar05aafed2017-08-11 19:12:11 +020061 let buf = Run_shell_in_terminal({})
Bram Moolenaar94053a52017-08-01 21:44:33 +020062 call Stop_shell_in_terminal(buf)
Bram Moolenaar20e6cd02017-08-01 20:25:22 +020063 call term_wait(buf)
64
65 setlocal modifiable
66 exe "normal Axxx\<Esc>"
67 call assert_fails(buf . 'bwipe', 'E517')
68 undo
69
Bram Moolenaarc6df10e2017-07-29 20:15:08 +020070 exe buf . 'bwipe'
71 unlet g:job
72endfunc
73
Bram Moolenaar94053a52017-08-01 21:44:33 +020074func Test_terminal_wipe_buffer()
Bram Moolenaar05aafed2017-08-11 19:12:11 +020075 let buf = Run_shell_in_terminal({})
Bram Moolenaareb44a682017-08-03 22:44:55 +020076 call assert_fails(buf . 'bwipe', 'E517')
77 exe buf . 'bwipe!'
Bram Moolenaar94053a52017-08-01 21:44:33 +020078 call WaitFor('job_status(g:job) == "dead"')
79 call assert_equal('dead', job_status(g:job))
80 call assert_equal("", bufname(buf))
81
82 unlet g:job
83endfunc
84
85func Test_terminal_hide_buffer()
Bram Moolenaar05aafed2017-08-11 19:12:11 +020086 let buf = Run_shell_in_terminal({})
Bram Moolenaar94053a52017-08-01 21:44:33 +020087 quit
88 for nr in range(1, winnr('$'))
89 call assert_notequal(winbufnr(nr), buf)
90 endfor
91 call assert_true(bufloaded(buf))
92 call assert_true(buflisted(buf))
93
94 exe 'split ' . buf . 'buf'
95 call Stop_shell_in_terminal(buf)
96 exe buf . 'bwipe'
97
98 unlet g:job
99endfunc
100
Bram Moolenaar3c3a80d2017-08-03 17:06:45 +0200101func! s:Nasty_exit_cb(job, st)
102 exe g:buf . 'bwipe!'
103 let g:buf = 0
104endfunc
105
106func Test_terminal_nasty_cb()
Bram Moolenaar33a43be2017-08-06 21:36:22 +0200107 let cmd = Get_cat_123_cmd()
Bram Moolenaar3c3a80d2017-08-03 17:06:45 +0200108 let g:buf = term_start(cmd, {'exit_cb': function('s:Nasty_exit_cb')})
109 let g:job = term_getjob(g:buf)
110
111 call WaitFor('job_status(g:job) == "dead"')
112 call WaitFor('g:buf == 0')
113 unlet g:buf
114 unlet g:job
115 call delete('Xtext')
116endfunc
117
Bram Moolenaarc6df10e2017-07-29 20:15:08 +0200118func Check_123(buf)
Bram Moolenaar5c838a32017-08-02 22:10:34 +0200119 let l = term_scrape(a:buf, 0)
120 call assert_true(len(l) == 0)
121 let l = term_scrape(a:buf, 999)
122 call assert_true(len(l) == 0)
Bram Moolenaar9c844842017-08-01 18:41:21 +0200123 let l = term_scrape(a:buf, 1)
Bram Moolenaarc6df10e2017-07-29 20:15:08 +0200124 call assert_true(len(l) > 0)
125 call assert_equal('1', l[0].chars)
126 call assert_equal('2', l[1].chars)
127 call assert_equal('3', l[2].chars)
128 call assert_equal('#00e000', l[0].fg)
129 if &background == 'light'
130 call assert_equal('#ffffff', l[0].bg)
131 else
132 call assert_equal('#000000', l[0].bg)
133 endif
134
Bram Moolenaar5c838a32017-08-02 22:10:34 +0200135 let l = term_getline(a:buf, -1)
136 call assert_equal('', l)
137 let l = term_getline(a:buf, 0)
138 call assert_equal('', l)
139 let l = term_getline(a:buf, 999)
140 call assert_equal('', l)
Bram Moolenaar9c844842017-08-01 18:41:21 +0200141 let l = term_getline(a:buf, 1)
Bram Moolenaarc6df10e2017-07-29 20:15:08 +0200142 call assert_equal('123', l)
143endfunc
144
Bram Moolenaar33a43be2017-08-06 21:36:22 +0200145func Get_cat_123_cmd()
Bram Moolenaarc6df10e2017-07-29 20:15:08 +0200146 if has('win32')
Bram Moolenaar3c3a80d2017-08-03 17:06:45 +0200147 return 'cmd /c "cls && color 2 && echo 123"'
Bram Moolenaarc6df10e2017-07-29 20:15:08 +0200148 else
149 call writefile(["\<Esc>[32m123"], 'Xtext')
Bram Moolenaar3c3a80d2017-08-03 17:06:45 +0200150 return "cat Xtext"
Bram Moolenaarc6df10e2017-07-29 20:15:08 +0200151 endif
Bram Moolenaar3c3a80d2017-08-03 17:06:45 +0200152endfunc
153
Bram Moolenaar33a43be2017-08-06 21:36:22 +0200154func Test_terminal_scrape_123()
155 let cmd = Get_cat_123_cmd()
Bram Moolenaarc6df10e2017-07-29 20:15:08 +0200156 let buf = term_start(cmd)
157
158 let termlist = term_list()
159 call assert_equal(1, len(termlist))
160 call assert_equal(buf, termlist[0])
161
Bram Moolenaarf144a3f2017-07-30 18:02:12 +0200162 " Nothing happens with invalid buffer number
163 call term_wait(1234)
164
Bram Moolenaarc6df10e2017-07-29 20:15:08 +0200165 call term_wait(buf)
Bram Moolenaar620d0642017-08-03 21:08:05 +0200166 if has('win32')
167 " TODO: this should not be needed
168 sleep 100m
169 endif
Bram Moolenaarc6df10e2017-07-29 20:15:08 +0200170 call Check_123(buf)
171
172 " Must still work after the job ended.
173 let g:job = term_getjob(buf)
174 call WaitFor('job_status(g:job) == "dead"')
175 call term_wait(buf)
176 call Check_123(buf)
177
178 exe buf . 'bwipe'
Bram Moolenaarf144a3f2017-07-30 18:02:12 +0200179 call delete('Xtext')
Bram Moolenaarc6df10e2017-07-29 20:15:08 +0200180endfunc
Bram Moolenaarcfcc0222017-08-05 17:13:48 +0200181
Bram Moolenaar33a43be2017-08-06 21:36:22 +0200182func Test_terminal_scrape_multibyte()
183 if !has('multi_byte')
184 return
185 endif
186 call writefile(["léttまrs"], 'Xtext')
187 if has('win32')
188 let cmd = 'cmd /c "type Xtext"'
189 else
190 let cmd = "cat Xtext"
191 endif
Bram Moolenaarc0870612017-08-14 22:01:16 +0200192 let g:buf = term_start(cmd)
Bram Moolenaar33a43be2017-08-06 21:36:22 +0200193
Bram Moolenaarc0870612017-08-14 22:01:16 +0200194 call WaitFor('term_scrape(g:buf, 1)[0].chars == "l"')
195 let l = term_scrape(g:buf, 1)
Bram Moolenaar33a43be2017-08-06 21:36:22 +0200196 call assert_true(len(l) >= 7)
197 call assert_equal('l', l[0].chars)
198 call assert_equal('é', l[1].chars)
199 call assert_equal(1, l[1].width)
200 call assert_equal('t', l[2].chars)
201 call assert_equal('t', l[3].chars)
202 call assert_equal('ま', l[4].chars)
203 call assert_equal(2, l[4].width)
204 call assert_equal('r', l[5].chars)
205 call assert_equal('s', l[6].chars)
206
Bram Moolenaarc0870612017-08-14 22:01:16 +0200207 let g:job = term_getjob(g:buf)
Bram Moolenaar33a43be2017-08-06 21:36:22 +0200208 call WaitFor('job_status(g:job) == "dead"')
Bram Moolenaarc0870612017-08-14 22:01:16 +0200209 call term_wait(g:buf)
Bram Moolenaar33a43be2017-08-06 21:36:22 +0200210
Bram Moolenaarc0870612017-08-14 22:01:16 +0200211 exe g:buf . 'bwipe'
212 unlet g:buf
Bram Moolenaar33a43be2017-08-06 21:36:22 +0200213 call delete('Xtext')
214endfunc
215
Bram Moolenaarf8d57a52017-08-07 20:38:42 +0200216func Test_terminal_scroll()
217 call writefile(range(1, 200), 'Xtext')
218 if has('win32')
219 let cmd = 'cmd /c "type Xtext"'
220 else
221 let cmd = "cat Xtext"
222 endif
223 let buf = term_start(cmd)
224
225 let g:job = term_getjob(buf)
226 call WaitFor('job_status(g:job) == "dead"')
227 call term_wait(buf)
228 if has('win32')
229 " TODO: this should not be needed
230 sleep 100m
231 endif
232
Bram Moolenaar82b9ca02017-08-08 23:06:46 +0200233 let scrolled = term_getscrolled(buf)
Bram Moolenaarf8d57a52017-08-07 20:38:42 +0200234 call assert_equal('1', getline(1))
Bram Moolenaar82b9ca02017-08-08 23:06:46 +0200235 call assert_equal('1', term_getline(buf, 1 - scrolled))
Bram Moolenaarf8d57a52017-08-07 20:38:42 +0200236 call assert_equal('49', getline(49))
Bram Moolenaar82b9ca02017-08-08 23:06:46 +0200237 call assert_equal('49', term_getline(buf, 49 - scrolled))
Bram Moolenaarf8d57a52017-08-07 20:38:42 +0200238 call assert_equal('200', getline(200))
Bram Moolenaar82b9ca02017-08-08 23:06:46 +0200239 call assert_equal('200', term_getline(buf, 200 - scrolled))
Bram Moolenaarf8d57a52017-08-07 20:38:42 +0200240
241 exe buf . 'bwipe'
242 call delete('Xtext')
243endfunc
244
Bram Moolenaarcfcc0222017-08-05 17:13:48 +0200245func Test_terminal_size()
Bram Moolenaar33a43be2017-08-06 21:36:22 +0200246 let cmd = Get_cat_123_cmd()
Bram Moolenaarcfcc0222017-08-05 17:13:48 +0200247
248 exe '5terminal ' . cmd
249 let size = term_getsize('')
250 bwipe!
251 call assert_equal(5, size[0])
252
Bram Moolenaar08d384f2017-08-11 21:51:23 +0200253 call term_start(cmd, {'term_rows': 6})
254 let size = term_getsize('')
255 bwipe!
256 call assert_equal(6, size[0])
257
Bram Moolenaarcfcc0222017-08-05 17:13:48 +0200258 vsplit
259 exe '5,33terminal ' . cmd
260 let size = term_getsize('')
261 bwipe!
262 call assert_equal([5, 33], size)
263
Bram Moolenaar08d384f2017-08-11 21:51:23 +0200264 call term_start(cmd, {'term_rows': 6, 'term_cols': 36})
265 let size = term_getsize('')
266 bwipe!
267 call assert_equal([6, 36], size)
268
Bram Moolenaarcfcc0222017-08-05 17:13:48 +0200269 exe 'vertical 20terminal ' . cmd
270 let size = term_getsize('')
271 bwipe!
272 call assert_equal(20, size[1])
273
Bram Moolenaar08d384f2017-08-11 21:51:23 +0200274 call term_start(cmd, {'vertical': 1, 'term_cols': 26})
275 let size = term_getsize('')
276 bwipe!
277 call assert_equal(26, size[1])
278
Bram Moolenaarcfcc0222017-08-05 17:13:48 +0200279 split
280 exe 'vertical 6,20terminal ' . cmd
281 let size = term_getsize('')
282 bwipe!
283 call assert_equal([6, 20], size)
Bram Moolenaar08d384f2017-08-11 21:51:23 +0200284
285 call term_start(cmd, {'vertical': 1, 'term_rows': 7, 'term_cols': 27})
286 let size = term_getsize('')
287 bwipe!
288 call assert_equal([7, 27], size)
Bram Moolenaarda43b612017-08-11 22:27:50 +0200289endfunc
290
291func Test_terminal_curwin()
292 let cmd = Get_cat_123_cmd()
293 call assert_equal(1, winnr('$'))
294
295 split dummy
296 exe 'terminal ++curwin ' . cmd
297 call assert_equal(2, winnr('$'))
298 bwipe!
299
300 split dummy
301 call term_start(cmd, {'curwin': 1})
302 call assert_equal(2, winnr('$'))
303 bwipe!
304
305 split dummy
306 call setline(1, 'change')
307 call assert_fails('terminal ++curwin ' . cmd, 'E37:')
308 call assert_equal(2, winnr('$'))
309 exe 'terminal! ++curwin ' . cmd
310 call assert_equal(2, winnr('$'))
311 bwipe!
312
313 split dummy
314 call setline(1, 'change')
315 call assert_fails("call term_start(cmd, {'curwin': 1})", 'E37:')
316 call assert_equal(2, winnr('$'))
317 bwipe!
318
319 split dummy
320 bwipe!
Bram Moolenaar08d384f2017-08-11 21:51:23 +0200321
Bram Moolenaarcfcc0222017-08-05 17:13:48 +0200322endfunc
Bram Moolenaardd693ce2017-08-10 23:15:19 +0200323
Bram Moolenaar37c45832017-08-12 16:01:04 +0200324func Test_finish_open_close()
Bram Moolenaardd693ce2017-08-10 23:15:19 +0200325 call assert_equal(1, winnr('$'))
326
Bram Moolenaarb81bc772017-08-11 22:45:01 +0200327 if s:python != ''
328 let cmd = s:python . " test_short_sleep.py"
329 let waittime = 500
Bram Moolenaardd693ce2017-08-10 23:15:19 +0200330 else
Bram Moolenaarb81bc772017-08-11 22:45:01 +0200331 echo 'This will take five seconds...'
332 let waittime = 2000
333 if has('win32')
334 let cmd = $windir . '\system32\timeout.exe 1'
335 else
336 let cmd = 'sleep 1'
337 endif
Bram Moolenaardd693ce2017-08-10 23:15:19 +0200338 endif
Bram Moolenaarb81bc772017-08-11 22:45:01 +0200339
Bram Moolenaardd693ce2017-08-10 23:15:19 +0200340 exe 'terminal ++close ' . cmd
Bram Moolenaardd693ce2017-08-10 23:15:19 +0200341 call assert_equal(2, winnr('$'))
Bram Moolenaardd693ce2017-08-10 23:15:19 +0200342 wincmd p
Bram Moolenaarb81bc772017-08-11 22:45:01 +0200343 call WaitFor("winnr('$') == 1", waittime)
Bram Moolenaardd693ce2017-08-10 23:15:19 +0200344 call assert_equal(1, winnr('$'))
345
346 call term_start(cmd, {'term_finish': 'close'})
347 call assert_equal(2, winnr('$'))
Bram Moolenaardd693ce2017-08-10 23:15:19 +0200348 wincmd p
Bram Moolenaarb81bc772017-08-11 22:45:01 +0200349 call WaitFor("winnr('$') == 1", waittime)
Bram Moolenaardd693ce2017-08-10 23:15:19 +0200350 call assert_equal(1, winnr('$'))
351
352 exe 'terminal ++open ' . cmd
Bram Moolenaardd693ce2017-08-10 23:15:19 +0200353 close
Bram Moolenaarb81bc772017-08-11 22:45:01 +0200354 call WaitFor("winnr('$') == 2", waittime)
Bram Moolenaardd693ce2017-08-10 23:15:19 +0200355 call assert_equal(2, winnr('$'))
356 bwipe
357
358 call term_start(cmd, {'term_finish': 'open'})
Bram Moolenaardd693ce2017-08-10 23:15:19 +0200359 close
Bram Moolenaarb81bc772017-08-11 22:45:01 +0200360 call WaitFor("winnr('$') == 2", waittime)
Bram Moolenaardd693ce2017-08-10 23:15:19 +0200361 call assert_equal(2, winnr('$'))
Bram Moolenaar8cad9302017-08-12 14:32:32 +0200362 bwipe
Bram Moolenaardd693ce2017-08-10 23:15:19 +0200363
Bram Moolenaar8cad9302017-08-12 14:32:32 +0200364 exe 'terminal ++hidden ++open ' . cmd
365 call assert_equal(1, winnr('$'))
366 call WaitFor("winnr('$') == 2", waittime)
367 call assert_equal(2, winnr('$'))
368 bwipe
369
370 call term_start(cmd, {'term_finish': 'open', 'hidden': 1})
371 call assert_equal(1, winnr('$'))
372 call WaitFor("winnr('$') == 2", waittime)
373 call assert_equal(2, winnr('$'))
Bram Moolenaardd693ce2017-08-10 23:15:19 +0200374 bwipe
Bram Moolenaar37c45832017-08-12 16:01:04 +0200375
376 call assert_fails("call term_start(cmd, {'term_opencmd': 'open'})", 'E475:')
377 call assert_fails("call term_start(cmd, {'term_opencmd': 'split %x'})", 'E475:')
378 call assert_fails("call term_start(cmd, {'term_opencmd': 'split %d and %s'})", 'E475:')
379 call assert_fails("call term_start(cmd, {'term_opencmd': 'split % and %d'})", 'E475:')
380
381 call term_start(cmd, {'term_finish': 'open', 'term_opencmd': '4split | buffer %d'})
382 close
383 call WaitFor("winnr('$') == 2", waittime)
384 call assert_equal(2, winnr('$'))
385 call assert_equal(4, winheight(0))
386 bwipe
387
Bram Moolenaardd693ce2017-08-10 23:15:19 +0200388endfunc
Bram Moolenaar05aafed2017-08-11 19:12:11 +0200389
390func Test_terminal_cwd()
391 if !has('unix')
392 return
393 endif
394 call mkdir('Xdir')
395 let buf = term_start('pwd', {'cwd': 'Xdir'})
396 sleep 100m
397 call term_wait(buf)
398 call assert_equal(getcwd() . '/Xdir', getline(1))
399
400 exe buf . 'bwipe'
401 call delete('Xdir', 'rf')
402endfunc
403
404func Test_terminal_env()
405 if !has('unix')
406 return
407 endif
Bram Moolenaarc0870612017-08-14 22:01:16 +0200408 let g:buf = Run_shell_in_terminal({'env': {'TESTENV': 'correct'}})
Bram Moolenaar51c23682017-08-14 21:45:00 +0200409 " Wait for the shell to display a prompt
Bram Moolenaarc0870612017-08-14 22:01:16 +0200410 call WaitFor('term_getline(g:buf, 1) != ""')
411 call term_sendkeys(g:buf, "echo $TESTENV\r")
412 call term_wait(g:buf)
413 call Stop_shell_in_terminal(g:buf)
Bram Moolenaar51c23682017-08-14 21:45:00 +0200414 call WaitFor('getline(2) == "correct"')
Bram Moolenaar05aafed2017-08-11 19:12:11 +0200415 call assert_equal('correct', getline(2))
416
Bram Moolenaarc0870612017-08-14 22:01:16 +0200417 exe g:buf . 'bwipe'
418 unlet g:buf
Bram Moolenaar05aafed2017-08-11 19:12:11 +0200419endfunc
Bram Moolenaar679653e2017-08-13 14:13:19 +0200420
421" must be last, we can't go back from GUI to terminal
422func Test_zz_terminal_in_gui()
Bram Moolenaar9f0139a2017-08-13 20:26:20 +0200423 if !CanRunGui()
Bram Moolenaar679653e2017-08-13 14:13:19 +0200424 return
425 endif
426 gui -f
427
428 call assert_equal(1, winnr('$'))
429 let buf = Run_shell_in_terminal({'term_finish': 'close'})
430 call Stop_shell_in_terminal(buf)
431 call term_wait(buf)
432
433 " closing window wipes out the terminal buffer a with finished job
434 call WaitFor("winnr('$') == 1")
435 call assert_equal(1, winnr('$'))
436 call assert_equal("", bufname(buf))
437
438 unlet g:job
439endfunc
Bram Moolenaardcaa6132017-08-13 17:13:09 +0200440
441func Test_terminal_list_args()
442 let buf = term_start([&shell, &shellcmdflag, 'echo "123"'])
443 call assert_fails(buf . 'bwipe', 'E517')
444 exe buf . 'bwipe!'
445 call assert_equal("", bufname(buf))
446endfunction