ci: initial release for automated tests

Author: AntoineGS

.github/workflows/ci.yaml

@@ -0,0 +1,46 @@
+name: Tests
+
+on: [push, pull_request]
+
+jobs:
+  unit_tests:
+    name: unit tests
+    if: github.repository == 'AntoineGS/copilot.lua'
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-24.04, ubuntu-24.04-arm, macos-latest, windows-2025]
+        rev: [nightly, v0.10.4, v0.11.0]
+        include:
+          - os: ubuntu-24.04
+            install-rg: sudo apt-get update && sudo apt-get install -y nodejs curl
+          - os: ubuntu-24.04-arm
+            install-rg: sudo apt-get update && sudo apt-get install -y nodejs curl
+          - os: macos-latest
+            install-rg: brew update && brew install node curl
+          - os: windows-2025
+            install-rg: choco install nodejs-lts curl
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: rhysd/action-setup-vim@v1
+        with:
+          neovim: true
+          version: ${{ matrix.rev }}
+
+      - name: Prepare
+        run: |
+          ${{ matrix.install-rg }}
+          mkdir deps
+          mkdir ./tests/logs
+          git clone --filter=blob:none https://github.com/echasnovski/mini.nvim deps/mini.nvim
+          mv ./tests/env.lua.ci ./tests/env.lua
+
+      - name: Run tests
+        env:
+          GH_COPILOT_TOKEN: ${{ secrets.GH_COPILOT_TOKEN }}
+        run: |
+          nvim --version
+          make test

Makefile

@@ -1,11 +1,11 @@
 # Run all test files
 # test: deps/mini.nvim
 test: 
-	nvim --headless --noplugin -u ./scripts/minimal_init.lua -c "lua MiniTest.run()"
+	nvim --headless --noplugin -u ./tests/scripts/minimal_init.lua -c "lua MiniTest.run()"
 
 # Run test from file at `$FILE` environment variable
 test_file: deps/mini.nvim
-	nvim --headless --noplugin -u ./scripts/minimal_init.lua -c "lua MiniTest.run_file('$(FILE)')"
+	nvim --headless --noplugin -u ./tests/scripts/minimal_init.lua -c "lua MiniTest.run_file('$(FILE)')"
 
 # Download 'mini.nvim' to use its 'mini.test' testing module
 # deps/mini.nvim:

lua/copilot/auth/init.lua

@@ -145,10 +145,10 @@ function M.find_config_path()
     config = vim.fn.expand("~/.config")
     if vim.fn.isdirectory(config) > 0 then
       return config
-    else
-      logger.error("could not find config path")
     end
   end
+
+  logger.error("could not find config path")
 end
 
 M.get_creds = function()

tests/child_helper.lua

@@ -60,8 +60,11 @@ function M.new_child_neovim(test_name)
   function child.run_pre_case()
     child.reset_config()
     child.restart({ "-u", "tests/scripts/minimal_init.lua" })
-    child.fn.setenv("GITHUB_COPILOT_TOKEN", env.COPILOT_TOKEN)
+    if env.COPILOT_TOKEN and env.COPILOT_TOKEN ~= "" then
+      child.fn.setenv("GITHUB_COPILOT_TOKEN", env.COPILOT_TOKEN)
+    end
     child.setup_and_wait_for_debugger()
+    child.lua("M = require('copilot')")
   end
 
   function child.configure_copilot()

tests/env.lua.ci

@@ -0,0 +1,5 @@
+local M = {
+  COPILOT_TOKEN = '',
+}
+
+return M

tests/test_auth.lua

@@ -2,9 +2,10 @@ local child_helper = require("tests.child_helper")
 local child = child_helper.new_child_neovim("test_auth")
 local u = require("tests.utils")
 
-local config_path = require("copilot.auth").find_config_path()
+local config_path = require("copilot.auth").find_config_path() .. "/github-copilot"
 local config_path_renamed = config_path .. "_temp_renamed"
 
