mirrors/neovim
1
0
Fork 0
mirror of https://github.com/neovim/neovim.git synced 2025-09-06 19:38:20 +00:00
Code Issues Packages Projects Releases Wiki Activity

feat(lua): enable stack traces in error output (#16228)

Browse Source
This commit is contained in:
Gregory Anders
2021-11-06 08:26:10 -06:00
committed by GitHub
parent 1fdbd29dfa
commit 03b805aee6
13 changed files with 174 additions and 195 deletions
Download Patch File Download Diff File Expand all files Collapse all files

139
test/functional/lua/vim_spec.lua
View File

@@ -4,7 +4,6 @@ local Screen = require('test.functional.ui.screen')
local funcs = helpers.funcs
local meths = helpers.meths
local dedent = helpers.dedent
local command = helpers.command
local insert = helpers.insert
local clear = helpers.clear
@@ -19,6 +18,7 @@ local source = helpers.source
local NIL = helpers.NIL
local retry = helpers.retry
local next_msg = helpers.next_msg
local remove_trace = helpers.remove_trace
before_each(clear)
@@ -121,11 +121,6 @@ describe('lua stdlib', function()
eq(1, funcs.luaeval('vim.stricmp("\\0C\\0", "\\0B\\0")'))
end)
-- for brevity, match only the error header (not the traceback)
local function pcall_header(...)
return string.gsub(string.gsub(pcall_err(exec_lua, ...), '[\r\n].*', ''), '^Error executing lua: ', '')
end
it('vim.startswith', function()
eq(true, funcs.luaeval('vim.startswith("123", "1")'))
eq(true, funcs.luaeval('vim.startswith("123", "")'))
@@ -136,8 +131,10 @@ describe('lua stdlib', function()
eq(false, funcs.luaeval('vim.startswith("123", "2")'))
eq(false, funcs.luaeval('vim.startswith("123", "1234")'))
eq("vim/shared.lua:0: prefix: expected string, got nil", pcall_header 'return vim.startswith("123", nil)')
eq("vim/shared.lua:0: s: expected string, got nil", pcall_header 'return vim.startswith(nil, "123")')
eq("Error executing lua: vim/shared.lua:0: prefix: expected string, got nil",
pcall_err(exec_lua, 'return vim.startswith("123", nil)'))
eq("Error executing lua: vim/shared.lua:0: s: expected string, got nil",
pcall_err(exec_lua, 'return vim.startswith(nil, "123")'))
end)
it('vim.endswith', function()
@@ -150,8 +147,10 @@ describe('lua stdlib', function()
eq(false, funcs.luaeval('vim.endswith("123", "2")'))
eq(false, funcs.luaeval('vim.endswith("123", "1234")'))
eq("vim/shared.lua:0: suffix: expected string, got nil", pcall_header 'return vim.endswith("123", nil)')
eq("vim/shared.lua:0: s: expected string, got nil", pcall_header 'return vim.endswith(nil, "123")')
eq("Error executing lua: vim/shared.lua:0: suffix: expected string, got nil",
pcall_err(exec_lua, 'return vim.endswith("123", nil)'))
eq("Error executing lua: vim/shared.lua:0: s: expected string, got nil",
pcall_err(exec_lua, 'return vim.endswith(nil, "123")'))
end)
it("vim.str_utfindex/str_byteindex", function()
@@ -233,7 +232,7 @@ describe('lua stdlib', function()
]])
feed("<cr>")
eq('Error executing vim.schedule lua callback: [string "<nvim>"]:2: big failure\nvery async', eval("v:errmsg"))
eq('Error executing vim.schedule lua callback: [string "<nvim>"]:2: big failure\nvery async', remove_trace(eval("v:errmsg")))
local screen = Screen.new(60,5)
screen:set_default_attr_ids({
@@ -259,10 +258,10 @@ describe('lua stdlib', function()
end)
]])
screen:expect{grid=[[
|
{2: }|
{3:Error executing vim.schedule lua callback: [string "<nvim>"]}|
{3::2: Vim(echo):E115: Missing quote: 'err} |
{3:stack traceback:} |
{3: [C]: in function 'nvim_command'} |
{3: [string "<nvim>"]:2: in function <[string "<nvim>"]:}|
{3:1>} |
{4:Press ENTER or type command to continue}^ |
]]}
end)
@@ -306,22 +305,11 @@ describe('lua stdlib', function()
-- Validates args.
eq(true, pcall(split, 'string', 'string'))
eq(dedent([[
Error executing lua: vim/shared.lua:0: s: expected string, got number
stack traceback:
vim/shared.lua:0: in function 'gsplit'
vim/shared.lua:0: in function <vim/shared.lua:0>]]),
eq('Error executing lua: vim/shared.lua:0: s: expected string, got number',
pcall_err(split, 1, 'string'))
eq(dedent([[
Error executing lua: vim/shared.lua:0: sep: expected string, got number
stack traceback:
vim/shared.lua:0: in function 'gsplit'
vim/shared.lua:0: in function <vim/shared.lua:0>]]),
eq('Error executing lua: vim/shared.lua:0: sep: expected string, got number',
pcall_err(split, 'string', 1))
eq(dedent([[
Error executing lua: vim/shared.lua:0: kwargs: expected table, got number
stack traceback:
vim/shared.lua:0: in function <vim/shared.lua:0>]]),
eq('Error executing lua: vim/shared.lua:0: kwargs: expected table, got number',
pcall_err(split, 'string', 'string', 1))
end)
@@ -342,10 +330,7 @@ describe('lua stdlib', function()
end
-- Validates args.
eq(dedent([[
Error executing lua: vim/shared.lua:0: s: expected string, got number
stack traceback:
vim/shared.lua:0: in function <vim/shared.lua:0>]]),
eq('Error executing lua: vim/shared.lua:0: s: expected string, got number',
pcall_err(trim, 2))
end)
@@ -424,10 +409,7 @@ describe('lua stdlib', function()
eq('foo%%%-bar', exec_lua([[return vim.pesc(vim.pesc('foo-bar'))]]))
-- Validates args.
eq(dedent([[
Error executing lua: vim/shared.lua:0: s: expected string, got number
stack traceback:
vim/shared.lua:0: in function <vim/shared.lua:0>]]),
eq('Error executing lua: vim/shared.lua:0: s: expected string, got number',
pcall_err(exec_lua, [[return vim.pesc(2)]]))
end)
@@ -710,10 +692,7 @@ describe('lua stdlib', function()
it('vim.list_extend', function()
eq({1,2,3}, exec_lua [[ return vim.list_extend({1}, {2,3}) ]])
eq(dedent([[
Error executing lua: vim/shared.lua:0: src: expected table, got nil
stack traceback:
vim/shared.lua:0: in function <vim/shared.lua:0>]]),
eq('Error executing lua: vim/shared.lua:0: src: expected table, got nil',
pcall_err(exec_lua, [[ return vim.list_extend({1}, nil) ]]))
eq({1,2}, exec_lua [[ return vim.list_extend({1}, {2;a=1}) ]])
eq(true, exec_lua [[ local a = {1} return vim.list_extend(a, {2;a=1}) == a ]])
@@ -845,12 +824,12 @@ describe('lua stdlib', function()
end)
]])
screen:expect{grid=[[
foo |
{1:~ }|
{2: }|
{3:Error executing luv callback:} |
{3:[string "<nvim>"]:6: E5560: rpcrequest must not be}|
{3: called in a lua loop callback} |
{3:stack traceback:} |
{3: [C]: in function 'rpcrequest'} |
{3: [string "<nvim>"]:6: in function <[string }|
{3:"<nvim>"]:2>} |
{4:Press ENTER or type command to continue}^ |
]]}
feed('<cr>')
@@ -914,76 +893,37 @@ describe('lua stdlib', function()
exec_lua("vim.validate{arg1={{}, 't' }, arg2={ 'foo', 's' }}")
exec_lua("vim.validate{arg1={2, function(a) return (a % 2) == 0 end, 'even number' }}")
eq(dedent([[
Error executing lua: [string "<nvim>"]:0: opt[1]: expected table, got number
stack traceback:
[string "<nvim>"]:0: in main chunk]]),
eq('Error executing lua: [string "<nvim>"]:0: opt[1]: expected table, got number',
pcall_err(exec_lua, "vim.validate{ 1, 'x' }"))
eq(dedent([[
Error executing lua: [string "<nvim>"]:0: invalid type name: x
stack traceback:
[string "<nvim>"]:0: in main chunk]]),
eq('Error executing lua: [string "<nvim>"]:0: invalid type name: x',
pcall_err(exec_lua, "vim.validate{ arg1={ 1, 'x' }}"))
eq(dedent([[
Error executing lua: [string "<nvim>"]:0: invalid type name: 1
stack traceback:
[string "<nvim>"]:0: in main chunk]]),
eq('Error executing lua: [string "<nvim>"]:0: invalid type name: 1',
pcall_err(exec_lua, "vim.validate{ arg1={ 1, 1 }}"))
eq(dedent([[
Error executing lua: [string "<nvim>"]:0: invalid type name: nil
stack traceback:
[string "<nvim>"]:0: in main chunk]]),
eq('Error executing lua: [string "<nvim>"]:0: invalid type name: nil',
pcall_err(exec_lua, "vim.validate{ arg1={ 1 }}"))
-- Validated parameters are required by default.
eq(dedent([[
Error executing lua: [string "<nvim>"]:0: arg1: expected string, got nil
stack traceback:
[string "<nvim>"]:0: in main chunk]]),
eq('Error executing lua: [string "<nvim>"]:0: arg1: expected string, got nil',
pcall_err(exec_lua, "vim.validate{ arg1={ nil, 's' }}"))
-- Explicitly required.
eq(dedent([[
Error executing lua: [string "<nvim>"]:0: arg1: expected string, got nil
stack traceback:
[string "<nvim>"]:0: in main chunk]]),
eq('Error executing lua: [string "<nvim>"]:0: arg1: expected string, got nil',
pcall_err(exec_lua, "vim.validate{ arg1={ nil, 's', false }}"))
eq(dedent([[
Error executing lua: [string "<nvim>"]:0: arg1: expected table, got number
stack traceback:
[string "<nvim>"]:0: in main chunk]]),
eq('Error executing lua: [string "<nvim>"]:0: arg1: expected table, got number',
pcall_err(exec_lua, "vim.validate{arg1={1, 't'}}"))
eq(dedent([[
Error executing lua: [string "<nvim>"]:0: arg2: expected string, got number
stack traceback:
[string "<nvim>"]:0: in main chunk]]),
eq('Error executing lua: [string "<nvim>"]:0: arg2: expected string, got number',
pcall_err(exec_lua, "vim.validate{arg1={{}, 't'}, arg2={1, 's'}}"))
eq(dedent([[
Error executing lua: [string "<nvim>"]:0: arg2: expected string, got nil
stack traceback:
[string "<nvim>"]:0: in main chunk]]),
eq('Error executing lua: [string "<nvim>"]:0: arg2: expected string, got nil',
pcall_err(exec_lua, "vim.validate{arg1={{}, 't'}, arg2={nil, 's'}}"))
eq(dedent([[
Error executing lua: [string "<nvim>"]:0: arg2: expected string, got nil
stack traceback:
[string "<nvim>"]:0: in main chunk]]),
eq('Error executing lua: [string "<nvim>"]:0: arg2: expected string, got nil',
pcall_err(exec_lua, "vim.validate{arg1={{}, 't'}, arg2={nil, 's'}}"))
eq(dedent([[
Error executing lua: [string "<nvim>"]:0: arg1: expected even number, got 3
stack traceback:
[string "<nvim>"]:0: in main chunk]]),
eq('Error executing lua: [string "<nvim>"]:0: arg1: expected even number, got 3',
pcall_err(exec_lua, "vim.validate{arg1={3, function(a) return a == 1 end, 'even number'}}"))
eq(dedent([[
Error executing lua: [string "<nvim>"]:0: arg1: expected ?, got 3
stack traceback:
[string "<nvim>"]:0: in main chunk]]),
eq('Error executing lua: [string "<nvim>"]:0: arg1: expected ?, got 3',
pcall_err(exec_lua, "vim.validate{arg1={3, function(a) return a == 1 end}}"))
-- Pass an additional message back.
eq(dedent([[
Error executing lua: [string "<nvim>"]:0: arg1: expected ?, got 3. Info: TEST_MSG
stack traceback:
[string "<nvim>"]:0: in main chunk]]),
eq('Error executing lua: [string "<nvim>"]:0: arg1: expected ?, got 3. Info: TEST_MSG',
pcall_err(exec_lua, "vim.validate{arg1={3, function(a) return a == 1, 'TEST_MSG' end}}"))
end)
@@ -2133,9 +2073,10 @@ describe('lua stdlib', function()
end)
it('should not crash when callback errors', function()
eq({false, '[string "<nvim>"]:1: As Expected'}, exec_lua [[
local result = exec_lua [[
return {pcall(function() vim.wait(1000, function() error("As Expected") end) end)}
]])
]]
eq({false, '[string "<nvim>"]:1: As Expected'}, {result[1], remove_trace(result[2])})
end)
it('if callback is passed, it must be a function', function()