test: convert a panel and suggestion tests to use stub lsp

Author: AntoineGS

lua/copilot/suggestion/init.lua

@@ -581,7 +581,7 @@ function M.accept(modifier)
   local ctx = get_ctx()
   logger.trace("suggestion accept", ctx)
 
-  if config.suggestion.trigger_on_accept and M.first_request_scheduled(ctx) then
+  if config.suggestion.trigger_on_accept and not get_current_suggestion(ctx) and M.first_request_scheduled(ctx) then
     return
   end
 

tests/child_helper.lua

@@ -57,9 +57,15 @@ function M.new_child_neovim(test_name)
     ]])
   end
 
-  function child.run_pre_case()
+  ---@param mock_lsp_server? boolean
+  function child.run_pre_case(mock_lsp_server)
     child.reset_config()
     child.restart({ "-u", "tests/scripts/minimal_init.lua" })
+
+    if mock_lsp_server then
+      child.lua('package.loaded["copilot.lsp"] = require("tests.stubs.lsp_init")')
+    end
+
     if env.COPILOT_TOKEN and env.COPILOT_TOKEN ~= "" then
       child.fn.setenv("GITHUB_COPILOT_TOKEN", env.COPILOT_TOKEN)
     end

tests/screenshots/tests-test_suggestion.lua---suggestion()---accept_line,-1-line,-then-accept

@@ -1,40 +1,40 @@
 --|---------|---------|---------|---------|
-01|# Numbers in a 3x3 grid, up to 63       
-02|{                                       
-03|  1,2,3                                 
-04|  4,5,6                                 
-05|  7,8,9                                 
-06|}                                       
-07|{                                       
-08|  10,11,12                              
-09|  13,14,15                              
-10|  16,17,18                              
-11|}                                       
-12|{                                       
-13|  19,20,21                              
-14|  22,23,24                              
-15|  25,26,27                              
-16|}                                       
-17|{                                       
-18|  28,29,30                              
-19|  31,32,33                              
-20|  34,35,36                              
-21|}                                       
-22|{                                       
-23|  37,38,39                              
-24|  40,41,42                              
-25|  43,44,45                              
-26|}                                       
-27|{                                       
-28|  46,47,48                              
-29|  49,50,51                              
-30|  52,53,54                              
-31|}                                       
-32|{                                       
-33|  55,56,57                              
-34|  58,59,60                              
-35|  61,62,63                              
-36|}                                       
+01|{                                       
+02|  1,2,3                                 
+03|  4,5,6                                 
+04|  7,8,9                                 
+05|}                                       
+06|{                                       
+07|  10,11,12                              
+08|  13,14,15                              
+09|  16,17,18                              
+10|}                                       
+11|{                                       
+12|  19,20,21                              
+13|  22,23,24                              
+14|  25,26,27                              
+15|}                                       
+16|{                                       
+17|  28,29,30                              
+18|  31,32,33                              
+19|  34,35,36                              
+20|}                                       
+21|{                                       
+22|  37,38,39                              
+23|  40,41,42                              
+24|  43,44,45                              
+25|}                                       
+26|{                                       
+27|  46,47,48                              
+28|  49,50,51                              
+29|  52,53,54                              
+30|}                                       
+31|~                                       
+32|~                                       
+33|~                                       
+34|~                                       
+35|~                                       
+36|~                                       
 37|~                                       
 38|~                                       
 39|~                                       
@@ -47,7 +47,7 @@
 46|~                                       
 47|~                                       
 48|~                                       
-49|[No Name] [+]         36,2           All
+49|<rs_as_arrays.txt [+] 30,2           All
 50|-- INSERT --                            
 
 --|---------|---------|---------|---------|
@@ -76,17 +76,17 @@
 23|0000000000000000000000000000000000000000
 24|0000000000000000000000000000000000000000
 25|0000000000000000000000000000000000000000
-26|0000000000000000000000000000000000000000
+26|1000000000000000000000000000000000000000
 27|0000000000000000000000000000000000000000
 28|0000000000000000000000000000000000000000
 29|0000000000000000000000000000000000000000
-30|0000000000000000000000000000000000000000
-31|0000000000000000000000000000000000000000
-32|1000000000000000000000000000000000000000
-33|0000000000000000000000000000000000000000
-34|0000000000000000000000000000000000000000
-35|0000000000000000000000000000000000000000
-36|1000000000000000000000000000000000000000
+30|1000000000000000000000000000000000000000
+31|2222222222222222222222222222222222222222
+32|2222222222222222222222222222222222222222
+33|2222222222222222222222222222222222222222
+34|2222222222222222222222222222222222222222
+35|2222222222222222222222222222222222222222
+36|2222222222222222222222222222222222222222
 37|2222222222222222222222222222222222222222
 38|2222222222222222222222222222222222222222
 39|2222222222222222222222222222222222222222

tests/screenshots/tests-test_suggestion.lua---suggestion()---duplicated-keymap-yields-correct-error-message

@@ -21,7 +21,7 @@
 20|~                                                                               
 21|~                                                                               
 22|~                                                                               
-23|[No Name] [+]                                                 3,7-9          All
+23|numbers_with_spaces.txt [+]                                   3,7-9          All
 24|-- INSERT --                                                                    
 
 --|---------|---------|---------|---------|---------|---------|---------|---------|

tests/stubs/lsp_init.lua

