YouCompleteMe/python/ycm/tests/omni_completer_test.py

# encoding: utf-8
#
# 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
# Not installing aliases from python-future; it's unreliable and slow.
from builtins import *  # noqa

from hamcrest import assert_that, contains, contains_string, empty, has_entries

from ycm.tests.test_utils import ( ExpectedFailure, MockVimBuffers,
                                   MockVimModule, ToBytesOnPY2, VimBuffer )
MockVimModule()

from ycm.tests import YouCompleteMeInstance


@YouCompleteMeInstance( { 'cache_omnifunc': 1 } )
def OmniCompleter_GetCompletions_Cache_List_test( ycm ):
  def Omnifunc( findstart, base ):
    if findstart:
      return 5
    return [ 'a', 'b', 'cdef' ]

  current_buffer = VimBuffer( 'buffer',
                              contents = [ 'test.' ],
                              filetype = 'java',
                              omnifunc = Omnifunc )

  with MockVimBuffers( [ current_buffer ], current_buffer, ( 1, 5 ) ):
    # Make sure there is an omnifunc set up.
    ycm.OnFileReadyToParse()
    ycm.SendCompletionRequest()
    assert_that(
      ycm.GetCompletionResponse(),
      has_entries( {
        'completions': ToBytesOnPY2( [ 'a', 'b', 'cdef' ] ),
        'completion_start_column': 6
      } )
    )


@YouCompleteMeInstance( { 'cache_omnifunc': 1 } )
def OmniCompleter_GetCompletions_Cache_ListFilter_test( ycm ):
  def Omnifunc( findstart, base ):
    if findstart:
      return 5
    return [ 'a', 'b', 'cdef' ]

  current_buffer = VimBuffer( 'buffer',
                              contents = [ 'test.t' ],
                              filetype = 'java',
                              omnifunc = Omnifunc )

  with MockVimBuffers( [ current_buffer ], current_buffer, ( 1, 6 ) ):
    # Make sure there is an omnifunc set up.
    ycm.OnFileReadyToParse()
    ycm.SendCompletionRequest()
    assert_that(
      ycm.GetCompletionResponse(),
      has_entries( {
        'completions': empty(),
        'completion_start_column': 6
      } )
    )


@YouCompleteMeInstance( { 'cache_omnifunc': 0 } )
def OmniCompleter_GetCompletions_NoCache_List_test( ycm ):
  def Omnifunc( findstart, base ):
    if findstart:
      return 5
    return [ 'a', 'b', 'cdef' ]

  current_buffer = VimBuffer( 'buffer',
                              contents = [ 'test.' ],
                              filetype = 'java',
                              omnifunc = Omnifunc )

  with MockVimBuffers( [ current_buffer ], current_buffer, ( 1, 5 ) ):
    # Make sure there is an omnifunc set up.
    ycm.OnFileReadyToParse()
    ycm.SendCompletionRequest()
    assert_that(
      ycm.GetCompletionResponse(),
      has_entries( {
        'completions': ToBytesOnPY2( [ 'a', 'b', 'cdef' ] ),
        'completion_start_column': 6
      } )
    )


@YouCompleteMeInstance( { 'cache_omnifunc': 0 } )
def OmniCompleter_GetCompletions_NoCache_ListFilter_test( ycm ):
  def Omnifunc( findstart, base ):
    if findstart:
      return 5
    return [ 'a', 'b', 'cdef' ]

  current_buffer = VimBuffer( 'buffer',
                              contents = [ 'test.t' ],
                              filetype = 'java',
                              omnifunc = Omnifunc )

  with MockVimBuffers( [ current_buffer ], current_buffer, ( 1, 6 ) ):
    # Make sure there is an omnifunc set up.
    ycm.OnFileReadyToParse()
    ycm.SendCompletionRequest()
    # Actual result is that the results are not filtered, as we expect the
    # omnifunc or vim itself to do this filtering.
    assert_that(
      ycm.GetCompletionResponse(),
      has_entries( {
        'completions': ToBytesOnPY2( [ 'a', 'b', 'cdef' ] ),
        'completion_start_column': 6
      } )
    )


