test: cleanup some tests, finish conversion to LSP mock

Author: AntoineGS

Makefile

@@ -10,5 +10,5 @@ test_file: deps/mini.nvim
 # Download 'mini.nvim' to use its 'mini.test' testing module
 # deps/mini.nvim:
 # 	@mkdir deps
-# 	git clone --filter=blob:none https://github.com/echasnovski/mini.nvim deps/mini.nvim 
+# 	git clone --filter=blob:none https://github.com/nvim-mini/mini.nvim deps/mini.nvim 
 # 	git clone https://github.com/jbyuki/one-small-step-for-vimkind deps/osv

tests/child_helper.lua

@@ -61,11 +61,11 @@ 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
+    M.mock_lsp_server = mock_lsp_server or true
     child.reset_config()
     child.restart({ "-u", "tests/scripts/minimal_init.lua" })
 
-    if mock_lsp_server then
+    if M.mock_lsp_server then
       child.lua('package.loaded["copilot.lsp"] = require("tests.stubs.lsp_init")')
     end
 

tests/stubs/lsp_server.lua

@@ -105,7 +105,9 @@ function M.server()
       -- if not seen_files[params.textDocument.uri] then
       -- seen_files[params.textDocument.uri] = true
       local response = get_lsp_responses(params.textDocument)
-      handler(nil, response)
+      vim.defer_fn(function()
+        handler(nil, response)
+      end, 10)
     -- local empty_response = {
     --   edits = {},
     -- }
@@ -126,11 +128,10 @@ function M.server()
       local params_panel = params or {}
       local panelId = params_panel.panelId or (params_panel.doc and params_panel.doc.panelId) or "test-panel-id"
 
-      handler(nil, {
-        solutionCountTarget = 10,
-      })
-
       vim.defer_fn(function()
+        handler(nil, {
+          solutionCountTarget = 10,
+        })
         local handlers = require("copilot.panel.handlers")
 
         handlers.handlers.PanelSolution(nil, {

tests/test_auth.lua

@@ -2,26 +2,14 @@ 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() .. "/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()
-      if vim.fn.isdirectory(config_path) == 1 then
-        vim.fn.rename(config_path, config_path_renamed)
-      end
-    end,
+    pre_once = function() end,
     pre_case = function()
-      child.run_pre_case()
+      child.run_pre_case(true)
     end,
     post_once = function()
       child.stop()
-
-      if vim.fn.isdirectory(config_path_renamed) == 1 then
-        vim.fn.rename(config_path_renamed, config_path)
-      end
     end,
   },
 })

tests/test_base_to_organize.lua

