test: migrate to Neovim busted

.github/workflows/ci.yml

@@ -38,7 +38,7 @@ jobs:
           GH_TOKEN: ${{ github.token }}
           NEOVIM_PATH: ${{ github.workspace }}/neovim
         run: |
-          make patch-runner
+          # make patch-runner
           cd neovim
           TEST_FILE=test/functional/example_spec.lua make functionaltest
 

Makefile

@@ -1,22 +1,25 @@
-.PHONY: test patch-runner
+.PHONY: validate test
 
-# nvim -c "set runtimepath+=." -l test/gh_spec.lua
+TEST_CWD := $(shell pwd)
+
+validate:
+ifeq ($(NEOVIM_PATH),)
+	$(error NEOVIM_PATH is not set. Export it or pass it like: make NEOVIM_PATH=/path/to/neovim test)
+endif
 
 # Run tests with "nvim -l" instead of "-ll", so tests can use the full "vim."
 # API from the Nvim test harness process itself.
-patch-runner:
-	@if grep -q -- "-ll " "$(NEOVIM_PATH)/cmake/RunTests.cmake"; then \
-		echo "Patching RunTests.cmake (-ll → -l)..."; \
-		sed -i.bak 's/-ll /-l /' "$(NEOVIM_PATH)/cmake/RunTests.cmake" && rm -f "$(NEOVIM_PATH)/cmake/RunTests.cmake.bak"; \
-	else \
-		echo "RunTests.cmake already patched; skipping."; \
-	fi
+# patch-runner: validate
+# 	@if grep -q -- "-ll " "$(NEOVIM_PATH)/cmake/RunTests.cmake"; then \
+# 		echo "Patching RunTests.cmake (-ll → -l)..."; \
+# 		sed -i.bak 's/-ll /-l /' "$(NEOVIM_PATH)/cmake/RunTests.cmake" && rm -f "$(NEOVIM_PATH)/cmake/RunTests.cmake.bak"; \
+# 	else \
+# 		echo "RunTests.cmake already patched; skipping."; \
+# 	fi
 
 
-test: patch-runner
-ifeq ($(NEOVIM_PATH),)
-	$(error NEOVIM_PATH is not set)
-endif
+test: validate
 	ln -sf $(shell pwd) $(NEOVIM_PATH)/test/functional/guh.nvim
 	@cd $(NEOVIM_PATH) && env GH_TOKEN=$${GH_TOKEN:-$(shell gh auth token 2>/dev/null)} \
+		TEST_CWD=$(TEST_CWD) \
 		TEST_FILE=test/functional/guh.nvim/test/gh_spec.lua make functionaltest

README.md

@@ -43,6 +43,16 @@ Requirements:
    without doing a checkout.
 5. (TODO) PR comments will display on relevant git objects.
 
+## Development
+
+Run the tests:
+
+    NEOVIM_PATH='/path/to/neovim/' make test
+
+Run specific tests:
+
+    NEOVIM_PATH='/path/to/neovim/' make test TEST_FILTER=load_comments
+
 ## Related
 
 - https://github.com/pwntester/octo.nvim