blob: cf1ddba5dc6792224809a1dedd0120637b069c59 [file] [log] [blame]
Bram Moolenaar6d20e172016-07-13 22:44:12 +02001" Test for cscope commands.
2
Bram Moolenaarb46fecd2019-06-15 17:58:09 +02003source check.vim
4CheckFeature cscope
5CheckFeature quickfix
Bram Moolenaar8c5a2782019-08-07 23:07:07 +02006CheckExecutable cscope
Bram Moolenaar6d20e172016-07-13 22:44:12 +02007
Bram Moolenaar812ad4f2016-08-07 14:03:13 +02008func CscopeSetupOrClean(setup)
9 if a:setup
10 noa sp ../memfile_test.c
11 saveas! Xmemfile_test.c
12 call system('cscope -bk -fXcscope.out Xmemfile_test.c')
13 call system('cscope -bk -fXcscope2.out Xmemfile_test.c')
14 cscope add Xcscope.out
15 set cscopequickfix=s-,g-,d-,c-,t-,e-,f-,i-,a-
16 else
17 cscope kill -1
18 for file in ['Xcscope.out', 'Xcscope2.out', 'Xmemfile_test.c']
19 call delete(file)
20 endfo
21 endif
22endfunc
23
24func Test_cscopeWithCscopeConnections()
25 call CscopeSetupOrClean(1)
26 " Test 0: E568: duplicate cscope database not added
27 try
28 set nocscopeverbose
29 cscope add Xcscope.out
30 set cscopeverbose
31 catch
Bram Moolenaar37175402017-03-18 20:18:45 +010032 call assert_report('exception thrown')
Bram Moolenaar812ad4f2016-08-07 14:03:13 +020033 endtry
34 call assert_fails('cscope add', 'E560')
35 call assert_fails('cscope add Xcscope.out', 'E568')
36 call assert_fails('cscope add doesnotexist.out', 'E563')
37
38 " Test 1: Find this C-Symbol
39 for cmd in ['cs find s main', 'cs find 0 main']
Bram Moolenaar259f26a2018-05-15 22:25:40 +020040 let a = execute(cmd)
Bram Moolenaar812ad4f2016-08-07 14:03:13 +020041 " Test 1.1 test where it moves the cursor
42 call assert_equal('main(void)', getline('.'))
43 " Test 1.2 test the output of the :cs command
44 call assert_match('\n(1 of 1): <<main>> main(void )', a)
45 endfor
46
47 " Test 2: Find this definition
48 for cmd in ['cs find g test_mf_hash', 'cs find 1 test_mf_hash']
49 exe cmd
50 call assert_equal(['', '/*', ' * Test mf_hash_*() functions.', ' */', ' static void', 'test_mf_hash(void)', '{'], getline(line('.')-5, line('.')+1))
51 endfor
52
53 " Test 3: Find functions called by this function
54 for cmd in ['cs find d test_mf_hash', 'cs find 2 test_mf_hash']
Bram Moolenaar259f26a2018-05-15 22:25:40 +020055 let a = execute(cmd)
Bram Moolenaar812ad4f2016-08-07 14:03:13 +020056 call assert_match('\n(1 of 42): <<mf_hash_init>> mf_hash_init(&ht);', a)
57 call assert_equal(' mf_hash_init(&ht);', getline('.'))
58 endfor
59
60 " Test 4: Find functions calling this function
61 for cmd in ['cs find c test_mf_hash', 'cs find 3 test_mf_hash']
Bram Moolenaar259f26a2018-05-15 22:25:40 +020062 let a = execute(cmd)
Bram Moolenaar812ad4f2016-08-07 14:03:13 +020063 call assert_match('\n(1 of 1): <<main>> test_mf_hash();', a)
64 call assert_equal(' test_mf_hash();', getline('.'))
65 endfor
66
67 " Test 5: Find this text string
68 for cmd in ['cs find t Bram', 'cs find 4 Bram']
Bram Moolenaar259f26a2018-05-15 22:25:40 +020069 let a = execute(cmd)
Bram Moolenaar812ad4f2016-08-07 14:03:13 +020070 call assert_match('(1 of 1): <<<unknown>>> \* VIM - Vi IMproved^Iby Bram Moolenaar', a)
71 call assert_equal(' * VIM - Vi IMproved by Bram Moolenaar', getline('.'))
72 endfor
73
74 " Test 6: Find this egrep pattern
75 " test all matches returned by cscope
76 for cmd in ['cs find e ^\#includ.', 'cs find 6 ^\#includ.']
Bram Moolenaar259f26a2018-05-15 22:25:40 +020077 let a = execute(cmd)
Bram Moolenaar812ad4f2016-08-07 14:03:13 +020078 call assert_match('\n(1 of 3): <<<unknown>>> #include <assert.h>', a)
79 call assert_equal('#include <assert.h>', getline('.'))
80 cnext
81 call assert_equal('#include "main.c"', getline('.'))
82 cnext
83 call assert_equal('#include "memfile.c"', getline('.'))
84 call assert_fails('cnext', 'E553:')
85 endfor
86
87 " Test 7: Find the same egrep pattern using lcscope this time.
Bram Moolenaar259f26a2018-05-15 22:25:40 +020088 let a = execute('lcs find e ^\#includ.')
Bram Moolenaar812ad4f2016-08-07 14:03:13 +020089 call assert_match('\n(1 of 3): <<<unknown>>> #include <assert.h>', a)
90 call assert_equal('#include <assert.h>', getline('.'))
91 lnext
92 call assert_equal('#include "main.c"', getline('.'))
93 lnext
94 call assert_equal('#include "memfile.c"', getline('.'))
95 call assert_fails('lnext', 'E553:')
96
97 " Test 8: Find this file
98 for cmd in ['cs find f Xmemfile_test.c', 'cs find 7 Xmemfile_test.c']
99 enew
Bram Moolenaar259f26a2018-05-15 22:25:40 +0200100 let a = execute(cmd)
Bram Moolenaar47922552016-08-30 10:56:50 +0200101 call assert_true(a =~ '"Xmemfile_test.c" \d\+L, \d\+C')
Bram Moolenaar812ad4f2016-08-07 14:03:13 +0200102 call assert_equal('Xmemfile_test.c', @%)
103 endfor
104
105 " Test 9: Find files #including this file
106 for cmd in ['cs find i assert.h', 'cs find 8 assert.h']
107 enew
Bram Moolenaar259f26a2018-05-15 22:25:40 +0200108 let a = execute(cmd)
Bram Moolenaar47922552016-08-30 10:56:50 +0200109 let alines = split(a, '\n', 1)
110 call assert_equal('', alines[0])
111 call assert_true(alines[1] =~ '"Xmemfile_test.c" \d\+L, \d\+C')
112 call assert_equal('(1 of 1): <<global>> #include <assert.h>', alines[2])
Bram Moolenaar812ad4f2016-08-07 14:03:13 +0200113 call assert_equal('#include <assert.h>', getline('.'))
114 endfor
115
116 " Test 10: Invalid find command
117 call assert_fails('cs find x', 'E560:')
118
Bram Moolenaar5feabe02020-01-30 18:24:53 +0100119 if has('float')
120 " Test 11: Find places where this symbol is assigned a value
121 " this needs a cscope >= 15.8
122 " unfortunately, Travis has cscope version 15.7
123 let cscope_version = systemlist('cscope --version')[0]
124 let cs_version = str2float(matchstr(cscope_version, '\d\+\(\.\d\+\)\?'))
125 if cs_version >= 15.8
126 for cmd in ['cs find a item', 'cs find 9 item']
127 let a = execute(cmd)
128 call assert_equal(['', '(1 of 4): <<test_mf_hash>> item = LALLOC_CLEAR_ONE(mf_hashitem_T);'], split(a, '\n', 1))
129 call assert_equal(' item = LALLOC_CLEAR_ONE(mf_hashitem_T);', getline('.'))
130 cnext
131 call assert_equal(' item = mf_hash_find(&ht, key);', getline('.'))
132 cnext
133 call assert_equal(' item = mf_hash_find(&ht, key);', getline('.'))
134 cnext
135 call assert_equal(' item = mf_hash_find(&ht, key);', getline('.'))
136 endfor
137 endif
Bram Moolenaar812ad4f2016-08-07 14:03:13 +0200138 endif
139
140 " Test 12: leading whitespace is not removed for cscope find text
Bram Moolenaar259f26a2018-05-15 22:25:40 +0200141 let a = execute('cscope find t test_mf_hash')
Bram Moolenaar812ad4f2016-08-07 14:03:13 +0200142 call assert_equal(['', '(1 of 1): <<<unknown>>> test_mf_hash();'], split(a, '\n', 1))
143 call assert_equal(' test_mf_hash();', getline('.'))
144
145 " Test 13: test with scscope
Bram Moolenaar259f26a2018-05-15 22:25:40 +0200146 let a = execute('scs find t Bram')
Bram Moolenaar812ad4f2016-08-07 14:03:13 +0200147 call assert_match('(1 of 1): <<<unknown>>> \* VIM - Vi IMproved^Iby Bram Moolenaar', a)
148 call assert_equal(' * VIM - Vi IMproved by Bram Moolenaar', getline('.'))
149
150 " Test 14: cscope help
151 for cmd in ['cs', 'cs help', 'cs xxx']
Bram Moolenaar259f26a2018-05-15 22:25:40 +0200152 let a = execute(cmd)
Bram Moolenaar812ad4f2016-08-07 14:03:13 +0200153 call assert_match('^cscope commands:\n', a)
154 call assert_match('\nadd :', a)
155 call assert_match('\nfind :', a)
156 call assert_match('\nhelp : Show this message', a)
157 call assert_match('\nkill : Kill a connection', a)
158 call assert_match('\nreset: Reinit all connections', a)
159 call assert_match('\nshow : Show connections', a)
160 endfor
Bram Moolenaar259f26a2018-05-15 22:25:40 +0200161 let a = execute('scscope help')
Bram Moolenaar812ad4f2016-08-07 14:03:13 +0200162 call assert_match('This cscope command does not support splitting the window\.', a)
163
164 " Test 15: reset connections
Bram Moolenaar259f26a2018-05-15 22:25:40 +0200165 let a = execute('cscope reset')
Bram Moolenaar812ad4f2016-08-07 14:03:13 +0200166 call assert_match('\nAdded cscope database.*Xcscope.out (#0)', a)
167 call assert_match('\nAll cscope databases reset', a)
168
169 " Test 16: cscope show
Bram Moolenaar259f26a2018-05-15 22:25:40 +0200170 let a = execute('cscope show')
Bram Moolenaar812ad4f2016-08-07 14:03:13 +0200171 call assert_match('\n 0 \d\+.*Xcscope.out\s*<none>', a)
172
173 " Test 17: cstag and 'csto' option
174 set csto=0
Bram Moolenaar259f26a2018-05-15 22:25:40 +0200175 let a = execute('cstag TEST_COUNT')
Bram Moolenaar812ad4f2016-08-07 14:03:13 +0200176 call assert_match('(1 of 1): <<TEST_COUNT>> #define TEST_COUNT 50000', a)
177 call assert_equal('#define TEST_COUNT 50000', getline('.'))
178 set csto=1
Bram Moolenaar259f26a2018-05-15 22:25:40 +0200179 let a = execute('cstag index_to_key')
Bram Moolenaar812ad4f2016-08-07 14:03:13 +0200180 call assert_match('(1 of 1): <<index_to_key>> #define index_to_key(i) ((i) ^ 15167)', a)
181 call assert_equal('#define index_to_key(i) ((i) ^ 15167)', getline('.'))
182 call assert_fails('cstag xxx', 'E257:')
183 call assert_fails('cstag', 'E562:')
184
185 " Test 18: 'cst' option
186 set nocst
187 call assert_fails('tag TEST_COUNT', 'E426:')
188 set cst
Bram Moolenaar259f26a2018-05-15 22:25:40 +0200189 let a = execute('tag TEST_COUNT')
Bram Moolenaar812ad4f2016-08-07 14:03:13 +0200190 call assert_match('(1 of 1): <<TEST_COUNT>> #define TEST_COUNT 50000', a)
191 call assert_equal('#define TEST_COUNT 50000', getline('.'))
Bram Moolenaar259f26a2018-05-15 22:25:40 +0200192 let a = execute('tags')
Bram Moolenaar812ad4f2016-08-07 14:03:13 +0200193 call assert_match('1 1 TEST_COUNT\s\+\d\+\s\+#define index_to_key', a)
194
195 " Test 19: this should trigger call to cs_print_tags()
196 " Unclear how to check result though, we just exercise the code.
197 set cst cscopequickfix=s0
198 call feedkeys(":cs find s main\<CR>", 't')
199
200 " Test 20: cscope kill
201 call assert_fails('cscope kill 2', 'E261:')
202 call assert_fails('cscope kill xxx', 'E261:')
203
Bram Moolenaar259f26a2018-05-15 22:25:40 +0200204 let a = execute('cscope kill 0')
Bram Moolenaar812ad4f2016-08-07 14:03:13 +0200205 call assert_match('cscope connection 0 closed', a)
206
207 cscope add Xcscope.out
Bram Moolenaar259f26a2018-05-15 22:25:40 +0200208 let a = execute('cscope kill Xcscope.out')
Bram Moolenaar812ad4f2016-08-07 14:03:13 +0200209 call assert_match('cscope connection Xcscope.out closed', a)
210
211 cscope add Xcscope.out .
Bram Moolenaar259f26a2018-05-15 22:25:40 +0200212 let a = execute('cscope kill -1')
Bram Moolenaar812ad4f2016-08-07 14:03:13 +0200213 call assert_match('cscope connection .*Xcscope.out closed', a)
Bram Moolenaar259f26a2018-05-15 22:25:40 +0200214 let a = execute('cscope kill -1')
Bram Moolenaar812ad4f2016-08-07 14:03:13 +0200215 call assert_equal('', a)
216
217 " Test 21: 'csprg' option
218 call assert_equal('cscope', &csprg)
219 set csprg=doesnotexist
220 call assert_fails('cscope add Xcscope2.out', 'E609:')
221 set csprg=cscope
222
223 " Test 22: multiple cscope connections
224 cscope add Xcscope.out
225 cscope add Xcscope2.out . -C
Bram Moolenaar259f26a2018-05-15 22:25:40 +0200226 let a = execute('cscope show')
Bram Moolenaar812ad4f2016-08-07 14:03:13 +0200227 call assert_match('\n 0 \d\+.*Xcscope.out\s*<none>', a)
228 call assert_match('\n 1 \d\+.*Xcscope2.out\s*\.', a)
229
230 " Test 23: test Ex command line completion
231 call feedkeys(":cs \<C-A>\<C-B>\"\<CR>", 'tx')
232 call assert_equal('"cs add find help kill reset show', @:)
233
234 call feedkeys(":scs \<C-A>\<C-B>\"\<CR>", 'tx')
235 call assert_equal('"scs find', @:)
236
237 call feedkeys(":cs find \<C-A>\<C-B>\"\<CR>", 'tx')
238 call assert_equal('"cs find a c d e f g i s t', @:)
239
240 call feedkeys(":cs kill \<C-A>\<C-B>\"\<CR>", 'tx')
241 call assert_equal('"cs kill -1 0 1', @:)
242
243 call feedkeys(":cs add Xcscope\<C-A>\<C-B>\"\<CR>", 'tx')
244 call assert_equal('"cs add Xcscope.out Xcscope2.out', @:)
245
246 " Test 24: cscope_connection()
247 call assert_equal(cscope_connection(), 1)
248 call assert_equal(cscope_connection(0, 'out'), 1)
249 call assert_equal(cscope_connection(0, 'xxx'), 1)
250 call assert_equal(cscope_connection(1, 'out'), 1)
251 call assert_equal(cscope_connection(1, 'xxx'), 0)
252 call assert_equal(cscope_connection(2, 'out'), 0)
253 call assert_equal(cscope_connection(3, 'xxx', '..'), 0)
254 call assert_equal(cscope_connection(3, 'out', 'xxx'), 0)
255 call assert_equal(cscope_connection(3, 'out', '.'), 1)
256 call assert_equal(cscope_connection(4, 'out', '.'), 0)
257
258 " CleanUp
259 call CscopeSetupOrClean(0)
Bram Moolenaar2196bca2018-07-15 17:36:32 +0200260endfunc
Bram Moolenaar812ad4f2016-08-07 14:03:13 +0200261
Bram Moolenaar2196bca2018-07-15 17:36:32 +0200262" Test ":cs add {dir}" (add the {dir}/cscope.out database)
263func Test_cscope_add_dir()
264 call mkdir('Xcscopedir', 'p')
Bram Moolenaar320bf2d2018-08-22 20:06:26 +0200265
266 " Cscope doesn't handle symlinks, so this needs to be resolved in case a
267 " shadow directory is being used.
268 let memfile = resolve('../memfile_test.c')
269 call system('cscope -bk -fXcscopedir/cscope.out ' . memfile)
270
Bram Moolenaar2196bca2018-07-15 17:36:32 +0200271 cs add Xcscopedir
272 let a = execute('cscope show')
273 let lines = split(a, "\n", 1)
274 call assert_equal(3, len(lines))
275 call assert_equal(' # pid database name prepend path', lines[0])
276 call assert_equal('', lines[1])
277 call assert_match('^ 0 \d\+.*Xcscopedir/cscope.out\s\+<none>$', lines[2])
278
279 cs kill -1
280 call delete('Xcscopedir/cscope.out')
281 call assert_fails('cs add Xcscopedir', 'E563:')
282
283 call delete('Xcscopedir', 'd')
Bram Moolenaar812ad4f2016-08-07 14:03:13 +0200284endfunc
285
Bram Moolenaar6d20e172016-07-13 22:44:12 +0200286func Test_cscopequickfix()
287 set cscopequickfix=s-,g-,d+,c-,t+,e-,f0,i-,a-
288 call assert_equal('s-,g-,d+,c-,t+,e-,f0,i-,a-', &cscopequickfix)
289
290 call assert_fails('set cscopequickfix=x-', 'E474:')
291 call assert_fails('set cscopequickfix=s', 'E474:')
292 call assert_fails('set cscopequickfix=s7', 'E474:')
293 call assert_fails('set cscopequickfix=s-a', 'E474:')
294endfunc
Bram Moolenaaredf634e2016-08-02 23:01:40 +0200295
Bram Moolenaar812ad4f2016-08-07 14:03:13 +0200296func Test_withoutCscopeConnection()
297 call assert_equal(cscope_connection(), 0)
298
299 call assert_fails('cscope find s main', 'E567:')
Bram Moolenaar259f26a2018-05-15 22:25:40 +0200300 let a = execute('cscope show')
Bram Moolenaar812ad4f2016-08-07 14:03:13 +0200301 call assert_match('no cscope connections', a)
Bram Moolenaaredf634e2016-08-02 23:01:40 +0200302endfunc
303
Bram Moolenaaredf634e2016-08-02 23:01:40 +0200304
305" vim: shiftwidth=2 sts=2 expandtab