mirror of
https://github.com/neovim/neovim
synced 2025-07-16 01:01:49 +00:00
db7c2acbc6
Problem: termdebug: not enough ways to configure breakpoints
Solution: add the termdebug_config['signs'] config setting, rework the
termdebug test cases (Dimitry Ishenko)
Allow to configure custom breakpoint signs so one can do something like
this:
```vim
let g:termdebug_config['signs'] = ['>1', '>2', '>3', '>4', '>5', '>6', '>7', '>8', '>9']
let g:termdebug_config['sign'] = '>>'
```
where the first 9 breakpoints will have their own signs and the rest
will be the same (>>).
While at it, rework the test for the termdebug plugin:
- Added test for g:termdebug_config['signs'].
- Added test for g:termdebug_config['sign'].
- Moved test for g:termdebug_config['sign_decimal'] into
Test_termdebug_basic()
closes: vim/vim#17694
c4bca1de0b
Co-authored-by: Dimitry Ishenko <dimitry.ishenko@gmail.com>
465 lines
14 KiB
VimL
465 lines
14 KiB
VimL
" Test for the termdebug plugin
|
|
|
|
source shared.vim
|
|
source check.vim
|
|
|
|
CheckUnix
|
|
" CheckFeature terminal
|
|
CheckExecutable gdb
|
|
CheckExecutable gcc
|
|
|
|
let g:GDB = exepath('gdb')
|
|
if g:GDB->empty()
|
|
throw 'Skipped: gdb is not found in $PATH'
|
|
endif
|
|
|
|
let g:GCC = exepath('gcc')
|
|
if g:GCC->empty()
|
|
throw 'Skipped: gcc is not found in $PATH'
|
|
endif
|
|
|
|
function s:generate_files(bin_name)
|
|
let src_name = a:bin_name .. '.c'
|
|
let lines =<< trim END
|
|
#include <stdio.h>
|
|
#include <stdlib.h>
|
|
|
|
int isprime(int n)
|
|
{
|
|
if (n <= 1)
|
|
return 0;
|
|
|
|
for (int i = 2; i <= n / 2; i++)
|
|
if (n % i == 0)
|
|
return 0;
|
|
|
|
return 1;
|
|
}
|
|
|
|
int main(int argc, char *argv[])
|
|
{
|
|
int n = 7;
|
|
|
|
printf("%d is %s prime\n", n, isprime(n) ? "a" : "not a");
|
|
|
|
return 0;
|
|
}
|
|
END
|
|
call writefile(lines, src_name)
|
|
call system($'{g:GCC} -g -o {a:bin_name} {src_name}')
|
|
endfunction
|
|
|
|
function s:cleanup_files(bin_name)
|
|
call delete(a:bin_name)
|
|
call delete(a:bin_name .. '.c')
|
|
endfunction
|
|
|
|
packadd termdebug
|
|
|
|
func Test_termdebug_basic()
|
|
let bin_name = 'XTD_basic'
|
|
let src_name = bin_name .. '.c'
|
|
call s:generate_files(bin_name)
|
|
|
|
edit XTD_basic.c
|
|
Termdebug ./XTD_basic
|
|
call WaitForAssert({-> assert_equal(3, winnr('$'))})
|
|
let gdb_buf = winbufnr(1)
|
|
wincmd b
|
|
Break 9
|
|
call Nterm_wait(gdb_buf)
|
|
redraw!
|
|
call assert_equal([
|
|
\ {'lnum': 9, 'id': 1014, 'name': 'debugBreakpoint1.0',
|
|
\ 'priority': 110, 'group': 'TermDebug'}],
|
|
\ sign_getplaced('', #{group: 'TermDebug'})[0].signs)
|
|
Run
|
|
call Nterm_wait(gdb_buf, 400)
|
|
redraw!
|
|
call WaitForAssert({-> assert_equal([
|
|
\ {'lnum': 9, 'id': 12, 'name': 'debugPC', 'priority': 110,
|
|
\ 'group': 'TermDebug'},
|
|
\ {'lnum': 9, 'id': 1014, 'name': 'debugBreakpoint1.0',
|
|
\ 'priority': 110, 'group': 'TermDebug'}],
|
|
"\ sign_getplaced('', #{group: 'TermDebug'})[0].signs)})
|
|
\ sign_getplaced('', #{group: 'TermDebug'})[0].signs->reverse())})
|
|
Finish
|
|
call Nterm_wait(gdb_buf)
|
|
redraw!
|
|
call WaitForAssert({-> assert_equal([
|
|
\ {'lnum': 9, 'id': 1014, 'name': 'debugBreakpoint1.0',
|
|
\ 'priority': 110, 'group': 'TermDebug'},
|
|
\ {'lnum': 20, 'id': 12, 'name': 'debugPC',
|
|
\ 'priority': 110, 'group': 'TermDebug'}],
|
|
\ sign_getplaced('', #{group: 'TermDebug'})[0].signs)})
|
|
Continue
|
|
call Nterm_wait(gdb_buf)
|
|
|
|
let g:termdebug_config = {}
|
|
let g:termdebug_config['signs'] = ['>1', '>2', '>3']
|
|
let g:termdebug_config['sign'] = '>>'
|
|
let g:termdebug_config['sign_decimal'] = 1
|
|
|
|
let i = 2
|
|
while i <= 258
|
|
Break
|
|
call Nterm_wait(gdb_buf)
|
|
if i == 2
|
|
call WaitForAssert({-> assert_equal(sign_getdefined('debugBreakpoint2.0')[0].text, '>2')})
|
|
endif
|
|
if i == 3
|
|
call WaitForAssert({-> assert_equal(sign_getdefined('debugBreakpoint3.0')[0].text, '>3')})
|
|
endif
|
|
if i == 4
|
|
call WaitForAssert({-> assert_equal(sign_getdefined('debugBreakpoint4.0')[0].text, '>>')})
|
|
endif
|
|
if i == 5
|
|
call WaitForAssert({-> assert_equal(sign_getdefined('debugBreakpoint5.0')[0].text, '>>')})
|
|
unlet g:termdebug_config['sign']
|
|
endif
|
|
if i == 6
|
|
call WaitForAssert({-> assert_equal(sign_getdefined('debugBreakpoint6.0')[0].text, '06')})
|
|
endif
|
|
if i == 10
|
|
call WaitForAssert({-> assert_equal(sign_getdefined('debugBreakpoint10.0')[0].text, '10')})
|
|
endif
|
|
if i == 99
|
|
call WaitForAssert({-> assert_equal(sign_getdefined('debugBreakpoint99.0')[0].text, '99')})
|
|
endif
|
|
if i == 100
|
|
call WaitForAssert({-> assert_equal(sign_getdefined('debugBreakpoint100.0')[0].text, '9+')})
|
|
endif
|
|
if i == 110
|
|
call WaitForAssert({-> assert_equal(sign_getdefined('debugBreakpoint110.0')[0].text, '9+')})
|
|
unlet g:termdebug_config
|
|
endif
|
|
if i == 128
|
|
call WaitForAssert({-> assert_equal(sign_getdefined('debugBreakpoint128.0')[0].text, '80')})
|
|
endif
|
|
if i == 168
|
|
call WaitForAssert({-> assert_equal(sign_getdefined('debugBreakpoint168.0')[0].text, 'A8')})
|
|
endif
|
|
if i == 255
|
|
call WaitForAssert({-> assert_equal(sign_getdefined('debugBreakpoint255.0')[0].text, 'FF')})
|
|
endif
|
|
if i == 256
|
|
call WaitForAssert({-> assert_equal(sign_getdefined('debugBreakpoint256.0')[0].text, 'F+')})
|
|
endif
|
|
if i == 258
|
|
call WaitForAssert({-> assert_equal(sign_getdefined('debugBreakpoint258.0')[0].text, 'F+')})
|
|
endif
|
|
let i += 1
|
|
endwhile
|
|
|
|
let cn = 0
|
|
" 60 is approx spaceBuffer * 3
|
|
if winwidth(0) <= 78 + 60
|
|
Var
|
|
call assert_equal(winnr('$'), winnr())
|
|
call assert_equal(['col', [['leaf', 1002], ['leaf', 1001], ['leaf', 1000], ['leaf', 1003 + cn]]], winlayout())
|
|
let cn += 1
|
|
bw!
|
|
Asm
|
|
call assert_equal(winnr('$'), winnr())
|
|
call assert_equal(['col', [['leaf', 1002], ['leaf', 1001], ['leaf', 1000], ['leaf', 1003 + cn]]], winlayout())
|
|
let cn += 1
|
|
bw!
|
|
endif
|
|
set columns=160
|
|
call Nterm_wait(gdb_buf)
|
|
let winw = winwidth(0)
|
|
Var
|
|
if winwidth(0) < winw
|
|
call assert_equal(winnr('$') - 1, winnr())
|
|
call assert_equal(['col', [['leaf', 1002], ['leaf', 1001], ['row', [['leaf', 1003 + cn], ['leaf', 1000]]]]], winlayout())
|
|
let cn += 1
|
|
bw!
|
|
endif
|
|
let winw = winwidth(0)
|
|
Asm
|
|
if winwidth(0) < winw
|
|
call assert_equal(winnr('$') - 1, winnr())
|
|
call assert_equal(['col', [['leaf', 1002], ['leaf', 1001], ['row', [['leaf', 1003 + cn], ['leaf', 1000]]]]], winlayout())
|
|
let cn += 1
|
|
bw!
|
|
endif
|
|
set columns&
|
|
call Nterm_wait(gdb_buf)
|
|
|
|
wincmd t
|
|
quit!
|
|
redraw!
|
|
call WaitForAssert({-> assert_equal(1, winnr('$'))})
|
|
call assert_equal([], sign_getplaced('', #{group: 'TermDebug'})[0].signs)
|
|
|
|
for use_prompt in [0, 1]
|
|
let g:termdebug_config = {}
|
|
let g:termdebug_config['use_prompt'] = use_prompt
|
|
TermdebugCommand ./XTD_basic arg args
|
|
call WaitForAssert({-> assert_equal(3, winnr('$'))})
|
|
wincmd t
|
|
quit!
|
|
redraw!
|
|
call WaitForAssert({-> assert_equal(1, winnr('$'))})
|
|
unlet g:termdebug_config
|
|
endfor
|
|
|
|
call s:cleanup_files(bin_name)
|
|
%bw!
|
|
endfunc
|
|
|
|
func Test_termdebug_tbreak()
|
|
let g:test_is_flaky = 1
|
|
let bin_name = 'XTD_tbreak'
|
|
let src_name = bin_name .. '.c'
|
|
|
|
eval s:generate_files(bin_name)
|
|
|
|
execute 'edit ' .. src_name
|
|
execute 'Termdebug ./' .. bin_name
|
|
|
|
call WaitForAssert({-> assert_equal(3, winnr('$'))})
|
|
let gdb_buf = winbufnr(1)
|
|
wincmd b
|
|
|
|
let bp_line = 22 " 'return' statement in main
|
|
let temp_bp_line = 10 " 'if' statement in 'for' loop body
|
|
execute "Tbreak " .. temp_bp_line
|
|
execute "Break " .. bp_line
|
|
|
|
call Nterm_wait(gdb_buf)
|
|
redraw!
|
|
" both temporary and normal breakpoint signs were displayed...
|
|
call assert_equal([
|
|
\ {'lnum': temp_bp_line, 'id': 1014, 'name': 'debugBreakpoint1.0',
|
|
\ 'priority': 110, 'group': 'TermDebug'},
|
|
\ {'lnum': bp_line, 'id': 2014, 'name': 'debugBreakpoint2.0',
|
|
\ 'priority': 110, 'group': 'TermDebug'}],
|
|
\ sign_getplaced('', #{group: 'TermDebug'})[0].signs)
|
|
|
|
Run
|
|
call Nterm_wait(gdb_buf, 400)
|
|
redraw!
|
|
" debugPC sign is on the line where the temp. bp was set;
|
|
" temp. bp sign was removed after hit;
|
|
" normal bp sign is still present
|
|
call WaitForAssert({-> assert_equal([
|
|
\ {'lnum': temp_bp_line, 'id': 12, 'name': 'debugPC', 'priority': 110,
|
|
\ 'group': 'TermDebug'},
|
|
\ {'lnum': bp_line, 'id': 2014, 'name': 'debugBreakpoint2.0',
|
|
\ 'priority': 110, 'group': 'TermDebug'}],
|
|
\ sign_getplaced('', #{group: 'TermDebug'})[0].signs)})
|
|
|
|
Continue
|
|
call Nterm_wait(gdb_buf)
|
|
redraw!
|
|
" debugPC is on the normal breakpoint,
|
|
" temp. bp on line 10 was only hit once
|
|
call WaitForAssert({-> assert_equal([
|
|
\ {'lnum': bp_line, 'id': 12, 'name': 'debugPC', 'priority': 110,
|
|
\ 'group': 'TermDebug'},
|
|
\ {'lnum': bp_line, 'id': 2014, 'name': 'debugBreakpoint2.0',
|
|
\ 'priority': 110, 'group': 'TermDebug'}],
|
|
"\ sign_getplaced('', #{group: 'TermDebug'})[0].signs)})
|
|
\ sign_getplaced('', #{group: 'TermDebug'})[0].signs->reverse())})
|
|
|
|
wincmd t
|
|
quit!
|
|
redraw!
|
|
call WaitForAssert({-> assert_equal(1, winnr('$'))})
|
|
call assert_equal([], sign_getplaced('', #{group: 'TermDebug'})[0].signs)
|
|
|
|
eval s:cleanup_files(bin_name)
|
|
%bw!
|
|
endfunc
|
|
|
|
func Test_termdebug_mapping()
|
|
%bw!
|
|
call assert_true(maparg('K', 'n', 0, 1)->empty())
|
|
call assert_true(maparg('-', 'n', 0, 1)->empty())
|
|
call assert_true(maparg('+', 'n', 0, 1)->empty())
|
|
Termdebug
|
|
call WaitForAssert({-> assert_equal(3, winnr('$'))})
|
|
wincmd b
|
|
call assert_false(maparg('K', 'n', 0, 1)->empty())
|
|
call assert_false(maparg('-', 'n', 0, 1)->empty())
|
|
call assert_false(maparg('+', 'n', 0, 1)->empty())
|
|
call assert_false(maparg('K', 'n', 0, 1).buffer)
|
|
call assert_false(maparg('-', 'n', 0, 1).buffer)
|
|
call assert_false(maparg('+', 'n', 0, 1).buffer)
|
|
call assert_equal(':Evaluate<CR>', maparg('K', 'n', 0, 1).rhs)
|
|
wincmd t
|
|
quit!
|
|
redraw!
|
|
call WaitForAssert({-> assert_equal(1, winnr('$'))})
|
|
call assert_true(maparg('K', 'n', 0, 1)->empty())
|
|
call assert_true(maparg('-', 'n', 0, 1)->empty())
|
|
call assert_true(maparg('+', 'n', 0, 1)->empty())
|
|
|
|
%bw!
|
|
nnoremap K :echom "K"<cr>
|
|
nnoremap - :echom "-"<cr>
|
|
nnoremap + :echom "+"<cr>
|
|
Termdebug
|
|
call WaitForAssert({-> assert_equal(3, winnr('$'))})
|
|
wincmd b
|
|
call assert_false(maparg('K', 'n', 0, 1)->empty())
|
|
call assert_false(maparg('-', 'n', 0, 1)->empty())
|
|
call assert_false(maparg('+', 'n', 0, 1)->empty())
|
|
call assert_false(maparg('K', 'n', 0, 1).buffer)
|
|
call assert_false(maparg('-', 'n', 0, 1).buffer)
|
|
call assert_false(maparg('+', 'n', 0, 1).buffer)
|
|
call assert_equal(':Evaluate<CR>', maparg('K', 'n', 0, 1).rhs)
|
|
wincmd t
|
|
quit!
|
|
redraw!
|
|
call WaitForAssert({-> assert_equal(1, winnr('$'))})
|
|
call assert_false(maparg('K', 'n', 0, 1)->empty())
|
|
call assert_false(maparg('-', 'n', 0, 1)->empty())
|
|
call assert_false(maparg('+', 'n', 0, 1)->empty())
|
|
call assert_false(maparg('K', 'n', 0, 1).buffer)
|
|
call assert_false(maparg('-', 'n', 0, 1).buffer)
|
|
call assert_false(maparg('+', 'n', 0, 1).buffer)
|
|
call assert_equal(':echom "K"<cr>', maparg('K', 'n', 0, 1).rhs)
|
|
|
|
%bw!
|
|
|
|
" -- Test that local-buffer mappings are restored in the correct buffers --
|
|
" local mappings for foo
|
|
file foo
|
|
nnoremap <buffer> K :echom "bK"<cr>
|
|
nnoremap <buffer> - :echom "b-"<cr>
|
|
nnoremap <buffer> + :echom "b+"<cr>
|
|
|
|
" no mappings for 'bar'
|
|
enew
|
|
file bar
|
|
|
|
" Start termdebug from foo
|
|
buffer foo
|
|
Termdebug
|
|
call WaitForAssert({-> assert_equal(3, winnr('$'))})
|
|
wincmd b
|
|
call assert_true(maparg('K', 'n', 0, 1).buffer)
|
|
call assert_true(maparg('-', 'n', 0, 1).buffer)
|
|
call assert_true(maparg('+', 'n', 0, 1).buffer)
|
|
call assert_equal(maparg('K', 'n', 0, 1).rhs, ':echom "bK"<cr>')
|
|
|
|
Source
|
|
buffer bar
|
|
call assert_false(maparg('K', 'n', 0, 1)->empty())
|
|
call assert_false(maparg('-', 'n', 0, 1)->empty())
|
|
call assert_false(maparg('+', 'n', 0, 1)->empty())
|
|
call assert_true(maparg('K', 'n', 0, 1).buffer->empty())
|
|
call assert_true(maparg('-', 'n', 0, 1).buffer->empty())
|
|
call assert_true(maparg('+', 'n', 0, 1).buffer->empty())
|
|
wincmd t
|
|
quit!
|
|
redraw!
|
|
call WaitForAssert({-> assert_equal(1, winnr('$'))})
|
|
|
|
" Termdebug session ended. Buffer 'bar' shall have no mappings
|
|
call assert_true(bufname() ==# 'bar')
|
|
call assert_false(maparg('K', 'n', 0, 1)->empty())
|
|
call assert_false(maparg('-', 'n', 0, 1)->empty())
|
|
call assert_false(maparg('+', 'n', 0, 1)->empty())
|
|
call assert_true(maparg('K', 'n', 0, 1).buffer->empty())
|
|
call assert_true(maparg('-', 'n', 0, 1).buffer->empty())
|
|
call assert_true(maparg('+', 'n', 0, 1).buffer->empty())
|
|
|
|
" Buffer 'foo' shall have the same mapping as before running the termdebug
|
|
" session
|
|
buffer foo
|
|
call assert_true(bufname() ==# 'foo')
|
|
call assert_true(maparg('K', 'n', 0, 1).buffer)
|
|
call assert_true(maparg('-', 'n', 0, 1).buffer)
|
|
call assert_true(maparg('+', 'n', 0, 1).buffer)
|
|
call assert_equal(':echom "bK"<cr>', maparg('K', 'n', 0, 1).rhs)
|
|
|
|
nunmap K
|
|
nunmap +
|
|
nunmap -
|
|
%bw!
|
|
endfunc
|
|
|
|
func Test_termdebug_bufnames()
|
|
" Test if user has filename/folders named gdb, Termdebug-gdb-console,
|
|
" etc. in the current directory
|
|
let g:termdebug_config = {}
|
|
let g:termdebug_config['use_prompt'] = 1
|
|
let filename = 'gdb'
|
|
let replacement_filename = 'Termdebug-gdb-console'
|
|
|
|
call writefile(['This', 'is', 'a', 'test'], filename, 'D')
|
|
" Throw away the file once the test has done.
|
|
Termdebug
|
|
" Once termdebug has completed the startup you should have 3 windows on screen
|
|
call WaitForAssert({-> assert_equal(3, winnr('$'))})
|
|
" A file named filename already exists in the working directory,
|
|
" hence you must call the newly created buffer differently
|
|
call WaitForAssert({-> assert_false(bufexists(filename))})
|
|
call WaitForAssert({-> assert_true(bufexists(replacement_filename))})
|
|
quit!
|
|
call WaitForAssert({-> assert_equal(1, winnr('$'))})
|
|
|
|
" Check if error message is in :message
|
|
let g:termdebug_config['disasm_window'] = 1
|
|
let filename = 'Termdebug-asm-listing'
|
|
call writefile(['This', 'is', 'a', 'test'], filename, 'D')
|
|
" Check only the head of the error message
|
|
let error_message = "You have a file/folder named '" .. filename .. "'"
|
|
Termdebug
|
|
" Once termdebug has completed the startup you should have 4 windows on screen
|
|
call WaitForAssert({-> assert_equal(4, winnr('$'))})
|
|
call WaitForAssert({-> assert_notequal(-1, stridx(execute('messages'), error_message))})
|
|
quit!
|
|
wincmd b
|
|
wincmd q
|
|
call WaitForAssert({-> assert_equal(1, winnr('$'))})
|
|
|
|
unlet g:termdebug_config
|
|
endfunc
|
|
|
|
function Test_termdebug_save_restore_variables()
|
|
" saved mousemodel
|
|
"let &mousemodel=''
|
|
let &mousemodel='extend'
|
|
|
|
" saved keys
|
|
nnoremap K :echo "hello world!"<cr>
|
|
let expected_map_K = maparg('K', 'n', 0 , 1)
|
|
nnoremap + :echo "hello plus!"<cr>
|
|
let expected_map_plus = maparg('+', 'n', 0 , 1)
|
|
let expected_map_minus = {}
|
|
|
|
" saved &columns
|
|
let expected_columns = &columns
|
|
|
|
" We want termdebug to overwrite 'K' map but not '+' map.
|
|
let g:termdebug_config = {}
|
|
let g:termdebug_config['map_K'] = 1
|
|
|
|
Termdebug
|
|
call WaitForAssert({-> assert_equal(3, winnr('$'))})
|
|
call WaitForAssert({-> assert_match(&mousemodel, 'popup_setpos')})
|
|
wincmd t
|
|
quit!
|
|
call WaitForAssert({-> assert_equal(1, winnr('$'))})
|
|
|
|
"call assert_true(empty(&mousemodel))
|
|
call assert_equal(&mousemodel, 'extend')
|
|
|
|
call assert_true(empty(expected_map_minus))
|
|
call assert_equal(expected_map_K.rhs, maparg('K', 'n', 0, 1).rhs)
|
|
call assert_equal(expected_map_plus.rhs, maparg('+', 'n', 0, 1).rhs)
|
|
|
|
call assert_equal(expected_columns, &columns)
|
|
|
|
nunmap K
|
|
nunmap +
|
|
unlet g:termdebug_config
|
|
endfunction
|
|
|
|
|
|
" vim: shiftwidth=2 sts=2 expandtab
|