xref: /vim-8.2.3635/src/testdir/test_cscope.vim (revision cb03397a) 
1" Test for cscope commands.
2
3if !has('cscope') || !executable('cscope') || !has('quickfix')
4  finish
5endif
6
7func CscopeSetupOrClean(setup)
8    if a:setup
9      noa sp ../memfile_test.c
10      saveas! Xmemfile_test.c
11      call system('cscope -bk -fXcscope.out Xmemfile_test.c')
12      call system('cscope -bk -fXcscope2.out Xmemfile_test.c')
13      cscope add Xcscope.out
14      set cscopequickfix=s-,g-,d-,c-,t-,e-,f-,i-,a-
15    else
16      cscope kill -1
17      for file in ['Xcscope.out', 'Xcscope2.out', 'Xmemfile_test.c']
18          call delete(file)
19      endfo
20    endif
21endfunc
22
23func Test_cscopeWithCscopeConnections()
24    call CscopeSetupOrClean(1)
25    " Test 0: E568: duplicate cscope database not added
26    try
27      set nocscopeverbose
28      cscope add Xcscope.out
29      set cscopeverbose
30    catch
31      call assert_true(0)
32    endtry
33    call assert_fails('cscope add', 'E560')
34    call assert_fails('cscope add Xcscope.out', 'E568')
35    call assert_fails('cscope add doesnotexist.out', 'E563')
36
37    " Test 1: Find this C-Symbol
38    for cmd in ['cs find s main', 'cs find 0 main']
39      let a=execute(cmd)
40      " Test 1.1 test where it moves the cursor
41      call assert_equal('main(void)', getline('.'))
42      " Test 1.2 test the output of the :cs command
43      call assert_match('\n(1 of 1): <<main>> main(void )', a)
44    endfor
45
46    " Test 2: Find this definition
47    for cmd in ['cs find g test_mf_hash', 'cs find 1 test_mf_hash']
48      exe cmd
49      call assert_equal(['', '/*', ' * Test mf_hash_*() functions.', ' */', '    static void', 'test_mf_hash(void)', '{'], getline(line('.')-5, line('.')+1))
50    endfor
51
52    " Test 3: Find functions called by this function
53    for cmd in ['cs find d test_mf_hash', 'cs find 2 test_mf_hash']
54      let a=execute(cmd)
55      call assert_match('\n(1 of 42): <<mf_hash_init>> mf_hash_init(&ht);', a)
56      call assert_equal('    mf_hash_init(&ht);', getline('.'))
57    endfor
58
59    " Test 4: Find functions calling this function
60    for cmd in ['cs find c test_mf_hash', 'cs find 3 test_mf_hash']
61      let a=execute(cmd)
62      call assert_match('\n(1 of 1): <<main>> test_mf_hash();', a)
63      call assert_equal('    test_mf_hash();', getline('.'))
64    endfor
65
66    " Test 5: Find this text string
67    for cmd in ['cs find t Bram', 'cs find 4 Bram']
68      let a=execute(cmd)
69      call assert_match('(1 of 1): <<<unknown>>>  \* VIM - Vi IMproved^Iby Bram Moolenaar', a)
70      call assert_equal(' * VIM - Vi IMproved	by Bram Moolenaar', getline('.'))
71    endfor
72
73    " Test 6: Find this egrep pattern
74    " test all matches returned by cscope
75    for cmd in ['cs find e ^\#includ.', 'cs find 6 ^\#includ.']
76      let a=execute(cmd)
77      call assert_match('\n(1 of 3): <<<unknown>>> #include <assert.h>', a)
78      call assert_equal('#include <assert.h>', getline('.'))
79      cnext
80      call assert_equal('#include "main.c"', getline('.'))
81      cnext
82      call assert_equal('#include "memfile.c"', getline('.'))
83      call assert_fails('cnext', 'E553:')
84    endfor
85
86    " Test 7: Find the same egrep pattern using lcscope this time.
87    let a=execute('lcs find e ^\#includ.')
88    call assert_match('\n(1 of 3): <<<unknown>>> #include <assert.h>', a)
89    call assert_equal('#include <assert.h>', getline('.'))
90    lnext
91    call assert_equal('#include "main.c"', getline('.'))
92    lnext
93    call assert_equal('#include "memfile.c"', getline('.'))
94    call assert_fails('lnext', 'E553:')
95
96    " Test 8: Find this file
97    for cmd in ['cs find f Xmemfile_test.c', 'cs find 7 Xmemfile_test.c']
98      enew
99      let a=execute(cmd)
100      call assert_match('\n"Xmemfile_test.c" 143L, 3137C', a)
101      call assert_equal('Xmemfile_test.c', @%)
102    endfor
103
104    " Test 9: Find files #including this file
105    for cmd in ['cs find i assert.h', 'cs find 8 assert.h']
106      enew
107      let a=execute(cmd)
108      call assert_equal(['','"Xmemfile_test.c" 143L, 3137C','(1 of 1): <<global>> #include <assert.h>'], split(a, '\n', 1))
109      call assert_equal('#include <assert.h>', getline('.'))
110    endfor
111
112    " Test 10: Invalid find command
113    call assert_fails('cs find x', 'E560:')
114
115    " Test 11: Find places where this symbol is assigned a value
116    " this needs a cscope >= 15.8
117    " unfortunately, Travis has cscope version 15.7
118    let cscope_version=systemlist('cscope --version')[0]
119    let cs_version=str2float(matchstr(cscope_version, '\d\+\(\.\d\+\)\?'))
120    if cs_version >= 15.8
121      for cmd in ['cs find a item', 'cs find 9 item']
122        let a=execute(cmd)
123        call assert_equal(['', '(1 of 4): <<test_mf_hash>> item = (mf_hashitem_T *)lalloc_clear(sizeof(mf_hashtab_T), FALSE);'], split(a, '\n', 1))
124        call assert_equal('	item = (mf_hashitem_T *)lalloc_clear(sizeof(mf_hashtab_T), FALSE);', getline('.'))
125        cnext
126        call assert_equal('	item = mf_hash_find(&ht, key);', getline('.'))
127        cnext
128        call assert_equal('	    item = mf_hash_find(&ht, key);', getline('.'))
129        cnext
130        call assert_equal('	item = mf_hash_find(&ht, key);', getline('.'))
131      endfor
132    endif
133
134    " Test 12: leading whitespace is not removed for cscope find text
135    let a=execute('cscope find t     test_mf_hash')
136    call assert_equal(['', '(1 of 1): <<<unknown>>>     test_mf_hash();'], split(a, '\n', 1))
137    call assert_equal('    test_mf_hash();', getline('.'))
138
139    " Test 13: test with scscope
140    let a=execute('scs find t Bram')
141    call assert_match('(1 of 1): <<<unknown>>>  \* VIM - Vi IMproved^Iby Bram Moolenaar', a)
142    call assert_equal(' * VIM - Vi IMproved	by Bram Moolenaar', getline('.'))
143
144    " Test 14: cscope help
145    for cmd in ['cs', 'cs help', 'cs xxx']
146      let a=execute(cmd)
147      call assert_match('^cscope commands:\n', a)
148      call assert_match('\nadd  :', a)
149      call assert_match('\nfind :', a)
150      call assert_match('\nhelp : Show this message', a)
151      call assert_match('\nkill : Kill a connection', a)
152      call assert_match('\nreset: Reinit all connections', a)
153      call assert_match('\nshow : Show connections', a)
154    endfor
155    let a=execute('scscope help')
156    call assert_match('This cscope command does not support splitting the window\.', a)
157
158    " Test 15: reset connections
159    let a=execute('cscope reset')
160    call assert_match('\nAdded cscope database.*Xcscope.out (#0)', a)
161    call assert_match('\nAll cscope databases reset', a)
162
163    " Test 16: cscope show
164    let a=execute('cscope show')
165    call assert_match('\n 0 \d\+.*Xcscope.out\s*<none>', a)
166
167    " Test 17: cstag and 'csto' option
168    set csto=0
169    let a=execute('cstag TEST_COUNT')
170    call assert_match('(1 of 1): <<TEST_COUNT>> #define TEST_COUNT 50000', a)
171    call assert_equal('#define TEST_COUNT 50000', getline('.'))
172    set csto=1
173    let a=execute('cstag index_to_key')
174    call assert_match('(1 of 1): <<index_to_key>> #define index_to_key(i) ((i) ^ 15167)', a)
175    call assert_equal('#define index_to_key(i) ((i) ^ 15167)', getline('.'))
176    call assert_fails('cstag xxx', 'E257:')
177    call assert_fails('cstag', 'E562:')
178
179    " Test 18: 'cst' option
180    set nocst
181    call assert_fails('tag TEST_COUNT', 'E426:')
182    set cst
183    let a=execute('tag TEST_COUNT')
184    call assert_match('(1 of 1): <<TEST_COUNT>> #define TEST_COUNT 50000', a)
185    call assert_equal('#define TEST_COUNT 50000', getline('.'))
186    let a=execute('tags')
187    call assert_match('1  1 TEST_COUNT\s\+\d\+\s\+#define index_to_key', a)
188
189    " Test 19: this should trigger call to cs_print_tags()
190    " Unclear how to check result though, we just exercise the code.
191    set cst cscopequickfix=s0
192    call feedkeys(":cs find s main\<CR>", 't')
193
194    " Test 20: cscope kill
195    call assert_fails('cscope kill 2', 'E261:')
196    call assert_fails('cscope kill xxx', 'E261:')
197
198    let a=execute('cscope kill 0')
199    call assert_match('cscope connection 0 closed', a)
200
201    cscope add Xcscope.out
202    let a=execute('cscope kill Xcscope.out')
203    call assert_match('cscope connection Xcscope.out closed', a)
204
205    cscope add Xcscope.out .
206    let a=execute('cscope kill -1')
207    call assert_match('cscope connection .*Xcscope.out closed', a)
208    let a=execute('cscope kill -1')
209    call assert_equal('', a)
210
211    " Test 21: 'csprg' option
212    call assert_equal('cscope', &csprg)
213    set csprg=doesnotexist
214    call assert_fails('cscope add Xcscope2.out', 'E609:')
215    set csprg=cscope
216
217    " Test 22: multiple cscope connections
218    cscope add Xcscope.out
219    cscope add Xcscope2.out . -C
220    let a=execute('cscope show')
221    call assert_match('\n 0 \d\+.*Xcscope.out\s*<none>', a)
222    call assert_match('\n 1 \d\+.*Xcscope2.out\s*\.', a)
223
224    " Test 23: test Ex command line completion
225    call feedkeys(":cs \<C-A>\<C-B>\"\<CR>", 'tx')
226    call assert_equal('"cs add find help kill reset show', @:)
227
228    call feedkeys(":scs \<C-A>\<C-B>\"\<CR>", 'tx')
229    call assert_equal('"scs find', @:)
230
231    call feedkeys(":cs find \<C-A>\<C-B>\"\<CR>", 'tx')
232    call assert_equal('"cs find a c d e f g i s t', @:)
233
234    call feedkeys(":cs kill \<C-A>\<C-B>\"\<CR>", 'tx')
235    call assert_equal('"cs kill -1 0 1', @:)
236
237    call feedkeys(":cs add Xcscope\<C-A>\<C-B>\"\<CR>", 'tx')
238    call assert_equal('"cs add Xcscope.out Xcscope2.out', @:)
239
240    " Test 24: cscope_connection()
241    call assert_equal(cscope_connection(), 1)
242    call assert_equal(cscope_connection(0, 'out'), 1)
243    call assert_equal(cscope_connection(0, 'xxx'), 1)
244    call assert_equal(cscope_connection(1, 'out'), 1)
245    call assert_equal(cscope_connection(1, 'xxx'), 0)
246    call assert_equal(cscope_connection(2, 'out'), 0)
247    call assert_equal(cscope_connection(3, 'xxx', '..'), 0)
248    call assert_equal(cscope_connection(3, 'out', 'xxx'), 0)
249    call assert_equal(cscope_connection(3, 'out', '.'), 1)
250    call assert_equal(cscope_connection(4, 'out', '.'), 0)
251
252    " CleanUp
253    call CscopeSetupOrClean(0)
254
255endfunc
256
257func Test_cscopequickfix()
258  set cscopequickfix=s-,g-,d+,c-,t+,e-,f0,i-,a-
259  call assert_equal('s-,g-,d+,c-,t+,e-,f0,i-,a-', &cscopequickfix)
260
261  call assert_fails('set cscopequickfix=x-', 'E474:')
262  call assert_fails('set cscopequickfix=s', 'E474:')
263  call assert_fails('set cscopequickfix=s7', 'E474:')
264  call assert_fails('set cscopequickfix=s-a', 'E474:')
265endfunc
266
267func Test_withoutCscopeConnection()
268  call assert_equal(cscope_connection(), 0)
269
270  call assert_fails('cscope find s main', 'E567:')
271  let a=execute('cscope show')
272  call assert_match('no cscope connections', a)
273endfunc
274
275
276" vim: shiftwidth=2 sts=2 expandtab
277