File: //home/ubuntu/neovim/test/functional/plugin/health_spec.lua
local t = require('test.testutil')
local n = require('test.functional.testnvim')()
local Screen = require('test.functional.ui.screen')
local clear = n.clear
local curbuf_contents = n.curbuf_contents
local command = n.command
local eq, matches = t.eq, t.matches
local getcompletion = n.fn.getcompletion
local insert = n.insert
local exec_lua = n.exec_lua
local source = n.source
local assert_alive = n.assert_alive
local fn = n.fn
local api = n.api
describe(':checkhealth', function()
it('detects invalid $VIMRUNTIME', function()
clear({
env = { VIMRUNTIME = 'bogus' },
})
local status, err = pcall(command, 'checkhealth')
eq(false, status)
eq('Invalid $VIMRUNTIME: bogus', string.match(err, 'Invalid.*'))
end)
it("detects invalid 'runtimepath'", function()
clear()
command('set runtimepath=bogus')
local status, err = pcall(command, 'checkhealth')
eq(false, status)
eq("Invalid 'runtimepath'", string.match(err, 'Invalid.*'))
end)
it('detects invalid $VIM', function()
clear()
-- Do this after startup, otherwise it just breaks $VIMRUNTIME.
command("let $VIM='zub'")
command('checkhealth vim.health')
matches('ERROR $VIM .* zub', curbuf_contents())
end)
it('completions can be listed via getcompletion()', function()
clear()
eq('vim.deprecated', getcompletion('vim', 'checkhealth')[1])
eq('vim.provider', getcompletion('vim.prov', 'checkhealth')[1])
eq('vim.lsp', getcompletion('vim.ls', 'checkhealth')[1])
end)
it('completion checks for vim.health._complete() return type #28456', function()
clear()
exec_lua([[vim.health._complete = function() return 1 end]])
eq({}, getcompletion('', 'checkhealth'))
exec_lua([[vim.health._complete = function() return { 1 } end]])
eq({}, getcompletion('', 'checkhealth'))
assert_alive()
end)
end)
describe('health.vim', function()
before_each(function()
clear { args = { '-u', 'NORC' } }
-- Provides healthcheck functions
command('set runtimepath+=test/functional/fixtures')
end)
describe(':checkhealth', function()
it('functions report_*() render correctly', function()
command('checkhealth full_render')
n.expect([[
==============================================================================
test_plug.full_render: require("test_plug.full_render.health").check()
report 1 ~
- OK life is fine
- WARNING no what installed
- ADVICE:
- pip what
- make what
report 2 ~
- stuff is stable
- ERROR why no hardcopy
- ADVICE:
- :help |:hardcopy|
- :help |:TOhtml|
]])
end)
it('concatenates multiple reports', function()
command('checkhealth success1 success2 test_plug')
n.expect([[
==============================================================================
test_plug: require("test_plug.health").check()
report 1 ~
- OK everything is fine
report 2 ~
- OK nothing to see here
==============================================================================
test_plug.success1: require("test_plug.success1.health").check()
report 1 ~
- OK everything is fine
report 2 ~
- OK nothing to see here
==============================================================================
test_plug.success2: require("test_plug.success2.health").check()
another 1 ~
- OK ok
]])
end)
it('lua plugins submodules', function()
command('checkhealth test_plug.submodule')
n.expect([[
==============================================================================
test_plug.submodule: require("test_plug.submodule.health").check()
report 1 ~
- OK everything is fine
report 2 ~
- OK nothing to see here
]])
end)
it('... including empty reports', function()
command('checkhealth test_plug.submodule_empty')
n.expect([[
==============================================================================
test_plug.submodule_empty: require("test_plug.submodule_empty.health").check()
- ERROR The healthcheck report for "test_plug.submodule_empty" plugin is empty.
]])
end)
it('highlights OK, ERROR', function()
local screen = Screen.new(50, 12)
screen:attach()
screen:set_default_attr_ids({
Ok = { foreground = Screen.colors.LightGreen },
Error = { foreground = Screen.colors.Red },
Heading = { foreground = tonumber('0x6a0dad') },
Bar = { foreground = Screen.colors.LightGrey, background = Screen.colors.DarkGrey },
})
command('checkhealth foo success1')
command('set nofoldenable nowrap laststatus=0')
screen:expect {
grid = [[
^ |
{Bar:──────────────────────────────────────────────────}|
{Heading:foo: } |
|
- {Error:ERROR} No healthcheck found for "foo" plugin. |
|
{Bar:──────────────────────────────────────────────────}|
{Heading:test_plug.success1: require("test_plug.success1.he}|
|
{Heading:report 1} |
- {Ok:OK} everything is fine |
|
]],
}
end)
it('gracefully handles invalid healthcheck', function()
command('checkhealth non_existent_healthcheck')
-- luacheck: ignore 613
n.expect([[
==============================================================================
non_existent_healthcheck:
- ERROR No healthcheck found for "non_existent_healthcheck" plugin.
]])
end)
it('does not use vim.health as a healtcheck', function()
-- vim.health is not a healthcheck
command('checkhealth vim')
n.expect([[
ERROR: No healthchecks found.]])
end)
end)
end)
describe(':checkhealth provider', function()
it("works correctly with a wrongly configured 'shell'", function()
clear()
command([[set shell=echo\ WRONG!!!]])
command('let g:loaded_perl_provider = 0')
command('let g:loaded_python3_provider = 0')
command('checkhealth provider')
eq(nil, string.match(curbuf_contents(), 'WRONG!!!'))
end)
end)
describe(':checkhealth window', function()
before_each(function()
clear { args = { '-u', 'NORC' } }
-- Provides healthcheck functions
command('set runtimepath+=test/functional/fixtures')
command('set nofoldenable nowrap laststatus=0')
end)
it('opens directly if no buffer created', function()
local screen = Screen.new(50, 12)
screen:set_default_attr_ids {
[1] = { foreground = Screen.colors.Blue, bold = true },
[14] = { foreground = Screen.colors.LightGrey, background = Screen.colors.DarkGray },
[31] = { foreground = tonumber('0x6a0dad') },
[32] = { foreground = Screen.colors.PaleGreen2 },
}
screen:attach({ ext_multigrid = true })
command('checkhealth success1')
screen:expect {
grid = [[
## grid 1
[2:--------------------------------------------------]|*11
[3:--------------------------------------------------]|
## grid 2
^ |
{14:──────────────────────────────────────────────────}|
{14:────────────────────────────} |
{31:test_plug.success1: require("test_plug.success1. }|
{31:health").check()} |
|
{31:report 1} |
- {32:OK} everything is fine |
|
{31:report 2} |
- {32:OK} nothing to see here |
## grid 3
|
]],
}
end)
local function test_health_vsplit(left, emptybuf, mods)
local screen = Screen.new(50, 20)
screen:set_default_attr_ids {
[1] = { foreground = Screen.colors.Blue, bold = true },
[14] = { foreground = Screen.colors.LightGrey, background = Screen.colors.DarkGray },
[31] = { foreground = tonumber('0x6a0dad') },
[32] = { foreground = Screen.colors.PaleGreen2 },
}
screen:attach({ ext_multigrid = true })
if not emptybuf then
insert('hello')
end
command(mods .. ' checkhealth success1')
screen:expect(
([[
## grid 1
%s
[3:--------------------------------------------------]|
## grid 2
%s |
{1:~ }|*18
## grid 3
|
## grid 4
^ |
{14:─────────────────────────}|*3
{14:───} |
{31:test_plug.success1: }|
{31:require("test_plug. }|
{31:success1.health").check()}|
|
{31:report 1} |
- {32:OK} everything is fine |
|
{31:report 2} |
- {32:OK} nothing to see here |
|
{1:~ }|*4
]]):format(
left and '[4:-------------------------]│[2:------------------------]|*19'
or '[2:------------------------]│[4:-------------------------]|*19',
emptybuf and ' ' or 'hello'
)
)
end
for _, mods in ipairs({ 'vertical', 'leftabove vertical', 'topleft vertical' }) do
it(('opens in left vsplit window with :%s and no buffer created'):format(mods), function()
test_health_vsplit(true, true, mods)
end)
it(('opens in left vsplit window with :%s and non-empty buffer'):format(mods), function()
test_health_vsplit(true, false, mods)
end)
end
for _, mods in ipairs({ 'rightbelow vertical', 'botright vertical' }) do
it(('opens in right vsplit window with :%s and no buffer created'):format(mods), function()
test_health_vsplit(false, true, mods)
end)
it(('opens in right vsplit window with :%s and non-empty buffer'):format(mods), function()
test_health_vsplit(false, false, mods)
end)
end
local function test_health_split(top, emptybuf, mods)
local screen = Screen.new(50, 25)
screen:attach({ ext_multigrid = true })
screen._default_attr_ids = nil
if not emptybuf then
insert('hello')
end
command(mods .. ' checkhealth success1')
screen:expect(
([[
## grid 1
%s
[3:--------------------------------------------------]|
## grid 2
%s |
~ |*10
## grid 3
|
## grid 4
^ |
──────────────────────────────────────────────────|
──────────────────────────── |
test_plug.success1: require("test_plug.success1. |
health").check() |
|
report 1 |
- OK everything is fine |
|
report 2 |
- OK nothing to see here |
|
]]):format(
top
and [[
[4:--------------------------------------------------]|*12
health:// |
[2:--------------------------------------------------]|*11]]
or ([[
[2:--------------------------------------------------]|*11
[No Name] %s |
[4:--------------------------------------------------]|*12]]):format(
emptybuf and ' ' or '[+]'
),
emptybuf and ' ' or 'hello'
)
)
end
for _, mods in ipairs({ 'horizontal', 'leftabove', 'topleft' }) do
it(('opens in top split window with :%s and no buffer created'):format(mods), function()
test_health_split(true, true, mods)
end)
it(('opens in top split window with :%s and non-empty buffer'):format(mods), function()
test_health_split(true, false, mods)
end)
end
for _, mods in ipairs({ 'rightbelow', 'botright' }) do
it(('opens in bottom split window with :%s and no buffer created'):format(mods), function()
test_health_split(false, true, mods)
end)
it(('opens in bottom split window with :%s and non-empty buffer'):format(mods), function()
test_health_split(false, false, mods)
end)
end
it('opens in tab', function()
-- create an empty buffer called "my_buff"
api.nvim_create_buf(false, true)
command('file my_buff')
command('checkhealth success1')
-- define a function that collects all buffers in each tab
-- returns a dictionary like {tab1 = ["buf1", "buf2"], tab2 = ["buf3"]}
source([[
function CollectBuffersPerTab()
let buffs = {}
for i in range(tabpagenr('$'))
let key = 'tab' . (i + 1)
let value = []
for j in tabpagebuflist(i + 1)
call add(value, bufname(j))
endfor
let buffs[key] = value
endfor
return buffs
endfunction
]])
local buffers_per_tab = fn.CollectBuffersPerTab()
eq(buffers_per_tab, { tab1 = { 'my_buff' }, tab2 = { 'health://' } })
end)
end)