Implement LSP symbol search

3 files changed, 189 insertions, 1 deletions

diff --git a/test/lsp/test_lsp_client_messages.vader b/test/lsp/test_lsp_client_messages.vader
index d4abaad9..71768ce5 100644
--- a/test/lsp/test_lsp_client_messages.vader
+++ b/test/lsp/test_lsp_client_messages.vader
@@ -161,6 +161,17 @@ Execute(ale#lsp#message#References() should return correct messages):
   \ ],
   \ ale#lsp#message#References(bufnr(''), 12, 34)
 
+Execute(ale#lsp#message#Symbol() should return correct messages):
+  AssertEqual
+  \ [
+  \   0,
+  \   'workspace/symbol',
+  \   {
+  \     'query': 'foobar',
+  \   }
+  \ ],
+  \ ale#lsp#message#Symbol('foobar')
+
 Execute(ale#lsp#message#Hover() should return correct messages):
   AssertEqual
   \ [
diff --git a/test/lsp/test_other_initialize_message_handling.vader b/test/lsp/test_other_initialize_message_handling.vader
index e29f3358..072f8c4b 100644
--- a/test/lsp/test_other_initialize_message_handling.vader
+++ b/test/lsp/test_other_initialize_message_handling.vader
@@ -16,6 +16,7 @@ Before:
   \   'completion': 0,
   \   'completion_trigger_characters': [],
   \   'definition': 0,
+  \   'symbol_search': 0,
   \ },
   \}
 
@@ -67,7 +68,8 @@ Execute(Capabilities should bet set up correctly):
   \     },
   \     'definitionProvider': v:true,
   \     'experimental': {},
-  \     'documentHighlightProvider': v:true
+  \     'documentHighlightProvider': v:true,
+  \     'workspaceSymbolProvider': v:true
   \   },
   \ },
   \})
@@ -80,6 +82,7 @@ Execute(Capabilities should bet set up correctly):
   \   'references': 1,
   \   'hover': 1,
   \   'definition': 1,
+  \   'symbol_search': 1,
   \ },
   \ b:conn.capabilities
 
@@ -121,6 +124,7 @@ Execute(Disabled capabilities should be recognised correctly):
   \   'references': 0,
   \   'hover': 0,
   \   'definition': 0,
+  \   'symbol_search': 0,
   \ },
   \ b:conn.capabilities
 
