Files
neovim/test/functional/autocmd/cursorhold_spec.lua
Justin M. Keyes 6d8c8b18d5 test(harness): migrate away from magic globals
Problem:
The magic globals `it`, `describe`, etc., are more trouble than they are
worth.

- Hooking into `after_each` requires `getfenv()` hacks.
- They confuse luals/emmylua, because the top-level `.luarc.json` isn't
  merged with `test/.luarc.json` (apparently a luals limitation?)
- They totally defeat discoverability because the user just has to
  "know" about the various magic symbols.

So they harm DX, which means they serve no purpose at all.

Solution:
- Expose the test API from `testutil`, so tests can call `t.it()`,
  `t.describe()`, etc., in the conventional way.
- Drop `getfenv()` hacks.
- Drop the `setfenv()` injection in `load_chunk`.
- Drop `test/_meta.lua`.
2026-07-21 13:22:39 +02:00

105 lines
2.8 KiB
Lua

local t = require('test.testutil')
local n = require('test.functional.testnvim')()
local describe, it, before_each = t.describe, t.it, t.before_each
local clear = n.clear
local eq = t.eq
local feed = n.feed
local retry = t.retry
local exec = n.source
local sleep = vim.uv.sleep
local api = n.api
before_each(clear)
describe('CursorHold', function()
before_each(function()
exec([[
let g:cursorhold = 0
augroup test
au CursorHold * let g:cursorhold += 1
augroup END
]])
end)
it('is triggered correctly #12587', function()
local function test_cursorhold(fn, early)
local ut = 2
-- if testing with small 'updatetime' fails, double its value and test again
retry(10, nil, function()
ut = ut * 2
api.nvim_set_option_value('updatetime', ut, {})
feed('0') -- reset did_cursorhold
api.nvim_set_var('cursorhold', 0)
sleep(ut / 4)
fn()
eq(0, api.nvim_get_var('cursorhold'))
sleep(ut / 2)
fn()
eq(0, api.nvim_get_var('cursorhold'))
sleep(ut / 2)
eq(early, api.nvim_get_var('cursorhold'))
sleep(ut / 4 * 3)
eq(1, api.nvim_get_var('cursorhold'))
end)
end
local ignore_key = api.nvim_replace_termcodes('<Ignore>', true, true, true)
test_cursorhold(function() end, 1)
test_cursorhold(function()
feed('')
end, 1)
test_cursorhold(function()
api.nvim_feedkeys('', 'n', true)
end, 1)
test_cursorhold(function()
feed('<Ignore>')
end, 0)
test_cursorhold(function()
api.nvim_feedkeys(ignore_key, 'n', true)
end, 0)
end)
it("reducing 'updatetime' while waiting for CursorHold #20241", function()
api.nvim_set_option_value('updatetime', 10000, {})
feed('0') -- reset did_cursorhold
api.nvim_set_var('cursorhold', 0)
sleep(50)
eq(0, api.nvim_get_var('cursorhold'))
api.nvim_set_option_value('updatetime', 20, {})
sleep(10)
eq(1, api.nvim_get_var('cursorhold'))
end)
it('is not triggered after only K_EVENT on startup', function()
api.nvim_set_option_value('updatetime', 20, {})
sleep(50)
eq(0, api.nvim_get_var('cursorhold'))
feed('0')
-- Poll: CursorHold may take longer than one 'updatetime' to fire.
retry(nil, 1000, function()
eq(1, api.nvim_get_var('cursorhold'))
end)
end)
end)
describe('CursorHoldI', function()
-- NOTE: since this test uses RPC it is not necessary to trigger the initial
-- issue (#3757) via timer's or RPC callbacks in the first place.
it('is triggered after input', function()
exec([[
set updatetime=1
let g:cursorhold = 0
augroup test
au CursorHoldI * let g:cursorhold += 1
augroup END
]])
feed('ifoo')
retry(5, nil, function()
sleep(1)
eq(1, api.nvim_get_var('cursorhold'))
end)
end)
end)