ci(tests): run tests on multiple OS (#921)

Author: kristijanhusak

.github/workflows/tests.yml

@@ -24,13 +24,17 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
+        os:
+          - ubuntu-latest
+          - windows-latest
+          - macos-latest
         version:
           - v0.10.1
           - v0.10.2
           - v0.10.3
           - v0.10.4
           - nightly
-    runs-on: ubuntu-latest
+    runs-on: ${{ matrix.os }}
     steps:
       - uses: actions/checkout@v4
       - name: Install Neovim

Makefile

@@ -4,7 +4,7 @@ test:
 	nvim --headless --clean -u tests/test.lua "$(FILE)"
 # Re-run CI tests 3 times before failing, to avoid reporting false negatives
 test-ci:
-	for i in {1..3}; do nvim --headless --clean -u tests/test.lua && break || sleep 1; done
+	for i in {1..3}; do nvim --headless --clean -u tests/test.lua && s=0 && break || s=$$? && sleep 1; done; exit $$s
 vim_docs:
 	./scripts/build_docs.sh
 api_docs:

docs/contributing.org

@@ -91,6 +91,9 @@ specific spec you want to test. Example:
 make test FILE=./tests/plenary/api/api_spec.lua
 #+end_example
 
+📝 NOTE: Tests are currently not working on Windows. Test run will only verify if tree-sitter grammar
+can be installed, and exit with a success message.
+
 **** Parser
 :PROPERTIES:
 :CUSTOM_ID: parser

lua/orgmode/utils/treesitter/install.lua

@@ -10,25 +10,22 @@ local required_version = '2.0.0'
 function M.install()
   local version_info = M.get_version_info()
   if not version_info.installed then
-    M.run('install')
-    return true
+    return M.run('install')
   end
 
   -- Parser found but in invalid location
   if not version_info.install_location then
-    M.run('install')
+    local result = M.run('install')
     M.notify_conflicting_parsers(version_info.conflicting_parsers)
-    return true
+    return result
   end
 
   if version_info.outdated then
-    M.run('update')
-    return true
+    return M.run('update')
   end
 
   if version_info.version_mismatch then
-    M.reinstall()
-    return true
+    return M.reinstall()
   end
 
   M.notify_conflicting_parsers(version_info.conflicting_parsers)
@@ -93,7 +90,9 @@ function M.get_version_info()
 end
 
 function M.get_parser_locations()
-  local installed_org_parsers = vim.api.nvim_get_runtime_file('parser/org.so', true)
+  local installed_org_parsers = vim.tbl_map(function(item)
+    return vim.fn.fnamemodify(item, ':p')
+  end, vim.api.nvim_get_runtime_file('parser/org.so', true))
   local parser_path = M.get_parser_path()
   local install_location = nil
   local conflicting_parsers = {}
@@ -229,6 +228,7 @@ function M.get_path(url, type)
 end
 
 ---@param type? 'install' | 'update' | 'reinstall''
+---@return OrgPromise<boolean>
 function M.run(type)
   local url = 'https://github.com/nvim-orgmode/tree-sitter-org'
   local compiler = vim.tbl_filter(function(exe)
@@ -241,6 +241,7 @@ function M.run(type)
 
   local compiler_args = M.select_compiler_args(compiler)
   local path = nil
+  local lock_file = M.get_lock_file()
 
   return M.get_path(url, type)
     :next(function(directory)
@@ -250,17 +251,18 @@ function M.run(type)
         cwd = directory,
       })
     end)
