From 2cc523c3afd3c98e80499409182ca96708d996f4 Mon Sep 17 00:00:00 2001 From: TJ DeVries Date: Thu, 16 Jun 2016 17:01:47 -0400 Subject: [PATCH 1/5] CheckHealth - Use execute() instead of redir - Fixed logic on suboptimal pyenv/virtualenv checks. - Move system calls from strings to lists. Fixes #5218 - Add highlighting - Automatically discover health checkers - Add tests Helped-by: Shougo Matsushita Helped-by: Tommy Allen Closes #4932 --- runtime/autoload/health.vim | 639 +++++++------------------ runtime/autoload/health/nvim.vim | 426 +++++++++++++++++ runtime/doc/pi_health.txt | 146 ++++++ runtime/doc/provider.txt | 8 - runtime/plugin/health.vim | 2 + runtime/syntax/health.vim | 20 + test/functional/plugin/health_spec.lua | 58 +++ 7 files changed, 837 insertions(+), 462 deletions(-) create mode 100644 runtime/autoload/health/nvim.vim create mode 100644 runtime/doc/pi_health.txt create mode 100644 runtime/syntax/health.vim create mode 100644 test/functional/plugin/health_spec.lua diff --git a/runtime/autoload/health.vim b/runtime/autoload/health.vim index 0a698e6492..edcb3d792d 100644 --- a/runtime/autoload/health.vim +++ b/runtime/autoload/health.vim @@ -1,468 +1,199 @@ -function! s:trim(s) abort - return substitute(a:s, '^\_s*\|\_s*$', '', 'g') -endfunction - - -" Simple version comparison. -function! s:version_cmp(a, b) abort - let a = split(a:a, '\.') - let b = split(a:b, '\.') - - for i in range(len(a)) - if a[i] > b[i] - return 1 - elseif a[i] < b[i] - return -1 - endif - endfor - - return 0 -endfunction - - -" Fetch the contents of a URL. -function! s:download(url) abort - let content = '' - if executable('curl') - let content = system('curl -sL "'.a:url.'"') - endif - - if empty(content) && executable('python') - let script = " - \try:\n - \ from urllib.request import urlopen\n - \except ImportError:\n - \ from urllib2 import urlopen\n - \\n - \try:\n - \ response = urlopen('".a:url."')\n - \ print(response.read().decode('utf8'))\n - \except Exception:\n - \ pass\n - \" - let content = system('python -c "'.script.'" 2>/dev/null') - endif - - return content -endfunction - - -" Get the latest Neovim Python client version from PyPI. The result is -" cached. -function! s:latest_pypi_version() - if exists('s:pypi_version') - return s:pypi_version - endif - - let s:pypi_version = 'unknown' - let pypi_info = s:download('https://pypi.python.org/pypi/neovim/json') - if !empty(pypi_info) - let pypi_data = json_decode(pypi_info) - let s:pypi_version = get(get(pypi_data, 'info', {}), 'version', 'unknown') - return s:pypi_version - endif -endfunction - - -" Get version information using the specified interpreter. The interpreter is -" used directly in case breaking changes were introduced since the last time -" Neovim's Python client was updated. -function! s:version_info(python) abort - let pypi_version = s:latest_pypi_version() - let python_version = s:trim(system( - \ printf('"%s" -c "import sys; print(''.''.join(str(x) ' - \ . 'for x in sys.version_info[:3]))"', a:python))) - if empty(python_version) - let python_version = 'unknown' - endif - - let nvim_path = s:trim(system(printf('"%s" -c "import sys, neovim;' - \ . 'print(neovim.__file__)" 2>/dev/null', a:python))) - if empty(nvim_path) - return [python_version, 'not found', pypi_version, 'unknown'] - endif - - let nvim_version = 'unknown' - let base = fnamemodify(nvim_path, ':h') - for meta in glob(base.'-*/METADATA', 1, 1) + glob(base.'-*/PKG-INFO', 1, 1) - for meta_line in readfile(meta) - if meta_line =~# '^Version:' - let nvim_version = matchstr(meta_line, '^Version: \zs\S\+') - endif - endfor - endfor - - let version_status = 'unknown' - if nvim_version != 'unknown' && pypi_version != 'unknown' - if s:version_cmp(nvim_version, pypi_version) == -1 - let version_status = 'outdated' - else - let version_status = 'up to date' - endif - endif - - return [python_version, nvim_version, pypi_version, version_status] -endfunction - - -" Check the Python interpreter's usability. -function! s:check_bin(bin, notes) abort - if !filereadable(a:bin) - call add(a:notes, printf('Error: "%s" was not found.', a:bin)) - return 0 - elseif executable(a:bin) != 1 - call add(a:notes, printf('Error: "%s" is not executable.', a:bin)) - return 0 - endif - return 1 -endfunction - - -" Text wrapping that returns a list of lines -function! s:textwrap(text, width) abort - let pattern = '.*\%(\s\+\|\_$\)\zs\%<'.a:width.'c' - return map(split(a:text, pattern), 's:trim(v:val)') -endfunction - - -" Echo wrapped notes -function! s:echo_notes(notes) abort - if empty(a:notes) - return - endif - - echo ' Messages:' - for msg in a:notes - if msg =~# "\n" - let msg_lines = [] - for msgl in filter(split(msg, "\n"), 'v:val !~# ''^\s*$''') - call extend(msg_lines, s:textwrap(msgl, 74)) - endfor - else - let msg_lines = s:textwrap(msg, 74) - endif - - if !len(msg_lines) - continue - endif - echo ' *' msg_lines[0] - if len(msg_lines) > 1 - echo join(map(msg_lines[1:], '" ".v:val'), "\n") - endif - endfor -endfunction - - -" Load the remote plugin manifest file and check for unregistered plugins -function! s:diagnose_manifest() abort - echo 'Checking: Remote Plugins' - let existing_rplugins = {} - - for item in remote#host#PluginsForHost('python') - let existing_rplugins[item.path] = 'python' - endfor - - for item in remote#host#PluginsForHost('python3') - let existing_rplugins[item.path] = 'python3' - endfor - - let require_update = 0 - let notes = [] - - for path in map(split(&rtp, ','), 'resolve(v:val)') - let python_glob = glob(path.'/rplugin/python*', 1, 1) - if empty(python_glob) - continue - endif - - let python_dir = python_glob[0] - let python_version = fnamemodify(python_dir, ':t') - - for script in glob(python_dir.'/*.py', 1, 1) - \ + glob(python_dir.'/*/__init__.py', 1, 1) - let contents = join(readfile(script)) - if contents =~# '\<\%(from\|import\)\s\+neovim\>' - if script =~# '/__init__\.py$' - let script = fnamemodify(script, ':h') - endif - - if !has_key(existing_rplugins, script) - let msg = printf('"%s" is not registered.', fnamemodify(path, ':t')) - if python_version == 'pythonx' - if !has('python2') && !has('python3') - let msg .= ' (python2 and python3 not available)' - endif - elseif !has(python_version) - let msg .= printf(' (%s not available)', python_version) - else - let require_update = 1 - endif - - call add(notes, msg) - endif - - break - endif - endfor - endfor - - echo ' Status: ' - if require_update - echon 'Out of date' - call add(notes, 'Run :UpdateRemotePlugins') - else - echon 'Up to date' - endif - - call s:echo_notes(notes) -endfunction - - -function! s:diagnose_python(version) abort - let python_bin_name = 'python'.(a:version == 2 ? '' : '3') - let pyenv = resolve(exepath('pyenv')) - let pyenv_root = exists('$PYENV_ROOT') ? resolve($PYENV_ROOT) : '' - let venv = exists('$VIRTUAL_ENV') ? resolve($VIRTUAL_ENV) : '' - let host_prog_var = python_bin_name.'_host_prog' - let host_skip_var = python_bin_name.'_host_skip_check' - let python_bin = '' - let python_multiple = [] - let notes = [] - - if exists('g:'.host_prog_var) - call add(notes, printf('Using: g:%s = "%s"', host_prog_var, get(g:, host_prog_var))) - endif - - let [python_bin_name, pythonx_errs] = provider#pythonx#Detect(a:version) - if empty(python_bin_name) - call add(notes, 'Warning: No Python interpreter was found with the neovim ' - \ . 'module. Using the first available for diagnostics.') - if !empty(pythonx_errs) - call add(notes, pythonx_errs) - endif - let old_skip = get(g:, host_skip_var, 0) - let g:[host_skip_var] = 1 - let [python_bin_name, pythonx_errs] = provider#pythonx#Detect(a:version) - let g:[host_skip_var] = old_skip - endif - - if !empty(python_bin_name) - if exists('g:'.host_prog_var) - let python_bin = exepath(python_bin_name) - endif - let python_bin_name = fnamemodify(python_bin_name, ':t') - endif - - if !empty(pythonx_errs) - call add(notes, pythonx_errs) - endif - - if !empty(python_bin_name) && empty(python_bin) && empty(pythonx_errs) - if !exists('g:'.host_prog_var) - call add(notes, printf('Warning: "g:%s" is not set. Searching for ' - \ . '%s in the environment.', host_prog_var, python_bin_name)) - endif - - if !empty(pyenv) - if empty(pyenv_root) - call add(notes, 'Warning: pyenv was found, but $PYENV_ROOT ' - \ . 'is not set. Did you follow the final install ' - \ . 'instructions?') - else - call add(notes, printf('Notice: pyenv found: "%s"', pyenv)) - endif - - let python_bin = s:trim(system( - \ printf('"%s" which %s 2>/dev/null', pyenv, python_bin_name))) - - if empty(python_bin) - call add(notes, printf('Warning: pyenv couldn''t find %s.', python_bin_name)) - endif - endif - - if empty(python_bin) - let python_bin = exepath(python_bin_name) - - if exists('$PATH') - for path in split($PATH, ':') - let path_bin = path.'/'.python_bin_name - if path_bin != python_bin && index(python_multiple, path_bin) == -1 - \ && executable(path_bin) - call add(python_multiple, path_bin) - endif - endfor - - if len(python_multiple) - " This is worth noting since the user may install something - " that changes $PATH, like homebrew. - call add(notes, printf('Suggestion: There are multiple %s executables found. ' - \ . 'Set "g:%s" to avoid surprises.', python_bin_name, host_prog_var)) - endif - - if python_bin =~# '\' - call add(notes, printf('Warning: "%s" appears to be a pyenv shim. ' - \ . 'This could mean that a) the "pyenv" executable is not in ' - \ . '$PATH, b) your pyenv installation is broken. ' - \ . 'You should set "g:%s" to avoid surprises.', - \ python_bin, host_prog_var)) - endif - endif - endif - endif - - if !empty(python_bin) - if !empty(pyenv) && !exists('g:'.host_prog_var) && !empty(pyenv_root) - \ && resolve(python_bin) !~# '^'.pyenv_root.'/' - call add(notes, printf('Suggestion: Create a virtualenv specifically ' - \ . 'for Neovim using pyenv and use "g:%s". This will avoid ' - \ . 'the need to install Neovim''s Python client in each ' - \ . 'version/virtualenv.', host_prog_var)) - endif - - if !empty(venv) && exists('g:'.host_prog_var) - if !empty(pyenv_root) - let venv_root = pyenv_root - else - let venv_root = fnamemodify(venv, ':h') - endif - - if resolve(python_bin) !~# '^'.venv_root.'/' - call add(notes, printf('Suggestion: Create a virtualenv specifically ' - \ . 'for Neovim and use "g:%s". This will avoid ' - \ . 'the need to install Neovim''s Python client in each ' - \ . 'virtualenv.', host_prog_var)) - endif - endif - endif - - if empty(python_bin) && !empty(python_bin_name) - " An error message should have already printed. - call add(notes, printf('Error: "%s" was not found.', python_bin_name)) - elseif !empty(python_bin) && !s:check_bin(python_bin, notes) - let python_bin = '' - endif - - " Check if $VIRTUAL_ENV is active - let virtualenv_inactive = 0 - - if exists('$VIRTUAL_ENV') - if !empty(pyenv) - let pyenv_prefix = resolve(s:trim(system(printf('"%s" prefix', pyenv)))) - if $VIRTUAL_ENV != pyenv_prefix - let virtualenv_inactive = 1 - endif - elseif !empty(python_bin_name) && exepath(python_bin_name) !~# '^'.$VIRTUAL_ENV.'/' - let virtualenv_inactive = 1 - endif - endif - - if virtualenv_inactive - call add(notes, 'Warning: $VIRTUAL_ENV exists but appears to be ' - \ . 'inactive. This could lead to unexpected results. If you are ' - \ . 'using Zsh, see: http://vi.stackexchange.com/a/7654/5229') - endif - - " Diagnostic output - echo 'Checking: Python' a:version - echo ' Executable:' (empty(python_bin) ? 'Not found' : python_bin) - if len(python_multiple) - for path_bin in python_multiple - echo ' (other):' path_bin - endfor - endif - - if !empty(python_bin) - let [pyversion, current, latest, status] = s:version_info(python_bin) - if a:version != str2nr(pyversion) - call add(notes, 'Warning: Got an unexpected version of Python. ' - \ . 'This could lead to confusing error messages. Please ' - \ . 'consider this before reporting bugs to plugin developers.') - endif - if a:version == 3 && str2float(pyversion) < 3.3 - call add(notes, 'Warning: Python 3.3+ is recommended.') - endif - - echo ' Python Version:' pyversion - echo printf(' %s-neovim Version: %s', python_bin_name, current) - - if current == 'not found' - call add(notes, 'Error: Neovim Python client is not installed.') - endif - - if latest == 'unknown' - call add(notes, 'Warning: Unable to fetch latest Neovim Python client version.') - endif - - if status == 'outdated' - echon ' (latest: '.latest.')' - else - echon ' ('.status.')' - endif - endif - - call s:echo_notes(notes) -endfunction - - -function! s:diagnose_ruby() abort - echo 'Checking: Ruby' - let ruby_vers = systemlist('ruby -v')[0] - let ruby_prog = provider#ruby#Detect() - let notes = [] - - if empty(ruby_prog) - let ruby_prog = 'not found' - let prog_vers = 'not found' - call add(notes, 'Suggestion: Install the neovim RubyGem using ' . - \ '`gem install neovim`.') - else - silent let prog_vers = systemlist(ruby_prog . ' --version')[0] - - if v:shell_error - let prog_vers = 'outdated' - call add(notes, 'Suggestion: Install the latest neovim RubyGem using ' . - \ '`gem install neovim`.') - elseif s:version_cmp(prog_vers, "0.2.0") == -1 - let prog_vers .= ' (outdated)' - call add(notes, 'Suggestion: Install the latest neovim RubyGem using ' . - \ '`gem install neovim`.') - endif - endif - - echo ' Ruby Version: ' . ruby_vers - echo ' Host Executable: ' . ruby_prog - echo ' Host Version: ' . prog_vers - - call s:echo_notes(notes) -endfunction - - +" Dictionary where we keep all of the healtch check functions we've found. +" They will only be run if the value is true +let g:health_checkers = get(g:, 'health_checkers', {}) +let s:current_checker = get(s:, 'current_checker', '') + +"" +" Function to run the health checkers +" It manages the output and any file local settings function! health#check(bang) abort - redir => report - try - silent call s:diagnose_python(2) - silent echo '' - silent call s:diagnose_python(3) - silent echo '' - silent call s:diagnose_ruby() - silent echo '' - silent call s:diagnose_manifest() - silent echo '' - finally - redir END - endtry + let l:report = '# Checking health' + + if g:health_checkers == {} + call health#add_checker(s:_default_checkers()) + endif + + for l:checker in items(g:health_checkers) + " Disabled checkers will not run their registered check functions + if l:checker[1] + let s:current_checker = l:checker[0] + let l:report .= "\n\n--------------------------------------------------------------------------------\n" + let l:report .= printf("\n## Checker %s says:\n", s:current_checker) + + let l:report .= capture('call ' . l:checker[0] . '()') + endif + endfor + + let l:report .= "\n--------------------------------------------------------------------------------\n" if a:bang new setlocal bufhidden=wipe + set syntax=health + set filetype=health call setline(1, split(report, "\n")) setlocal nomodified else echo report echo "\nTip: Use " echohl Identifier - echon ":CheckHealth!" + echon ':CheckHealth!' echohl None - echon " to open this in a new buffer." + echon ' to open this in a new buffer.' endif endfunction + +" Report functions {{{ + +"" +" Start a report section. +" It should represent a general area of tests that can be understood +" from the argument {name} +" To start a new report section, use this function again +function! health#report_start(name) abort " {{{ + echo ' - Checking: ' . a:name +endfunction " }}} + +"" +" Format a message for a specific report item +function! s:format_report_message(status, msg, ...) abort " {{{ + let l:output = ' - ' . a:status . ': ' . a:msg + + " Check optional parameters + if a:0 > 0 + " Suggestions go in the first optional parameter can be a string or list + if type(a:1) == type("") + let l:output .= "\n - SUGGESTIONS:" + let l:output .= "\n - " . a:1 + elseif type(a:1) == type([]) + " Report each suggestion + let l:output .= "\n - SUGGESTIONS:" + for l:suggestion in a:1 + let l:output .= "\n - " . l:suggestion + endfor + else + echoerr "A string or list is required as the optional argument for suggestions" + endif + endif + + return output +endfunction " }}} + +"" +" Use {msg} to report information in the current section +function! health#report_info(msg) abort " {{{ + echo s:format_report_message('INFO', a:msg) +endfunction " }}} + +"" +" Use {msg} to represent the check that has passed +function! health#report_ok(msg) abort " {{{ + echo s:format_report_message('SUCCESS', a:msg) +endfunction " }}} + +"" +" Use {msg} to represent a failed health check and optionally a list of suggestions on how to fix it. +function! health#report_warn(msg, ...) abort " {{{ + if a:0 > 0 && type(a:1) == type([]) + echo s:format_report_message('WARNING', a:msg, a:1) + else + echo s:format_report_message('WARNING', a:msg) + endif +endfunction " }}} + +"" +" Use {msg} to represent a critically failed health check and optionally a list of suggestions on how to fix it. +function! health#report_error(msg, ...) abort " {{{ + if a:0 > 0 && type(a:1) == type([]) + echo s:format_report_message('ERROR', a:msg, a:1) + else + echo s:format_report_message('ERROR', a:msg) + endif +endfunction " }}} + +" }}} +" Health checker management {{{ + +"" +" Add a single health checker +" It does not modify any values if the checker already exists +function! s:add_single_checker(checker_name) abort " {{{ + if has_key(g:health_checkers, a:checker_name) + return + else + let g:health_checkers[a:checker_name] = v:true + endif +endfunction " }}} + +"" +" Enable a single health checker +" It will modify the values if the checker already exists +function! s:enable_single_checker(checker_name) abort " {{{ + let g:health_checkers[a:checker_name] = v:true +endfunction " }}} + +"" +" Disable a single health checker +" It will modify the values if the checker already exists +function! s:disable_single_checker(checker_name) abort " {{{ + let g:health_checkers[a:checker_name] = v:false +endfunction " }}} + + +"" +" Add at least one health checker +" {checker_name} can be specified by either a list of strings or a single string. +" It does not modify any values if the checker already exists +function! health#add_checker(checker_name) abort " {{{ + if type(a:checker_name) == type('') + call s:add_single_checker(a:checker_name) + elseif type(a:checker_name) == type([]) + for checker in a:checker_name + call s:add_single_checker(checker) + endfor + endif +endfunction " }}} + +"" +" Enable at least one health checker +" {checker_name} can be specified by either a list of strings or a single string. +function! health#enable_checker(checker_name) abort " {{{ + if type(a:checker_name) == type('') + call s:enable_single_checker(a:checker_name) + elseif type(a:checker_name) == type([]) + for checker in a:checker_name + call s:enable_single_checker(checker) + endfor + endif +endfunction " }}} + +"" +" Disable at least one health checker +" {checker_name} can be specified by either a list of strings or a single string. +function! health#disable_checker(checker_name) abort " {{{ + if type(a:checker_name) == type('') + call s:disable_single_checker(a:checker_name) + elseif type(a:checker_name) == type([]) + for checker in a:checker_name + call s:disable_single_checker(checker) + endfor + endif +endfunction " }}} + +function! s:change_file_name_to_health_checker(name) abort " {{{ + return substitute(substitute(substitute(a:name, ".*autoload/", "", ""), "\\.vim", "#check", ""), "/", "#", "g") +endfunction " }}} + +function! s:_default_checkers() abort " {{{ + " Get all of the files that are in autoload/health/ folders with a vim + " suffix + let checker_files = globpath(&runtimepath, 'autoload/health/*.vim', 1, 1) + let temp = checker_files[0] + + let checkers_to_source = [] + for file_name in checker_files + call add(checkers_to_source, s:change_file_name_to_health_checker(file_name)) + endfor + return checkers_to_source +endfunction " }}} +" }}} diff --git a/runtime/autoload/health/nvim.vim b/runtime/autoload/health/nvim.vim new file mode 100644 index 0000000000..e6092f1a86 --- /dev/null +++ b/runtime/autoload/health/nvim.vim @@ -0,0 +1,426 @@ +" Script variables +let s:bad_responses = [ + \ 'unable to parse python response', + \ 'unable to parse', + \ 'unable to get pypi response', + \ 'unable to get neovim executable', + \ 'unable to find neovim version' + \ ] + +"" +" Check if the string is a bad response +function! s:is_bad_response(s) abort + return index(s:bad_responses, a:s) >= 0 +endfunction + +function! s:trim(s) abort + return substitute(a:s, '^\_s*\|\_s*$', '', 'g') +endfunction + +" Simple version comparison. +function! s:version_cmp(a, b) abort + let a = split(a:a, '\.') + let b = split(a:b, '\.') + + for i in range(len(a)) + if a[i] > b[i] + return 1 + elseif a[i] < b[i] + return -1 + endif + endfor + + return 0 +endfunction + + +" Fetch the contents of a URL. +function! s:download(url) abort + let content = '' + if executable('curl') + let content = system(['curl', '-sL', "'", a:url, "'"]) + endif + + if empty(content) && executable('python') + let script = " + \try:\n + \ from urllib.request import urlopen\n + \except ImportError:\n + \ from urllib2 import urlopen\n + \\n + \try:\n + \ response = urlopen('".a:url."')\n + \ print(response.read().decode('utf8'))\n + \except Exception:\n + \ pass\n + \" + let content = system(['python', '-c', "'", script, "'", '2>/dev/null']) + endif + + return content +endfunction + + +" Get the latest Neovim Python client version from PyPI. The result is +" cached. +function! s:latest_pypi_version() abort + if exists('s:pypi_version') + return s:pypi_version + endif + + let s:pypi_version = 'unable to get pypi response' + let pypi_info = s:download('https://pypi.python.org/pypi/neovim/json') + if !empty(pypi_info) + let pypi_data = json_decode(pypi_info) + let s:pypi_version = get(get(pypi_data, 'info', {}), 'version', 'unable to parse') + return s:pypi_version + endif +endfunction + + +"" +" Get version information using the specified interpreter. The interpreter is +" used directly in case breaking changes were introduced since the last time +" Neovim's Python client was updated. +" +" Returns [ +" python executable version, +" current nvim version, +" current pypi nvim status, +" installed version status +" ] +function! s:version_info(python) abort + let pypi_version = s:latest_pypi_version() + let python_version = s:trim(system([ + \ a:python, + \ '-c', + \ 'import sys; print(".".join(str(x) for x in sys.version_info[:3]))', + \ ])) + + if empty(python_version) + let python_version = 'unable to parse python response' + endif + + let nvim_path = s:trim(system([ + \ a:python, + \ '-c', + \ 'import neovim; print(neovim.__file__)', + \ '2>/dev/null'])) + + let nvim_path = s:trim(system([ + \ 'python3', + \ '-c', + \ 'import neovim; print(neovim.__file__)' + \ ])) + " \ '2>/dev/null'])) + + if empty(nvim_path) + return [python_version, 'unable to find neovim executable', pypi_version, 'unable to get neovim executable'] + endif + + let nvim_version = 'unable to find neovim version' + let base = fnamemodify(nvim_path, ':h') + for meta in glob(base.'-*/METADATA', 1, 1) + glob(base.'-*/PKG-INFO', 1, 1) + for meta_line in readfile(meta) + if meta_line =~# '^Version:' + let nvim_version = matchstr(meta_line, '^Version: \zs\S\+') + endif + endfor + endfor + + let version_status = 'unknown' + if !s:is_bad_response(nvim_version) && !s:is_bad_response(pypi_version) + if s:version_cmp(nvim_version, pypi_version) == -1 + let version_status = 'outdated' + else + let version_status = 'up to date' + endif + endif + + return [python_version, nvim_version, pypi_version, version_status] +endfunction + + +" Check the Python interpreter's usability. +function! s:check_bin(bin) abort + if !filereadable(a:bin) + call health#report_error(printf('"%s" was not found.', a:bin)) + return 0 + elseif executable(a:bin) != 1 + call health#report_error(printf('"%s" is not executable.', a:bin)) + return 0 + endif + return 1 +endfunction + + + + +" Load the remote plugin manifest file and check for unregistered plugins +function! s:check_manifest() abort + call health#report_start('Remote Plugins') + let existing_rplugins = {} + + for item in remote#host#PluginsForHost('python') + let existing_rplugins[item.path] = 'python' + endfor + + for item in remote#host#PluginsForHost('python3') + let existing_rplugins[item.path] = 'python3' + endfor + + let require_update = 0 + + for path in map(split(&runtimepath, ','), 'resolve(v:val)') + let python_glob = glob(path.'/rplugin/python*', 1, 1) + if empty(python_glob) + continue + endif + + let python_dir = python_glob[0] + let python_version = fnamemodify(python_dir, ':t') + + for script in glob(python_dir.'/*.py', 1, 1) + \ + glob(python_dir.'/*/__init__.py', 1, 1) + let contents = join(readfile(script)) + if contents =~# '\<\%(from\|import\)\s\+neovim\>' + if script =~# '/__init__\.py$' + let script = fnamemodify(script, ':h') + endif + + if !has_key(existing_rplugins, script) + let msg = printf('"%s" is not registered.', fnamemodify(path, ':t')) + if python_version ==# 'pythonx' + if !has('python2') && !has('python3') + let msg .= ' (python2 and python3 not available)' + endif + elseif !has(python_version) + let msg .= printf(' (%s not available)', python_version) + else + let require_update = 1 + endif + + call health#report_warn(msg) + endif + + break + endif + endfor + endfor + + if require_update + call health#report_warn('Out of date', ['Run `:UpdateRemotePlugins`']) + else + call health#report_ok('Up to date') + endif +endfunction + + +function! s:check_python(version) abort + let python_bin_name = 'python'.(a:version == 2 ? '2' : '3') + let pyenv = resolve(exepath('pyenv')) + let pyenv_root = exists('$PYENV_ROOT') ? resolve($PYENV_ROOT) : 'n' + let venv = exists('$VIRTUAL_ENV') ? resolve($VIRTUAL_ENV) : '' + let host_prog_var = python_bin_name.'_host_prog' + let host_skip_var = python_bin_name.'_host_skip_check' + let python_bin = '' + let python_multiple = [] + + call health#report_start('Python ' . a:version . ' Configuration') + + if exists('g:'.host_prog_var) + call health#report_info(printf('Using: g:%s = "%s"', host_prog_var, get(g:, host_prog_var))) + endif + + let [python_bin_name, pythonx_errs] = provider#pythonx#Detect(a:version) + if empty(python_bin_name) + call health#report_warn('No Python interpreter was found with the neovim ' + \ . 'module. Using the first available for diagnostics.') + + " TODO: Not sure what to do about these errors, or if this is the right + " type. + if !empty(pythonx_errs) + call health#report_warn(pythonx_errs) + endif + let old_skip = get(g:, host_skip_var, 0) + let g:[host_skip_var] = 1 + let [python_bin_name, pythonx_errs] = provider#pythonx#Detect(a:version) + let g:[host_skip_var] = old_skip + endif + + if !empty(python_bin_name) + if exists('g:'.host_prog_var) + let python_bin = exepath(python_bin_name) + endif + let python_bin_name = fnamemodify(python_bin_name, ':t') + endif + + if !empty(pythonx_errs) + call health#report_error('Provier python has reported errors:', pythonx_errs) + endif + + if !empty(python_bin_name) && empty(python_bin) && empty(pythonx_errs) + if !exists('g:'.host_prog_var) + call health#report_warn(printf('"g:%s" is not set. Searching for ' + \ . '%s in the environment.', host_prog_var, python_bin_name)) + endif + + if !empty(pyenv) + if empty(pyenv_root) + call health#report_warn( + \ 'pyenv was found, but $PYENV_ROOT is not set.', + \ ['Did you follow the final install instructions?'] + \ ) + else + call health#report_ok(printf('pyenv found: "%s"', pyenv)) + endif + + let python_bin = s:trim(system( + \ printf('"%s" which %s 2>/dev/null', pyenv, python_bin_name))) + + if empty(python_bin) + call health#report_warn(printf('pyenv couldn''t find %s.', python_bin_name)) + endif + endif + + if empty(python_bin) + let python_bin = exepath(python_bin_name) + + if exists('$PATH') + for path in split($PATH, ':') + let path_bin = path.'/'.python_bin_name + if path_bin != python_bin && index(python_multiple, path_bin) == -1 + \ && executable(path_bin) + call add(python_multiple, path_bin) + endif + endfor + + if len(python_multiple) + " This is worth noting since the user may install something + " that changes $PATH, like homebrew. + call health#report_info(printf('There are multiple %s executables found. ' + \ . 'Set "g:%s" to avoid surprises.', python_bin_name, host_prog_var)) + endif + + if python_bin =~# '\' + call health#report_warn(printf('"%s" appears to be a pyenv shim.', python_bin), [ + \ 'The "pyenv" executable is not in $PATH,', + \ 'Your pyenv installation is broken. You should set ' + \ . '"g:'.host_prog_var.'" to avoid surprises.', + \ ]) + endif + endif + endif + endif + + if !empty(python_bin) + if empty(venv) && !empty(pyenv) && !exists('g:'.host_prog_var) + \ && !empty(pyenv_root) && resolve(python_bin) !~# '^'.pyenv_root.'/' + call health#report_warn('pyenv is not set up optimally.', [ + \ printf('Suggestion: Create a virtualenv specifically ' + \ . 'for Neovim using pyenv and use "g:%s". This will avoid ' + \ . 'the need to install Neovim''s Python client in each ' + \ . 'version/virtualenv.', host_prog_var) + \ ]) + elseif !empty(venv) && exists('g:'.host_prog_var) + if !empty(pyenv_root) + let venv_root = pyenv_root + else + let venv_root = fnamemodify(venv, ':h') + endif + + if resolve(python_bin) !~# '^'.venv_root.'/' + call health#report_warn('Your virtualenv is not set up optimally.', [ + \ printf('Suggestion: Create a virtualenv specifically ' + \ . 'for Neovim and use "g:%s". This will avoid ' + \ . 'the need to install Neovim''s Python client in each ' + \ . 'virtualenv.', host_prog_var) + \ ]) + endif + endif + endif + + if empty(python_bin) && !empty(python_bin_name) + " An error message should have already printed. + call health#report_error(printf('"%s" was not found.', python_bin_name)) + elseif !empty(python_bin) && !s:check_bin(python_bin) + let python_bin = '' + endif + + " Check if $VIRTUAL_ENV is active + let virtualenv_inactive = 0 + + if exists('$VIRTUAL_ENV') + if !empty(pyenv) + let pyenv_prefix = resolve(s:trim(system([pyenv, 'prefix']))) + if $VIRTUAL_ENV != pyenv_prefix + let virtualenv_inactive = 1 + endif + elseif !empty(python_bin_name) && exepath(python_bin_name) !~# '^'.$VIRTUAL_ENV.'/' + let virtualenv_inactive = 1 + endif + endif + + if virtualenv_inactive + let suggestions = [ + \ 'If you are using Zsh, see: http://vi.stackexchange.com/a/7654/5229', + \ ] + call health#report_warn( + \ '$VIRTUAL_ENV exists but appears to be inactive. ' + \ . 'This could lead to unexpected results.', + \ suggestions) + endif + + " Diagnostic output + call health#report_info('Executable:' . (empty(python_bin) ? 'Not found' : python_bin)) + if len(python_multiple) + for path_bin in python_multiple + call health#report_info('Other python executable: ' . path_bin) + endfor + endif + + if !empty(python_bin) + let [pyversion, current, latest, status] = s:version_info(python_bin) + if a:version != str2nr(pyversion) + call health#report_warn('Got an unexpected version of Python.' . + \ ' This could lead to confusing error messages.') + endif + if a:version == 3 && str2float(pyversion) < 3.3 + call health#report_warn('Python 3.3+ is recommended.') + endif + + call health#report_info('Python Version: ' . pyversion) + call health#report_info(printf('%s-neovim Version: %s', python_bin_name, current)) + + if s:is_bad_response(current) + let suggestions = [ + \ 'Error found was: ' . current, + \ 'Use the command `$ pip' . a:version . ' install neovim`', + \ ] + call health#report_error( + \ 'Neovim Python client is not installed.', + \ suggestions) + endif + + if s:is_bad_response(latest) + call health#report_warn('Unable to fetch latest Neovim Python client version.') + endif + + if s:is_bad_response(status) + call health#report_warn('Latest Neovim Python client versions: ('.latest.')') + else + call health#report_ok('Latest Neovim Python client is installed: ('.status.')') + endif + endif + +endfunction + + +function! health#nvim#check() abort + silent call s:check_python(2) + silent echo '' + silent call s:check_python(3) + silent echo '' + silent call s:check_manifest() + silent echo '' +endfunction diff --git a/runtime/doc/pi_health.txt b/runtime/doc/pi_health.txt new file mode 100644 index 0000000000..d61c42bc06 --- /dev/null +++ b/runtime/doc/pi_health.txt @@ -0,0 +1,146 @@ +*pi_health.txt* Check the status of your Neovim system + +Author: TJ DeVries + +============================================================================== +1. Contents *health.vim-contents* + + 1. Contents : |health.vim-contents| + 2. Health.vim introduction : |health.vim-intro| + 3. Health.vim manual : |health.vim-manual| + 3.1 Health.vim commands : |health.vim-commands| + 4. Making a new checker : |health.vim-checkers| + +============================================================================== +2. Health.vim introduction *health.vim-intro* + +Debugging common issues is a time consuming task that many developers would +like to eliminate, and where elimination is impossible, minimize. Many common +questions and difficulties could be answered by a simple check of an +environment variable or a setting that the user has made. However, even with +FAQs and other manuals, it can be difficult to suggest the path a user should +take without knowing some information about their system. + +Health.vim aims to solve this problem in two ways for both core and plugin +maintainers. + +The way this is done is to provide an interface that users will know to check +first before posting question in the issue tracker, dev channels, etc. This +is similar to how |:help| functions currently. The user experiencing +difficulty can run |:CheckHealth| to view the status of one's system. + +The aim of |:CheckHealth| is two-fold. + +The first aim is to provide maintainers with an overview of the user's working +environment. This skips large amounts of time where the maintainer must +instruct the user on which steps to take to get debug information, and allows +the maintainer to extend existing health scripts as more helpful debug +information is found. + +The second aim is to provide maintainers a way of automating the answering of +frequently encountered question. A common occurrence with Neovim is that the +user has not installed the necessary Python modules to interact with Python +remote plugins. A simple check of whether the Neovim remote plugin is +installed can lead to a suggestion of > + + You have not installed the Neovim Python module + You might want to try `$ pip install Neovim` + +< +With these possibilities, it allows the maintainer of a plugin to spend more +time on active development, rather than trying to spend time on debugging +common issues many times. + +============================================================================== +3. Health.vim manual *health.vim-manual* + +3.1 Commands +------------ + +:CheckHealth[!] *:CheckHealth* + Run all health checkers found in g:health_checkers + + It will check your setup for common problems that may be keeping a + plugin from functioning correctly. Include the output of this command + in bug reports to help reduce the amount of time it takes to address + your issue. With "!" the output will be placed in a new buffer which + can make it easier to save to a file or copy to the clipboard. + + +3.2 Functions *health.functions* +------------- + +3.2.1 Report Functions *health.report_functions* +---------------------- + +The |health.report_functions| are used by the plugin maintainer to remove the +hassle of formatting multiple different levels of output. Not only does it +remove the hassle of formatting, but it also provides users with a consistent +interface for viewing the health information about the system. + +These functions are also expected to have the capability to produce output in +multiple different formats. For example, if parsing of the results were to be +done by a remote plugin, the results could be output in a valid JSON format +and then the remote plugin could parse the results easily. + +health#report_start({name}) *health.funcs.report_start* + Start a report section. It should represent a general area of tests + that can be understood from the argument {name} To start a new report + section, use this function again + +health#report_info({msg}) *health.funcs.report_info* + Use {msg} to report information in the current section + +health#report_ok({msg}) *health.funcs.report_ok* + Use {msg} to represent the check that has passed + +health#report_warn({msg}, ...) *health.funcs.report_warn* + Use {msg} to represent a failed health check and optionally a list of + suggestions on how to fix it. + +health#report_error({msg}, ...) *health.funcs.report_error* + Use {msg} to represent a critically failed health check and optionally + a list of suggestions on how to fix it. + +3.3 User Functions *health.user_functions* +------------------ + +health#{my_plug}#check() *health.user_checker* + A user defined function to run all of the checks that are required for + either debugging or suggestion making. An example might be something + like: > + + function! health#my_plug#check() abort + silent call s:check_environment_vars() + silent call s:check_python_configuration() + endfunction +< + This function will be found, sourced, and automatically called when + the user invokes |:CheckHealth|. + + All output will be captured from the health checker. It is recommended + that the plugin maintainer uses the calls described in + |health.report_functions|. The benefits these functions provide are + described in the same section. + + +============================================================================== +4. Making a new checker *health.vim-checkers* + +Health checkers are the scripts that check the health of the system. Neovim +has built in checkers, which can be found in `runtime/autoload/health/`. To +add a checker for a plugin, add a `health` folder in the `autoload` directory +of your plugin. It is then suggested that the name of your script be +`{plug_name}.vim`. For example, the health checker for `my_plug` might be +placed in: > + + $PLUGIN_BASE/autoload/health/my_plug.vim +> + +Inside this script, a function must be specified to run. This function is +described in |health.user_checker|. + + +============================================================================== + +vim:tw=78:ts=8:ft=help:fdm=marker diff --git a/runtime/doc/provider.txt b/runtime/doc/provider.txt index 7380fb9346..63dbb00896 100644 --- a/runtime/doc/provider.txt +++ b/runtime/doc/provider.txt @@ -79,14 +79,6 @@ TROUBLESHOOTING *python-trouble* If you have trouble with a plugin that uses the `neovim` Python client, use the |:CheckHealth| command to diagnose your setup. - *:CheckHealth* -:CheckHealth[!] Check your setup for common problems that may be keeping a - plugin from functioning correctly. Include the output of - this command in bug reports to help reduce the amount of - time it takes to address your issue. With "!" the output - will be placed in a new buffer which can make it easier to - save to a file or copy to the clipboard. - ============================================================================== Ruby integration *provider-ruby* diff --git a/runtime/plugin/health.vim b/runtime/plugin/health.vim index db094a03a4..04345781a6 100644 --- a/runtime/plugin/health.vim +++ b/runtime/plugin/health.vim @@ -1 +1,3 @@ + +" call health#add_checker('health#nvim#check') command! -bang CheckHealth call health#check(0) diff --git a/runtime/syntax/health.vim b/runtime/syntax/health.vim new file mode 100644 index 0000000000..1e8e522b4d --- /dev/null +++ b/runtime/syntax/health.vim @@ -0,0 +1,20 @@ +if exists("b:current_syntax") + finish +endif + +syntax keyword healthError ERROR +highlight link healthError Error + +syntax keyword healthWarning WARNING +highlight link healthWarning Todo + +syntax keyword healthInfo INFO +highlight link healthInfo Identifier + +syntax keyword healthSuccess SUCCESS +highlight link healthSuccess Function + +syntax keyword healthSuggestion SUGGESTION +highlight link healthSuggestion String + +let b:current_syntax = "health" diff --git a/test/functional/plugin/health_spec.lua b/test/functional/plugin/health_spec.lua new file mode 100644 index 0000000000..972cabd662 --- /dev/null +++ b/test/functional/plugin/health_spec.lua @@ -0,0 +1,58 @@ +local helpers = require('test.functional.helpers')(after_each) +local plugin_helpers = require('test.functional.plugin.helpers') + +describe('health.vim', function() + before_each(function() + plugin_helpers.reset() + end) + + it('should echo the results when using the basic functions', function() + helpers.execute("call health#report_start('Foo')") + local report = helpers.redir_exec([[call health#report_start('Check Bar')]]) + .. helpers.redir_exec([[call health#report_ok('Bar status')]]) + .. helpers.redir_exec([[call health#report_ok('Other Bar status')]]) + .. helpers.redir_exec([[call health#report_warn('Zub')]]) + .. helpers.redir_exec([[call health#report_start('Baz')]]) + .. helpers.redir_exec([[call health#report_warn('Zim', ['suggestion 1', 'suggestion 2'])]]) + + local expected_contents = { + 'Checking: Check Bar', + 'SUCCESS: Bar status', + 'WARNING: Zub', + 'SUGGESTIONS:', + '- suggestion 1', + '- suggestion 2' + } + + for _, content in ipairs(expected_contents) do + assert(string.find(report, content)) + end + end) + + + describe('CheckHealth', function() + -- Run the health check and store important results + -- Run it here because it may take awhile to complete, depending on the system + helpers.execute([[CheckHealth!]]) + local report = helpers.curbuf_contents() + local health_checkers = helpers.redir_exec("echo g:health_checkers") + + it('should find the default checker upon execution', function() + assert(string.find(health_checkers, "'health#nvim#check': v:true")) + end) + + it('should alert the user that health#nvim#check is running', function() + assert(string.find(report, '# Checking health')) + assert(string.find(report, 'Checker health#nvim#check says:')) + assert(string.find(report, 'Checking:')) + end) + end) + + it('should allow users to disable checkers', function() + helpers.execute("call health#disable_checker('health#nvim#check')") + helpers.execute("CheckHealth!") + local health_checkers = helpers.redir_exec("echo g:health_checkers") + + assert(string.find(health_checkers, "'health#nvim#check': v:false")) + end) +end) From 545e7a416310c9ff700b2afed9eef834c8948c8b Mon Sep 17 00:00:00 2001 From: "Justin M. Keyes" Date: Sun, 7 Aug 2016 14:16:30 -0400 Subject: [PATCH 2/5] CheckHealth - Overlay markdown syntax/filetype, don't invent new filetypes/syntaxes. - migrate s:check_ruby() - s:indent_after_line1 - Less-verbose output --- runtime/autoload/health.vim | 132 +++++++-------- runtime/autoload/health/nvim.vim | 67 +++++--- runtime/doc/pi_health.txt | 217 +++++++++++-------------- runtime/plugin/health.vim | 2 - runtime/syntax/health.vim | 20 --- test/functional/plugin/health_spec.lua | 17 +- 6 files changed, 212 insertions(+), 243 deletions(-) delete mode 100644 runtime/syntax/health.vim diff --git a/runtime/autoload/health.vim b/runtime/autoload/health.vim index edcb3d792d..a94688cbf9 100644 --- a/runtime/autoload/health.vim +++ b/runtime/autoload/health.vim @@ -1,15 +1,30 @@ -" Dictionary where we keep all of the healtch check functions we've found. +" Dictionary of all health check functions we have found. " They will only be run if the value is true let g:health_checkers = get(g:, 'health_checkers', {}) let s:current_checker = get(s:, 'current_checker', '') -"" -" Function to run the health checkers -" It manages the output and any file local settings -function! health#check(bang) abort - let l:report = '# Checking health' +function! s:enhance_syntax() abort + syntax keyword healthError ERROR + highlight link healthError Error - if g:health_checkers == {} + syntax keyword healthWarning WARNING + highlight link healthWarning WarningMsg + + syntax keyword healthInfo INFO + highlight link healthInfo ModeMsg + + syntax keyword healthSuccess SUCCESS + highlight link healthSuccess Function + + syntax keyword healthSuggestion SUGGESTION + highlight link healthSuggestion String +endfunction + +" Runs the health checkers. Manages the output and buffer-local settings. +function! health#check(bang) abort + let l:report = '' + + if empty(g:health_checkers) call health#add_checker(s:_default_checkers()) endif @@ -17,20 +32,18 @@ function! health#check(bang) abort " Disabled checkers will not run their registered check functions if l:checker[1] let s:current_checker = l:checker[0] - let l:report .= "\n\n--------------------------------------------------------------------------------\n" - let l:report .= printf("\n## Checker %s says:\n", s:current_checker) + let l:report .= printf("\n%s\n================================================================================", + \ s:current_checker) - let l:report .= capture('call ' . l:checker[0] . '()') + let l:report .= execute('call ' . l:checker[0] . '()') endif endfor - let l:report .= "\n--------------------------------------------------------------------------------\n" - if a:bang new setlocal bufhidden=wipe - set syntax=health - set filetype=health + set filetype=markdown + call s:enhance_syntax() call setline(1, split(report, "\n")) setlocal nomodified else @@ -43,80 +56,76 @@ function! health#check(bang) abort endif endfunction -" Report functions {{{ - -"" -" Start a report section. -" It should represent a general area of tests that can be understood -" from the argument {name} -" To start a new report section, use this function again +" Starts a new report. function! health#report_start(name) abort " {{{ - echo ' - Checking: ' . a:name + echo "\n## " . a:name endfunction " }}} -"" +" Indents lines *except* line 1 of a string if it contains newlines. +function! s:indent_after_line1(s, columns) abort + let lines = split(a:s, "\n", 0) + if len(lines) < 2 " We do not indent line 1, so nothing to do. + return a:s + endif + for i in range(1, len(lines)-1) " Indent lines after the first. + let lines[i] = substitute(lines[i], '^\s*', repeat(' ', a:columns), 'g') + endfor + return join(lines, "\n") +endfunction + " Format a message for a specific report item function! s:format_report_message(status, msg, ...) abort " {{{ - let l:output = ' - ' . a:status . ': ' . a:msg + let output = ' - ' . a:status . ': ' . s:indent_after_line1(a:msg, 4) + let suggestions = [] - " Check optional parameters + " Optional parameters if a:0 > 0 - " Suggestions go in the first optional parameter can be a string or list - if type(a:1) == type("") - let l:output .= "\n - SUGGESTIONS:" - let l:output .= "\n - " . a:1 - elseif type(a:1) == type([]) - " Report each suggestion - let l:output .= "\n - SUGGESTIONS:" - for l:suggestion in a:1 - let l:output .= "\n - " . l:suggestion - endfor - else - echoerr "A string or list is required as the optional argument for suggestions" + let suggestions = type(a:1) == type("") ? [a:1] : a:1 + if type(suggestions) != type([]) + echoerr "Expected String or List" endif endif + " Report each suggestion + if len(suggestions) > 0 + let output .= "\n - SUGGESTIONS:" + endif + for suggestion in suggestions + let output .= "\n - " . s:indent_after_line1(suggestion, 10) + endfor + return output endfunction " }}} -"" " Use {msg} to report information in the current section function! health#report_info(msg) abort " {{{ echo s:format_report_message('INFO', a:msg) endfunction " }}} -"" " Use {msg} to represent the check that has passed function! health#report_ok(msg) abort " {{{ echo s:format_report_message('SUCCESS', a:msg) endfunction " }}} -"" " Use {msg} to represent a failed health check and optionally a list of suggestions on how to fix it. function! health#report_warn(msg, ...) abort " {{{ - if a:0 > 0 && type(a:1) == type([]) + if a:0 > 0 echo s:format_report_message('WARNING', a:msg, a:1) else echo s:format_report_message('WARNING', a:msg) endif endfunction " }}} -"" " Use {msg} to represent a critically failed health check and optionally a list of suggestions on how to fix it. function! health#report_error(msg, ...) abort " {{{ - if a:0 > 0 && type(a:1) == type([]) + if a:0 > 0 echo s:format_report_message('ERROR', a:msg, a:1) else echo s:format_report_message('ERROR', a:msg) endif endfunction " }}} -" }}} -" Health checker management {{{ - -"" -" Add a single health checker -" It does not modify any values if the checker already exists +" Adds a health checker. Does nothing if the checker already exists. function! s:add_single_checker(checker_name) abort " {{{ if has_key(g:health_checkers, a:checker_name) return @@ -125,25 +134,19 @@ function! s:add_single_checker(checker_name) abort " {{{ endif endfunction " }}} -"" -" Enable a single health checker -" It will modify the values if the checker already exists +" Enables a health checker. function! s:enable_single_checker(checker_name) abort " {{{ let g:health_checkers[a:checker_name] = v:true endfunction " }}} -"" -" Disable a single health checker -" It will modify the values if the checker already exists +" Disables a health checker. function! s:disable_single_checker(checker_name) abort " {{{ let g:health_checkers[a:checker_name] = v:false endfunction " }}} -"" -" Add at least one health checker -" {checker_name} can be specified by either a list of strings or a single string. -" It does not modify any values if the checker already exists +" Adds a health checker. `checker_name` can be a list of strings or +" a single string. Does nothing if the checker already exists. function! health#add_checker(checker_name) abort " {{{ if type(a:checker_name) == type('') call s:add_single_checker(a:checker_name) @@ -154,9 +157,8 @@ function! health#add_checker(checker_name) abort " {{{ endif endfunction " }}} -"" -" Enable at least one health checker -" {checker_name} can be specified by either a list of strings or a single string. +" Enables a health checker. `checker_name` can be a list of strings or +" a single string. function! health#enable_checker(checker_name) abort " {{{ if type(a:checker_name) == type('') call s:enable_single_checker(a:checker_name) @@ -167,9 +169,8 @@ function! health#enable_checker(checker_name) abort " {{{ endif endfunction " }}} -"" -" Disable at least one health checker -" {checker_name} can be specified by either a list of strings or a single string. +" Disables a health checker. `checker_name` can be a list of strings or +" a single string. function! health#disable_checker(checker_name) abort " {{{ if type(a:checker_name) == type('') call s:disable_single_checker(a:checker_name) @@ -196,4 +197,3 @@ function! s:_default_checkers() abort " {{{ endfor return checkers_to_source endfunction " }}} -" }}} diff --git a/runtime/autoload/health/nvim.vim b/runtime/autoload/health/nvim.vim index e6092f1a86..7865634313 100644 --- a/runtime/autoload/health/nvim.vim +++ b/runtime/autoload/health/nvim.vim @@ -1,4 +1,3 @@ -" Script variables let s:bad_responses = [ \ 'unable to parse python response', \ 'unable to parse', @@ -7,8 +6,6 @@ let s:bad_responses = [ \ 'unable to find neovim version' \ ] -"" -" Check if the string is a bad response function! s:is_bad_response(s) abort return index(s:bad_responses, a:s) >= 0 endfunction @@ -33,7 +30,6 @@ function! s:version_cmp(a, b) abort return 0 endfunction - " Fetch the contents of a URL. function! s:download(url) abort let content = '' @@ -61,8 +57,7 @@ function! s:download(url) abort endfunction -" Get the latest Neovim Python client version from PyPI. The result is -" cached. +" Get the latest Neovim Python client version from PyPI. Result is cached. function! s:latest_pypi_version() abort if exists('s:pypi_version') return s:pypi_version @@ -77,8 +72,6 @@ function! s:latest_pypi_version() abort endif endfunction - -"" " Get version information using the specified interpreter. The interpreter is " used directly in case breaking changes were introduced since the last time " Neovim's Python client was updated. @@ -140,7 +133,6 @@ function! s:version_info(python) abort return [python_version, nvim_version, pypi_version, version_status] endfunction - " Check the Python interpreter's usability. function! s:check_bin(bin) abort if !filereadable(a:bin) @@ -153,9 +145,6 @@ function! s:check_bin(bin) abort return 1 endfunction - - - " Load the remote plugin manifest file and check for unregistered plugins function! s:check_manifest() abort call health#report_start('Remote Plugins') @@ -217,6 +206,8 @@ endfunction function! s:check_python(version) abort + call health#report_start('Python ' . a:version . ' provider') + let python_bin_name = 'python'.(a:version == 2 ? '2' : '3') let pyenv = resolve(exepath('pyenv')) let pyenv_root = exists('$PYENV_ROOT') ? resolve($PYENV_ROOT) : 'n' @@ -226,8 +217,6 @@ function! s:check_python(version) abort let python_bin = '' let python_multiple = [] - call health#report_start('Python ' . a:version . ' Configuration') - if exists('g:'.host_prog_var) call health#report_info(printf('Using: g:%s = "%s"', host_prog_var, get(g:, host_prog_var))) endif @@ -236,9 +225,6 @@ function! s:check_python(version) abort if empty(python_bin_name) call health#report_warn('No Python interpreter was found with the neovim ' \ . 'module. Using the first available for diagnostics.') - - " TODO: Not sure what to do about these errors, or if this is the right - " type. if !empty(pythonx_errs) call health#report_warn(pythonx_errs) endif @@ -256,12 +242,12 @@ function! s:check_python(version) abort endif if !empty(pythonx_errs) - call health#report_error('Provier python has reported errors:', pythonx_errs) + call health#report_error('Python provider error', pythonx_errs) endif if !empty(python_bin_name) && empty(python_bin) && empty(pythonx_errs) if !exists('g:'.host_prog_var) - call health#report_warn(printf('"g:%s" is not set. Searching for ' + call health#report_info(printf('`g:%s` is not set. Searching for ' \ . '%s in the environment.', host_prog_var, python_bin_name)) endif @@ -372,7 +358,7 @@ function! s:check_python(version) abort endif " Diagnostic output - call health#report_info('Executable:' . (empty(python_bin) ? 'Not found' : python_bin)) + call health#report_info('Executable: ' . (empty(python_bin) ? 'Not found' : python_bin)) if len(python_multiple) for path_bin in python_multiple call health#report_info('Other python executable: ' . path_bin) @@ -389,7 +375,7 @@ function! s:check_python(version) abort call health#report_warn('Python 3.3+ is recommended.') endif - call health#report_info('Python Version: ' . pyversion) + call health#report_info('Python'.a:version.' version: ' . pyversion) call health#report_info(printf('%s-neovim Version: %s', python_bin_name, current)) if s:is_bad_response(current) @@ -415,12 +401,39 @@ function! s:check_python(version) abort endfunction +function! s:check_ruby() abort + call health#report_start('Ruby provider') + let min_version = "0.2.4" + let ruby_version = systemlist('ruby -v')[0] + let ruby_prog = provider#ruby#Detect() + let suggestions = + \ ['Install or upgrade the neovim RubyGem using `gem install neovim`.'] + + if empty(ruby_prog) + let ruby_prog = 'not found' + let prog_vers = 'not found' + call health#report_error('Missing Neovim RubyGem', suggestions) + else + silent let prog_vers = systemlist(ruby_prog . ' --version')[0] + if v:shell_error + let prog_vers = 'outdated' + call health#report_warn('Neovim RubyGem is not up-to-date', suggestions) + elseif s:version_cmp(prog_vers, min_version) == -1 + let prog_vers .= ' (outdated)' + call health#report_warn('Neovim RubyGem is not up-to-date', suggestions) + else + call health#report_ok('Found Neovim RubyGem') + endif + endif + + call health#report_info('Ruby Version: ' . ruby_version) + call health#report_info('Host Executable: ' . ruby_prog) + call health#report_info('Host Version: ' . prog_vers) +endfunction function! health#nvim#check() abort - silent call s:check_python(2) - silent echo '' - silent call s:check_python(3) - silent echo '' - silent call s:check_manifest() - silent echo '' + call s:check_manifest() + call s:check_python(2) + call s:check_python(3) + call s:check_ruby() endfunction diff --git a/runtime/doc/pi_health.txt b/runtime/doc/pi_health.txt index d61c42bc06..69833103d1 100644 --- a/runtime/doc/pi_health.txt +++ b/runtime/doc/pi_health.txt @@ -1,146 +1,127 @@ -*pi_health.txt* Check the status of your Neovim system +*pi_health.txt* Healthcheck framework Author: TJ DeVries ============================================================================== -1. Contents *health.vim-contents* - - 1. Contents : |health.vim-contents| - 2. Health.vim introduction : |health.vim-intro| - 3. Health.vim manual : |health.vim-manual| - 3.1 Health.vim commands : |health.vim-commands| - 4. Making a new checker : |health.vim-checkers| +1. Introduction |health.vim-intro| +2. Commands and functions |health.vim-manual| +3. Create a healthcheck |health.vim-dev| ============================================================================== -2. Health.vim introduction *health.vim-intro* +Introduction *healthcheck* *health.vim-intro* -Debugging common issues is a time consuming task that many developers would -like to eliminate, and where elimination is impossible, minimize. Many common -questions and difficulties could be answered by a simple check of an -environment variable or a setting that the user has made. However, even with -FAQs and other manuals, it can be difficult to suggest the path a user should -take without knowing some information about their system. +Troubleshooting user configuration problems is a time-consuming task that +developers want to minimize. health.vim provides a simple framework for plugin +authors to hook into, and for users to invoke, to check and report the user's +configuration and environment. Type this command to try it: > -Health.vim aims to solve this problem in two ways for both core and plugin -maintainers. - -The way this is done is to provide an interface that users will know to check -first before posting question in the issue tracker, dev channels, etc. This -is similar to how |:help| functions currently. The user experiencing -difficulty can run |:CheckHealth| to view the status of one's system. - -The aim of |:CheckHealth| is two-fold. - -The first aim is to provide maintainers with an overview of the user's working -environment. This skips large amounts of time where the maintainer must -instruct the user on which steps to take to get debug information, and allows -the maintainer to extend existing health scripts as more helpful debug -information is found. - -The second aim is to provide maintainers a way of automating the answering of -frequently encountered question. A common occurrence with Neovim is that the -user has not installed the necessary Python modules to interact with Python -remote plugins. A simple check of whether the Neovim remote plugin is -installed can lead to a suggestion of > + :CheckHealth +< +For example, some users have broken or unusual Python setups, which breaks the +|:python| command. |:CheckHealth| detects several common Python configuration +problems and reports them. If the Neovim Python module is not installed, it +shows a warning: > You have not installed the Neovim Python module - You might want to try `$ pip install Neovim` - + You might want to try `pip install Neovim` < -With these possibilities, it allows the maintainer of a plugin to spend more -time on active development, rather than trying to spend time on debugging -common issues many times. +Plugin authors are encouraged to add healthchecks, see |health.vim-dev|. ============================================================================== -3. Health.vim manual *health.vim-manual* +Commands and functions *health.vim-manual* -3.1 Commands ------------- +Commands +------------------------------------------------------------------------------ + *:CheckHealth* +:CheckHealth Run all healthchecks and show the output in a new + tabpage. These healthchecks are included by default: + - python2 + - python3 + - ruby + - remote plugin -:CheckHealth[!] *:CheckHealth* - Run all health checkers found in g:health_checkers - - It will check your setup for common problems that may be keeping a - plugin from functioning correctly. Include the output of this command - in bug reports to help reduce the amount of time it takes to address - your issue. With "!" the output will be placed in a new buffer which - can make it easier to save to a file or copy to the clipboard. - - -3.2 Functions *health.functions* -------------- - -3.2.1 Report Functions *health.report_functions* ----------------------- - -The |health.report_functions| are used by the plugin maintainer to remove the -hassle of formatting multiple different levels of output. Not only does it -remove the hassle of formatting, but it also provides users with a consistent -interface for viewing the health information about the system. - -These functions are also expected to have the capability to produce output in -multiple different formats. For example, if parsing of the results were to be -done by a remote plugin, the results could be output in a valid JSON format -and then the remote plugin could parse the results easily. - -health#report_start({name}) *health.funcs.report_start* - Start a report section. It should represent a general area of tests - that can be understood from the argument {name} To start a new report - section, use this function again - -health#report_info({msg}) *health.funcs.report_info* - Use {msg} to report information in the current section - -health#report_ok({msg}) *health.funcs.report_ok* - Use {msg} to represent the check that has passed - -health#report_warn({msg}, ...) *health.funcs.report_warn* - Use {msg} to represent a failed health check and optionally a list of - suggestions on how to fix it. - -health#report_error({msg}, ...) *health.funcs.report_error* - Use {msg} to represent a critically failed health check and optionally - a list of suggestions on how to fix it. - -3.3 User Functions *health.user_functions* ------------------- - -health#{my_plug}#check() *health.user_checker* - A user defined function to run all of the checks that are required for - either debugging or suggestion making. An example might be something - like: > - - function! health#my_plug#check() abort - silent call s:check_environment_vars() - silent call s:check_python_configuration() - endfunction +:CheckHealth {plugins} + Run healthchecks for one or more plugins. E.g. to run + only the standard Nvim healthcheck: > + :CheckHealth nvim +< To run the healthchecks for the "foo" and "bar" plugins + (assuming these plugins are on your 'runtimepath' and + they have implemented health#foo#check() and + health#bar#check(), respectively): > + :CheckHealth foo bar < - This function will be found, sourced, and automatically called when - the user invokes |:CheckHealth|. +Functions +------------------------------------------------------------------------------ - All output will be captured from the health checker. It is recommended - that the plugin maintainer uses the calls described in - |health.report_functions|. The benefits these functions provide are - described in the same section. +health.vim functions are for creating new healthchecks. They mostly just do +some layout and formatting, to give users a consistent presentation. +health#report_start({name}) *health#report_start* + Starts a new report. Most plugins should call this only once, but if + you want different sections to appear in your report, call this once + per section. + +health#report_info({msg}) *health#report_info* + Displays an informational message. + +health#report_ok({msg}) *health#report_ok* + Displays a "success" message. + +health#report_warn({msg}, [{suggestions}]) *health#report_warn* + Displays a warning. {suggestions} is an optional List of suggestions. + +health#report_error({msg}, [{suggestions}]) *health#report_error* + Displays an error. {suggestions} is an optional List of suggestions. + +health#{plugin}#check() *health.user_checker* + This is the form of a healthcheck definition. Call the above functions + from this function, then |:CheckHealth| does the rest. Example: > + + function! health#my_plug#check() abort + silent call s:check_environment_vars() + silent call s:check_python_configuration() + endfunction +< + The function will be found and called automatically when the user + invokes |:CheckHealth|. + + All output will be captured from the healthcheck. Use the + health#report_* functions so that your healthcheck has a format + consistent with the standard healthchecks. ============================================================================== -4. Making a new checker *health.vim-checkers* +Create a healthcheck *health.vim-dev* -Health checkers are the scripts that check the health of the system. Neovim -has built in checkers, which can be found in `runtime/autoload/health/`. To -add a checker for a plugin, add a `health` folder in the `autoload` directory -of your plugin. It is then suggested that the name of your script be -`{plug_name}.vim`. For example, the health checker for `my_plug` might be -placed in: > +Healthchecks are functions that check the health of the system. Neovim has +built-in checkers, found in $VIMRUNTIME/autoload/health/. - $PLUGIN_BASE/autoload/health/my_plug.vim -> +To add a new checker for your own plugin, simply define a +health#{plugin}#check() function in autoload/health/{plugin}.vim. +|:CheckHealth| automatically finds and invokes such functions. -Inside this script, a function must be specified to run. This function is -described in |health.user_checker|. +If your plugin is named "jslint", then its healthcheck function must be > + health#jslint#check() +< +defined in this file on 'runtimepath': > + autoload/health/jslint.vim +< +Here's a sample to get started: > + + function! health#jslint#check() abort + call health#report_start('sanity checks') + " perform arbitrary checks + " ... + + if looks_good + call health#report_ok('found required dependencies') + else + call health#report_error('cannot find jslint', + \ ['npm install --save jslint']) + endif + endfunction +< ============================================================================== vim:tw=78:ts=8:ft=help:fdm=marker diff --git a/runtime/plugin/health.vim b/runtime/plugin/health.vim index 04345781a6..db094a03a4 100644 --- a/runtime/plugin/health.vim +++ b/runtime/plugin/health.vim @@ -1,3 +1 @@ - -" call health#add_checker('health#nvim#check') command! -bang CheckHealth call health#check(0) diff --git a/runtime/syntax/health.vim b/runtime/syntax/health.vim deleted file mode 100644 index 1e8e522b4d..0000000000 --- a/runtime/syntax/health.vim +++ /dev/null @@ -1,20 +0,0 @@ -if exists("b:current_syntax") - finish -endif - -syntax keyword healthError ERROR -highlight link healthError Error - -syntax keyword healthWarning WARNING -highlight link healthWarning Todo - -syntax keyword healthInfo INFO -highlight link healthInfo Identifier - -syntax keyword healthSuccess SUCCESS -highlight link healthSuccess Function - -syntax keyword healthSuggestion SUGGESTION -highlight link healthSuggestion String - -let b:current_syntax = "health" diff --git a/test/functional/plugin/health_spec.lua b/test/functional/plugin/health_spec.lua index 972cabd662..50fbfd58ee 100644 --- a/test/functional/plugin/health_spec.lua +++ b/test/functional/plugin/health_spec.lua @@ -6,7 +6,7 @@ describe('health.vim', function() plugin_helpers.reset() end) - it('should echo the results when using the basic functions', function() + it('reports results', function() helpers.execute("call health#report_start('Foo')") local report = helpers.redir_exec([[call health#report_start('Check Bar')]]) .. helpers.redir_exec([[call health#report_ok('Bar status')]]) @@ -30,25 +30,22 @@ describe('health.vim', function() end) - describe('CheckHealth', function() - -- Run the health check and store important results - -- Run it here because it may take awhile to complete, depending on the system + describe(':CheckHealth', function() + -- Run it here because it may be slow, depending on the system. helpers.execute([[CheckHealth!]]) local report = helpers.curbuf_contents() local health_checkers = helpers.redir_exec("echo g:health_checkers") - it('should find the default checker upon execution', function() + it('finds the default checker', function() assert(string.find(health_checkers, "'health#nvim#check': v:true")) end) - it('should alert the user that health#nvim#check is running', function() - assert(string.find(report, '# Checking health')) - assert(string.find(report, 'Checker health#nvim#check says:')) - assert(string.find(report, 'Checking:')) + it('prints a header with the name of the checker', function() + assert(string.find(report, 'health#nvim#check')) end) end) - it('should allow users to disable checkers', function() + it('allows users to disable checkers', function() helpers.execute("call health#disable_checker('health#nvim#check')") helpers.execute("CheckHealth!") local health_checkers = helpers.redir_exec("echo g:health_checkers") From ed49d9d866f8260842ea177fa9ce31dbc398701d Mon Sep 17 00:00:00 2001 From: "Justin M. Keyes" Date: Sat, 20 Aug 2016 19:37:18 -0400 Subject: [PATCH 3/5] CheckHealth: Accept [plugin1 [, plugin2 [, ...]]] args. To healthcheck the "foo" plugin: :CheckHealth foo To healthcheck the "foo" and "bar" plugins: :CheckHealth foo bar To run all auto-discovered healthchecks: :CheckHealth --- runtime/autoload/health.vim | 108 ++++++++++-------- runtime/doc/vim_diff.txt | 1 + runtime/plugin/health.vim | 2 +- .../fixtures/autoload/health/broken.vim | 3 + .../fixtures/autoload/health/success1.vim | 6 + .../fixtures/autoload/health/success2.vim | 4 + test/functional/plugin/health_spec.lua | 96 ++++++++++------ 7 files changed, 136 insertions(+), 84 deletions(-) create mode 100644 test/functional/fixtures/autoload/health/broken.vim create mode 100644 test/functional/fixtures/autoload/health/success1.vim create mode 100644 test/functional/fixtures/autoload/health/success2.vim diff --git a/runtime/autoload/health.vim b/runtime/autoload/health.vim index a94688cbf9..d2f36b2f65 100644 --- a/runtime/autoload/health.vim +++ b/runtime/autoload/health.vim @@ -20,46 +20,49 @@ function! s:enhance_syntax() abort highlight link healthSuggestion String endfunction -" Runs the health checkers. Manages the output and buffer-local settings. -function! health#check(bang) abort - let l:report = '' +" Runs the specified healthchecks. +" Runs all discovered healthchecks if a:plugin_names is empty. +function! health#check(plugin_names) abort + let report = '' - if empty(g:health_checkers) - call health#add_checker(s:_default_checkers()) - endif + let healthchecks = empty(a:plugin_names) + \ ? s:discover_health_checks() + \ : s:to_fn_names(a:plugin_names) - for l:checker in items(g:health_checkers) - " Disabled checkers will not run their registered check functions - if l:checker[1] - let s:current_checker = l:checker[0] - let l:report .= printf("\n%s\n================================================================================", - \ s:current_checker) - - let l:report .= execute('call ' . l:checker[0] . '()') - endif - endfor - - if a:bang - new - setlocal bufhidden=wipe - set filetype=markdown - call s:enhance_syntax() - call setline(1, split(report, "\n")) - setlocal nomodified + if empty(healthchecks) + let report = "ERROR: No healthchecks found." else - echo report - echo "\nTip: Use " - echohl Identifier - echon ':CheckHealth!' - echohl None - echon ' to open this in a new buffer.' + for c in healthchecks + let report .= printf("\n%s\n%s", c, repeat('=',80)) + try + let report .= execute('call '.c.'()') + catch /^Vim\%((\a\+)\)\=:E117/ + let report .= execute( + \ 'call health#report_error(''No healthcheck found for "' + \ .s:to_plugin_name(c) + \ .'" plugin.'')') + catch + let report .= execute( + \ 'call health#report_error(''Failed to run healthcheck for "' + \ .s:to_plugin_name(c) + \ .'" plugin. Exception:''."\n".v:exception)') + endtry + let report .= "\n" + endfor endif + + new + setlocal bufhidden=wipe + set filetype=markdown + call s:enhance_syntax() + call setline(1, split(report, "\n")) + setlocal nomodified endfunction " Starts a new report. -function! health#report_start(name) abort " {{{ +function! health#report_start(name) abort echo "\n## " . a:name -endfunction " }}} +endfunction " Indents lines *except* line 1 of a string if it contains newlines. function! s:indent_after_line1(s, columns) abort @@ -102,12 +105,12 @@ function! health#report_info(msg) abort " {{{ echo s:format_report_message('INFO', a:msg) endfunction " }}} -" Use {msg} to represent the check that has passed +" Reports a successful healthcheck. function! health#report_ok(msg) abort " {{{ echo s:format_report_message('SUCCESS', a:msg) endfunction " }}} -" Use {msg} to represent a failed health check and optionally a list of suggestions on how to fix it. +" Reports a health warning. function! health#report_warn(msg, ...) abort " {{{ if a:0 > 0 echo s:format_report_message('WARNING', a:msg, a:1) @@ -116,7 +119,7 @@ function! health#report_warn(msg, ...) abort " {{{ endif endfunction " }}} -" Use {msg} to represent a critically failed health check and optionally a list of suggestions on how to fix it. +" Reports a failed healthcheck. function! health#report_error(msg, ...) abort " {{{ if a:0 > 0 echo s:format_report_message('ERROR', a:msg, a:1) @@ -181,19 +184,28 @@ function! health#disable_checker(checker_name) abort " {{{ endif endfunction " }}} -function! s:change_file_name_to_health_checker(name) abort " {{{ - return substitute(substitute(substitute(a:name, ".*autoload/", "", ""), "\\.vim", "#check", ""), "/", "#", "g") -endfunction " }}} +function! s:filepath_to_function(name) abort + return substitute(substitute(substitute(a:name, ".*autoload/", "", ""), + \ "\\.vim", "#check", ""), "/", "#", "g") +endfunction -function! s:_default_checkers() abort " {{{ - " Get all of the files that are in autoload/health/ folders with a vim - " suffix - let checker_files = globpath(&runtimepath, 'autoload/health/*.vim', 1, 1) - let temp = checker_files[0] +function! s:discover_health_checks() abort + let healthchecks = globpath(&runtimepath, 'autoload/health/*.vim', 1, 1) + let healthchecks = map(healthchecks, 'filepath_to_function(v:val)') + return healthchecks +endfunction - let checkers_to_source = [] - for file_name in checker_files - call add(checkers_to_source, s:change_file_name_to_health_checker(file_name)) +" Translates a list of plugin names to healthcheck function names. +function! s:to_fn_names(plugin_names) abort + let healthchecks = [] + for p in a:plugin_names + call add(healthchecks, 'health#'.p.'#check') endfor - return checkers_to_source -endfunction " }}} + return healthchecks +endfunction + +" Extracts 'foo' from 'health#foo#check'. +function! s:to_plugin_name(fn_name) abort + return substitute(a:fn_name, + \ '\v.*health\#(.+)\#check.*', '\1', '') +endfunction diff --git a/runtime/doc/vim_diff.txt b/runtime/doc/vim_diff.txt index 2b1c66d0c1..8ed8a7f64c 100644 --- a/runtime/doc/vim_diff.txt +++ b/runtime/doc/vim_diff.txt @@ -107,6 +107,7 @@ Events: |TabClosed| |TermOpen| |TermClose| + |TextYankPost| Highlight groups: |hl-EndOfBuffer| diff --git a/runtime/plugin/health.vim b/runtime/plugin/health.vim index db094a03a4..3c8e509acd 100644 --- a/runtime/plugin/health.vim +++ b/runtime/plugin/health.vim @@ -1 +1 @@ -command! -bang CheckHealth call health#check(0) +command! -nargs=* CheckHealth call health#check([]) diff --git a/test/functional/fixtures/autoload/health/broken.vim b/test/functional/fixtures/autoload/health/broken.vim new file mode 100644 index 0000000000..a2a595b96f --- /dev/null +++ b/test/functional/fixtures/autoload/health/broken.vim @@ -0,0 +1,3 @@ +function! health#broken#check() + throw 'caused an error' +endfunction diff --git a/test/functional/fixtures/autoload/health/success1.vim b/test/functional/fixtures/autoload/health/success1.vim new file mode 100644 index 0000000000..a360347455 --- /dev/null +++ b/test/functional/fixtures/autoload/health/success1.vim @@ -0,0 +1,6 @@ +function! health#success1#check() + call health#report_start("report 1") + call health#report_ok("everything is fine") + call health#report_start("report 2") + call health#report_ok("nothing to see here") +endfunction diff --git a/test/functional/fixtures/autoload/health/success2.vim b/test/functional/fixtures/autoload/health/success2.vim new file mode 100644 index 0000000000..b742b4879d --- /dev/null +++ b/test/functional/fixtures/autoload/health/success2.vim @@ -0,0 +1,4 @@ +function! health#success2#check() + call health#report_start("another 1") + call health#report_ok("ok") +endfunction diff --git a/test/functional/plugin/health_spec.lua b/test/functional/plugin/health_spec.lua index 50fbfd58ee..a9665cd751 100644 --- a/test/functional/plugin/health_spec.lua +++ b/test/functional/plugin/health_spec.lua @@ -4,52 +4,78 @@ local plugin_helpers = require('test.functional.plugin.helpers') describe('health.vim', function() before_each(function() plugin_helpers.reset() + -- Provides functions: + -- health#broken#check() + -- health#success1#check() + -- health#success2#check() + helpers.execute("set runtimepath+=test/functional/fixtures") end) - it('reports results', function() - helpers.execute("call health#report_start('Foo')") - local report = helpers.redir_exec([[call health#report_start('Check Bar')]]) - .. helpers.redir_exec([[call health#report_ok('Bar status')]]) - .. helpers.redir_exec([[call health#report_ok('Other Bar status')]]) - .. helpers.redir_exec([[call health#report_warn('Zub')]]) - .. helpers.redir_exec([[call health#report_start('Baz')]]) - .. helpers.redir_exec([[call health#report_warn('Zim', ['suggestion 1', 'suggestion 2'])]]) + it("reports", function() + helpers.source([[ + let g:health_report = execute([ + \ "call health#report_start('Check Bar')", + \ "call health#report_ok('Bar status')", + \ "call health#report_ok('Other Bar status')", + \ "call health#report_warn('Zub')", + \ "call health#report_start('Baz')", + \ "call health#report_warn('Zim', ['suggestion 1', 'suggestion 2'])" + \ ]) + ]]) + local result = helpers.eval("g:health_report") - local expected_contents = { - 'Checking: Check Bar', - 'SUCCESS: Bar status', - 'WARNING: Zub', - 'SUGGESTIONS:', - '- suggestion 1', - '- suggestion 2' - } + helpers.eq(helpers.dedent([[ - for _, content in ipairs(expected_contents) do - assert(string.find(report, content)) - end + + ## Check Bar + - SUCCESS: Bar status + - SUCCESS: Other Bar status + - WARNING: Zub + + ## Baz + - WARNING: Zim + - SUGGESTIONS: + - suggestion 1 + - suggestion 2]]), + result) end) - describe(':CheckHealth', function() - -- Run it here because it may be slow, depending on the system. - helpers.execute([[CheckHealth!]]) - local report = helpers.curbuf_contents() - local health_checkers = helpers.redir_exec("echo g:health_checkers") + describe(":CheckHealth", function() + it("concatenates multiple reports", function() + helpers.execute("CheckHealth success1 success2") + helpers.expect([[ + health#success1#check + ================================================================================ - it('finds the default checker', function() - assert(string.find(health_checkers, "'health#nvim#check': v:true")) + ## report 1 + - SUCCESS: everything is fine + + ## report 2 + - SUCCESS: nothing to see here + + health#success2#check + ================================================================================ + + ## another 1 + - SUCCESS: ok]]) end) - it('prints a header with the name of the checker', function() - assert(string.find(report, 'health#nvim#check')) + it("gracefully handles broken healthcheck", function() + helpers.execute("CheckHealth broken") + helpers.expect([[ + health#broken#check + ================================================================================ + - ERROR: Failed to run healthcheck for "broken" plugin. Exception: + caused an error]]) end) - end) - it('allows users to disable checkers', function() - helpers.execute("call health#disable_checker('health#nvim#check')") - helpers.execute("CheckHealth!") - local health_checkers = helpers.redir_exec("echo g:health_checkers") - - assert(string.find(health_checkers, "'health#nvim#check': v:false")) + it("gracefully handles invalid healthcheck", function() + helpers.execute("CheckHealth non_existent_healthcheck") + helpers.expect([[ + health#non_existent_healthcheck#check + ================================================================================ + - ERROR: No healthcheck found for "non_existent_healthcheck" plugin.]]) + end) end) end) From 45cc14d9a5c1d5eadf817c920de5f913bbc4d772 Mon Sep 17 00:00:00 2001 From: "Justin M. Keyes" Date: Sat, 20 Aug 2016 19:41:31 -0400 Subject: [PATCH 4/5] CheckHealth: Remove "disable"/"enable" concept We can add this later if it is proven necessary, but it should not be because: 1. User can run a subset of checkers via `:CheckHealth plugin1, ...,` 2. Healthcheck is a very rare operation. Optimizing it is not worth the code/API complexity. --- runtime/autoload/health.vim | 63 +------------------------------------ 1 file changed, 1 insertion(+), 62 deletions(-) diff --git a/runtime/autoload/health.vim b/runtime/autoload/health.vim index d2f36b2f65..6ba9405e0a 100644 --- a/runtime/autoload/health.vim +++ b/runtime/autoload/health.vim @@ -1,8 +1,3 @@ -" Dictionary of all health check functions we have found. -" They will only be run if the value is true -let g:health_checkers = get(g:, 'health_checkers', {}) -let s:current_checker = get(s:, 'current_checker', '') - function! s:enhance_syntax() abort syntax keyword healthError ERROR highlight link healthError Error @@ -51,7 +46,7 @@ function! health#check(plugin_names) abort endfor endif - new + tabnew setlocal bufhidden=wipe set filetype=markdown call s:enhance_syntax() @@ -128,62 +123,6 @@ function! health#report_error(msg, ...) abort " {{{ endif endfunction " }}} -" Adds a health checker. Does nothing if the checker already exists. -function! s:add_single_checker(checker_name) abort " {{{ - if has_key(g:health_checkers, a:checker_name) - return - else - let g:health_checkers[a:checker_name] = v:true - endif -endfunction " }}} - -" Enables a health checker. -function! s:enable_single_checker(checker_name) abort " {{{ - let g:health_checkers[a:checker_name] = v:true -endfunction " }}} - -" Disables a health checker. -function! s:disable_single_checker(checker_name) abort " {{{ - let g:health_checkers[a:checker_name] = v:false -endfunction " }}} - - -" Adds a health checker. `checker_name` can be a list of strings or -" a single string. Does nothing if the checker already exists. -function! health#add_checker(checker_name) abort " {{{ - if type(a:checker_name) == type('') - call s:add_single_checker(a:checker_name) - elseif type(a:checker_name) == type([]) - for checker in a:checker_name - call s:add_single_checker(checker) - endfor - endif -endfunction " }}} - -" Enables a health checker. `checker_name` can be a list of strings or -" a single string. -function! health#enable_checker(checker_name) abort " {{{ - if type(a:checker_name) == type('') - call s:enable_single_checker(a:checker_name) - elseif type(a:checker_name) == type([]) - for checker in a:checker_name - call s:enable_single_checker(checker) - endfor - endif -endfunction " }}} - -" Disables a health checker. `checker_name` can be a list of strings or -" a single string. -function! health#disable_checker(checker_name) abort " {{{ - if type(a:checker_name) == type('') - call s:disable_single_checker(a:checker_name) - elseif type(a:checker_name) == type([]) - for checker in a:checker_name - call s:disable_single_checker(checker) - endfor - endif -endfunction " }}} - function! s:filepath_to_function(name) abort return substitute(substitute(substitute(a:name, ".*autoload/", "", ""), \ "\\.vim", "#check", ""), "/", "#", "g") From 297677ecf42501d2bef45dd4f083002a0963b205 Mon Sep 17 00:00:00 2001 From: "Justin M. Keyes" Date: Sun, 21 Aug 2016 16:15:50 -0400 Subject: [PATCH 5/5] remote/host.vim: Avoid "No matching autocommands". :silent does not silence this message, even :redir does not consume it. But execute() _does_ consume it, which interferes with the current implementation of health.vim. It's prudent to avoid it in any case, even if the implementation of health.vim changes in the future. --- runtime/autoload/remote/host.vim | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/runtime/autoload/remote/host.vim b/runtime/autoload/remote/host.vim index 065644121a..110f80297a 100644 --- a/runtime/autoload/remote/host.vim +++ b/runtime/autoload/remote/host.vim @@ -178,7 +178,9 @@ endfunction function! remote#host#LoadRemotePluginsEvent(event, pattern) abort autocmd! nvim-rplugin call remote#host#LoadRemotePlugins() - execute 'silent doautocmd ' a:event a:pattern + if exists('#'.a:event.'#'.a:pattern) " Avoid 'No matching autocommands'. + execute 'silent doautocmd ' a:event a:pattern + endif endfunction