+--TODO: find a way to not mess with folders
 local T = MiniTest.new_set({
   hooks = {
     pre_once = function()
@@ -14,13 +15,6 @@ local T = MiniTest.new_set({
     end,
     pre_case = function()
       child.run_pre_case()
-      child.lua("M = require('copilot')")
-      child.lua("c = require('copilot.client')")
-      child.lua("s = require('copilot.status')")
-      child.lua("cmd = require('copilot.command')")
-      child.lua("a = require('copilot.api')")
-      child.lua("logger = require('copilot.logger')")
-      child.fn.setenv("GITHUB_COPILOT_TOKEN", vim.NIL)
     end,
     post_once = function()
       child.stop()
@@ -34,22 +28,59 @@ local T = MiniTest.new_set({
 
 T["auth()"] = MiniTest.new_set()
 
--- TODO: callback for this too
 T["auth()"]["auth before attaching, should not give error"] = function()
   child.configure_copilot()
   child.cmd("Copilot auth")
-  vim.loop.sleep(3000)
-  local messages = child.cmd_capture("messages")
+
+  local messages = child.lua([[
+    local messages = ""
+    local function has_passed()
+      messages = vim.api.nvim_exec("messages", { output = true }) or ""
+      return string.find(messages, ".*Authenticated as GitHub user.*") ~= nil
+    end
+
+    vim.wait(30000, function()
+      return has_passed()
+    end, 50)
+
+    return messages 
+  ]])
+
   u.expect_match(messages, ".*Authenticated as GitHub user.*")
 end
 
 T["auth()"]["auth issue replication"] = function()
   child.configure_copilot()
   child.cmd("Copilot auth")
-  vim.loop.sleep(2000)
+
+  child.lua([[
+    local messages = ""
+    local function has_passed()
+      messages = vim.api.nvim_exec("messages", { output = true }) or ""
+      return string.find(messages, ".*Authenticated as GitHub user.*") ~= nil
+    end
+
+    vim.wait(30000, function()
+      return has_passed()
+    end, 50)
+  ]])
+
   child.cmd("Copilot status")
-  vim.loop.sleep(500)
-  local messages = child.cmd_capture("messages")
+
+  local messages = child.lua([[
+    local messages = ""
+    local function has_passed()
+      messages = vim.api.nvim_exec("messages", { output = true }) or ""
+      return string.find(messages, ".*Online.*Enabled.*") ~= nil
+    end
+
+    vim.wait(30000, function()
+      return has_passed()
+    end, 50)
+
+    return messages 
+  ]])
+
   u.expect_match(messages, ".*Online.*Enabled.*")
 end
 

tests/test_base_to_organize.lua

@@ -6,7 +6,6 @@ local T = MiniTest.new_set({
   hooks = {
     pre_case = function()
       child.run_pre_case()
-      child.lua([[M = require('copilot')]])
       child.lua([[s = require('copilot.status')]])
       child.lua([[a = require('copilot.api')]])
     end,

tests/test_client.lua

@@ -7,7 +7,6 @@ local T = MiniTest.new_set({
     pre_once = function() end,
     pre_case = function()
       child.run_pre_case()
-      child.lua("M = require('copilot')")
       child.lua("s = require('copilot.status')")
       child.lua("c = require('copilot.client')")
     end,
@@ -30,8 +29,23 @@ T["client()"] = MiniTest.new_set()
 T["client()"]["status info"] = function()
   child.configure_copilot()
   child.cmd("Copilot status")
-  vim.loop.sleep(500)
-  local messages = child.cmd_capture("messages")
+
+  local messages = child.lua([[
+    local messages = ""
+    local function has_passed()
+      messages = vim.api.nvim_exec("messages", { output = true }) or ""
+      if messages:find(".*Online.*Enabled.*") then
+        return true
+      end
+    end
+
+    vim.wait(30000, function()
+      return has_passed()
+    end, 50)
+
+    return messages
+  ]])
+
   u.expect_match(messages, ".*Online.*Enabled.*")
 end
 

tests/test_panel.lua

@@ -8,7 +8,6 @@ local T = MiniTest.new_set({
     pre_case = function()
       child.run_pre_case()
       child.bo.readonly = false
-      child.lua("M = require('copilot')")
       child.lua("p = require('copilot.panel')")
     end,
     post_once = child.stop,
@@ -17,7 +16,6 @@ local T = MiniTest.new_set({
 
 T["panel()"] = MiniTest.new_set()
 
--- This test can fail if the LSP is taking more time than usual and re-running it passes
 T["panel()"]["panel suggestions works"] = function()
   child.o.lines, child.o.columns = 30, 100
   child.config.panel = child.config.panel .. "auto_refresh = true,"
@@ -26,16 +24,23 @@ T["panel()"]["panel suggestions works"] = function()
   child.type_keys("i123", "<Esc>", "o456", "<Esc>", "o7")
   child.lua("p.toggle()")
 
-  local i = 0
-  local lines = ""
-  while i < 50 do
-    vim.loop.sleep(200)
-    child.lua("vim.wait(0)")
-    lines = child.api.nvim_buf_get_lines(2, 4, 5, false)
-    if lines[1] == "789" then
-      break
+  local lines = child.lua([[
+    local messages = ""
+    local function suggestion_is_visible()
+      lines = vim.api.nvim_buf_get_lines(2, 4, 5, false)
+      return lines[1] == "789" or lines[1] == "789\r"
     end
-    i = i + 1
+
+    vim.wait(30000, function()
+      return suggestion_is_visible()
+    end, 50)
+
+    return lines
+  ]])
+
+  -- For Windows, on some shells not all
+  if lines[1] == "789\r" then
+    lines[1] = "789"
   end
 
   eq(lines[1], "789")

tests/test_suggestion.lua

@@ -8,7 +8,6 @@ local T = MiniTest.new_set({
     pre_case = function()
       child.run_pre_case()
       child.bo.readonly = false
-      child.lua("M = require('copilot')")
     end,
     post_once = child.stop,
   },