neovim

commit 3c697f62fa0d941a8cfd287f38a159293905bac4
parent 9e86f473e0f4e21c5f40bf990c53194d593a0f9f
Author: Michal Liszcz <liszcz.michal@gmail.com>
Date:   Tue, 11 Apr 2023 18:37:27 +0200

test(lsp): fix unstable tests for set_defaults (#23002)

In the `test_rpc_server` procedure, both `on_setup` and `on_init`
callbacks can run concurrently in some scenarios. This caused some CI
failures in tests for the LSP set_defaults feature.

This commit attempts to fix this by merging those two callbacks in the
impacted tests.

See: https://github.com/neovim/neovim/actions/runs/4553550710/attempts/1
Diffstat:
M
test/functional/plugin/lsp_spec.lua
 | 
31
+++++++++++++++----------------

1 file changed, 15 insertions(+), 16 deletions(-)
diff --git a/test/functional/plugin/lsp_spec.lua b/test/functional/plugin/lsp_spec.lua
@@ -323,15 +323,13 @@ describe('LSP', function()
       local client
       test_rpc_server {
         test_name = "set_defaults_all_capabilities";
-        on_setup = function()
+        on_init = function(_client)
+          client = _client
           exec_lua [[
             BUFFER = vim.api.nvim_create_buf(false, true)
+            lsp.buf_attach_client(BUFFER, TEST_RPC_CLIENT_ID)
           ]]
         end;
-        on_init = function(_client)
-          client = _client
-          exec_lua("lsp.buf_attach_client(BUFFER, TEST_RPC_CLIENT_ID)")
-        end;
         on_handler = function(_, _, ctx)
           if ctx.method == 'test' then
             eq('v:lua.vim.lsp.tagfunc', get_buf_option("tagfunc"))
@@ -352,7 +350,8 @@ describe('LSP', function()
       local client
       test_rpc_server {
         test_name = "set_defaults_all_capabilities";
-        on_setup = function()
+        on_init = function(_client)
+          client = _client
           exec_lua [[
             vim.api.nvim_command('filetype plugin on')
             BUFFER_1 = vim.api.nvim_create_buf(false, true)
@@ -360,14 +359,16 @@ describe('LSP', function()
             vim.api.nvim_buf_set_option(BUFFER_1, 'filetype', 'man')
             vim.api.nvim_buf_set_option(BUFFER_2, 'filetype', 'xml')
           ]]
+
+          -- Sanity check to ensure that some values are set after setting filetype.
           eq('v:lua.require\'man\'.goto_tag', get_buf_option("tagfunc", "BUFFER_1"))
           eq('xmlcomplete#CompleteTags', get_buf_option("omnifunc", "BUFFER_2"))
           eq('xmlformat#Format()', get_buf_option("formatexpr", "BUFFER_2"))
-        end;
-        on_init = function(_client)
-          client = _client
-          exec_lua("lsp.buf_attach_client(BUFFER_1, TEST_RPC_CLIENT_ID)")
-          exec_lua("lsp.buf_attach_client(BUFFER_2, TEST_RPC_CLIENT_ID)")
+
+          exec_lua [[
+            lsp.buf_attach_client(BUFFER_1, TEST_RPC_CLIENT_ID)
+            lsp.buf_attach_client(BUFFER_2, TEST_RPC_CLIENT_ID)
+          ]]
         end;
         on_handler = function(_, _, ctx)
           if ctx.method == 'test' then
@@ -389,18 +390,16 @@ describe('LSP', function()
       local client
       test_rpc_server {
         test_name = "set_defaults_all_capabilities";
-        on_setup = function()
+        on_init = function(_client)
+          client = _client
           exec_lua [[
             BUFFER = vim.api.nvim_create_buf(false, true)
             vim.api.nvim_buf_set_option(BUFFER, 'tagfunc', 'tfu')
             vim.api.nvim_buf_set_option(BUFFER, 'omnifunc', 'ofu')
             vim.api.nvim_buf_set_option(BUFFER, 'formatexpr', 'fex')
+            lsp.buf_attach_client(BUFFER, TEST_RPC_CLIENT_ID)
           ]]
         end;
-        on_init = function(_client)
-          client = _client
-          exec_lua("lsp.buf_attach_client(BUFFER, TEST_RPC_CLIENT_ID)")
-        end;
         on_handler = function(_, _, ctx)
           if ctx.method == 'test' then
             eq('tfu', get_buf_option("tagfunc"))