blob: 152a2e17729f9531e65bd3117fc1a4d5cc925e81 [file] [log] [blame]
Bram Moolenaar15bf76d2017-03-18 16:18:37 +01001" Tests for the +clientserver feature.
2
Bram Moolenaar8c5a2782019-08-07 23:07:07 +02003source check.vim
4CheckFeature job
Bram Moolenaaree4e0c12020-04-06 21:35:05 +02005
6if !has('clientserver')
7 call assert_fails('call remote_startserver("local")', 'E942:')
8endif
9
Bram Moolenaar8c5a2782019-08-07 23:07:07 +020010CheckFeature clientserver
Bram Moolenaar15bf76d2017-03-18 16:18:37 +010011
12source shared.vim
13
Bram Moolenaarcde0ff32020-04-04 14:00:39 +020014func Check_X11_Connection()
Bram Moolenaara683ec42017-03-25 20:14:34 +010015 if has('x11')
16 if empty($DISPLAY)
17 throw 'Skipped: $DISPLAY is not set'
18 endif
Bram Moolenaara2845b82017-03-25 15:20:06 +010019 try
20 call remote_send('xxx', '')
21 catch
22 if v:exception =~ 'E240:'
Bram Moolenaarcde0ff32020-04-04 14:00:39 +020023 throw 'Skipped: no connection to the X server'
Bram Moolenaara2845b82017-03-25 15:20:06 +010024 endif
25 " ignore other errors
26 endtry
27 endif
Bram Moolenaarcde0ff32020-04-04 14:00:39 +020028endfunc
29
30func Test_client_server()
31 let cmd = GetVimCommand()
32 if cmd == ''
33 return
34 endif
35 call Check_X11_Connection()
Bram Moolenaar42205552017-03-18 19:42:22 +010036
Bram Moolenaar42205552017-03-18 19:42:22 +010037 let name = 'XVIMTEST'
Bram Moolenaar15bf76d2017-03-18 16:18:37 +010038 let cmd .= ' --servername ' . name
Bram Moolenaarab8b1c12017-11-04 19:24:31 +010039 let job = job_start(cmd, {'stoponexit': 'kill', 'out_io': 'null'})
Bram Moolenaar50182fa2018-04-28 21:34:40 +020040 call WaitForAssert({-> assert_equal("run", job_status(job))})
Bram Moolenaar15bf76d2017-03-18 16:18:37 +010041
42 " Takes a short while for the server to be active.
Bram Moolenaar9d189612017-09-09 18:11:00 +020043 " When using valgrind it takes much longer.
Bram Moolenaar50182fa2018-04-28 21:34:40 +020044 call WaitForAssert({-> assert_match(name, serverlist())})
Bram Moolenaar15bf76d2017-03-18 16:18:37 +010045
Bram Moolenaara0d1fef2019-09-04 22:29:14 +020046 eval name->remote_foreground()
Bram Moolenaar15bf76d2017-03-18 16:18:37 +010047
48 call remote_send(name, ":let testvar = 'yes'\<CR>")
Bram Moolenaard97fbf12017-11-02 19:23:03 +010049 call WaitFor('remote_expr("' . name . '", "exists(\"testvar\") ? testvar : \"\"", "", 1) == "yes"')
Bram Moolenaar81b9d0b2017-03-19 21:20:53 +010050 call assert_equal('yes', remote_expr(name, "testvar", "", 2))
Bram Moolenaarca68ae12020-03-30 19:32:53 +020051 call assert_fails("let x=remote_expr(name, '2+x')", 'E449:')
52 call assert_fails("let x=remote_expr('[], '2+2')", 'E116:')
Bram Moolenaar15bf76d2017-03-18 16:18:37 +010053
Bram Moolenaar7416f3e2017-03-18 18:10:13 +010054 if has('unix') && has('gui') && !has('gui_running')
Bram Moolenaar60964f62017-06-10 17:06:16 +020055 " Running in a terminal and the GUI is available: Tell the server to open
Bram Moolenaar7416f3e2017-03-18 18:10:13 +010056 " the GUI and check that the remote command still works.
57 " Need to wait for the GUI to start up, otherwise the send hangs in trying
58 " to send to the terminal window.
Bram Moolenaar81b9d0b2017-03-19 21:20:53 +010059 if has('gui_athena') || has('gui_motif')
60 " For those GUIs, ignore the 'failed to create input context' error.
61 call remote_send(name, ":call test_ignore_error('E285') | gui -f\<CR>")
62 else
63 call remote_send(name, ":gui -f\<CR>")
64 endif
65 " Wait for the server to be up and answering requests.
Bram Moolenaar60964f62017-06-10 17:06:16 +020066 sleep 100m
Bram Moolenaara0d1fef2019-09-04 22:29:14 +020067 call WaitForAssert({-> assert_true(name->remote_expr("v:version", "", 1) != "")})
Bram Moolenaar81b9d0b2017-03-19 21:20:53 +010068
Bram Moolenaar7416f3e2017-03-18 18:10:13 +010069 call remote_send(name, ":let testvar = 'maybe'\<CR>")
Bram Moolenaar50182fa2018-04-28 21:34:40 +020070 call WaitForAssert({-> assert_equal('maybe', remote_expr(name, "testvar", "", 2))})
Bram Moolenaar7416f3e2017-03-18 18:10:13 +010071 endif
72
73 call assert_fails('call remote_send("XXX", ":let testvar = ''yes''\<CR>")', 'E241')
74
75 " Expression evaluated locally.
76 if v:servername == ''
Bram Moolenaara0d1fef2019-09-04 22:29:14 +020077 eval 'MYSELF'->remote_startserver()
Bram Moolenaar81b9d0b2017-03-19 21:20:53 +010078 " May get MYSELF1 when running the test again.
79 call assert_match('MYSELF', v:servername)
Bram Moolenaarca68ae12020-03-30 19:32:53 +020080 call assert_fails("call remote_startserver('MYSELF')", 'E941:')
Bram Moolenaar7416f3e2017-03-18 18:10:13 +010081 endif
82 let g:testvar = 'myself'
83 call assert_equal('myself', remote_expr(v:servername, 'testvar'))
Bram Moolenaarcde0ff32020-04-04 14:00:39 +020084 call remote_send(v:servername, ":let g:testvar2 = 75\<CR>")
85 call feedkeys('', 'x')
86 call assert_equal(75, g:testvar2)
87 call assert_fails('let v = remote_expr(v:servername, "/2")', 'E449:')
Bram Moolenaar7416f3e2017-03-18 18:10:13 +010088
89 call remote_send(name, ":call server2client(expand('<client>'), 'got it')\<CR>", 'g:myserverid')
Bram Moolenaara0d1fef2019-09-04 22:29:14 +020090 call assert_equal('got it', g:myserverid->remote_read(2))
Bram Moolenaar7416f3e2017-03-18 18:10:13 +010091
Bram Moolenaar196b4662019-09-06 21:34:30 +020092 call remote_send(name, ":eval expand('<client>')->server2client('another')\<CR>", 'g:myserverid')
Bram Moolenaar6caf6062017-03-18 20:45:05 +010093 let peek_result = 'nothing'
Bram Moolenaara0d1fef2019-09-04 22:29:14 +020094 let r = g:myserverid->remote_peek('peek_result')
Bram Moolenaarab8b1c12017-11-04 19:24:31 +010095 " unpredictable whether the result is already available.
Bram Moolenaar6caf6062017-03-18 20:45:05 +010096 if r > 0
97 call assert_equal('another', peek_result)
98 elseif r == 0
99 call assert_equal('nothing', peek_result)
100 else
101 call assert_report('remote_peek() failed')
102 endif
103 let g:peek_result = 'empty'
104 call WaitFor('remote_peek(g:myserverid, "g:peek_result") > 0')
Bram Moolenaar6caf6062017-03-18 20:45:05 +0100105 call assert_equal('another', g:peek_result)
Bram Moolenaar81b9d0b2017-03-19 21:20:53 +0100106 call assert_equal('another', remote_read(g:myserverid, 2))
Bram Moolenaar6caf6062017-03-18 20:45:05 +0100107
Bram Moolenaarcde0ff32020-04-04 14:00:39 +0200108 if !has('gui_running')
109 " In GUI vim, the following tests display a dialog box
110
111 let cmd = GetVimProg() .. ' --servername ' .. name
112
113 " Run a separate instance to send a command to the server
114 call remote_expr(name, 'execute("only")')
115 call system(cmd .. ' --remote-send ":new Xfile<CR>"')
116 call assert_equal('2', remote_expr(name, 'winnr("$")'))
117 call assert_equal('Xfile', remote_expr(name, 'winbufnr(1)->bufname()'))
118 call remote_expr(name, 'execute("only")')
119
120 " Invoke a remote-expr. On MS-Windows, the returned value has a carriage
121 " return.
122 let l = system(cmd .. ' --remote-expr "2 + 2"')
123 call assert_equal(['4'], split(l, "\n"))
124
125 " Edit multiple files using --remote
126 call system(cmd .. ' --remote Xfile1 Xfile2 Xfile3')
127 call assert_equal("Xfile1\nXfile2\nXfile3\n", remote_expr(name, 'argv()'))
128 eval name->remote_send(":%bw!\<CR>")
129
130 " Edit files in separate tab pages
131 call system(cmd .. ' --remote-tab Xfile1 Xfile2 Xfile3')
Bram Moolenaar25d57002020-04-08 22:56:34 +0200132 call WaitForAssert({-> assert_equal('3', remote_expr(name, 'tabpagenr("$")'))})
Bram Moolenaarcde0ff32020-04-04 14:00:39 +0200133 call assert_equal('Xfile2', remote_expr(name, 'bufname(tabpagebuflist(2)[0])'))
134 eval name->remote_send(":%bw!\<CR>")
135
136 " Edit a file using --remote-wait
137 eval name->remote_send(":source $VIMRUNTIME/plugin/rrhelper.vim\<CR>")
138 call system(cmd .. ' --remote-wait +enew Xfile1')
139 call assert_equal("Xfile1", remote_expr(name, 'bufname("#")'))
140 eval name->remote_send(":%bw!\<CR>")
141
142 " Edit files using --remote-tab-wait
143 call system(cmd .. ' --remote-tabwait +tabonly\|enew Xfile1 Xfile2')
144 call assert_equal('1', remote_expr(name, 'tabpagenr("$")'))
145 eval name->remote_send(":%bw!\<CR>")
146
147 " Error cases
148 if v:lang == "C" || v:lang =~ '^[Ee]n'
149 let l = split(system(cmd .. ' --remote +pwd'), "\n")
150 call assert_equal("Argument missing after: \"+pwd\"", l[1])
151 endif
152 let l = system(cmd .. ' --remote-expr "abcd"')
153 call assert_match('^E449: ', l)
154 endif
155
156 eval name->remote_send(":%bw!\<CR>")
Bram Moolenaara0d1fef2019-09-04 22:29:14 +0200157 eval name->remote_send(":qa!\<CR>")
Bram Moolenaarab8b1c12017-11-04 19:24:31 +0100158 try
Bram Moolenaar50182fa2018-04-28 21:34:40 +0200159 call WaitForAssert({-> assert_equal("dead", job_status(job))})
Bram Moolenaarab8b1c12017-11-04 19:24:31 +0100160 finally
161 if job_status(job) != 'dead'
162 call assert_report('Server did not exit')
163 call job_stop(job, 'kill')
164 endif
165 endtry
Bram Moolenaar0e05de42020-03-25 22:23:46 +0100166
Bram Moolenaar99fa7212020-04-26 15:59:55 +0200167 call assert_fails('call remote_startserver([])', 'E730:')
Bram Moolenaarcde0ff32020-04-04 14:00:39 +0200168 call assert_fails("let x = remote_peek([])", 'E730:')
169 call assert_fails("let x = remote_read('vim10')", 'E277:')
Bram Moolenaaree4e0c12020-04-06 21:35:05 +0200170 call assert_fails("call server2client('abc', 'xyz')", 'E258:')
Bram Moolenaar15bf76d2017-03-18 16:18:37 +0100171endfunc
172
173" Uncomment this line to get a debugging log
174" call ch_logfile('channellog', 'w')
Bram Moolenaar0e05de42020-03-25 22:23:46 +0100175
176" vim: shiftwidth=2 sts=2 expandtab