test: avoid noise in NVIM_LOG_FILE

Problem:
Tests that _intentionally_ fail certain conditions cause noise in
$NVIM_LOG_FILE:

    $NVIM_LOG_FILE: /home/runner/work/neovim/neovim/build/.nvimlog
    (last 100 lines)
    WRN 2023-01-16T18:26:27.673 T599.7799.0 unsubscribe:519: RPC: ch 1: tried to unsubscribe unknown event 'doesnotexist'
    WRN 2023-01-16T18:29:00.557 ?.11151    server_start:163: Failed to start server: no such file or directory: /X/X/X/...
    WRN 2023-01-16T18:33:07.269 127.0.0.1:12345 server_start:163: Failed to start server: address already in use: 127.0.0.1
    ...
    -- Output to stderr:
    module 'vim.shared' not found:
    	no field package.preload['vim.shared']
    	no file './vim/shared.lua'
    	no file '/home/runner/nvim-deps/usr/share/lua/5.1/vim/shared.lua'
    	no file '/home/runner/nvim-deps/usr/share/lua/5.1/vim/shared/init.lua'
    	no file '/home/runner/nvim-deps/usr/lib/lua/5.1/vim/shared.lua'
    	no file '/home/runner/nvim-deps/usr/lib/lua/5.1/vim/shared/init.lua'
    	no file './vim/shared.so'
    	...
    E970: Failed to initialize builtin lua modules

Solution:
- Log to a private $NVIM_LOG_FILE in tests that intentionally fail and
  cause ERR log messages.
- Assert that the expected messages are actually logged.

1 files changed, 25 insertions, 2 deletions

diff --git a/test/functional/vimscript/server_spec.lua b/test/functional/vimscript/server_spec.lua
index 14c87d9d93..a2d99c7d45 100644
--- a/test/functional/vimscript/server_spec.lua
+++ b/test/functional/vimscript/server_spec.lua
@@ -1,4 +1,6 @@
 local helpers = require('test.functional.helpers')(after_each)
+local assert_log = helpers.assert_log
+local retry = helpers.retry
 local eq, neq, eval = helpers.eq, helpers.neq, helpers.eval
 local clear, funcs, meths = helpers.clear, helpers.funcs, helpers.meths
 local ok = helpers.ok
@@ -7,6 +9,8 @@ local pcall_err = helpers.pcall_err
 local mkdir = helpers.mkdir
 local is_os = helpers.is_os
 
+local testlog = 'Xtest-server-log'
+
 local function clear_serverlist()
   for _, server in pairs(funcs.serverlist()) do
     funcs.serverstop(server)
@@ -14,6 +18,10 @@ local function clear_serverlist()
 end
 
 describe('server', function()
+  after_each(function()
+    os.remove(testlog)
+  end)
+
   it('serverstart() stores sockets in $XDG_RUNTIME_DIR', function()
     local dir = 'Xtest_xdg_run'
     mkdir(dir)
@@ -74,13 +82,22 @@ describe('server', function()
   end)
 
   it('serverstop() returns false for invalid input', function()
-    clear()
+    clear{env={
+      NVIM_LOG_FILE=testlog,
+      NVIM_LISTEN_ADDRESS='.',
+    }}
     eq(0, eval("serverstop('')"))
     eq(0, eval("serverstop('bogus-socket-name')"))
+    retry(nil, 1000, function()
+      assert_log('Not listening on bogus%-socket%-name', testlog, 10)
+    end)
   end)
 
   it('parses endpoints', function()
-    clear()
+    clear{env={
+      NVIM_LOG_FILE=testlog,
+      NVIM_LISTEN_ADDRESS='.',
+    }}
     clear_serverlist()
     eq({}, funcs.serverlist())
 
@@ -104,6 +121,9 @@ describe('server', function()
     if status then
       table.insert(expected, v4)
       pcall(funcs.serverstart, v4)  -- exists already; ignore
+      retry(nil, 1000, function()
+        assert_log('Failed to start server: address already in use: 127%.0%.0%.1', testlog, 10)
+      end)
     end
 
     local v6 = '::1:12345'
@@ -111,6 +131,9 @@ describe('server', function()
     if status then
       table.insert(expected, v6)
       pcall(funcs.serverstart, v6)  -- exists already; ignore
+      retry(nil, 1000, function()
+        assert_log('Failed to start server: address already in use: ::1', testlog, 10)
+      end)
     end
     eq(expected, funcs.serverlist())
     clear_serverlist()