neovim

ui_spec.lua (6195B)

---

local t = require('test.testutil')
local n = require('test.functional.testnvim')()
local Screen = require('test.functional.ui.screen')

local clear = n.clear
local command = n.command
local eq = t.eq
local eval = n.eval
local exec = n.exec
local feed = n.feed
local api = n.api
local request = n.request
local poke_eventloop = n.poke_eventloop
local pcall_err = t.pcall_err
local uv = vim.uv

describe('nvim_ui_attach()', function()
 before_each(function()
   clear()
 end)

 it('handles very large width/height #2180', function()
   local _ = Screen.new(999, 999)
   eq(999, eval('&lines'))
   eq(999, eval('&columns'))
 end)

 it('validation', function()
   eq('No such UI option: foo', pcall_err(api.nvim_ui_attach, 80, 24, { foo = { 'foo' } }))

   eq(
     "Invalid 'ext_linegrid': expected Boolean, got Array",
     pcall_err(api.nvim_ui_attach, 80, 24, { ext_linegrid = {} })
   )
   eq(
     "Invalid 'override': expected Boolean, got Array",
     pcall_err(api.nvim_ui_attach, 80, 24, { override = {} })
   )
   eq(
     "Invalid 'rgb': expected Boolean, got Array",
     pcall_err(api.nvim_ui_attach, 80, 24, { rgb = {} })
   )
   eq(
     "Invalid 'term_name': expected String, got Boolean",
     pcall_err(api.nvim_ui_attach, 80, 24, { term_name = true })
   )
   eq(
     "Invalid 'term_colors': expected Integer, got Boolean",
     pcall_err(api.nvim_ui_attach, 80, 24, { term_colors = true })
   )
   eq(
     "Invalid 'stdin_fd': expected Integer, got String",
     pcall_err(api.nvim_ui_attach, 80, 24, { stdin_fd = 'foo' })
   )
   eq(
     "Invalid 'stdin_tty': expected Boolean, got String",
     pcall_err(api.nvim_ui_attach, 80, 24, { stdin_tty = 'foo' })
   )
   eq(
     "Invalid 'stdout_tty': expected Boolean, got String",
     pcall_err(api.nvim_ui_attach, 80, 24, { stdout_tty = 'foo' })
   )

   eq('UI not attached to channel: 1', pcall_err(request, 'nvim_ui_try_resize', 40, 10))
   eq('UI not attached to channel: 1', pcall_err(request, 'nvim_ui_set_option', 'rgb', true))
   eq('UI not attached to channel: 1', pcall_err(request, 'nvim_ui_detach'))

   local _ = Screen.new(nil, nil, { rgb = false })
   eq(
     'UI already attached to channel: 1',
     pcall_err(request, 'nvim_ui_attach', 40, 10, { rgb = false })
   )
 end)

 it('does not crash if maximum UI count is reached', function()
   local server = api.nvim_get_vvar('servername')
   local screens = {} --- @type test.functional.ui.screen[]
   for i = 1, 16 do
     screens[i] = Screen.new(nil, nil, nil, n.connect(server))
   end
   eq(
     -- 0 is kErrorTypeException
     { false, { 0, 'Maximum UI count reached' } },
     { n.connect(server):request('nvim_ui_attach', 80, 24, {}) }
   )
   for i = 1, 16 do
     screens[i]:detach()
   end
 end)
end)

describe('nvim_ui_send', function()
 before_each(function()
   clear()
 end)

 it('works with stdout_tty', function()
   local fds = assert(uv.pipe())

   local read_pipe = assert(uv.new_pipe())
   read_pipe:open(fds.read)

   local read_data = {}
   read_pipe:read_start(function(err, data)
     assert(not err, err)
     if data then
       table.insert(read_data, data)
     end
   end)

   local screen = Screen.new(50, 10, { stdout_tty = true })
   screen:set_stdout(fds.write)

   api.nvim_ui_send('Hello world')

   poke_eventloop()

   screen:expect([[
     ^                                                  |
     {1:~                                                 }|*8
                                                       |
   ]])

   eq('Hello world', table.concat(read_data))
 end)

 it('ignores ui_send event for UIs without stdout_tty', function()
   local fds = assert(uv.pipe())

   local read_pipe = assert(uv.new_pipe())
   read_pipe:open(fds.read)

   local read_data = {}
   read_pipe:read_start(function(err, data)
     assert(not err, err)
     if data then
       table.insert(read_data, data)
     end
   end)

   local screen = Screen.new(50, 10)
   screen:set_stdout(fds.write)

   api.nvim_ui_send('Hello world')

   poke_eventloop()

   screen:expect([[
     ^                                                  |
     {1:~                                                 }|*8
                                                       |
   ]])

   eq('', table.concat(read_data))
 end)
end)

it('autocmds UIEnter/UILeave', function()
 clear { args_rm = { '--headless' } }
 exec([[
   let g:evs = []
   autocmd UIEnter * call add(g:evs, "UIEnter") | let g:uienter_ev = deepcopy(v:event)
   autocmd UILeave * call add(g:evs, "UILeave") | let g:uileave_ev = deepcopy(v:event)
   autocmd VimEnter * call add(g:evs, "VimEnter")
 ]])
 local screen = Screen.new()
 eq({ chan = 1 }, eval('g:uienter_ev'))
 screen:detach()
 eq({ chan = 1 }, eval('g:uileave_ev'))
 eq({
   'VimEnter',
   'UIEnter',
   'UILeave',
 }, eval('g:evs'))
end)

it('autocmds VimSuspend/VimResume #22041', function()
 clear()
 local screen = Screen.new()
 exec([[
   let g:ev = []
   autocmd VimResume  * :call add(g:ev, 'r')
   autocmd VimSuspend * :call add(g:ev, 's')
 ]])

 eq(false, screen.suspended)
 feed('<C-Z>')
 screen:expect(function()
   eq(true, screen.suspended)
 end)
 eq({ 's' }, eval('g:ev'))
 screen.suspended = false
 feed('<Ignore>')
 eq({ 's', 'r' }, eval('g:ev'))

 command('suspend')
 screen:expect(function()
   eq(true, screen.suspended)
 end)
 eq({ 's', 'r', 's' }, eval('g:ev'))
 screen.suspended = false
 api.nvim_input_mouse('move', '', '', 0, 0, 0)
 eq({ 's', 'r', 's', 'r' }, eval('g:ev'))

 feed('<C-Z><C-Z><C-Z>')
 screen:expect(function()
   eq(true, screen.suspended)
 end)
 api.nvim_ui_set_focus(false)
 eq({ 's', 'r', 's', 'r', 's' }, eval('g:ev'))
 screen.suspended = false
 api.nvim_ui_set_focus(true)
 eq({ 's', 'r', 's', 'r', 's', 'r' }, eval('g:ev'))

 command('suspend | suspend | suspend')
 screen:expect(function()
   eq(true, screen.suspended)
 end)
 screen:detach()
 eq({ 's', 'r', 's', 'r', 's', 'r', 's' }, eval('g:ev'))
 screen.suspended = false
 screen:attach()
 eq({ 's', 'r', 's', 'r', 's', 'r', 's', 'r' }, eval('g:ev'))
end)