1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
|
# encoding: utf-8
#
# Copyright (C) 2015-2016 YouCompleteMe contributors
#
# This file is part of YouCompleteMe.
#
# YouCompleteMe is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# YouCompleteMe is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with YouCompleteMe. If not, see <http://www.gnu.org/licenses/>.
from ycm.tests.test_utils import MockVimModule
MockVimModule()
import contextlib
import json
from hamcrest import assert_that, contains_exactly, empty, equal_to, none
from unittest import TestCase
from unittest.mock import MagicMock, DEFAULT, patch
from ycm import vimsupport
from ycmd.utils import ToBytes
from ycm.client.completion_request import ( CompletionRequest,
_FilterToMatchingCompletions,
_GetRequiredNamespaceImport )
from ycm.client.omni_completion_request import OmniCompletionRequest
def CompleteItemIs( word, abbr = None, menu = None,
info = None, kind = None, **kwargs ):
item = {
'word': ToBytes( word ),
'abbr': ToBytes( abbr ),
'menu': ToBytes( menu ),
'info': ToBytes( info ),
'kind': ToBytes( kind ),
}
item.update( **kwargs )
return item
def GetVariableValue_CompleteItemIs( word, abbr = None, menu = None,
info = None, kind = None, **kwargs ):
def Result( variable ):
if variable == 'v:completed_item':
return CompleteItemIs( word, abbr, menu, info, kind, **kwargs )
return DEFAULT
return MagicMock( side_effect = Result )
def BuildCompletion( insertion_text = 'Test',
menu_text = None,
extra_menu_info = None,
detailed_info = None,
kind = None,
extra_data = None ):
completion = {
'insertion_text': insertion_text
}
if extra_menu_info:
completion[ 'extra_menu_info' ] = extra_menu_info
if menu_text:
completion[ 'menu_text' ] = menu_text
if detailed_info:
completion[ 'detailed_info' ] = detailed_info
if kind:
completion[ 'kind' ] = kind
if extra_data:
completion[ 'extra_data' ] = extra_data
return completion
def BuildCompletionNamespace( namespace = None,
insertion_text = 'Test',
menu_text = None,
extra_menu_info = None,
detailed_info = None,
kind = None ):
return BuildCompletion( insertion_text = insertion_text,
menu_text = menu_text,
extra_menu_info = extra_menu_info,
detailed_info = detailed_info,
kind = kind,
extra_data = {
'required_namespace_import': namespace
} )
def BuildCompletionFixIt( fixits,
insertion_text = 'Test',
menu_text = None,
extra_menu_info = None,
detailed_info = None,
kind = None ):
return BuildCompletion( insertion_text = insertion_text,
menu_text = menu_text,
extra_menu_info = extra_menu_info,
detailed_info = detailed_info,
kind = kind,
extra_data = {
'fixits': fixits,
} )
@contextlib.contextmanager
def _SetupForCsharpCompletionDone( completions ):
with patch( 'ycm.vimsupport.InsertNamespace' ):
with _SetUpCompleteDone( completions ) as request:
yield request
@contextlib.contextmanager
def _SetUpCompleteDone( completions ):
with patch( 'ycm.vimsupport.TextBeforeCursor', return_value = ' Test' ):
request = CompletionRequest( None )
request.Done = MagicMock( return_value = True )
request._RawResponse = MagicMock( return_value = {
'completions': completions
} )
yield request
class PostcompleteTest( TestCase ):
@patch( 'ycm.vimsupport.CurrentFiletypes', return_value = [ 'ycmtest' ] )
def test_OnCompleteDone_DefaultFixIt( self, *args ):
request = CompletionRequest( None )
request.Done = MagicMock( return_value = True )
request._OnCompleteDone_Csharp = MagicMock()
request._OnCompleteDone_FixIt = MagicMock()
request.OnCompleteDone()
request._OnCompleteDone_Csharp.assert_not_called()
request._OnCompleteDone_FixIt.assert_called_once_with()
@patch( 'ycm.vimsupport.CurrentFiletypes', return_value = [ 'cs' ] )
def test_OnCompleteDone_CsharpFixIt( self, *args ):
request = CompletionRequest( None )
request.Done = MagicMock( return_value = True )
request._OnCompleteDone_Csharp = MagicMock()
request._OnCompleteDone_FixIt = MagicMock()
request.OnCompleteDone()
request._OnCompleteDone_Csharp.assert_called_once_with()
request._OnCompleteDone_FixIt.assert_not_called()
@patch( 'ycm.vimsupport.CurrentFiletypes', return_value = [ 'ycmtest' ] )
def test_OnCompleteDone_NoFixItIfNotDone( self, *args ):
request = CompletionRequest( None )
request.Done = MagicMock( return_value = False )
request._OnCompleteDone_Csharp = MagicMock()
request._OnCompleteDone_FixIt = MagicMock()
request.OnCompleteDone()
request._OnCompleteDone_Csharp.assert_not_called()
request._OnCompleteDone_FixIt.assert_not_called()
@patch( 'ycm.vimsupport.CurrentFiletypes', return_value = [ 'ycmtest' ] )
def test_OnCompleteDone_NoFixItForOmnifunc( self, *args ):
request = OmniCompletionRequest( 'omnifunc', None )
request.Done = MagicMock( return_value = True )
request._OnCompleteDone_Csharp = MagicMock()
request._OnCompleteDone_FixIt = MagicMock()
request.OnCompleteDone()
request._OnCompleteDone_Csharp.assert_not_called()
request._OnCompleteDone_FixIt.assert_not_called()
def test_FilterToCompletedCompletions_MatchIsReturned( self ):
completions = [ BuildCompletion( insertion_text = 'Test' ) ]
result = _FilterToMatchingCompletions( CompleteItemIs( 'Test' ),
completions )
assert_that( list( result ), contains_exactly( {} ) )
def test_FilterToCompletedCompletions_ShortTextDoesntRaise( self ):
completions = [ BuildCompletion( insertion_text = 'AAA' ) ]
result = _FilterToMatchingCompletions( CompleteItemIs( 'A' ), completions )
assert_that( list( result ), empty() )
def test_FilterToCompletedCompletions_ExactMatchIsReturned( self ):
completions = [ BuildCompletion( insertion_text = 'Test' ) ]
result = _FilterToMatchingCompletions( CompleteItemIs( 'Test' ),
completions )
assert_that( list( result ), contains_exactly( {} ) )
def test_FilterToCompletedCompletions_NonMatchIsntReturned( self ):
completions = [ BuildCompletion( insertion_text = 'A' ) ]
result = _FilterToMatchingCompletions( CompleteItemIs( ' Quote' ),
completions )
assert_that( list( result ), empty() )
def test_FilterToCompletedCompletions_Unicode( self ):
completions = [ BuildCompletion( insertion_text = '†es†' ) ]
result = _FilterToMatchingCompletions( CompleteItemIs( '†es†' ),
completions )
assert_that( list( result ), contains_exactly( {} ) )
def test_GetRequiredNamespaceImport_ReturnNoneForNoExtraData( self ):
assert_that( _GetRequiredNamespaceImport( {} ), none() )
def test_GetRequiredNamespaceImport_ReturnNamespaceFromExtraData( self ):
namespace = 'A_NAMESPACE'
assert_that( _GetRequiredNamespaceImport(
BuildCompletionNamespace( namespace )[ 'extra_data' ] ),
equal_to( namespace ) )
@patch( 'ycm.vimsupport.GetVariableValue',
GetVariableValue_CompleteItemIs( 'Te' ) )
def test_GetExtraDataUserMayHaveCompleted_ReturnEmptyIfPendingMatches(
*args ):
completions = [ BuildCompletionNamespace( None ) ]
with _SetupForCsharpCompletionDone( completions ) as request:
assert_that( request._GetExtraDataUserMayHaveCompleted(), empty() )
def test_GetExtraDataUserMayHaveCompleted_ReturnMatchIfExactMatches(
self, *args ):
info = [ 'NS', 'Test', 'Abbr', 'Menu', 'Info', 'Kind' ]
completions = [ BuildCompletionNamespace( *info ) ]
with _SetupForCsharpCompletionDone( completions ) as request:
with patch( 'ycm.vimsupport.GetVariableValue',
GetVariableValue_CompleteItemIs( *info[ 1: ] ) ):
assert_that( request._GetExtraDataUserMayHaveCompleted(),
contains_exactly( completions[ 0 ][ 'extra_data' ] ) )
def test_GetExtraDataUserMayHaveCompleted_ReturnMatchIfExactMatchesEvenIfPartial( self ): # noqa
info = [ 'NS', 'Test', 'Abbr', 'Menu', 'Info', 'Kind' ]
completions = [ BuildCompletionNamespace( *info ),
BuildCompletion( insertion_text = 'TestTest' ) ]
with _SetupForCsharpCompletionDone( completions ) as request:
with patch( 'ycm.vimsupport.GetVariableValue',
GetVariableValue_CompleteItemIs( *info[ 1: ] ) ):
assert_that( request._GetExtraDataUserMayHaveCompleted(),
contains_exactly( completions[ 0 ][ 'extra_data' ] ) )
def test_GetExtraDataUserMayHaveCompleted_DontReturnMatchIfNoExactMatchesAndPartial( self ): # noqa
info = [ 'NS', 'Test', 'Abbr', 'Menu', 'Info', 'Kind' ]
completions = [ BuildCompletion( insertion_text = info[ 0 ] ),
BuildCompletion( insertion_text = 'TestTest' ) ]
with _SetupForCsharpCompletionDone( completions ) as request:
with patch( 'ycm.vimsupport.GetVariableValue',
GetVariableValue_CompleteItemIs( *info[ 1: ] ) ):
assert_that( request._GetExtraDataUserMayHaveCompleted(), empty() )
@patch( 'ycm.vimsupport.GetVariableValue',
GetVariableValue_CompleteItemIs( 'Test' ) )
def test_GetExtraDataUserMayHaveCompleted_ReturnMatchIfMatches( self, *args ):
completions = [ BuildCompletionNamespace( None ) ]
with _SetupForCsharpCompletionDone( completions ) as request:
assert_that( request._GetExtraDataUserMayHaveCompleted(),
contains_exactly( completions[ 0 ][ 'extra_data' ] ) )
@patch( 'ycm.vimsupport.GetVariableValue',
GetVariableValue_CompleteItemIs(
'Test',
user_data=json.dumps( {
'required_namespace_import': 'namespace1' } ) ) )
def test_GetExtraDataUserMayHaveCompleted_UseUserData0( self, *args ):
# Identical completions but we specify the first one via user_data.
completions = [
BuildCompletionNamespace( 'namespace1' ),
BuildCompletionNamespace( 'namespace2' )
]
with _SetupForCsharpCompletionDone( completions ) as request:
assert_that(
request._GetExtraDataUserMayHaveCompleted(),
contains_exactly(
BuildCompletionNamespace( 'namespace1' )[ 'extra_data' ] ) )
@patch( 'ycm.vimsupport.GetVariableValue',
GetVariableValue_CompleteItemIs(
'Test',
user_data=json.dumps( {
'required_namespace_import': 'namespace2' } ) ) )
def test_GetExtraDataUserMayHaveCompleted_UseUserData1( self, *args ):
# Identical completions but we specify the second one via user_data.
completions = [
BuildCompletionNamespace( 'namespace1' ),
BuildCompletionNamespace( 'namespace2' )
]
with _SetupForCsharpCompletionDone( completions ) as request:
assert_that(
request._GetExtraDataUserMayHaveCompleted(),
contains_exactly(
BuildCompletionNamespace( 'namespace2' )[ 'extra_data' ] ) )
@patch( 'ycm.vimsupport.GetVariableValue',
GetVariableValue_CompleteItemIs( 'Test', user_data='' ) )
def test_GetExtraDataUserMayHaveCompleted_EmptyUserData( self, *args ):
# Identical completions but none is selected.
completions = [
BuildCompletionNamespace( 'namespace1' ),
BuildCompletionNamespace( 'namespace2' )
]
with _SetupForCsharpCompletionDone( completions ) as request:
assert_that( request._GetExtraDataUserMayHaveCompleted(), empty() )
@patch( 'ycm.vimsupport.GetVariableValue',
GetVariableValue_CompleteItemIs( 'Test' ) )
def test_PostCompleteCsharp_EmptyDoesntInsertNamespace( self, *args ):
with _SetupForCsharpCompletionDone( [] ) as request:
request._OnCompleteDone_Csharp()
assert_that( not vimsupport.InsertNamespace.called )
@patch( 'ycm.vimsupport.GetVariableValue',
GetVariableValue_CompleteItemIs( 'Test' ) )
def test_PostCompleteCsharp_ExistingWithoutNamespaceDoesntInsertNamespace(
self, *args ):
completions = [ BuildCompletionNamespace( None ) ]
with _SetupForCsharpCompletionDone( completions ) as request:
request._OnCompleteDone_Csharp()
assert_that( not vimsupport.InsertNamespace.called )
@patch( 'ycm.vimsupport.GetVariableValue',
GetVariableValue_CompleteItemIs( 'Test' ) )
def test_PostCompleteCsharp_ValueDoesInsertNamespace( self, *args ):
namespace = 'A_NAMESPACE'
completions = [ BuildCompletionNamespace( namespace ) ]
with _SetupForCsharpCompletionDone( completions ) as request:
request._OnCompleteDone_Csharp()
vimsupport.InsertNamespace.assert_called_once_with( namespace )
@patch( 'ycm.vimsupport.GetVariableValue',
GetVariableValue_CompleteItemIs( 'Test' ) )
@patch( 'ycm.vimsupport.PresentDialog', return_value = 1 )
def test_PostCompleteCsharp_InsertSecondNamespaceIfSelected( self, *args ):
namespace = 'A_NAMESPACE'
namespace2 = 'ANOTHER_NAMESPACE'
completions = [
BuildCompletionNamespace( namespace ),
BuildCompletionNamespace( namespace2 ),
]
with _SetupForCsharpCompletionDone( completions ) as request:
request._OnCompleteDone_Csharp()
vimsupport.InsertNamespace.assert_called_once_with( namespace2 )
@patch( 'ycm.vimsupport.GetVariableValue',
GetVariableValue_CompleteItemIs( 'Test' ) )
@patch( 'ycm.vimsupport.ReplaceChunks' )
def test_PostCompleteFixIt_ApplyFixIt_NoFixIts( self, replace_chunks, *args ):
completions = [
BuildCompletionFixIt( [] )
]
with _SetUpCompleteDone( completions ) as request:
request._OnCompleteDone_FixIt()
replace_chunks.assert_not_called()
@patch( 'ycm.vimsupport.GetVariableValue',
GetVariableValue_CompleteItemIs( 'Test' ) )
@patch( 'ycm.vimsupport.ReplaceChunks' )
def test_PostCompleteFixIt_ApplyFixIt_EmptyFixIt(
self, replace_chunks, *args ):
completions = [
BuildCompletionFixIt( [ { 'chunks': [] } ] )
]
with _SetUpCompleteDone( completions ) as request:
request._OnCompleteDone_FixIt()
replace_chunks.assert_called_once_with( [], silent = True )
@patch( 'ycm.vimsupport.GetVariableValue',
GetVariableValue_CompleteItemIs( 'Test' ) )
@patch( 'ycm.vimsupport.ReplaceChunks' )
def test_PostCompleteFixIt_ApplyFixIt_NoFixIt( self, replace_chunks, *args ):
completions = [
BuildCompletion()
]
with _SetUpCompleteDone( completions ) as request:
request._OnCompleteDone_FixIt()
replace_chunks.assert_not_called()
@patch( 'ycm.vimsupport.GetVariableValue',
GetVariableValue_CompleteItemIs( 'Test' ) )
@patch( 'ycm.vimsupport.ReplaceChunks' )
def test_PostCompleteFixIt_ApplyFixIt_PickFirst(
self, replace_chunks, *args ):
completions = [
BuildCompletionFixIt( [ { 'chunks': 'one' } ] ),
BuildCompletionFixIt( [ { 'chunks': 'two' } ] ),
]
with _SetUpCompleteDone( completions ) as request:
request._OnCompleteDone_FixIt()
replace_chunks.assert_called_once_with( 'one', silent = True )
@patch( 'ycm.vimsupport.GetVariableValue',
GetVariableValue_CompleteItemIs(
'Test',
user_data=json.dumps( { 'fixits': [ { 'chunks': 'one' } ] } ) ) )
@patch( 'ycm.vimsupport.ReplaceChunks' )
def test_PostCompleteFixIt_ApplyFixIt_PickFirstUserData( self,
replace_chunks,
*args ):
completions = [
BuildCompletionFixIt( [ { 'chunks': 'one' } ] ),
BuildCompletionFixIt( [ { 'chunks': 'two' } ] ),
]
with _SetUpCompleteDone( completions ) as request:
request._OnCompleteDone_FixIt()
replace_chunks.assert_called_once_with( 'one', silent = True )
@patch( 'ycm.vimsupport.GetVariableValue',
GetVariableValue_CompleteItemIs(
'Test',
user_data=json.dumps( { 'fixits': [ { 'chunks': 'two' } ] } ) ) )
@patch( 'ycm.vimsupport.ReplaceChunks' )
def test_PostCompleteFixIt_ApplyFixIt_PickSecond(
self, replace_chunks, *args ):
completions = [
BuildCompletionFixIt( [ { 'chunks': 'one' } ] ),
BuildCompletionFixIt( [ { 'chunks': 'two' } ] ),
]
with _SetUpCompleteDone( completions ) as request:
request._OnCompleteDone_FixIt()
replace_chunks.assert_called_once_with( 'two', silent = True )
|
