test: test improvements and conversion of test_client to stub LSP

Author: AntoineGS

tests/child_helper.lua

@@ -1,5 +1,7 @@
 local env = require("tests.env")
-local M = {}
+local M = {
+  mock_lsp_server = false,
+}
 
 if not _G.attach_debugger then
   _G.attach_debugger = false
@@ -59,6 +61,7 @@ function M.new_child_neovim(test_name)
 
   ---@param mock_lsp_server? boolean
   function child.run_pre_case(mock_lsp_server)
+    M.mock_lsp_server = mock_lsp_server or false
     child.reset_config()
     child.restart({ "-u", "tests/scripts/minimal_init.lua" })
 
@@ -124,15 +127,35 @@ function M.new_child_neovim(test_name)
   end
 
   function child.wait_for_suggestion()
-    child.lua([[
+    if M.mock_lsp_server then
+      child.lua([[
+      vim.wait(500, function()
+        return M.suggested
+      end, 10)
+    ]])
+    else
+      child.lua([[
       vim.wait(5000, function()
         return M.suggested
       end, 10)
     ]])
+    end
   end
 
   function child.wait_for_panel_suggestion()
-    child.lua([[
+    if M.mock_lsp_server then
+      child.lua([[
+      local function suggestion_is_visible()
+        lines = vim.api.nvim_buf_get_lines(2, 4, 5, false)
+        return lines[1] and (lines[1] == "789" or lines[1] == "789\r")
+      end
+
+      vim.wait(500, function()
+        return suggestion_is_visible()
+      end, 50)
+    ]])
+    else
+      child.lua([[
       local function suggestion_is_visible()
         lines = vim.api.nvim_buf_get_lines(2, 4, 5, false)
         return lines[1] and (lines[1] == "789" or lines[1] == "789\r")
@@ -142,6 +165,7 @@ function M.new_child_neovim(test_name)
         return suggestion_is_visible()
       end, 50)
     ]])
+    end
   end
 
   return child

tests/stubs/lsp_server.lua

@@ -111,7 +111,15 @@ function M.server()
     -- }
     -- handler(nil, empty_response)
     elseif method == "checkStatus" then
-      handler(nil, { user = "someUser", status = "OK" })
+      vim.defer_fn(function()
+        handler(nil, { user = "someUser", status = "OK" })
+        local handlers = require("copilot.status").handlers
+        handlers.statusNotification(
+          nil,
+          { busy = false, kind = "Normal", message = "", status = "Normal" },
+          { client_id = 1, method = "statusNotification" }
+        )
+      end, 10)
     elseif method == "notifyAccepted" or method == "notifyRejected" or method == "notifyShown" then
       handler(nil, {})
     elseif method == "getPanelCompletions" then

tests/test_client.lua

@@ -7,7 +7,7 @@ local T = MiniTest.new_set({
   hooks = {
     pre_once = function() end,
     pre_case = function()
-      child.run_pre_case()
+      child.run_pre_case(true)
       child.lua("s = require('copilot.status')")
       child.lua("c = require('copilot.client')")
     end,
@@ -40,7 +40,7 @@ T["client()"]["status info"] = function()
       end
     end
 
-    vim.wait(5000, function()
+    vim.wait(500, function()
       return has_passed()
     end, 50)
 
@@ -192,7 +192,7 @@ T["client()"]["manually detached buffer stays detached"] = function()
       end
     end
 
-    vim.wait(5000, function()
+    vim.wait(500, function()
       return has_passed()
     end, 50)
 
@@ -255,7 +255,7 @@ end
 --       end
 --     end
 --
---     vim.wait(1000, function()
+--     vim.wait(500, function()
 --       return has_passed()
 --     end, 50)
 --
@@ -280,7 +280,7 @@ T["client()"]["auto_trigger off - will attach automatically"] = function()
       end
     end
 
-    vim.wait(5000, function()
+    vim.wait(500, function()
       return has_passed()
     end, 50)
 
@@ -306,7 +306,7 @@ T["client()"]["suggestion and panel off - will attach automatically"] = function
       end
     end
 
-    vim.wait(5000, function()
+    vim.wait(500, function()
       return has_passed()
     end, 50)
 
@@ -331,7 +331,7 @@ end
 --       end
 --     end
 --
---     vim.wait(5000, function()
+--     vim.wait(500, function()
 --       return has_passed()
 --     end, 50)
 --

tests/test_command.lua

@@ -1,5 +1,5 @@
 local child_helper = require("tests.child_helper")
-local child = child_helper.new_child_neovim("test_suggestion")
+local child = child_helper.new_child_neovim("test_command")
 local u = require("tests.utils")
 local reference_screenshot = MiniTest.expect.reference_screenshot
 
@@ -33,7 +33,7 @@ T["command()"]["panel toggle - close works"] = function()
   child.configure_copilot()
   child.cmd("Copilot panel toggle")
   child.cmd("Copilot panel toggle")
-  reference_screenshot(child.get_screenshot())
+  reference_screenshot(child.get_screenshot(), nil, { ignore_text = { 23, 24 }, ignore_attr = { 23, 24 } })
 end
 
 T["command()"]["panel open - it works"] = function()

tests/test_suggestion.lua

@@ -29,7 +29,7 @@ T["suggestion()"]["auto_trigger is false, will not show ghost test"] = function(
   child.o.lines, child.o.columns = 10, 15
   child.configure_copilot()
   child.type_keys("i123", "<Esc>", "o456", "<Esc>", "o7")
-  vim.loop.sleep(50)
+  child.wait_for_suggestion()
 
   reference_screenshot(child.get_screenshot(), nil, { ignore_text = { 9, 10 }, ignore_attr = { 9, 10 } })
 end