tests: initial round of tests using mini.test

Author: AntoineGS

.luarc.json

@@ -0,0 +1,3 @@
+{
+  "_workspace.ignoreDir": ["deps"]
+}

Makefile

@@ -0,0 +1,13 @@
+# Run all test files
+# test: deps/mini.nvim
+test: 
+	nvim --headless --noplugin -u ./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)')"
+
+# 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 $@

lua/copilot/client/config.lua

@@ -16,25 +16,7 @@ function M.prepare_client_config(overrides, client)
 
   client.startup_error = nil
 
-  local server_path = nil
-  local cmd = nil
-
-  if config.server.custom_server_filepath and vim.fn.filereadable(config.server.custom_server_filepath) then
-    server_path = config.server.custom_server_filepath
-  end
-
-  if config.server.type == "nodejs" then
-    cmd = {
-      lsp.nodejs.node_command,
-      server_path or lsp.nodejs.get_server_path(),
-      "--stdio",
-    }
-  elseif config.server.type == "binary" then
-    cmd = {
-      server_path or lsp.binary.get_server_path(),
-      "--stdio",
-    }
-  end
+  local cmd = lsp.get_execute_command()
 
   if not cmd then
     logger.error("copilot server type not supported")
@@ -84,7 +66,7 @@ function M.prepare_client_config(overrides, client)
   }
 
   if proxy_uri then