@YouCompleteMeInstance( { 'cache_omnifunc': 0 } )
def OmniCompleter_GetCompletions_NoCache_UseFindStart_test( ycm ):
  def Omnifunc( findstart, base ):
    if findstart:
      return 0
    return [ 'a', 'b', 'cdef' ]

  current_buffer = VimBuffer( 'buffer',
                              contents = [ 'test.t' ],
                              filetype = 'java',
                              omnifunc = Omnifunc )

  with MockVimBuffers( [ current_buffer ], current_buffer, ( 1, 6 ) ):
    # Make sure there is an omnifunc set up.
    ycm.OnFileReadyToParse()
    ycm.SendCompletionRequest()
    # Actual result is that the results are not filtered, as we expect the
    # omnifunc or vim itself to do this filtering.
    assert_that(
      ycm.GetCompletionResponse(),
      has_entries( {
        'completions': ToBytesOnPY2( [ 'a', 'b', 'cdef' ] ),
        'completion_start_column': 1
      } )
    )


@YouCompleteMeInstance( { 'cache_omnifunc': 1 } )
def OmniCompleter_GetCompletions_Cache_UseFindStart_test( ycm ):
  def Omnifunc( findstart, base ):
    if findstart:
      return 0
    return [ 'a', 'b', 'cdef' ]

  current_buffer = VimBuffer( 'buffer',
                              contents = [ 'test.t' ],
                              filetype = 'java',
                              omnifunc = Omnifunc )

  with MockVimBuffers( [ current_buffer ], current_buffer, ( 1, 6 ) ):
    # Make sure there is an omnifunc set up.
    ycm.OnFileReadyToParse()
    ycm.SendCompletionRequest()
    # There are no results because the query 'test.t' doesn't match any
    # candidate (and cache_omnifunc=1, so we FilterAndSortCandidates).
    assert_that(
      ycm.GetCompletionResponse(),
      has_entries( {
        'completions': empty(),
        'completion_start_column': 1
      } )
    )


@YouCompleteMeInstance( { 'cache_omnifunc': 1 } )
def OmniCompleter_GetCompletions_Cache_Object_test( ycm ):
  def Omnifunc( findstart, base ):
    if findstart:
      return 5
    return { 'words': [ 'a', 'b', 'CDtEF' ] }

  current_buffer = VimBuffer( 'buffer',
                              contents = [ 'test.t' ],
                              filetype = 'java',
                              omnifunc = Omnifunc )

  with MockVimBuffers( [ current_buffer ], current_buffer, ( 1, 6 ) ):
    # Make sure there is an omnifunc set up.
    ycm.OnFileReadyToParse()
    ycm.SendCompletionRequest()
    assert_that(
      ycm.GetCompletionResponse(),
      has_entries( {
        'completions': [ 'CDtEF' ],
        'completion_start_column': 6
      } )
    )


@YouCompleteMeInstance( { 'cache_omnifunc': 1 } )
def OmniCompleter_GetCompletions_Cache_ObjectList_test( ycm ):
  def Omnifunc( findstart, base ):
    if findstart:
      return 5
    return [
      {
        'word': 'a',
        'abbr': 'ABBR',
        'menu': 'MENU',
        'info': 'INFO',
        'kind': 'K'
      },
      {
        'word': 'test',
        'abbr': 'ABBRTEST',
        'menu': 'MENUTEST',
        'info': 'INFOTEST',
        'kind': 'T'
      }
    ]

  current_buffer = VimBuffer( 'buffer',
                              contents = [ 'test.tt' ],
                              filetype = 'java',
                              omnifunc = Omnifunc )

  with MockVimBuffers( [ current_buffer ], current_buffer, ( 1, 7 ) ):
    # Make sure there is an omnifunc set up.
    ycm.OnFileReadyToParse()
    ycm.SendCompletionRequest()
    assert_that(
      ycm.GetCompletionResponse(),
      has_entries( {
        'completions': contains( {
          'word': 'test',
          'abbr': 'ABBRTEST',
          'menu': 'MENUTEST',
          'info': 'INFOTEST',
          'kind': 'T'
        } ),
        'completion_start_column': 6
      } )
    )