@@ -0,0 +1,27 @@
+local M = {}
+
+---@return boolean
+function M.initialization_failed()
+  return false
+end
+
+---@return boolean
+function M.init()
+  return true
+end
+
+---@param _ vim.lsp.Client|nil
+---@return string
+function M.get_server_info(_)
+  return "mocked"
+end
+
+function M.get_execute_command()
+  return require("tests.stubs.lsp_server").server
+end
+
+function M.setup(_, _)
+  return true
+end
+
+return M

tests/stubs/lsp_server.lua

@@ -0,0 +1,181 @@
+local logger = require("copilot.logger")
+local M = {}
+
+M.messages = {}
+M.completion_responses = {
+  ["numbers_with_spaces.txt"] = {
+    completions = {
+      {
+        displayText = "8 9",
+        docVersion = 7,
+        position = {
+          character = 2,
+          line = 2,
+        },
+        range = {
+          ["end"] = {
+            character = 2,
+            line = 2,
+          },
+          start = {
+            character = 0,
+            line = 2,
+          },
+        },
+        text = "7 8 9",
+        uuid = "b7493391-cd5e-4c10-b0a6-2a844533fbed",
+      },
+    },
+  },
+  ["numbers_as_arrays.txt"] = {
+    completions = {
+      {
+        displayText = "  19,20,21\n  22,23,24\n  25,26,27\n}\n{\n  28,29,30\n  31,32,33\n  34,35,36\n}\n{\n  37,38,39\n  40,41,42\n  43,44,45\n}\n{\n  46,47,48\n  49,50,51\n  52,53,54\n}",
+        docVersion = 30,
+        position = {
+          character = 0,
+          line = 11,
+        },
+        range = {
+          ["end"] = {
+            character = 0,
+            line = 11,
+          },
+          start = {
+            character = 0,
+            line = 11,
+          },
+        },
+        text = "  19,20,21\n  22,23,24\n  25,26,27\n}\n{\n  28,29,30\n  31,32,33\n  34,35,36\n}\n{\n  37,38,39\n  40,41,42\n  43,44,45\n}\n{\n  46,47,48\n  49,50,51\n  52,53,54\n}",
+        uuid = "1df58ae9-3e93-4e6a-b514-218a9fe7e816",
+      },
+    },
+  },
+}
+
+---@param text_document lsp.VersionedTextDocumentIdentifier
+local function get_lsp_responses(text_document)
+  local filename = vim.fs.basename(vim.uri_to_fname(text_document.uri))
+  logger.trace("get_lsp_responses: " .. filename)
+
+  return M.completion_responses[filename]
+    or {
+      ---@type copilot_get_completions_data
+      completions = {
+        {
+          displayText = "89",
+          docVersion = 7,
+          position = {
+            character = 1,
+            line = 2,
+          },
+          range = {
+            ["end"] = {
+              character = 1,
+              line = 2,
+            },
+            start = {
+              character = 0,
+              line = 2,
+            },
+          },
+          text = "789",
+          uuid = "63f4ab66-e550-4313-9023-144a33254607",
+        },
+      },
+    }
+end
+
+function M.server()
+  local closing = false
+  local srv = {}
+  -- local seen_files = {}
+
+  function srv.request(method, params, handler)
+    logger.trace("lsp request: " .. method)
+    table.insert(M.messages, { method = method, params = params })
+    if method == "initialize" then
+      handler(nil, {
+        capabilities = {},
+      })
+    elseif method == "shutdown" then
+      handler(nil, nil)
+    elseif method == "getCompletions" then
+      -- elseif method == "textDocument/copilotInlineEdit" then
+      -- if not seen_files[params.textDocument.uri] then
+      -- seen_files[params.textDocument.uri] = true
+      local response = get_lsp_responses(params.textDocument)
+      handler(nil, response)
+    -- local empty_response = {
+    --   edits = {},
+    -- }
+    -- handler(nil, empty_response)
+    elseif method == "checkStatus" then
+      handler(nil, { user = "someUser", status = "OK" })
+    elseif method == "notifyAccepted" or method == "notifyRejected" or method == "notifyShown" then
+      handler(nil, {})
+    elseif method == "getPanelCompletions" then
+      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()
+        local handlers = require("copilot.panel.handlers")
+
+        handlers.handlers.PanelSolution(nil, {
+          completionText = "89\n0\n1",
+          displayText = "789\n0\n1",
+          panelId = panelId,
+          range = {
+            ["end"] = {
+              character = 1,
+              line = 2,
+            },
+            start = {
+              character = 1,
+              line = 2,
+            },
+          },
+          score = 0,
+          solutionId = "213fc33d8f2dbde3207734e3097ea72a69fb8b009f2878468cdd9e74b70a1e59",
+        })
+
+        handlers.handlers.PanelSolutionsDone(nil, {
+          panelId = panelId,
+          status = "OK",
+        })
+      end, 10)
+    else
+      assert(false, "Unhandled method: " .. method)
+    end
+  end
+
+  function srv.notify(method, params)
+    logger.trace("lsp notify")
+    table.insert(M.messages, { method = method, params = params })
+    if method == "exit" then
+      closing = true
+    end
+  end
+
+  function srv.is_closing()
+    logger.trace("lsp closing")
+    return closing
+  end
+
+  function srv.terminate()
+    logger.trace("lsp terminate")
+    closing = true
+  end
+
+  return srv
+end
+
+function M.reset()
+  M.messages = {}
+end
+
+return M

tests/test_panel.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
       child.lua("p = require('copilot.panel')")
     end,