feat(lsp): improved parsing of test result error messages

Author: Marc Jakobi

CHANGELOG.md

@@ -6,6 +6,12 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [4.3.0] - 2024-01-31
+
+### Changed
+
+- LSP: Improved parsing of test result failure messages.
+
 ## [4.2.1] - 2024-01-30
 
 ### Fixed

lua/rustaceanvim/executors/background.lua

@@ -11,31 +11,47 @@ end
 local M = {}
 
 ---@package
+---@param file_name string
 ---@param output string
 ---@return vim.Diagnostic[]
 ---@diagnostic disable-next-line: inject-field
-M.parse_diagnostics = function(output)
+M.parse_diagnostics = function(file_name, output)
+  output = output:gsub('\r\n', '\n')
+  local lines = vim.split(output, '\n')
   ---@type vim.Diagnostic[]
   local diagnostics = {}
-  for line, col, message in output:gmatch("thread '[^']+' panicked at [^:]+:(%d+):(%d+):\n([^\n]*)") do
-    diagnostics[#diagnostics + 1] = {
-      lnum = tonumber(line) - 1,
-      col = tonumber(col) or 0,
-      message = message,
-      source = 'rustaceanvim',
-      severity = vim.diagnostic.severity.ERROR,
-    }
-  end
-  if #diagnostics == 0 then
-    --- Fall back to old format
-    for message, line, col in output:gmatch("thread '[^']+' panicked at '([^']+)', [^:]+:(%d+):(%d+)") do
-      diagnostics[#diagnostics + 1] = {
-        lnum = tonumber(line) - 1,
+  for i, line in ipairs(lines) do
+    local message = ''
+    local file, lnum, col = line:match("thread '[^']+' panicked at ([^:]+):(%d+):(%d+):")
+    if lnum and col and message and vim.endswith(file_name, file) then
+      local next_i = i + 1
+      while #lines >= next_i and lines[next_i] ~= '' do
+        message = message .. lines[next_i] .. '\n'
+        next_i = next_i + 1
+      end
+      local diagnostic = {
+        lnum = tonumber(lnum) - 1,
         col = tonumber(col) or 0,
         message = message,
         source = 'rustaceanvim',
         severity = vim.diagnostic.severity.ERROR,
       }
+      table.insert(diagnostics, diagnostic)
+    end
+  end
+  if #diagnostics == 0 then
+    --- Fall back to old format
+    for message, file, lnum, col in output:gmatch("thread '[^']+' panicked at '([^']+)', ([^:]+):(%d+):(%d+)") do
+      if vim.endswith(file_name, file) then
+        local diagnostic = {
+          lnum = tonumber(lnum) - 1,
+          col = tonumber(col) or 0,
+          message = message,
+          source = 'rustaceanvim',
+          severity = vim.diagnostic.severity.ERROR,
+        }
+        table.insert(diagnostics, diagnostic)
+      end
     end
   end
   return diagnostics
@@ -56,6 +72,7 @@ M.execute_command = function(command, args, cwd, opts)
   local notify_prefix = (is_single_test and 'test ' or 'tests ')
   local compat = require('rustaceanvim.compat')
   local cmd = vim.list_extend({ command }, args)
+  local fname = vim.api.nvim_buf_get_name(opts.bufnr)
   compat.system(cmd, { cwd = cwd }, function(sc)
     ---@cast sc vim.SystemCompleted
     if sc.code == 0 then
@@ -65,8 +82,8 @@ M.execute_command = function(command, args, cwd, opts)
       end)
       return
     end
-    local output = sc.stderr or ''
-    local diagnostics = M.parse_diagnostics(output)
+    local output = (sc.stderr or '') .. '\n' .. (sc.stdout or '')
+    local diagnostics = M.parse_diagnostics(fname, output)
     local summary = get_test_summary(sc.stdout or '')
     vim.schedule(function()
       vim.diagnostic.set(diag_namespace, opts.bufnr, diagnostics)

spec/parse_test_result_spec.lua

@@ -17,12 +17,17 @@ Location:
     rocks-lib/src/rocks/dependency.rs:62:22
 note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace
 ]]
-    local diagnostics = test_executor.parse_diagnostics(fixture)
+    local fname = 'rocks-lib/src/rocks/dependency.rs'
+    local diagnostics = test_executor.parse_diagnostics(fname, fixture)
     local expected = {
       {
         lnum = 85,
         col = 64,
-        message = 'called `Result::unwrap()` on an `Err` value: unexpected end of input while parsing min or version number',
+        message = [[called `Result::unwrap()` on an `Err` value: unexpected end of input while parsing min or version number
+Location:
+    rocks-lib/src/rocks/dependency.rs:62:22
+note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace
+]],
         severity = vim.diagnostic.severity.ERROR,
         source = 'rustaceanvim',
       },
@@ -40,7 +45,8 @@ thread 'tests::failed_math' panicked at 'assertion failed: `(left == right)`
  right: `3`', src/main.rs:16:9
 note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace
 ]]
-    local diagnostics = test_executor.parse_diagnostics(fixture)
+    local fname = 'src/main.rs'
+    local diagnostics = test_executor.parse_diagnostics(fname, fixture)
     local expected = {
       {
         lnum = 15,