@@ -5,7 +5,7 @@ local child = child_helper.new_child_neovim("test_base_to_organize")
 local T = MiniTest.new_set({
   hooks = {
     pre_case = function()
-      child.run_pre_case()
+      child.run_pre_case(true)
       child.lua([[s = require('copilot.status')]])
       child.lua([[a = require('copilot.api')]])
     end,

tests/test_command.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.bo.readonly = false
     end,
     post_once = child.stop,
@@ -20,13 +20,13 @@ T["command()"]["version works"] = function()
   child.configure_copilot()
   child.cmd("Copilot version")
   local result = child.cmd_capture("mess")
-  u.expect_match(result, ".*copilot language server.*copilot%.lua.*Node%.js.*language%-server%.js.*")
+  u.expect_match(result, ".*copilot language server.*copilot%.lua.*mocked.*")
 end
 
 T["command()"]["panel toggle - open works"] = function()
   child.configure_copilot()
   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 toggle - close works"] = function()
@@ -39,14 +39,14 @@ end
 T["command()"]["panel open - it works"] = function()
   child.configure_copilot()
   child.cmd("Copilot panel open")
-  reference_screenshot(child.get_screenshot())
+  reference_screenshot(child.get_screenshot(), nil, { ignore_text = { 23, 24 }, ignore_attr = { 23, 24 } })
 end
 
 T["command()"]["panel close - it works"] = function()
   child.configure_copilot()
   child.cmd("Copilot panel open")
   child.cmd("Copilot panel close")
-  reference_screenshot(child.get_screenshot())
+  reference_screenshot(child.get_screenshot(), nil, { ignore_text = { 23, 24 }, ignore_attr = { 23, 24 } })
 end
 
 T["command()"]["panel is_open - is opened - returns true"] = function()

tests/test_nodejs.lua

@@ -7,6 +7,7 @@ local T = MiniTest.new_set({
     pre_case = function()
       -- Reset the module state before each test
       package.loaded["copilot.lsp.nodejs"] = nil
+      M.nodejs = require("copilot.lsp.nodejs")
     end,
   },
 })
@@ -15,10 +16,8 @@ T["get_node_version()"] = MiniTest.new_set()
 
 T["get_node_version()"]["default node command"] = function()
   local captured_args = stub.valid_node(function()
-    local nodejs = require("copilot.lsp.nodejs")
-    nodejs.setup()
-
-    local version, error = nodejs.get_node_version()
+    M.nodejs.setup()
+    local version, error = M.nodejs.get_node_version()
 
     eq(version, stub.valid_node_version)
     eq(error, nil)
@@ -28,10 +27,9 @@ end
 
 T["get_node_version()"]["custom node command as string"] = function()
   local captured_args = stub.valid_node(function()
-    local nodejs = require("copilot.lsp.nodejs")
-    nodejs.setup("/usr/local/bin/node")
+    M.nodejs.setup("/usr/local/bin/node")
 
-    local version, error = nodejs.get_node_version()
+    local version, error = M.nodejs.get_node_version()
 
     eq(version, stub.valid_node_version)
     eq(error, nil)
@@ -41,10 +39,9 @@ end
 
 T["get_node_version()"]["custom node command as string with spaces"] = function()
   local captured_args = stub.valid_node(function()
-    local nodejs = require("copilot.lsp.nodejs")
-    nodejs.setup("/path to/node")
+    M.nodejs.setup("/path to/node")
 
-    local version, error = nodejs.get_node_version()
+    local version, error = M.nodejs.get_node_version()
 
     eq(version, stub.valid_node_version)
     eq(error, nil)
@@ -54,10 +51,9 @@ end
 
 T["get_node_version()"]["custom node command as table"] = function()
   local captured_args = stub.valid_node(function()
-    local nodejs = require("copilot.lsp.nodejs")
-    nodejs.setup({ "mise", "x", "node@lts", "--", "node" })
+    M.nodejs.setup({ "mise", "x", "node@lts", "--", "node" })
 
-    local version, error = nodejs.get_node_version()
+    local version, error = M.nodejs.get_node_version()
 
     eq(version, stub.valid_node_version)
     eq(error, nil)
@@ -67,10 +63,9 @@ end
 
 T["get_node_version()"]["handles vim.system failure"] = function()
   local captured_args = stub.process("", -1, true, function()
-    local nodejs = require("copilot.lsp.nodejs")
-    nodejs.setup("node")
+    M.nodejs.setup("node")
 
-    local _, error = nodejs.get_node_version()
+    local _, error = M.nodejs.get_node_version()
     error = error or ""
 
     eq(error:find("Could not determine Node.js version") ~= nil, true)
@@ -80,10 +75,9 @@ end
 
 T["get_node_version()"]["handles process with non-zero exit code"] = function()
   local captured_args = stub.process("", 127, false, function()
-    local nodejs = require("copilot.lsp.nodejs")
-    nodejs.setup("nonexistent-node")
+    M.nodejs.setup("nonexistent-node")
 
-    local _, error = nodejs.get_node_version()
+    local _, error = M.nodejs.get_node_version()
     error = error or ""
 
     eq(error:find("Could not determine Node.js version") ~= nil, true)
@@ -93,10 +87,9 @@ end
 
 T["get_node_version()"]["validates node version requirement"] = function()
   local captured_args = stub.invalid_node(function()
-    local nodejs = require("copilot.lsp.nodejs")
-    nodejs.setup("node")
+    M.nodejs.setup("node")
 
-    local _, error = nodejs.get_node_version()
+    local _, error = M.nodejs.get_node_version()
     error = error or ""
 
     eq(error:find("Node.js version 20 or newer required") ~= nil, true)
@@ -108,76 +101,68 @@ T["get_execute_command()"] = MiniTest.new_set()
 
 T["get_execute_command()"]["default node command, default server path"] = function()
   local captured_path = stub.get_runtime_server_path(function()
-    local nodejs = require("copilot.lsp.nodejs")
-    eq(nodejs.setup(), true)
-    local cmd = nodejs.get_execute_command()
+    eq(M.nodejs.setup(), true)
+    local cmd = M.nodejs.get_execute_command()
     eq(cmd, { "node", vim.fn.expand(stub.default_server_path), "--stdio" })
   end)
   eq(captured_path, stub.default_server_path)
 end
 
 T["get_execute_command()"]["default node command, custom server path"] = function()
   stub.get_runtime_server_path(function()
-    local nodejs = require("copilot.lsp.nodejs")
-    eq(nodejs.setup(nil, vim.fn.expand(stub.custom_server_path)), true)
-    local cmd = nodejs.get_execute_command()
+    eq(M.nodejs.setup(nil, vim.fn.expand(stub.custom_server_path)), true)
+    local cmd = M.nodejs.get_execute_command()
     eq(cmd, { "node", vim.fn.expand(stub.custom_server_path), "--stdio" })
   end)
 end
 
 T["get_execute_command()"]["custom node command as string, default server path"] = function()
   local captured_path = stub.get_runtime_server_path(function()
-    local nodejs = require("copilot.lsp.nodejs")
-    eq(nodejs.setup("/usr/local/bin/node"), true)
-    local cmd = nodejs.get_execute_command()
+    eq(M.nodejs.setup("/usr/local/bin/node"), true)
+    local cmd = M.nodejs.get_execute_command()
     eq(cmd, { "/usr/local/bin/node", vim.fn.expand(stub.default_server_path), "--stdio" })
   end)
   eq(captured_path, stub.default_server_path)
 end
 
 T["get_execute_command()"]["custom node command as string, custom server path"] = function()
   stub.get_runtime_server_path(function()
-    local nodejs = require("copilot.lsp.nodejs")
-    nodejs.setup("/usr/local/bin/node", stub.custom_server_path)
-    local cmd = nodejs.get_execute_command()
+    M.nodejs.setup("/usr/local/bin/node", stub.custom_server_path)
+    local cmd = M.nodejs.get_execute_command()
     eq(cmd, { "/usr/local/bin/node", stub.custom_server_path, "--stdio" })
   end)
 end
 
 T["get_execute_command()"]["custom node command as string with spaces, default server path"] = function()
   local captured_path = stub.get_runtime_server_path(function()
-    local nodejs = require("copilot.lsp.nodejs")
-    nodejs.setup("/path to/node")
-    local cmd = nodejs.get_execute_command()
+    M.nodejs.setup("/path to/node")
+    local cmd = M.nodejs.get_execute_command()
     eq(cmd, { "/path to/node", vim.fn.expand(stub.default_server_path), "--stdio" })
   end)
   eq(captured_path, stub.default_server_path)
 end
 
 T["get_execute_command()"]["custom node command as string with spaces, custom server path"] = function()
   stub.get_runtime_server_path(function()
-    local nodejs = require("copilot.lsp.nodejs")
-    nodejs.setup("/path to/node", stub.custom_server_path)
-    local cmd = nodejs.get_execute_command()
+    M.nodejs.setup("/path to/node", stub.custom_server_path)
+    local cmd = M.nodejs.get_execute_command()
     eq(cmd, { "/path to/node", stub.custom_server_path, "--stdio" })
   end)
 end
 
 T["get_execute_command()"]["custom node command as table, default server path"] = function()
   local captured_path = stub.get_runtime_server_path(function()
-    local nodejs = require("copilot.lsp.nodejs")
-    nodejs.setup({ "mise", "x", "node@lts", "--", "node" })
-    local cmd = nodejs.get_execute_command()
+    M.nodejs.setup({ "mise", "x", "node@lts", "--", "node" })
+    local cmd = M.nodejs.get_execute_command()
     eq(cmd, { "mise", "x", "node@lts", "--", "node", vim.fn.expand(stub.default_server_path), "--stdio" })
   end)
   eq(captured_path, stub.default_server_path)
 end
 
 T["get_execute_command()"]["custom node command as table, custom server path"] = function()
   stub.get_runtime_server_path(function()
-    local nodejs = require("copilot.lsp.nodejs")
-    nodejs.setup({ "mise", "x", "node@lts", "--", "node" }, stub.custom_server_path)
-    local cmd = nodejs.get_execute_command()
+    M.nodejs.setup({ "mise", "x", "node@lts", "--", "node" }, stub.custom_server_path)
+    local cmd = M.nodejs.get_execute_command()
     eq(cmd, { "mise", "x", "node@lts", "--", "node", stub.custom_server_path, "--stdio" })
   end)
 end