@YouCompleteMeInstance( { 'cache_omnifunc': 0 } )
def OmniCompleter_GetCompletions_NoCache_ObjectList_test( ycm ):
  def Omnifunc( findstart, base ):
    if findstart:
      return 5
    return [
      {
        'word': 'a',
        'abbr': 'ABBR',
        'menu': 'MENU',
        'info': 'INFO',
        'kind': 'K'
      },
      {
        'word': 'test',
        'abbr': 'ABBRTEST',
        'menu': 'MENUTEST',
        'info': 'INFOTEST',
        'kind': 'T'
      }
    ]

  current_buffer = VimBuffer( 'buffer',
                              contents = [ 'test.tt' ],
                              filetype = 'java',
                              omnifunc = Omnifunc )

  with MockVimBuffers( [ current_buffer ], current_buffer, ( 1, 7 ) ):
    # Make sure there is an omnifunc set up.
    ycm.OnFileReadyToParse()
    ycm.SendCompletionRequest()
    # We don't filter the result - we expect the omnifunc to do that
    # based on the query we supplied (Note: that means no fuzzy matching!).
    assert_that(
      ycm.GetCompletionResponse(),
      has_entries( {
        'completions': ToBytesOnPY2( [ {
          'word': 'a',
          'abbr': 'ABBR',
          'menu': 'MENU',
          'info': 'INFO',
          'kind': 'K'
        }, {
          'word': 'test',
          'abbr': 'ABBRTEST',
          'menu': 'MENUTEST',
          'info': 'INFOTEST',
          'kind': 'T'
        } ] ),
        'completion_start_column': 6
      } )
    )


@YouCompleteMeInstance( { 'cache_omnifunc': 1 } )
def OmniCompleter_GetCompletions_Cache_ObjectListObject_test( ycm ):
  def Omnifunc( findstart, base ):
    if findstart:
      return 5
    return { 'words': [
      {
        'word': 'a',
        'abbr': 'ABBR',
        'menu': 'MENU',
        'info': 'INFO',
        'kind': 'K'
      },
      {
        'word': 'test',
        'abbr': 'ABBRTEST',
        'menu': 'MENUTEST',
        'info': 'INFOTEST',
        'kind': 'T'
      }
    ] }

  current_buffer = VimBuffer( 'buffer',
                              contents = [ 'test.tt' ],
                              filetype = 'java',
                              omnifunc = Omnifunc )

  with MockVimBuffers( [ current_buffer ], current_buffer, ( 1, 7 ) ):
    # Make sure there is an omnifunc set up.
    ycm.OnFileReadyToParse()
    ycm.SendCompletionRequest()
    assert_that(
      ycm.GetCompletionResponse(),
      has_entries( {
        'completions': ToBytesOnPY2( [ {
          'word': 'test',
          'abbr': 'ABBRTEST',
          'menu': 'MENUTEST',
          'info': 'INFOTEST',
          'kind': 'T'
        } ] ),
        'completion_start_column': 6
      } )
    )


@YouCompleteMeInstance( { 'cache_omnifunc': 0 } )
def OmniCompleter_GetCompletions_NoCache_ObjectListObject_test( ycm ):
  def Omnifunc( findstart, base ):
    if findstart:
      return 5
    return { 'words': [
      {
        'word': 'a',
        'abbr': 'ABBR',
        'menu': 'MENU',
        'info': 'INFO',
        'kind': 'K'
      },
      {
        'word': 'test',
        'abbr': 'ABBRTEST',
        'menu': 'MENUTEST',
        'info': 'INFOTEST',
        'kind': 'T'
      }
    ] }

  current_buffer = VimBuffer( 'buffer',
                              contents = [ 'test.tt' ],
                              filetype = 'java',
                              omnifunc = Omnifunc )

  with MockVimBuffers( [ current_buffer ], current_buffer, ( 1, 7 ) ):
    # Make sure there is an omnifunc set up.
    ycm.OnFileReadyToParse()
    ycm.SendCompletionRequest()
    # No FilterAndSortCandidates for cache_omnifunc=0 (we expect the omnifunc
    # to do the filtering?)
    assert_that(
      ycm.GetCompletionResponse(),
      has_entries( {
        'completions': ToBytesOnPY2( [ {
          'word': 'a',
          'abbr': 'ABBR',
          'menu': 'MENU',
          'info': 'INFO',
          'kind': 'K'
        }, {
          'word': 'test',
          'abbr': 'ABBRTEST',
          'menu': 'MENUTEST',
          'info': 'INFOTEST',
          'kind': 'T'
        } ] ),
        'completion_start_column': 6
      } )
    )


