test: migrate testing to busted

.busted

@@ -0,0 +1,13 @@
+return {
+  _all = {
+    coverage = false,
+    lpath = "lua/?.lua;lua/?/init.lua",
+    lua = "~/.luarocks/bin/nlua",
+  },
+  default = {
+    verbose = true
+  },
+  tests = {
+    verbose = true
+  },
+}

.github/workflows/ci.yml

@@ -84,13 +84,15 @@ jobs:
           neovim: true
           version: ${{ matrix.neovim_version }}
 
-      - name: Prepare plenary
-        run: |
-          git clone --depth 1 https://github.com/nvim-lua/plenary.nvim ~/.local/share/nvim/site/pack/vendor/start/plenary.nvim
-          ln -s $(pwd) ~/.local/share/nvim/site/pack/vendor/start
+      - name: Install Lua
+        uses: leso-kn/gh-actions-lua@master
+        with:
+          luaVersion: "5.1"
 
-      - name: Run setup tests
-        run: make test-setup
+      - name: Install Luarocks
+        uses: hishamhm/gh-actions-luarocks@master
+        with:
+          luarocksVersion: "3.11.0"
 
       - name: Run tests
         run: make test

Makefile

@@ -1,25 +1,25 @@
 format:
-	stylua lua/ tests/
+	stylua lua/ spec/
 
 format-check:
-	stylua --check lua/ tests/
+	stylua --check lua/ spec/
 
 lint:
-	selene lua/ tests/
+	selene lua/ spec/
 
 local-test-setup:
 	git clone https://github.com/ckipp01/multiple-build-file-example.git
 	git clone https://github.com/ckipp01/mill-minimal.git
 	git clone https://github.com/ckipp01/minimal-scala-cli-test.git
 
 test-setup:
-	nvim --headless --noplugin -u tests/minimal.vim -c "PlenaryBustedDirectory tests/setup/ { minimal = true, sequential = true }"
+	luarocks test spec/setup --local
 
 test:
-	nvim --headless --noplugin -u tests/minimal.vim -c "PlenaryBustedDirectory tests/tests/ { minimal = true, sequential = true }"
+	luarocks test --local
 
 test-handlers:
-	nvim --headless --noplugin -u tests/minimal.vim -c "PlenaryBustedDirectory tests/tests/handlers/ { minimal = true, sequential = true }"
+	luarocks test spec/tests/test-handlers --local
 
 clean:
 	rm -rf mill-minimal

lua/metals/status.lua

@@ -2,19 +2,23 @@ local log = require("metals.log")
 
 -- @param status (string) a new status to be displayed
 local function set_status(status, type)
-  -- Scaping the status to prevent % characters breaking the statusline
-  local scaped_status = status:gsub("[%%]", "%%%1")
-  local _status = "_status"
-  local metals = "metals"
-  local status_var = nil
-  if type and type == metals then
-    status_var = type .. _status
-  elseif type then
-    status_var = "metals_" .. type .. _status
-  else
-    status_var = metals .. _status
+  -- Not really sure why but this is at times getting called when status is nil
+  -- so in that scenario we just do nothing
+  if status ~= nil then
+    -- Scaping the status to prevent % characters breaking the statusline
+    local scaped_status = status:gsub("[%%]", "%%%1")
+    local _status = "_status"
+    local metals = "metals"
+    local status_var = nil
+    if type and type == metals then
+      status_var = type .. _status
+    elseif type then
+      status_var = "metals_" .. type .. _status
+    else
+      status_var = metals .. _status
+    end
+    vim.api.nvim_set_var(status_var, scaped_status)
   end
-  vim.api.nvim_set_var(status_var, scaped_status)
 end
 
 -- Used to handle the full status response from Metals

nvim-metals-scm-1.rockspec

@@ -0,0 +1,18 @@
+rockspec_format = '3.0'
+package = 'nvim-metals'
+version = 'scm-1'
+
+test_dependencies = {
+  'lua >= 5.1',
+  'nlua',
+  'nui.nvim',
+  'plenary.nvim'
+}
+
+source = {
+  url = 'git://github.com/scalameta/' .. package,
+}
+
+build = {
+  type = 'builtin',
+}