patch 9.1.1110: Vim tests are slow and flaky
Problem: Vim tests are slow and flaky at the same time due to reliance
on timeouts which are unreliable.
Solution: improve Vim test performance and reduce flakiness
(Yee Cheng Chin)
A lot of Vim tests currently rely on waiting a specific amount of time
before asserting a condition. This is bad because 1) it is slow, as the
timeout is hardcoded, 2) it's unreliable as a resource-starved runner
may overshoot the timeout. Also, there are a lot of builtin sleep
commands in commonly used utilities like VerifyScreenDump and WaitFor()
which leads to a lot of unnecessary idle time.
Fix these issues by doing the following:
1. Make utilities like VerifyScreenDump and WaitFor use the lowest wait
time possible (1 ms). This essentially turns it into a spin wait. On
fast machines, these will finish very quickly. For existing tests
that had an implicit reliance on the old timeouts (e.g.
VerifyScreenDump had a 50ms wait before), fix the tests to wait that
specific amount explicitly.
2. Fix tests that sleep or wait for long amounts of time to instead
explicitly use a callback mechanism to be notified when a child
terminal job has finished. This allows the test to only take as much
time as possible instead of having to hard code an unreliable
timeout.
With these fixes, tests should 1) completely quickly on fast machines,
and 2) on slow machines they will still run to completion albeit slowly.
Note that previoulsy both were not true. The hardcoded timeouts meant
that on fast machines the tests were mostly idling wasting time, whereas
on slow machines, the timeouts often were not generous enough to allow
them to run to completion.
closes: #16615
Signed-off-by: Yee Cheng Chin <ychin.git@gmail.com>
Signed-off-by: Christian Brabandt <cb@256bit.org>
diff --git a/src/testdir/test_terminal3.vim b/src/testdir/test_terminal3.vim
index 5865d18..0e5f70b 100644
--- a/src/testdir/test_terminal3.vim
+++ b/src/testdir/test_terminal3.vim
@@ -75,22 +75,30 @@
let lines = [
\ 'call setline(1, range(20))',
+ \ 'func NotifyParent()',
+ \ ' call echoraw("' .. TermNotifyParentCmd(v:true) .. '")',
+ \ 'endfunc',
\ 'func OpenTerm()',
\ ' set noruler',
- \ " call term_start('cat', #{vertical: 1, " .. a:highlight_opt .. "})",
+ \ " call term_start('cat', #{vertical: 1, "
+ \ .. 'exit_cb: {->NotifyParent()}, '
+ \ .. a:highlight_opt .. "})",
+ \ ' call NotifyParent()',
\ ] + a:open_cmds + [
\ 'endfunc',
- \ ] + a:highlight_cmds
+ \ ] + a:highlight_cmds + [
+ \ 'call NotifyParent()',
+ \ ]
call writefile(lines, 'XtermStart', 'D')
let buf = RunVimInTerminal('-S XtermStart', #{rows: 15})
- call TermWait(buf, 100)
+ call WaitForChildNotification()
call term_sendkeys(buf, ":call OpenTerm()\<CR>")
- call TermWait(buf, 50)
+ call WaitForChildNotification()
call term_sendkeys(buf, "hello\<CR>")
call VerifyScreenDump(buf, 'Test_terminal_color_' .. a:group_name, {})
call term_sendkeys(buf, "\<C-D>")
- call TermWait(buf, 50)
+ call WaitForChildNotification()
call StopVimInTerminal(buf)
endfunc
@@ -270,11 +278,11 @@
\ ]
call writefile(lines, 'XtermPopup', 'D')
let buf = RunVimInTerminal('-S XtermPopup', #{rows: 15})
- call TermWait(buf, 200)
+ call TermWait(buf,0)
call term_sendkeys(buf, ":call OpenTerm(0)\<CR>")
- call TermWait(buf, 800)
+ call TermWait(buf,0)
call term_sendkeys(buf, ":\<CR>")
- call TermWait(buf, 500)
+ call TermWait(buf,0)
call term_sendkeys(buf, "\<C-W>:echo getwinvar(g:winid, \"&buftype\") win_gettype(g:winid)\<CR>")
call VerifyScreenDump(buf, 'Test_terminal_popup_1', {})
@@ -282,16 +290,16 @@
call VerifyScreenDump(buf, 'Test_terminal_popup_2', {})
call term_sendkeys(buf, ":call OpenTerm(1)\<CR>")
- call TermWait(buf, 800)
+ call TermWait(buf,0)
call term_sendkeys(buf, ":set hlsearch\<CR>")
- call TermWait(buf, 500)
+ call TermWait(buf,0)
call term_sendkeys(buf, "/edit\<CR>")
call VerifyScreenDump(buf, 'Test_terminal_popup_3', {})
call term_sendkeys(buf, "\<C-W>:call HidePopup()\<CR>")
call VerifyScreenDump(buf, 'Test_terminal_popup_4', {})
call term_sendkeys(buf, "\<CR>")
- call TermWait(buf, 50)
+ call TermWait(buf,0)
call term_sendkeys(buf, "\<C-W>:call ClosePopup()\<CR>")
call VerifyScreenDump(buf, 'Test_terminal_popup_5', {})
@@ -307,9 +315,9 @@
call term_sendkeys(buf, "A")
call VerifyScreenDump(buf, 'Test_terminal_popup_8', {})
- call TermWait(buf, 50)
+ call TermWait(buf,0)
call term_sendkeys(buf, ":q\<CR>")
- call TermWait(buf, 250) " wait for terminal to vanish
+ call WaitForAssert({-> assert_equal(0, match(term_getline(buf, 6), '^5\s*$'))}, 250) " wait for terminal to vanish
call StopVimInTerminal(buf)
endfunc
@@ -353,27 +361,32 @@
let lines = [
\ 'call setline(1, range(20))',
+ \ 'func NotifyParent(...)',
+ \ ' call echoraw("' .. TermNotifyParentCmd(v:true) .. '")',
+ \ 'endfunc',
\ 'func OpenTerm()',
- \ " let s:buf = term_start('cat', #{hidden: 1, "
+ \ " let s:buf = term_start('cat', #{hidden: 1, term_finish: 'close', "
\ .. a:highlight_opt .. "})",
- \ ' let g:winid = popup_create(s:buf, #{border: [], '
- \ .. a:popup_opt .. '})',
- \ ] + a:popup_cmds + [
+ \ ' let g:winid = popup_create(s:buf, #{border: [], '
+ \ .. 'callback: {->NotifyParent()}, '
+ \ .. a:popup_opt .. '})',
+ \ ] + a:popup_cmds + [
+ \ ' call NotifyParent()',
\ 'endfunc',
- \ ] + a:highlight_cmds
+ \ ] + a:highlight_cmds + [
+ \ 'call NotifyParent()',
+ \ ]
call writefile(lines, 'XtermPopup', 'D')
let buf = RunVimInTerminal('-S XtermPopup', #{rows: 15})
- call TermWait(buf, 100)
+ call WaitForChildNotification()
call term_sendkeys(buf, ":set noruler\<CR>")
call term_sendkeys(buf, ":call OpenTerm()\<CR>")
- call TermWait(buf, 50)
+ call WaitForChildNotification()
call term_sendkeys(buf, "hello\<CR>")
call VerifyScreenDump(buf, 'Test_terminal_popup_' .. a:group_name, {})
call term_sendkeys(buf, "\<C-D>")
- call TermWait(buf, 50)
- call term_sendkeys(buf, ":q\<CR>")
- call TermWait(buf, 50) " wait for terminal to vanish
+ call WaitForChildNotification()
call StopVimInTerminal(buf)
endfunc