@YouCompleteMeInstance( { 'cache_omnifunc': 1 } )
def OmniCompleter_GetCompletions_Cache_List_Unicode_test( ycm ):
  def Omnifunc( findstart, base ):
    if findstart:
      return 12
    return [ '†est', 'å_unicode_identifier', 'πππππππ yummy πie' ]

  current_buffer = VimBuffer( 'buffer',
                              contents = [ '†åsty_π.' ],
                              filetype = 'java',
                              omnifunc = Omnifunc )

  with MockVimBuffers( [ current_buffer ], current_buffer, ( 1, 12 ) ):
    # Make sure there is an omnifunc set up.
    ycm.OnFileReadyToParse()
    ycm.SendCompletionRequest()
    assert_that(
      ycm.GetCompletionResponse(),
      has_entries( {
        'completions': ToBytesOnPY2( [ '†est',
                                       'å_unicode_identifier',
                                       'πππππππ yummy πie' ] ),
        'completion_start_column': 13
      } )
    )


@YouCompleteMeInstance( { 'cache_omnifunc': 0 } )
def OmniCompleter_GetCompletions_NoCache_List_Unicode_test( ycm ):
  def Omnifunc( findstart, base ):
    if findstart:
      return 12
    return [ '†est', 'å_unicode_identifier', 'πππππππ yummy πie' ]

  current_buffer = VimBuffer( 'buffer',
                              contents = [ '†åsty_π.' ],
                              filetype = 'java',
                              omnifunc = Omnifunc )

  with MockVimBuffers( [ current_buffer ], current_buffer, ( 1, 12 ) ):
    # Make sure there is an omnifunc set up.
    ycm.OnFileReadyToParse()
    ycm.SendCompletionRequest()
    assert_that(
      ycm.GetCompletionResponse(),
      has_entries( {
        'completions': ToBytesOnPY2( [ '†est',
                                       'å_unicode_identifier',
                                       'πππππππ yummy πie' ] ),
        'completion_start_column': 13
      } )
    )


@ExpectedFailure( 'Filtering on unicode is not supported by the server',
                  contains_string( "value for 'completions' was <[]>" ) )
@YouCompleteMeInstance( { 'cache_omnifunc': 1 } )
def OmniCompleter_GetCompletions_Cache_List_Filter_Unicode_test( ycm ):
  def Omnifunc( findstart, base ):
    if findstart:
      return 12
    return [ '†est', 'å_unicode_identifier', 'πππππππ yummy πie' ]

  current_buffer = VimBuffer( 'buffer',
                              contents = [ '†åsty_π.ππ' ],
                              filetype = 'java',
                              omnifunc = Omnifunc )

  with MockVimBuffers( [ current_buffer ], current_buffer, ( 1, 17 ) ):
    # Make sure there is an omnifunc set up.
    ycm.OnFileReadyToParse()
    ycm.SendCompletionRequest()
    assert_that(
      ycm.GetCompletionResponse(),
      has_entries( {
        'completions': ToBytesOnPY2( [ 'πππππππ yummy πie' ] ),
        'completion_start_column': 13
      } )
    )