-    :next(vim.schedule_wrap(function(code)
+    :next(function(code)
       if code ~= 0 then
         error('[orgmode] Failed to compile parser', 0)
       end
       local source = vim.fs.joinpath(path, 'parser.so')
-      local destination = M.get_parser_path()
-      local renamed = vim.fn.rename(source, destination)
-      if renamed ~= 0 then
-        error('[orgmode] Failed to move generated tree-sitter parser to runtime folder', 0)
+      local copied, err = vim.uv.fs_copyfile(source, M.get_parser_path())
+      if not copied then
+        error('[orgmode] Failed to copy generated tree-sitter parser to runtime folder: ' .. err, 0)
       end
-      utils.writefile(M.get_lock_file(), vim.json.encode({ version = required_version })):wait()
+      return utils.writefile(lock_file, vim.json.encode({ version = required_version }))
+    end)
+    :next(vim.schedule_wrap(function()
       local msg = { 'Tree-sitter grammar installed!' }
 
       if type == 'update' then

tests/plenary/capture/capture_spec.lua

@@ -146,7 +146,7 @@ describe('Refile', function()
         destination_file = destination_file,
       })
       :wait()
-    vim.cmd('edit' .. vim.fn.fnameescape(destination_file.filename))
+    vim.cmd('edit ' .. vim.fn.fnameescape(destination_file.filename))
     assert.are.same({
       '* foo',
     }, vim.api.nvim_buf_get_lines(0, 0, -1, false))
@@ -177,7 +177,7 @@ describe('Refile', function()
         source_headline = item,
       })
       :wait()
-    vim.cmd('edit' .. vim.fn.fnameescape(destination_file.filename))
+    vim.cmd('edit ' .. vim.fn.fnameescape(destination_file.filename))
     assert.are.same({
       '* foobar',
       '* baz',
@@ -208,7 +208,7 @@ describe('Refile', function()
         destination_headline = destination_file:get_headlines()[1],
       })
       :wait()
-    vim.cmd('edit' .. vim.fn.fnameescape(destination_file.filename))
+    vim.cmd('edit ' .. vim.fn.fnameescape(destination_file.filename))
     assert.are.same({
       '* foobar',
       '** baz',
@@ -242,7 +242,7 @@ describe('Capture', function()
         },
       }),
     })
-    vim.cmd('edit' .. vim.fn.fnameescape(destination_file.filename))
+    vim.cmd('edit ' .. vim.fn.fnameescape(destination_file.filename))
     assert.are.same({
       '',
       '',
@@ -279,7 +279,7 @@ describe('Capture', function()
         },
       }),
     })
-    vim.cmd('edit' .. vim.fn.fnameescape(destination_file.filename))
+    vim.cmd('edit ' .. vim.fn.fnameescape(destination_file.filename))
     assert.are.same({
       '* foobar',
       '',
@@ -320,7 +320,7 @@ describe('Capture', function()
         },
       }),
     })
-    vim.cmd('edit' .. vim.fn.fnameescape(destination_file.filename))
+    vim.cmd('edit ' .. vim.fn.fnameescape(destination_file.filename))
     assert.are.same({
       '* foobar',
       '',
@@ -356,7 +356,7 @@ describe('Capture', function()
         regexp = 'appendhere',
       }),
     })
-    vim.cmd('edit' .. vim.fn.fnameescape(destination_file.filename))
+    vim.cmd('edit ' .. vim.fn.fnameescape(destination_file.filename))
     assert.are.same({
       '#+title foo',
       'appendhere',

tests/test.lua

@@ -1,3 +1,18 @@
+-- Ensure that tree-sitter grammar can be correctly installed, exit early on error
+vim.opt.runtimepath:prepend(vim.fn.fnamemodify(debug.getinfo(1, 'S').source:sub(2), ':p:h:h'))
+local ok, err = pcall(function()
+  return require('orgmode.utils.treesitter.install').install()
+end)
+if not ok then
+  print(vim.inspect(err), '\n')
+  return os.exit(1)
+end
+
+-- Do not run tests on Windows, just ensure that tree-sitter grammar can be installed.
+if vim.fn.has('win32') > 0 then
+  return os.exit(0)
+end
+
 require('tests.minimal_init')
 ---@type string
 local test_file = vim.v.argv[#vim.v.argv]