-    vim.tbl_extend("force", settings, {
+    settings = vim.tbl_extend("force", settings, {
       http = { ---@type copilot_settings_http
         proxy = proxy_uri,
         proxyStrictSSL = vim.g.copilot_proxy_strict_ssl or false,
@@ -94,7 +76,7 @@ function M.prepare_client_config(overrides, client)
   end
 
   if provider_url then
-    vim.tbl_extend("force", settings, {
+    settings = vim.tbl_extend("force", settings, {
       ["github-enterprise"] = { ---@type copilot_settings_github-enterprise
         uri = provider_url,
       },

lua/copilot/client/filetypes.lua

@@ -1,4 +1,16 @@
-local M = {}
+local M = {
+  internal_filetypes = {
+    yaml = false,
+    markdown = false,
+    help = false,
+    gitcommit = false,
+    gitrebase = false,
+    hgcommit = false,
+    svn = false,
+    cvs = false,
+    ["."] = false,
+  },
+}
 
 local language_normalization_map = {
   bash = "shellscript",
@@ -27,18 +39,6 @@ function M.language_for_file_type(filetype)
   return language_normalization_map[ft] or ft
 end
 
-local internal_filetypes = {
-  yaml = false,
-  markdown = false,
-  help = false,
-  gitcommit = false,
-  gitrebase = false,
-  hgcommit = false,
-  svn = false,
-  cvs = false,
-  ["."] = false,
-}
-
 ---@param filetype_enabled boolean|fun():boolean
 local function resolve_filetype_enabled(filetype_enabled)
   if type(filetype_enabled) == "function" then
@@ -69,8 +69,8 @@ function M.is_ft_disabled(ft, filetypes)
       string.format("'filetype' %s rejected by config filetypes[%s]", ft, "*")
   end
 
-  if internal_filetypes[short_ft] ~= nil then
-    return not internal_filetypes[short_ft],
+  if M.internal_filetypes[short_ft] ~= nil then
+    return not M.internal_filetypes[short_ft],
       string.format("'filetype' %s rejected by internal_filetypes[%s]", ft, short_ft)
   end
 

lua/copilot/client/init.lua

@@ -38,7 +38,8 @@ end
 
 ---@param force? boolean
 function M.buf_attach(force)
-  if lsp.binary.initialization_failed then
+  if lsp.initialization_failed() then
+    logger.error("copilot-language-server failed to initialize")
     M.startup_error = "initialization of copilot-language-server failed"
     return
   end
@@ -48,10 +49,7 @@ function M.buf_attach(force)
     return
   end
 
-  local bufnr = vim.api.nvim_get_current_buf()
-  local bufname = vim.api.nvim_buf_get_name(bufnr)
-
-  if not (force or (config.should_attach(bufnr, bufname) and util.should_attach())) then
+  if not (force or util.should_attach()) then
     logger.debug("not attaching to buffer based on force and should_attach criteria")
     return
   end
@@ -64,6 +62,7 @@ function M.buf_attach(force)
   -- In case it has changed, we update it
   M.config.root_dir = utils.get_root_dir(config.root_dir)
 
+  logger.trace("attaching to buffer")
   local ok, client_id_or_err = pcall(vim.lsp.start, M.config)
   if not ok then
     logger.error(string.format("failed to start LSP client: %s", client_id_or_err))
@@ -75,6 +74,7 @@ function M.buf_attach(force)
   else
     logger.error("LSP client failed to start (no client ID returned)")
   end
+  logger.trace("buffer attached")
 end
 
 function M.buf_detach()
@@ -83,7 +83,7 @@ function M.buf_detach()
   end
 end
 
----@return nil|vim.lsp.Client
+---@return vim.lsp.Client|nil
 function M.get()
   return vim.lsp.get_client_by_id(M.id)
 end
@@ -95,11 +95,11 @@ end
 ---@param callback fun(client:table):nil
 function M.use_client(callback)
   if is_disabled then
-    logger.warn("copilot is offline")
+    logger.notify("copilot is offline")
     return
   end
 
-  local client = M.get() --[[@as table]]
+  local client = M.get()
 
   if not client then
     if not M.config then
@@ -124,36 +124,37 @@ function M.use_client(callback)
     return
   end
 
-  local timer, err, _ = vim.uv.new_timer()
-
-  if not timer then
-    logger.error(string.format("error creating timer: %s", err))
-    return
-  end
-
-  timer:start(
-    0,
-    100,
-    vim.schedule_wrap(function()
-      if client.initialized and not timer:is_closing() then
-        timer:stop()
-        timer:close()
-        callback(client)
-      end
-    end)
-  )
+  logger.error("client is not initialized yet")
+  -- Following code is commented out for now because:
+  -- 1) I am hoping it is not needed anymore and
+  -- 2) It causes issues with testing >_<
+  --
+  -- local timer, err, _ = vim.uv.new_timer()
+  --
+  -- if not timer then
+  --   logger.error(string.format("error creating timer: %s", err))
+  --   return
+  -- end
+  --
+  -- timer:start(
+  --   0,
+  --   100,
+  --   vim.schedule_wrap(function()
+  --     if client.initialized and not timer:is_closing() then
+  --       timer:stop()
+  --       timer:close()
+  --       callback(client)
+  --     else
+  --       logger.error("client not initialized yet")
+  --     end
+  --   end)
+  -- )
 end
 
 function M.setup()
+  logger.trace("setting up client")
   local node_command = config.copilot_node_command
-
-  --TODO: merge the two types into an indirection
-  if config.server.type == "nodejs" then
-    lsp.nodejs.setup(node_command, config.server.custom_server_filepath)
-  elseif config.server.type == "binary" then
-    lsp.binary.setup(config.server.custom_server_filepath)
-  end
-
+  lsp.setup(config.server, node_command)
   M.config = require("copilot.client.config").prepare_client_config(config.server_opts_overrides, M)
 
   if not M.config then

lua/copilot/client/utils.lua

@@ -1,5 +1,6 @@
 local config = require("copilot.config")
 local logger = require("copilot.logger")
+local client_ft = require("copilot.client.filetypes")
 local M = {}
 
 ---@param config_root_dir RootDirFuncOrString
@@ -25,7 +26,7 @@ function M.get_workspace_configurations()
   local filetypes = vim.deepcopy(config.filetypes) --[[@as table<string, boolean>]]
 
   if filetypes["*"] == nil then
-    filetypes = vim.tbl_deep_extend("keep", filetypes, require("copilot.client.filetypes").internal_filetypes)
+    filetypes = vim.tbl_deep_extend("keep", filetypes, client_ft.internal_filetypes)
   end
 
   local copilot_model = config and config.copilot_model ~= "" and config.copilot_model or ""

lua/copilot/command.lua

@@ -1,53 +1,38 @@
-local a = require("copilot.api")
 local c = require("copilot.client")
 local u = require("copilot.util")
+local logger = require("copilot.logger")
+local lsp = require("copilot.lsp")
 
 local M = {}
 
 function M.version()
   local info = u.get_editor_info()
 
-  ---@type (string|table)[]
+  ---@type string
   local lines = {
     info.editorInfo.name .. " " .. info.editorInfo.version,
-    "copilot.vim" .. " " .. info.editorPluginInfo.version,
+    "copilot language server" .. " " .. info.editorPluginInfo.version,
     "copilot.lua" .. " " .. u.get_copilot_lua_version(),
   }
 
   local client = c.get()
 
   coroutine.wrap(function()
-    -- TODO: this is now in lsp/*
-    local copilot_server_info = u.get_copilot_server_info()
-    if client then
-      local _, data = a.get_version(client)
-      lines[#lines + 1] = copilot_server_info.path .. "/" .. copilot_server_info().filename .. " " .. data.version
-    else
-      lines[#lines + 1] = copilot_server_info.path .. "/" .. copilot_server_info().filename .. " " .. "not running"
-    end
-
-    local chunks = {}
-    for _, line in ipairs(lines) do
-      chunks[#chunks + 1] = type(line) == "table" and line or { line }
-      chunks[#chunks + 1] = { "\n", "NONE" }
-    end
-
-    vim.api.nvim_echo(chunks, true, {})
+    local server_info = lsp.get_server_info(client)
+    logger.notify(lines .. "\n" .. server_info)
   end)()
 end
 
 ---@param opts? { force?: boolean }
 function M.attach(opts)
+  logger.trace("attaching to buffer")
   opts = opts or {}
 
   if not opts.force then
     local should_attach, no_attach_reason = u.should_attach()
-    -- TODO: add other should_attach method here
+
     if not should_attach then
-      vim.api.nvim_echo({
-        { "[Copilot] " .. no_attach_reason .. "\n" },
-        { "[Copilot] to force attach, run ':Copilot! attach'" },
-      }, true, {})
+      logger.notify(no_attach_reason .. "\nto force attach, run ':Copilot! attach'")
       return
     end
 
@@ -76,12 +61,14 @@ function M.toggle(opts)
 end
 
 function M.enable()
+  logger.trace("enabling Copilot")
   c.setup()
   require("copilot.panel").setup()
   require("copilot.suggestion").setup()
 end
 
 function M.disable()
+  logger.trace("disabling Copilot")
   c.teardown()
   require("copilot.panel").teardown()
   require("copilot.suggestion").teardown()

lua/copilot/lsp/binary.lua

@@ -180,10 +180,9 @@ local function set_permissions(filename)
   return true
 end
 
--- TODO: when this fails, it will cause a couple more errors before crashing
 -- let's hope the naming convention does not change!!!
 ---@return boolean
-function M.ensure_client_is_downloaded()
+function M.init()
   if M.initialized then
     return true
   elseif M.initialization_failed then
@@ -268,6 +267,26 @@ local function is_musl()
   return string.sub(ldd_output, 1, 4) == "musl"
 end
 
+---@param client vim.lsp.Client|nil
+---@return string
+function M.get_server_info(client)
+  local copilot_server_info = M.get_copilot_server_info()
+
+  if client then
+    return copilot_server_info.path .. "/" .. copilot_server_info().filename
+  else
+    return copilot_server_info.path .. "/" .. copilot_server_info().filename .. " " .. "not running"
+  end
+end
+
+---@return table
+function M.get_execute_command()
+  return {
+    M.server_path or M.get_server_path(),
+    "--stdio",
+  }
+end
+
 ---@return copilot_server_info
 function M.get_copilot_server_info()
   if M.copilot_server_info then
@@ -345,8 +364,6 @@ function M.setup(custom_server_path)
 
     M.initialized = true
   end
-
-  M.ensure_client_is_downloaded()
 end
 
 return M