@YouCompleteMeInstance( { 'cache_omnifunc': 0 } )
def OmniCompleter_GetCompletions_NoCache_List_Filter_Unicode_test( ycm ):
  def Omnifunc( findstart, base ):
    if findstart:
      return 12
    return [ 'πππππππ yummy πie' ]

  current_buffer = VimBuffer( 'buffer',
                              contents = [ '†åsty_π.ππ' ],
                              filetype = 'java',
                              omnifunc = Omnifunc )

  with MockVimBuffers( [ current_buffer ], current_buffer, ( 1, 17 ) ):
    # Make sure there is an omnifunc set up.
    ycm.OnFileReadyToParse()
    ycm.SendCompletionRequest()
    assert_that(
      ycm.GetCompletionResponse(),
      has_entries( {
        'completions': ToBytesOnPY2( [ 'πππππππ yummy πie' ] ),
        'completion_start_column': 13
      } )
    )


@ExpectedFailure( 'Filtering on unicode is not supported by the server',
                  contains_string( "value for 'completions' was <[]>" ) )
@YouCompleteMeInstance( { 'cache_omnifunc': 1 } )
def OmniCompleter_GetCompletions_Cache_ObjectList_Unicode_test( ycm ):
  def Omnifunc( findstart, base ):
    if findstart:
      return 12
    return [
      {
        'word': 'ålpha∫et',
        'abbr': 'å∫∫®',
        'menu': 'µ´~¨á',
        'info': '^~fo',
        'kind': '˚'
      },
      {
        'word': 'π†´ß†π',
        'abbr': 'ÅııÂʉÍÊ',
        'menu': '˜‰ˆËʉÍÊ',
        'info': 'ȈÏØʉÍÊ',
        'kind': 'Ê'
      }
    ]

  current_buffer = VimBuffer( 'buffer',
                              contents = [ '†åsty_π.ππ' ],
                              filetype = 'java',
                              omnifunc = Omnifunc )

  with MockVimBuffers( [ current_buffer ], current_buffer, ( 1, 17 ) ):
    # Make sure there is an omnifunc set up.
    ycm.OnFileReadyToParse()
    ycm.SendCompletionRequest()
    assert_that(
      ycm.GetCompletionResponse(),
      has_entries( {
        'completions': ToBytesOnPY2( [ {
          'word': 'π†´ß†π',
          'abbr': 'ÅııÂʉÍÊ',
          'menu': '˜‰ˆËʉÍÊ',
          'info': 'ȈÏØʉÍÊ',
          'kind': 'Ê'
        } ] ),
        'completion_start_column': 13
      } )
    )


@YouCompleteMeInstance( { 'cache_omnifunc': 1 } )
def OmniCompleter_GetCompletions_Cache_ObjectListObject_Unicode_test( ycm ):
  def Omnifunc( findstart, base ):
    if findstart:
      return 12
    return {
      'words': [
        {
          'word': 'ålpha∫et',
          'abbr': 'å∫∫®',
          'menu': 'µ´~¨á',
          'info': '^~fo',
          'kind': '˚'
        },
        {
          'word': 'π†´ß†π',
          'abbr': 'ÅııÂʉÍÊ',
          'menu': '˜‰ˆËʉÍÊ',
          'info': 'ȈÏØʉÍÊ',
          'kind': 'Ê'
        },
        {
          'word': 'test',
          'abbr': 'ÅııÂʉÍÊ',
          'menu': '˜‰ˆËʉÍÊ',
          'info': 'ȈÏØʉÍÊ',
          'kind': 'Ê'
        }
      ]
    }

  current_buffer = VimBuffer( 'buffer',
                              contents = [ '†åsty_π.t' ],
                              filetype = 'java',
                              omnifunc = Omnifunc )

  with MockVimBuffers( [ current_buffer ], current_buffer, ( 1, 13 ) ):
    # Make sure there is an omnifunc set up.
    ycm.OnFileReadyToParse()
    ycm.SendCompletionRequest()
    assert_that(
      ycm.GetCompletionResponse(),
      has_entries( {
        'completions': contains( {
          'word': 'test',
          'abbr': 'ÅııÂʉÍÊ',
          'menu': '˜‰ˆËʉÍÊ',
          'info': 'ȈÏØʉÍÊ',
          'kind': 'Ê'
        } ),
        'completion_start_column': 13
      } )
    )