diff --git a/test/test_symbol_search.vader b/test/test_symbol_search.vader
new file mode 100644
index 00000000..d8b7a4a6
--- /dev/null
+++ b/test/test_symbol_search.vader
@@ -0,0 +1,173 @@
+Before:
+  call ale#test#SetDirectory('/testplugin/test')
+  call ale#test#SetFilename('dummy.txt')
+
+  let g:Callback = ''
+  let g:expr_list = []
+  let g:message_list = []
+  let g:preview_called = 0
+  let g:item_list = []
+  let g:capability_checked = ''
+  let g:conn_id = v:null
+  let g:WaitCallback = v:null
+
+  runtime autoload/ale/lsp_linter.vim
+  runtime autoload/ale/lsp.vim
+  runtime autoload/ale/util.vim
+  runtime autoload/ale/preview.vim
+
+  function! ale#lsp_linter#StartLSP(buffer, linter) abort
+    let g:conn_id = ale#lsp#Register('executable', '/foo/bar', {})
+    call ale#lsp#MarkDocumentAsOpen(g:conn_id, a:buffer)
+
+    return {
+    \ 'buffer': a:buffer,
+    \ 'connection_id': g:conn_id,
+    \ 'project_root': '/foo/bar',
+    \ 'language_id': 'python',
+    \}
+  endfunction
+
+  function! ale#lsp#WaitForCapability(conn_id, capability, callback) abort
+    let g:capability_checked = a:capability
+    let g:WaitCallback = a:callback
+  endfunction
+
+  function! ale#lsp#RegisterCallback(conn_id, callback) abort
+    let g:Callback = a:callback
+  endfunction
+
+  function! ale#lsp#Send(conn_id, message) abort
+    call add(g:message_list, a:message)
+
+    return 42
+  endfunction
+
+  function! ale#util#Execute(expr) abort
+    call add(g:expr_list, a:expr)
+  endfunction
+
+  function! ale#preview#ShowSelection(item_list) abort
+    let g:preview_called = 1
+    let g:item_list = a:item_list
+  endfunction
+
+After:
+  call ale#test#RestoreDirectory()
+  call ale#linter#Reset()
+
+  unlet! g:capability_checked
+  unlet! g:WaitCallback
+  unlet! g:conn_id
+  unlet! g:Callback
+  unlet! g:message_list
+  unlet! g:expr_list
+  unlet! b:ale_linters
+  unlet! g:item_list
+  unlet! g:preview_called
+
+  runtime autoload/ale/lsp_linter.vim
+  runtime autoload/ale/lsp.vim
+  runtime autoload/ale/util.vim
+  runtime autoload/ale/preview.vim
+
+Execute(Other messages for the LSP handler should be ignored):
+  call ale#symbol#HandleLSPResponse(1, {'command': 'foo'})
+
+Execute(Failed symbol responses should be handled correctly):
+  call ale#symbol#SetMap({3: {}})
+  call ale#symbol#HandleLSPResponse(1, {'id': 3})
+  AssertEqual {}, ale#symbol#GetMap()
+
+Execute(LSP symbol responses should be handled):
+  call ale#symbol#SetMap({3: {}})
+  call ale#symbol#HandleLSPResponse(
+  \ 1,
+  \ {
+  \   'id': 3,
+  \   'result': [
+  \     {
+  \       'name': 'foo',
+  \       'location': {
+  \         'uri': ale#path#ToURI(ale#path#Simplify(g:dir . '/completion_dummy_file')),
+  \         'range': {
+  \           'start': {'line': 2, 'character': 7},
+  \         },
+  \       },
+  \     },
+  \     {
+  \       'name': 'foobar',
+  \       'location': {
+  \         'uri': ale#path#ToURI(ale#path#Simplify(g:dir . '/other_file')),
+  \         'range': {
+  \           'start': {'line': 7, 'character': 15},
+  \         },
+  \       },
+  \     },
+  \   ],
+  \ }
+  \)
+
+  AssertEqual
+  \ [
+  \   {
+  \     'filename': ale#path#Simplify(g:dir . '/completion_dummy_file'),
+  \     'line': 3,
+  \     'column': 8,
+  \     'match': 'foo',
+  \   },
+  \   {
+  \     'filename': ale#path#Simplify(g:dir . '/other_file'),
+  \     'line': 8,
+  \     'column': 16,
+  \     'match': 'foobar',
+  \   },
+  \ ],
+  \ g:item_list
+  AssertEqual {}, ale#symbol#GetMap()
+
+Execute(Preview windows should not be opened for empty LSP symbol responses):
+  call ale#symbol#SetMap({3: {}})
+  call ale#symbol#HandleLSPResponse(
+  \ 1,
+  \ {
+  \   'id': 3,
+  \   'result': [
+  \   ],
+  \ }
+  \)
+
+  Assert !g:preview_called
+  AssertEqual {}, ale#symbol#GetMap()
+  AssertEqual ['echom ''No symbols found.'''], g:expr_list
+
+Given python(Some Python file):
+  foo
+  somelongerline
+  bazxyzxyzxyz
+
+Execute(LSP symbol requests should be sent):
+  runtime ale_linters/python/pyls.vim
+  let b:ale_linters = ['pyls']
+  call setpos('.', [bufnr(''), 1, 5, 0])
+
+  ALESymbolSearch foo bar
+
+  " We shouldn't register the callback yet.
+  AssertEqual '''''', string(g:Callback)
+
+  AssertEqual 'symbol_search', g:capability_checked
+  AssertEqual type(function('type')), type(g:WaitCallback)
+  call call(g:WaitCallback, [g:conn_id, '/foo/bar'])
+
+  AssertEqual
+  \ 'function(''ale#symbol#HandleLSPResponse'')',
+  \ string(g:Callback)
+
+  AssertEqual
+  \ [
+  \   [0, 'workspace/symbol', {'query': 'foo bar'}],
+  \ ],
+  \ g:message_list
+
+  AssertEqual {'42': {'buffer': bufnr('')}}, ale#symbol#GetMap()