c92b4ac0ff
assert_has_calls is not enough to check if a call didn't raise a warning. We also need to check the number of calls. This is done by creating a subclass of MagicMock implementing the assert_has_exact_calls method.
127 lines
3.9 KiB
Python
127 lines
3.9 KiB
Python
#!/usr/bin/env python
|
|
#
|
|
# Copyright (C) 2011, 2012 Google Inc.
|
|
#
|
|
# 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 mock import MagicMock
|
|
from hamcrest import assert_that, equal_to
|
|
import re
|
|
import sys
|
|
|
|
|
|
BUFNR_REGEX = re.compile( r"^bufnr\('(.+)', ([0-9]+)\)$" )
|
|
BUFWINNR_REGEX = re.compile( r"^bufwinnr\(([0-9]+)\)$" )
|
|
BWIPEOUT_REGEX = re.compile( r"^(?:silent! )bwipeout!? ([0-9]+)$" )
|
|
|
|
# One-and only instance of mocked Vim object. The first 'import vim' that is
|
|
# executed binds the vim module to the instance of MagicMock that is created,
|
|
# and subsquent assignments to sys.modules[ 'vim' ] don't retrospectively
|
|
# update them. The result is that while running the tests, we must assign only
|
|
# one instance of MagicMock to sys.modules[ 'vim' ] and always return it.
|
|
#
|
|
# More explanation is available:
|
|
# https://github.com/Valloric/YouCompleteMe/pull/1694
|
|
VIM_MOCK = MagicMock()
|
|
|
|
|
|
def MockGetBufferNumber( buffer_filename ):
|
|
for buffer in VIM_MOCK.buffers:
|
|
if buffer[ 'filename' ] == buffer_filename:
|
|
return buffer[ 'number' ]
|
|
return -1
|
|
|
|
|
|
def MockGetBufferWindowNumber( buffer_number ):
|
|
for buffer in VIM_MOCK.buffers:
|
|
if buffer[ 'number' ] == buffer_number and 'window' in buffer:
|
|
return buffer[ 'window' ]
|
|
return -1
|
|
|
|
|
|
def MockVimEval( value ):
|
|
if value == "g:ycm_min_num_of_chars_for_completion":
|
|
return 0
|
|
if value == "g:ycm_path_to_python_interpreter":
|
|
return ''
|
|
if value == "tempname()":
|
|
return '_TEMP_FILE_'
|
|
if value == "&previewheight":
|
|
# Default value from Vim
|
|
return 12
|
|
|
|
match = BUFNR_REGEX.search( value )
|
|
if match:
|
|
return MockGetBufferNumber( match.group( 1 ) )
|
|
|
|
match = BUFWINNR_REGEX.search( value )
|
|
if match:
|
|
return MockGetBufferWindowNumber( int( match.group( 1 ) ) )
|
|
|
|
raise ValueError( 'Unexpected evaluation: ' + value )
|
|
|
|
|
|
def MockWipeoutBuffer( buffer_number ):
|
|
buffers = VIM_MOCK.buffers
|
|
|
|
for index, buffer in enumerate( buffers ):
|
|
if buffer[ 'number' ] == buffer_number:
|
|
return buffers.pop( index )
|
|
|
|
|
|
def MockVimCommand( command ):
|
|
match = BWIPEOUT_REGEX.search( command )
|
|
if match:
|
|
return MockWipeoutBuffer( int( match.group( 1 ) ) )
|
|
|
|
raise RuntimeError( 'Unexpected command: ' + command )
|
|
|
|
|
|
def MockVimModule():
|
|
"""The 'vim' module is something that is only present when running inside the
|
|
Vim Python interpreter, so we replace it with a MagicMock for tests. If you
|
|
need to add additional mocks to vim module functions, then use 'patch' from
|
|
mock module, to ensure that the state of the vim mock is returned before the
|
|
next test. That is:
|
|
|
|
from ycm.test_utils import MockVimModule
|
|
from mock import patch
|
|
|
|
# Do this once
|
|
MockVimModule()
|
|
|
|
@patch( 'vim.eval', return_value='test' )
|
|
@patch( 'vim.command', side_effect=ValueError )
|
|
def test( vim_command, vim_eval ):
|
|
# use vim.command via vim_command, e.g.:
|
|
vim_command.assert_has_calls( ... )
|
|
|
|
Failure to use this approach may lead to unexpected failures in other
|
|
tests."""
|
|
|
|
VIM_MOCK.buffers = {}
|
|
VIM_MOCK.eval = MagicMock( side_effect = MockVimEval )
|
|
sys.modules[ 'vim' ] = VIM_MOCK
|
|
|
|
return VIM_MOCK
|
|
|
|
|
|
class ExtendedMock( MagicMock ):
|
|
|
|
def assert_has_exact_calls( self, calls, any_order = False ):
|
|
self.assert_has_calls( calls, any_order )
|
|
assert_that( self.call_count, equal_to( len( calls ) ) )
|