test: improve test conventions

Specifically, functions that are run in the context of the test runner
are put in module `test/testutil.lua` while the functions that are run
in the context of the test session are put in
`test/functional/testnvim.lua`.

Closes https://github.com/neovim/neovim/issues/27004.

10 files changed, 57 insertions, 45 deletions

diff --git a/test/functional/plugin/lsp/codelens_spec.lua b/test/functional/plugin/lsp/codelens_spec.lua
index 20e850eeee..cd20e95dd1 100644
--- a/test/functional/plugin/lsp/codelens_spec.lua
+++ b/test/functional/plugin/lsp/codelens_spec.lua
@@ -1,14 +1,15 @@
-local t = require('test.functional.testutil')()
+local t = require('test.testutil')
+local n = require('test.functional.testnvim')()
 
-local exec_lua = t.exec_lua
+local exec_lua = n.exec_lua
 local eq = t.eq
 
 describe('vim.lsp.codelens', function()
   before_each(function()
-    t.clear()
+    n.clear()
     exec_lua('require("vim.lsp")')
   end)
-  after_each(t.clear)
+  after_each(n.clear)
 
   it('on_codelens_stores_and_displays_lenses', function()
     local fake_uri = 'file:///fake/uri'
diff --git a/test/functional/plugin/lsp/completion_spec.lua b/test/functional/plugin/lsp/completion_spec.lua
index 18f123a979..2798d57381 100644
--- a/test/functional/plugin/lsp/completion_spec.lua
+++ b/test/functional/plugin/lsp/completion_spec.lua
@@ -1,7 +1,9 @@
 ---@diagnostic disable: no-unknown
-local t = require('test.functional.testutil')()
+local t = require('test.testutil')
+local n = require('test.functional.testnvim')()
+
 local eq = t.eq
-local exec_lua = t.exec_lua
+local exec_lua = n.exec_lua
 
 --- Convert completion results.
 ---
@@ -41,7 +43,7 @@ local function complete(line, candidates, lnum)
 end
 
 describe('vim.lsp._completion', function()
-  before_each(t.clear)
+  before_each(n.clear)
 
   -- https://microsoft.github.io/language-server-protocol/specifications/specification-current/#textDocument_completion
   it('prefers textEdit over label as word', function()
diff --git a/test/functional/plugin/lsp/diagnostic_spec.lua b/test/functional/plugin/lsp/diagnostic_spec.lua
index 27b0da1f3d..c5e14ffdc2 100644
--- a/test/functional/plugin/lsp/diagnostic_spec.lua
+++ b/test/functional/plugin/lsp/diagnostic_spec.lua
@@ -1,8 +1,10 @@
-local t = require('test.functional.testutil')()
+local t = require('test.testutil')
+local n = require('test.functional.testnvim')()
+
 local t_lsp = require('test.functional.plugin.lsp.testutil')
 
-local clear = t.clear
-local exec_lua = t.exec_lua
+local clear = n.clear
+local exec_lua = n.exec_lua
 local eq = t.eq
 local neq = t.neq
 
diff --git a/test/functional/plugin/lsp/handler_spec.lua b/test/functional/plugin/lsp/handler_spec.lua
index 0ce7479c49..013a5fb5e7 100644
--- a/test/functional/plugin/lsp/handler_spec.lua
+++ b/test/functional/plugin/lsp/handler_spec.lua
@@ -1,7 +1,8 @@
-local t = require('test.functional.testutil')()
+local t = require('test.testutil')
+local n = require('test.functional.testnvim')()
 
 local eq = t.eq
-local exec_lua = t.exec_lua
+local exec_lua = n.exec_lua
 local pcall_err = t.pcall_err
 local matches = t.matches
 
diff --git a/test/functional/plugin/lsp/incremental_sync_spec.lua b/test/functional/plugin/lsp/incremental_sync_spec.lua
index a44b861ca1..238b90b57d 100644
--- a/test/functional/plugin/lsp/incremental_sync_spec.lua
+++ b/test/functional/plugin/lsp/incremental_sync_spec.lua
@@ -1,11 +1,12 @@
 -- Test suite for testing interactions with the incremental sync algorithms powering the LSP client
-local t = require('test.functional.testutil')()
+local t = require('test.testutil')
+local n = require('test.functional.testnvim')()
 
-local api = t.api
-local clear = t.clear
+local api = n.api
+local clear = n.clear
 local eq = t.eq
-local exec_lua = t.exec_lua
-local feed = t.feed
+local exec_lua = n.exec_lua
+local feed = n.feed
 
 before_each(function()
   clear()
diff --git a/test/functional/plugin/lsp/inlay_hint_spec.lua b/test/functional/plugin/lsp/inlay_hint_spec.lua
index 24c93fcbe0..0aaf94d6da 100644
--- a/test/functional/plugin/lsp/inlay_hint_spec.lua
+++ b/test/functional/plugin/lsp/inlay_hint_spec.lua
@@ -1,12 +1,13 @@
-local t = require('test.functional.testutil')()
-local t_lsp = require('test.functional.plugin.lsp.testutil')
+local t = require('test.testutil')
+local n = require('test.functional.testnvim')()
 local Screen = require('test.functional.ui.screen')
+local t_lsp = require('test.functional.plugin.lsp.testutil')
 
 local eq = t.eq
 local dedent = t.dedent
-local exec_lua = t.exec_lua
-local insert = t.insert
-local api = t.api
+local exec_lua = n.exec_lua
+local insert = n.insert
+local api = n.api
 
 local clear_notrace = t_lsp.clear_notrace
 local create_server_definition = t_lsp.create_server_definition
diff --git a/test/functional/plugin/lsp/semantic_tokens_spec.lua b/test/functional/plugin/lsp/semantic_tokens_spec.lua
index a9d8592eb0..013393095e 100644
--- a/test/functional/plugin/lsp/semantic_tokens_spec.lua
+++ b/test/functional/plugin/lsp/semantic_tokens_spec.lua
@@ -1,16 +1,17 @@
-local t = require('test.functional.testutil')()
-local t_lsp = require('test.functional.plugin.lsp.testutil')
+local t = require('test.testutil')
+local n = require('test.functional.testnvim')()
 local Screen = require('test.functional.ui.screen')
+local t_lsp = require('test.functional.plugin.lsp.testutil')
 
-local command = t.command
+local command = n.command
 local dedent = t.dedent
 local eq = t.eq
-local exec_lua = t.exec_lua
-local feed = t.feed
-local feed_command = t.feed_command
-local insert = t.insert
+local exec_lua = n.exec_lua
+local feed = n.feed
+local feed_command = n.feed_command
+local insert = n.insert
 local matches = t.matches
-local api = t.api
+local api = n.api
 
 local clear_notrace = t_lsp.clear_notrace
 local create_server_definition = t_lsp.create_server_definition
diff --git a/test/functional/plugin/lsp/snippet_spec.lua b/test/functional/plugin/lsp/snippet_spec.lua
index 0f4304868b..e60c36cd23 100644
--- a/test/functional/plugin/lsp/snippet_spec.lua
+++ b/test/functional/plugin/lsp/snippet_spec.lua
@@ -1,13 +1,15 @@
-local t = require('test.functional.testutil')()
+local t = require('test.testutil')
+local n = require('test.functional.testnvim')()
+
 local snippet = require('vim.lsp._snippet_grammar')
 local type = snippet.NodeType
 
 local eq = t.eq
-local exec_lua = t.exec_lua
+local exec_lua = n.exec_lua
 
 describe('vim.lsp._snippet_grammar', function()
-  before_each(t.clear)
-  after_each(t.clear)
+  before_each(n.clear)
+  after_each(n.clear)
 
   local parse = function(...)
     local res = exec_lua('return require("vim.lsp._snippet_grammar").parse(...)', ...)
diff --git a/test/functional/plugin/lsp/testutil.lua b/test/functional/plugin/lsp/testutil.lua
index c51ccf3097..4d14752f2a 100644
--- a/test/functional/plugin/lsp/testutil.lua
+++ b/test/functional/plugin/lsp/testutil.lua
@@ -1,10 +1,10 @@
-local t = require('test.functional.testutil')()
+local n = require('test.functional.testnvim')()
 
-local clear = t.clear
-local exec_lua = t.exec_lua
-local run = t.run
-local stop = t.stop
-local api = t.api
+local clear = n.clear
+local exec_lua = n.exec_lua
+local run = n.run
+local stop = n.stop
+local api = n.api
 local NIL = vim.NIL
 
 local M = {}
diff --git a/test/functional/plugin/lsp/utils_spec.lua b/test/functional/plugin/lsp/utils_spec.lua
index 8e57ace449..6c6dec0667 100644
--- a/test/functional/plugin/lsp/utils_spec.lua
+++ b/test/functional/plugin/lsp/utils_spec.lua
@@ -1,12 +1,13 @@
-local t = require('test.functional.testutil')()
+local t = require('test.testutil')
+local n = require('test.functional.testnvim')()
 local Screen = require('test.functional.ui.screen')
-local feed = t.feed
 
+local feed = n.feed
 local eq = t.eq
-local exec_lua = t.exec_lua
+local exec_lua = n.exec_lua
 
 describe('vim.lsp.util', function()
-  before_each(t.clear)
+  before_each(n.clear)
 
   describe('stylize_markdown', function()
     local stylize_markdown = function(content, opts)
@@ -142,7 +143,7 @@ describe('vim.lsp.util', function()
 
     local screen
     before_each(function()
-      t.clear()
+      n.clear()
       screen = Screen.new(80, 80)
       screen:attach()
       feed('79i<CR><Esc>') -- fill screen with empty lines