diff options
Diffstat (limited to 'mnv/src/testdir/test_help.mnv')
| -rw-r--r-- | mnv/src/testdir/test_help.mnv | 292 |
1 files changed, 292 insertions, 0 deletions
diff --git a/mnv/src/testdir/test_help.mnv b/mnv/src/testdir/test_help.mnv new file mode 100644 index 0000000000..1f53ac738c --- /dev/null +++ b/mnv/src/testdir/test_help.mnv @@ -0,0 +1,292 @@ +" Tests for :help + +import './util/mnv9.mnv' as v9 + +func Test_help_restore_snapshot() + help + set buftype= + help + edit x + help + helpclose +endfunc + +func Test_help_restore_snapshot_split() + " Squeeze the unnamed buffer, Xfoo and the help one side-by-side and focus + " the first one before calling :help. + let bnr = bufnr() + botright vsp Xfoo + wincmd h + help + wincmd L + let g:did_bufenter = v:false + augroup T + au! + au BufEnter Xfoo let g:did_bufenter = v:true + augroup END + helpclose + augroup! T + " We're back to the unnamed buffer. + call assert_equal(bnr, bufnr()) + " No BufEnter was triggered for Xfoo. + call assert_equal(v:false, g:did_bufenter) + + close! + bwipe! +endfunc + +func Test_help_errors() + call assert_fails('help doesnotexist', 'E149:') + call assert_fails('help!', 'E478:') + if has('multi_lang') + call assert_fails('help help@xy', 'E661:') + endif + + let save_hf = &helpfile + set helpfile=help_missing + help + call assert_equal(1, winnr('$')) + call assert_notequal('help', &buftype) + let &helpfile = save_hf + + call assert_fails('help ' . repeat('a', 1048), 'E149:') + + new + set keywordprg=:help + call setline(1, " ") + call assert_fails('normal VK', 'E349:') + bwipe! +endfunc + +func Test_helpclose_errors() + call assert_fails('42helpclose', 'E481:') + call assert_fails('helpclose 42', 'E488:') + call assert_fails('helpclose foo', 'E488:') + call assert_fails('helpclose!', 'E477:') +endfunc + +func Test_help_expr() + help expr-!~? + call assert_equal('eval.txt', expand('%:t')) + close +endfunc + +func Test_help_keyword() + new + set keywordprg=:help + call setline(1, " Visual ") + normal VK + call assert_match('^Visual mode', getline('.')) + call assert_equal('help', &ft) + close + bwipe! +endfunc + +func Test_help_local_additions() + call mkdir('Xruntime/doc', 'pR') + call writefile(['*mydoc.txt* my awesome doc'], 'Xruntime/doc/mydoc.txt') + call writefile(['*mydoc-ext.txt* my extended awesome doc'], 'Xruntime/doc/mydoc-ext.txt') + let rtp_save = &rtp + set rtp+=./Xruntime + help local-additions + let lines = getline(line(".") + 1, search("^$") - 1) + call assert_equal([ + \ '|mydoc-ext.txt| my extended awesome doc', + \ '|mydoc.txt| my awesome doc' + \ ], lines) + call delete('Xruntime/doc/mydoc-ext.txt') + close + + call mkdir('Xruntime-ja/doc', 'pR') + call writefile(["local-additions\thelp.jax\t/*local-additions*"], 'Xruntime-ja/doc/tags-ja') + call writefile(['*help.txt* This is jax file', '', + \ 'LOCAL ADDITIONS: *local-additions*', ''], 'Xruntime-ja/doc/help.jax') + call writefile(['*work.txt* This is jax file'], 'Xruntime-ja/doc/work.jax') + call writefile(['*work2.txt* This is jax file'], 'Xruntime-ja/doc/work2.jax') + set rtp+=./Xruntime-ja + + help local-additions@en + let lines = getline(line(".") + 1, search("^$") - 1) + call assert_equal([ + \ '|mydoc.txt| my awesome doc' + \ ], lines) + close + + help local-additions@ja + let lines = getline(line(".") + 1, search("^$") - 1) + call assert_equal([ + \ '|mydoc.txt| my awesome doc', + \ '|help.txt| This is jax file', + \ '|work.txt| This is jax file', + \ '|work2.txt| This is jax file', + \ ], lines) + close + + let &rtp = rtp_save +endfunc + +func Test_help_completion() + call feedkeys(":help :undo\<C-A>\<C-B>\"\<CR>", 'tx') + call assert_equal('"help :undo :undoj :undol :undojoin :undolist', @:) +endfunc + +" Test for the :helptags command +" NOTE: if you run tests as root this will fail. Don't run tests as root! +func Test_helptag_cmd() + call mkdir('Xtagdir/a/doc', 'pR') + + " No help file to process in the directory + call assert_fails('helptags Xtagdir', 'E151:') + + call writefile([], 'Xtagdir/a/doc/sample.txt') + + " Test for ++t argument + helptags ++t Xtagdir + call assert_equal(["help-tags\ttags\t1"], readfile('Xtagdir/tags')) + call delete('Xtagdir/tags') + + " Test parsing tags + call writefile(['*tag1*', 'Example: >', ' *notag1*', 'Example end: *tag2*', + \ '>', ' *notag2*', '<', + \ '*tag3*', 'Code: >mnv', ' *notag3*', 'Code end: *tag4*', + \ '>i3config', ' *notag4*', '<'], + \ 'Xtagdir/a/doc/sample.txt') + helptags Xtagdir + call assert_equal(["tag1\ta/doc/sample.txt\t/*tag1*", + \ "tag2\ta/doc/sample.txt\t/*tag2*", + \ "tag3\ta/doc/sample.txt\t/*tag3*", + \ "tag4\ta/doc/sample.txt\t/*tag4*"], + \ readfile('Xtagdir/tags')) + + " Duplicate tags in the help file + call writefile(['*tag1*', '*tag1*', '*tag2*'], 'Xtagdir/a/doc/sample.txt') + call assert_fails('helptags Xtagdir', 'E154:') +endfunc + +func Test_helptag_cmd_readonly() + CheckUnix + CheckNotRoot + + " Read-only tags file + call mkdir('Xrodir/doc', 'pR') + call writefile([''], 'Xrodir/doc/tags') + call writefile([], 'Xrodir/doc/sample.txt') + call setfperm('Xrodir/doc/tags', 'r-xr--r--') + call assert_fails('helptags Xrodir/doc', 'E152:', getfperm('Xrodir/doc/tags')) + + let rtp = &rtp + let &rtp = 'Xrodir' + helptags ALL + let &rtp = rtp + + call delete('Xrodir/doc/tags') + + " No permission to read the help file + call mkdir('Xrodir/b/doc', 'p') + call writefile([], 'Xrodir/b/doc/sample.txt') + call setfperm('Xrodir/b/doc/sample.txt', '-w-------') + call assert_fails('helptags Xrodir', 'E153:', getfperm('Xrodir/b/doc/sample.txt')) +endfunc + +" Test for setting the 'helpheight' option in the help window +func Test_help_window_height() + let &cmdheight = &lines - 23 + set helpheight=10 + help + set helpheight=14 + call assert_equal(14, winheight(0)) + set helpheight& cmdheight=1 + close +endfunc + +func Test_help_long_argument() + try + exe 'help \%' .. repeat('0', 1021) + catch + call assert_match("E149:", v:exception) + endtry +endfunc + +func Test_help_using_visual_match() + let lines =<< trim END + call setline(1, ' ') + /^ + exe "normal \<C-V>\<C-V>" + h5\%V] + END + call v9.CheckScriptFailure(lines, 'E149:') +endfunc + +func Test_helptag_navigation() + let helpdir = tempname() + let tempfile = helpdir . '/test.txt' + call mkdir(helpdir, 'pR') + call writefile(['', '*[tag*', '', '|[tag|'], tempfile) + exe 'helptags' helpdir + exe 'sp' tempfile + exe 'lcd' helpdir + setl ft=help + let &l:iskeyword='!-~,^*,^|,^",192-255' + call cursor(4, 2) + " MNV must not escape `[` when expanding the tag + exe "normal! \<C-]>" + call assert_equal(2, line('.')) + bw +endfunc + +func Test_help_command_termination() + " :help {arg} + call execute('help |') + call assert_match('*bar\*', getline('.')) + + " :help {arg} + call execute('help ||') + call assert_match('*expr-barbar\*', getline('.')) + + " :help | <whitespace> <empty-command> + call execute('help | ') + call assert_match('*help.txt\*', getline('.')) + + " :help {arg} | <whitespace> <empty-command> + call execute('help || ') + call assert_match('*bar\*', getline('.')) + + " :help {arg} + call assert_fails('help |||', 'E149:') + " :help {arg} | <whitespace> <empty-command> + call execute('help ||| ') + call assert_match('*expr-barbar\*', getline('.')) + + " :help {invalid-arg} + call assert_fails('help ||||', 'E149:') + " :help {invalid-arg} | <whitespace> <empty-command> + " (aborted command sequence) + call assert_fails('help |||| ', 'E149:') + + call assert_equal("nextcmd", + \ execute("help | echo 'nextcmd'")->split("\n")[-1]) + call assert_equal("nextcmd", + \ execute("help || echo 'nextcmd'")->split("\n")[-1]) + call assert_equal("nextcmd", + \ execute("help \<NL> echo 'nextcmd'")->split("\n")[-1]) + call assert_equal("nextcmd", + \ execute("help \<CR> echo 'nextcmd'")->split("\n")[-1]) + + helpclose +endfunc + +" This caused a buffer overflow +func Test_helpfile_overflow() + let _helpfile = &helpfile + let &helpfile = repeat('A', 5000) + help + helpclose + for i in range(4089, 4096) + let &helpfile = repeat('A', i) .. '/A' + help + helpclose + endfor + let &helpfile = _helpfile +endfunc + +" mnv: shiftwidth=2 sts=2 expandtab |