293 lines
9.6 KiB
Python
293 lines
9.6 KiB
Python
# Copyright (C) 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 __future__ import unicode_literals
|
|
from __future__ import print_function
|
|
from __future__ import division
|
|
from __future__ import absolute_import
|
|
from future import standard_library
|
|
standard_library.install_aliases()
|
|
from builtins import * # noqa
|
|
|
|
from ycm.tests.test_utils import ExtendedMock, MockVimModule
|
|
MockVimModule()
|
|
|
|
import json
|
|
from mock import patch, call
|
|
from nose.tools import ok_
|
|
from ycm.client.command_request import CommandRequest
|
|
|
|
|
|
class GoToResponse_QuickFix_test( object ):
|
|
"""This class tests the generation of QuickFix lists for GoTo responses which
|
|
return multiple locations, such as the Python completer and JavaScript
|
|
completer. It mostly proves that we use 1-based indexing for the column
|
|
number."""
|
|
|
|
def setUp( self ):
|
|
self._request = CommandRequest( [ 'GoToTest' ] )
|
|
|
|
|
|
def tearDown( self ):
|
|
self._request = None
|
|
|
|
|
|
def GoTo_EmptyList_test( self ):
|
|
self._CheckGoToList( [], [] )
|
|
|
|
|
|
def GoTo_SingleItem_List_test( self ):
|
|
self._CheckGoToList( [ {
|
|
'filepath': 'dummy_file',
|
|
'line_num': 10,
|
|
'column_num': 1,
|
|
'description': 'this is some text',
|
|
} ], [ {
|
|
'filename': 'dummy_file',
|
|
'text': 'this is some text',
|
|
'lnum': 10,
|
|
'col': 1
|
|
} ] )
|
|
|
|
|
|
def GoTo_MultiItem_List_test( self ):
|
|
self._CheckGoToList( [ {
|
|
'filepath': 'dummy_file',
|
|
'line_num': 10,
|
|
'column_num': 1,
|
|
'description': 'this is some other text',
|
|
}, {
|
|
'filepath': 'dummy_file2',
|
|
'line_num': 1,
|
|
'column_num': 21,
|
|
'description': 'this is some text',
|
|
} ], [ {
|
|
'filename': 'dummy_file',
|
|
'text': 'this is some other text',
|
|
'lnum': 10,
|
|
'col': 1
|
|
}, {
|
|
'filename': 'dummy_file2',
|
|
'text': 'this is some text',
|
|
'lnum': 1,
|
|
'col': 21
|
|
} ] )
|
|
|
|
|
|
@patch( 'ycm.vimsupport.VariableExists', return_value = True )
|
|
@patch( 'ycm.vimsupport.SetFittingHeightForCurrentWindow' )
|
|
@patch( 'vim.command', new_callable = ExtendedMock )
|
|
@patch( 'vim.eval', new_callable = ExtendedMock )
|
|
def _CheckGoToList( self,
|
|
completer_response,
|
|
expected_qf_list,
|
|
vim_eval,
|
|
vim_command,
|
|
set_fitting_height,
|
|
variable_exists ):
|
|
self._request._response = completer_response
|
|
|
|
self._request.RunPostCommandActionsIfNeeded()
|
|
|
|
vim_eval.assert_has_exact_calls( [
|
|
call( 'setqflist( {0} )'.format( json.dumps( expected_qf_list ) ) )
|
|
] )
|
|
vim_command.assert_has_exact_calls( [
|
|
call( 'botright copen' ),
|
|
call( 'au WinLeave <buffer> q' ),
|
|
call( 'doautocmd User YcmQuickFixOpened' )
|
|
] )
|
|
set_fitting_height.assert_called_once_with()
|
|
|
|
|
|
class Response_Detection_test( object ):
|
|
|
|
def BasicResponse_test( self ):
|
|
def _BasicResponseTest( command, response ):
|
|
with patch( 'vim.command' ) as vim_command:
|
|
request = CommandRequest( [ command ] )
|
|
request._response = response
|
|
request.RunPostCommandActionsIfNeeded()
|
|
vim_command.assert_called_with( "echo '{0}'".format( response ) )
|
|
|
|
tests = [
|
|
[ 'AnythingYouLike', True ],
|
|
[ 'GoToEvenWorks', 10 ],
|
|
[ 'FixItWorks', 'String!' ],
|
|
[ 'and8434fd andy garbag!', 10.3 ],
|
|
]
|
|
|
|
for test in tests:
|
|
yield _BasicResponseTest, test[ 0 ], test[ 1 ]
|
|
|
|
|
|
def FixIt_Response_Empty_test( self ):
|
|
# Ensures we recognise and handle fixit responses which indicate that there
|
|
# are no fixits available
|
|
def EmptyFixItTest( command ):
|
|
with patch( 'ycm.vimsupport.ReplaceChunks' ) as replace_chunks:
|
|
with patch( 'ycm.vimsupport.PostVimMessage' ) as post_vim_message:
|
|
request = CommandRequest( [ command ] )
|
|
request._response = {
|
|
'fixits': []
|
|
}
|
|
request.RunPostCommandActionsIfNeeded()
|
|
|
|
post_vim_message.assert_called_with(
|
|
'No fixits found for current line', warning = False )
|
|
replace_chunks.assert_not_called()
|
|
|
|
for test in [ 'FixIt', 'Refactor', 'GoToHell', 'any_old_garbade!!!21' ]:
|
|
yield EmptyFixItTest, test
|
|
|
|
|
|
def FixIt_Response_test( self ):
|
|
# Ensures we recognise and handle fixit responses with some dummy chunk data
|
|
def FixItTest( command, response, chunks, selection ):
|
|
with patch( 'ycm.vimsupport.ReplaceChunks' ) as replace_chunks:
|
|
with patch( 'ycm.vimsupport.PostVimMessage' ) as post_vim_message:
|
|
with patch( 'ycm.vimsupport.SelectFromList',
|
|
return_value = selection ):
|
|
request = CommandRequest( [ command ] )
|
|
request._response = response
|
|
request.RunPostCommandActionsIfNeeded()
|
|
|
|
replace_chunks.assert_called_with( chunks )
|
|
post_vim_message.assert_not_called()
|
|
|
|
basic_fixit = {
|
|
'fixits': [ {
|
|
'chunks': [ {
|
|
'dummy chunk contents': True
|
|
} ]
|
|
} ]
|
|
}
|
|
basic_fixit_chunks = basic_fixit[ 'fixits' ][ 0 ][ 'chunks' ]
|
|
|
|
multi_fixit = {
|
|
'fixits': [ {
|
|
'text': 'first',
|
|
'chunks': [ {
|
|
'dummy chunk contents': True
|
|
} ]
|
|
}, {
|
|
'text': 'second',
|
|
'chunks': [ {
|
|
'dummy chunk contents': False
|
|
}]
|
|
} ]
|
|
}
|
|
multi_fixit_first_chunks = multi_fixit[ 'fixits' ][ 0 ][ 'chunks' ]
|
|
multi_fixit_second_chunks = multi_fixit[ 'fixits' ][ 1 ][ 'chunks' ]
|
|
|
|
tests = [
|
|
[ 'AnythingYouLike', basic_fixit, basic_fixit_chunks, 0 ],
|
|
[ 'GoToEvenWorks', basic_fixit, basic_fixit_chunks, 0 ],
|
|
[ 'FixItWorks', basic_fixit, basic_fixit_chunks, 0 ],
|
|
[ 'and8434fd andy garbag!', basic_fixit, basic_fixit_chunks, 0 ],
|
|
[ 'select from multiple 1', multi_fixit, multi_fixit_first_chunks, 0 ],
|
|
[ 'select from multiple 2', multi_fixit, multi_fixit_second_chunks, 1 ],
|
|
]
|
|
|
|
for test in tests:
|
|
yield FixItTest, test[ 0 ], test[ 1 ], test[ 2 ], test[ 3 ]
|
|
|
|
|
|
def Message_Response_test( self ):
|
|
# Ensures we correctly recognise and handle responses with a message to show
|
|
# to the user
|
|
|
|
def MessageTest( command, message ):
|
|
with patch( 'ycm.vimsupport.PostVimMessage' ) as post_vim_message:
|
|
request = CommandRequest( [ command ] )
|
|
request._response = { 'message': message }
|
|
request.RunPostCommandActionsIfNeeded()
|
|
post_vim_message.assert_called_with( message, warning = False )
|
|
|
|
tests = [
|
|
[ '___________', 'This is a message' ],
|
|
[ '', 'this is also a message' ],
|
|
[ 'GetType', 'std::string' ],
|
|
]
|
|
|
|
for test in tests:
|
|
yield MessageTest, test[ 0 ], test[ 1 ]
|
|
|
|
|
|
def Detailed_Info_test( self ):
|
|
# Ensures we correctly detect and handle detailed_info responses which are
|
|
# used to display information in the preview window
|
|
|
|
def DetailedInfoTest( command, info ):
|
|
with patch( 'ycm.vimsupport.WriteToPreviewWindow' ) as write_to_preview:
|
|
request = CommandRequest( [ command ] )
|
|
request._response = { 'detailed_info': info }
|
|
request.RunPostCommandActionsIfNeeded()
|
|
write_to_preview.assert_called_with( info )
|
|
|
|
tests = [
|
|
[ '___________', 'This is a message' ],
|
|
[ '', 'this is also a message' ],
|
|
[ 'GetDoc', 'std::string\netc\netc' ],
|
|
]
|
|
|
|
for test in tests:
|
|
yield DetailedInfoTest, test[ 0 ], test[ 1 ]
|
|
|
|
|
|
def GoTo_Single_test( self ):
|
|
# Ensures we handle any unknown type of response as a GoTo response
|
|
|
|
def GoToTest( command, response ):
|
|
with patch( 'ycm.vimsupport.JumpToLocation' ) as jump_to_location:
|
|
request = CommandRequest( [ command ] )
|
|
request._response = response
|
|
request.RunPostCommandActionsIfNeeded()
|
|
jump_to_location.assert_called_with(
|
|
response[ 'filepath' ],
|
|
response[ 'line_num' ],
|
|
response[ 'column_num' ] )
|
|
|
|
def GoToListTest( command, response ):
|
|
# Note: the detail of these called are tested by
|
|
# GoToResponse_QuickFix_test, so here we just check that the right call is
|
|
# made
|
|
with patch( 'ycm.vimsupport.SetQuickFixList' ) as set_qf_list:
|
|
request = CommandRequest( [ command ] )
|
|
request._response = response
|
|
request.RunPostCommandActionsIfNeeded()
|
|
ok_( set_qf_list.called )
|
|
|
|
basic_goto = {
|
|
'filepath': 'test',
|
|
'line_num': 10,
|
|
'column_num': 100,
|
|
}
|
|
|
|
tests = [
|
|
[ GoToTest, 'AnythingYouLike', basic_goto ],
|
|
[ GoToTest, 'GoTo', basic_goto ],
|
|
[ GoToTest, 'FindAThing', basic_goto ],
|
|
[ GoToTest, 'FixItGoto', basic_goto ],
|
|
[ GoToListTest, 'AnythingYouLike', [ basic_goto ] ],
|
|
[ GoToListTest, 'GoTo', [] ],
|
|
[ GoToListTest, 'FixItGoto', [ basic_goto, basic_goto ] ],
|
|
]
|
|
|
|
for test in tests:
|
|
yield test[ 0 ], test[ 1 ], test[ 2 ]
|