test: support running functionaltests in parallel by directory (#37918)

Define a CMake target for every subdirectory of test/functional that
contains functional tests, and a functionaltest_parallel target that
depends on all those targets, allowing multiple test runners to run in
parallel.

On CI, use at most 2 parallel test runners, as using more may increase
system load and make tests unstable.

test/functional/api/vim_spec.lua

@@ -734,23 +734,24 @@ describe('API', function()
 
   describe('nvim_set_current_dir', function()
     local start_dir
+    local test_dir = 'Xtest_set_current_dir'
 
     before_each(function()
-      fn.mkdir('Xtestdir')
+      fn.mkdir(test_dir)
       start_dir = fn.getcwd()
     end)
 
     after_each(function()
-      n.rmdir('Xtestdir')
+      n.rmdir(test_dir)
     end)
 
     it('works', function()
-      api.nvim_set_current_dir('Xtestdir')
-      eq(start_dir .. n.get_pathsep() .. 'Xtestdir', fn.getcwd())
+      api.nvim_set_current_dir(test_dir)
+      eq(start_dir .. n.get_pathsep() .. test_dir, fn.getcwd())
     end)
 
     it('sets previous directory', function()
-      api.nvim_set_current_dir('Xtestdir')
+      api.nvim_set_current_dir(test_dir)
       command('cd -')
       eq(start_dir, fn.getcwd())
     end)
@@ -1670,8 +1671,9 @@ describe('API', function()
 
       -- Check if autoload works properly
       local pathsep = n.get_pathsep()
-      local xconfig = 'Xhome' .. pathsep .. 'Xconfig'
-      local xdata = 'Xhome' .. pathsep .. 'Xdata'
+      local xhome = 'Xhome_api'
+      local xconfig = xhome .. pathsep .. 'Xconfig'
+      local xdata = xhome .. pathsep .. 'Xdata'
       local autoload_folder = table.concat({ xconfig, 'nvim', 'autoload' }, pathsep)
       local autoload_file = table.concat({ autoload_folder, 'testload.vim' }, pathsep)
       mkdir_p(autoload_folder)
@@ -1679,7 +1681,7 @@ describe('API', function()
 
       clear { args_rm = { '-u' }, env = { XDG_CONFIG_HOME = xconfig, XDG_DATA_HOME = xdata } }
       eq(2, api.nvim_get_var('testload#value'))
-      rmdir('Xhome')
+      rmdir(xhome)
     end)
 
     it('nvim_get_vvar, nvim_set_vvar', function()
@@ -2966,16 +2968,18 @@ describe('API', function()
   end)
 
   describe('nvim_list_runtime_paths', function()
+    local test_dir = 'Xtest_list_runtime_paths'
+
     setup(function()
       local pathsep = n.get_pathsep()
-      mkdir_p('Xtest' .. pathsep .. 'a')
-      mkdir_p('Xtest' .. pathsep .. 'b')
+      mkdir_p(test_dir .. pathsep .. 'a')
+      mkdir_p(test_dir .. pathsep .. 'b')
     end)
     teardown(function()
-      rmdir 'Xtest'
+      rmdir(test_dir)
     end)
     before_each(function()
-      api.nvim_set_current_dir 'Xtest'
+      api.nvim_set_current_dir(test_dir)
     end)
 
     it('returns nothing with empty &runtimepath', function()

test/functional/ex_cmds/trust_spec.lua

@@ -11,57 +11,63 @@ local is_os = t.is_os
 local fn = n.fn
 
 describe(':trust', function()
-  local xstate = 'Xstate'
+  local xstate = 'Xstate_ex_trust'
+  local test_file = 'Xtest_functional_ex_cmds_trust'
 
   before_each(function()
     n.mkdir_p(xstate .. pathsep .. (is_os('win') and 'nvim-data' or 'nvim'))
-    t.write_file('test_file', 'test')
+    t.write_file(test_file, 'test')
     clear { env = { XDG_STATE_HOME = xstate } }
   end)
 
   after_each(function()
-    os.remove('test_file')
+    os.remove(test_file)
     n.rmdir(xstate)
   end)
 
+  --- @param s string
+  local function fmt(s)
+    return s:format(test_file)
+  end
+
   it('is not executed when inside false condition', function()
-    command('edit test_file')
+    command(fmt('edit %s'))
     eq('', exec_capture('if 0 | trust | endif'))
     eq(nil, vim.uv.fs_stat(fn.stdpath('state') .. pathsep .. 'trust'))
   end)
 
   it('trust then deny then remove a file using current buffer', function()
     local cwd = fn.getcwd()
-    local hash = fn.sha256(t.read_file('test_file'))
+    local hash = fn.sha256(assert(t.read_file(test_file)))
 
-    command('edit test_file')
-    matches('^Allowed in trust database%: ".*test_file"$', exec_capture('trust'))
+    command(fmt('edit %s'))
+    matches(fmt('^Allowed in trust database%%: ".*%s"$'), exec_capture('trust'))
     local trust = t.read_file(fn.stdpath('state') .. pathsep .. 'trust')
-    eq(string.format('%s %s', hash, cwd .. pathsep .. 'test_file'), vim.trim(trust))
+    eq(string.format('%s %s', hash, cwd .. pathsep .. test_file), vim.trim(trust))
 
-    matches('^Denied in trust database%: ".*test_file"$', exec_capture('trust ++deny'))
+    matches(fmt('^Denied in trust database%%: ".*%s"$'), exec_capture('trust ++deny'))
     trust = t.read_file(fn.stdpath('state') .. pathsep .. 'trust')
-    eq(string.format('! %s', cwd .. pathsep .. 'test_file'), vim.trim(trust))
+    eq(string.format('! %s', cwd .. pathsep .. test_file), vim.trim(trust))
 
-    matches('^Removed from trust database%: ".*test_file"$', exec_capture('trust ++remove'))
+    matches(fmt('^Removed from trust database%%: ".*%s"$'), exec_capture('trust ++remove'))
     trust = t.read_file(fn.stdpath('state') .. pathsep .. 'trust')
     eq(string.format(''), vim.trim(trust))
   end)
 
   it('deny then trust then remove a file using current buffer', function()
     local cwd = fn.getcwd()
-    local hash = fn.sha256(t.read_file('test_file'))
+    local hash = fn.sha256(assert(t.read_file(test_file)))
 
-    command('edit test_file')
-    matches('^Denied in trust database%: ".*test_file"$', exec_capture('trust ++deny'))
+    command(fmt('edit %s'))
+    matches(fmt('^Denied in trust database%%: ".*%s"$'), exec_capture('trust ++deny'))
     local trust = t.read_file(fn.stdpath('state') .. pathsep .. 'trust')
-    eq(string.format('! %s', cwd .. pathsep .. 'test_file'), vim.trim(trust))
+    eq(string.format('! %s', cwd .. pathsep .. test_file), vim.trim(trust))
 
-    matches('^Allowed in trust database%: ".*test_file"$', exec_capture('trust'))
+    matches(fmt('^Allowed in trust database%%: ".*%s"$'), exec_capture('trust'))
     trust = t.read_file(fn.stdpath('state') .. pathsep .. 'trust')
-    eq(string.format('%s %s', hash, cwd .. pathsep .. 'test_file'), vim.trim(trust))
+    eq(string.format('%s %s', hash, cwd .. pathsep .. test_file), vim.trim(trust))
 
-    matches('^Removed from trust database%: ".*test_file"$', exec_capture('trust ++remove'))
+    matches(fmt('^Removed from trust database%%: ".*%s"$'), exec_capture('trust ++remove'))
     trust = t.read_file(fn.stdpath('state') .. pathsep .. 'trust')
     eq(string.format(''), vim.trim(trust))
   end)
@@ -69,14 +75,11 @@ describe(':trust', function()
   it('deny then remove a file using file path', function()
     local cwd = fn.getcwd()
 
-    matches('^Denied in trust database%: ".*test_file"$', exec_capture('trust ++deny test_file'))
+    matches(fmt('^Denied in trust database%%: ".*%s"$'), exec_capture(fmt('trust ++deny %s')))
     local trust = t.read_file(fn.stdpath('state') .. pathsep .. 'trust')
-    eq(string.format('! %s', cwd .. pathsep .. 'test_file'), vim.trim(trust))
+    eq(string.format('! %s', cwd .. pathsep .. test_file), vim.trim(trust))
 
-    matches(
-      '^Removed from trust database%: ".*test_file"$',
-      exec_capture('trust ++remove test_file')
-    )
+    matches(fmt('^Removed from trust database%%: ".*%s"$'), exec_capture(fmt('trust ++remove %s')))
     trust = t.read_file(fn.stdpath('state') .. pathsep .. 'trust')
     eq(string.format(''), vim.trim(trust))
   end)

test/functional/legacy/normal_spec.lua

@@ -143,7 +143,7 @@ describe('normal', function()
     fn.mkdir(locale_dir, 'p')
     fn.filecopy(build_dir .. '/src/nvim/po/tr.mo', locale_dir .. '/nvim.mo')
     finally(function()
-      n.rmdir(build_dir .. '/share')
+      n.rmdir(vim.fs.dirname(locale_dir))
     end)
 
     clear({ env = { LANG = 'tr_TR.UTF-8' } })

test/functional/lua/option_and_var_spec.lua

@@ -128,8 +128,9 @@ describe('lua stdlib', function()
 
       -- Check if autoload works properly
       local pathsep = n.get_pathsep()
-      local xconfig = 'Xhome' .. pathsep .. 'Xconfig'
-      local xdata = 'Xhome' .. pathsep .. 'Xdata'
+      local xhome = 'Xhome_lua'
+      local xconfig = xhome .. pathsep .. 'Xconfig'
+      local xdata = xhome .. pathsep .. 'Xdata'
       local autoload_folder = table.concat({ xconfig, 'nvim', 'autoload' }, pathsep)
       local autoload_file = table.concat({ autoload_folder, 'testload.vim' }, pathsep)
       mkdir_p(autoload_folder)
@@ -138,7 +139,7 @@ describe('lua stdlib', function()
       clear { args_rm = { '-u' }, env = { XDG_CONFIG_HOME = xconfig, XDG_DATA_HOME = xdata } }
 
       eq(2, exec_lua("return vim.g['testload#value']"))
-      rmdir('Xhome')
+      rmdir(xhome)
     end)
 
     it('vim.b', function()

test/functional/lua/secure_spec.lua

@@ -19,7 +19,7 @@ local read_file = t.read_file
 
 describe('vim.secure', function()
   describe('read()', function()
-    local xstate = 'Xstate'
+    local xstate = 'Xstate_lua_secure'
     local screen ---@type test.functional.ui.screen
 
     before_each(function()
@@ -272,7 +272,9 @@ describe('vim.secure', function()
   end)
 
   describe('trust()', function()
-    local xstate = 'Xstate'
+    local xstate = 'Xstate_lua_secure'
+    local test_file = 'Xtest_functional_lua_secure'
+    local test_dir = 'Xtest_functional_lua_secure_dir'
 
     setup(function()
       clear { env = { XDG_STATE_HOME = xstate } }
@@ -280,20 +282,20 @@ describe('vim.secure', function()
 
     before_each(function()
       n.mkdir_p(xstate .. pathsep .. (is_os('win') and 'nvim-data' or 'nvim'))
-      t.write_file('test_file', 'test')
-      t.mkdir('test_dir')
+      t.write_file(test_file, 'test')
+      t.mkdir(test_dir)
     end)
 
     after_each(function()
-      os.remove('test_file')
-      n.rmdir('test_dir')
+      os.remove(test_file)
+      n.rmdir(test_dir)
       n.rmdir(xstate)
     end)
 
     it('returns error when passing both path and bufnr', function()
       matches(
         '"path" and "bufnr" are mutually exclusive',
-        pcall_err(exec_lua, [[vim.secure.trust({action='deny', bufnr=0, path='test_file'})]])
+        pcall_err(exec_lua, [[vim.secure.trust({action='deny', bufnr=0, path=...})]], test_file)
       )
     end)
 
@@ -306,10 +308,10 @@ describe('vim.secure', function()
 
     it('trust then deny then remove a file using bufnr', function()
       local cwd = fn.getcwd()
-      local hash = fn.sha256(assert(read_file('test_file')))
-      local full_path = cwd .. pathsep .. 'test_file'
+      local hash = fn.sha256(assert(read_file(test_file)))
+      local full_path = cwd .. pathsep .. test_file
 
-      command('edit test_file')
+      command('edit ' .. test_file)
       eq({ true, full_path }, exec_lua([[return {vim.secure.trust({action='allow', bufnr=0})}]]))
       local trust = assert(read_file(stdpath('state') .. pathsep .. 'trust'))
       eq(string.format('%s %s', hash, full_path), vim.trim(trust))
@@ -325,10 +327,10 @@ describe('vim.secure', function()
 
     it('deny then trust then remove a file using bufnr', function()
       local cwd = fn.getcwd()
-      local hash = fn.sha256(assert(read_file('test_file')))
-      local full_path = cwd .. pathsep .. 'test_file'
+      local hash = fn.sha256(assert(read_file(test_file)))
+      local full_path = cwd .. pathsep .. test_file
 
-      command('edit test_file')
+      command('edit ' .. test_file)
       eq({ true, full_path }, exec_lua([[return {vim.secure.trust({action='deny', bufnr=0})}]]))
       local trust = assert(read_file(stdpath('state') .. pathsep .. 'trust'))
       eq(string.format('! %s', full_path), vim.trim(trust))
@@ -344,24 +346,24 @@ describe('vim.secure', function()
 
     it('trust using bufnr then deny then remove a file using path', function()
       local cwd = fn.getcwd()
-      local hash = fn.sha256(assert(read_file('test_file')))
-      local full_path = cwd .. pathsep .. 'test_file'
+      local hash = fn.sha256(assert(read_file(test_file)))
+      local full_path = cwd .. pathsep .. test_file
 
-      command('edit test_file')
+      command('edit ' .. test_file)
       eq({ true, full_path }, exec_lua([[return {vim.secure.trust({action='allow', bufnr=0})}]]))
       local trust = assert(read_file(stdpath('state') .. pathsep .. 'trust'))
       eq(string.format('%s %s', hash, full_path), vim.trim(trust))
 
       eq(
         { true, full_path },
-        exec_lua([[return {vim.secure.trust({action='deny', path='test_file'})}]])
+        exec_lua([[return {vim.secure.trust({action='deny', path=...})}]], test_file)
       )
       trust = assert(read_file(stdpath('state') .. pathsep .. 'trust'))
       eq(string.format('! %s', full_path), vim.trim(trust))
 
       eq(
         { true, full_path },
-        exec_lua([[return {vim.secure.trust({action='remove', path='test_file'})}]])
+        exec_lua([[return {vim.secure.trust({action='remove', path=...})}]], test_file)
       )
       trust = assert(read_file(stdpath('state') .. pathsep .. 'trust'))
       eq('', vim.trim(trust))
@@ -369,13 +371,13 @@ describe('vim.secure', function()
 
     it('deny then trust then remove a file using bufnr', function()
       local cwd = fn.getcwd()
-      local hash = fn.sha256(assert(read_file('test_file')))
-      local full_path = cwd .. pathsep .. 'test_file'
+      local hash = fn.sha256(assert(read_file(test_file)))
+      local full_path = cwd .. pathsep .. test_file
 
-      command('edit test_file')
+      command('edit ' .. test_file)
       eq(
         { true, full_path },
-        exec_lua([[return {vim.secure.trust({action='deny', path='test_file'})}]])
+        exec_lua([[return {vim.secure.trust({action='deny', path=...})}]], test_file)
       )
       local trust = assert(read_file(stdpath('state') .. pathsep .. 'trust'))
       eq(string.format('! %s', full_path), vim.trim(trust))
@@ -386,7 +388,7 @@ describe('vim.secure', function()
 
       eq(
         { true, full_path },
-        exec_lua([[return {vim.secure.trust({action='remove', path='test_file'})}]])
+        exec_lua([[return {vim.secure.trust({action='remove', path=...})}]], test_file)
       )
       trust = assert(read_file(stdpath('state') .. pathsep .. 'trust'))
       eq('', vim.trim(trust))
@@ -402,8 +404,8 @@ describe('vim.secure', function()
 
     it('trust then deny then remove a directory using bufnr', function()
       local cwd = fn.getcwd()
-      local full_path = cwd .. pathsep .. 'test_dir'
-      command('edit test_dir')
+      local full_path = cwd .. pathsep .. test_dir
+      command('edit ' .. test_dir)
 
       eq({ true, full_path }, exec_lua([[return {vim.secure.trust({action='allow', bufnr=0})}]]))
       local trust = assert(read_file(stdpath('state') .. pathsep .. 'trust'))

test/functional/plugin/spellfile_spec.lua

@@ -6,8 +6,8 @@ local neq = t.neq
 local exec_lua = n.exec_lua
 
 describe('nvim.spellfile', function()
-  local data_root = 'Xtest_data'
-  local rtp_dir = 'Xtest_rtp'
+  local data_root = 'Xtest_data_spellfile'
+  local rtp_dir = 'Xtest_rtp_spellfile'
 
   before_each(function()
     n.clear()

test/functional/ui/messages_spec.lua

@@ -2447,7 +2447,7 @@ describe('ui/msg_puts_printf', function()
     fn.mkdir(locale_dir, 'p')
     fn.filecopy(build_dir .. '/src/nvim/po/ja.mo', locale_dir .. '/nvim.mo')
     finally(function()
-      n.rmdir(build_dir .. '/share')
+      n.rmdir(vim.fs.dirname(locale_dir))
     end)
 
     cmd = cmd .. '"' .. nvim_prog .. '" -u NONE -i NONE -Es -V1'

test/functional/vimscript/executable_spec.lua

@@ -33,9 +33,15 @@ describe('executable()', function()
     end)
 
     it('stdpath respects shellslash', function()
-      eq([[build\Xtest_xdg\share\nvim-data]], call('fnamemodify', call('stdpath', 'data'), ':.'))
+      t.matches(
+        [[build\Xtest_xdg[%w_]*\share\nvim%-data]],
+        call('fnamemodify', call('stdpath', 'data'), ':.')
+      )
       command('set shellslash')
-      eq('build/Xtest_xdg/share/nvim-data', call('fnamemodify', call('stdpath', 'data'), ':.'))
+      t.matches(
+        'build/Xtest_xdg[%w_]*/share/nvim%-data',
+        call('fnamemodify', call('stdpath', 'data'), ':.')
+      )
     end)
   end