Merge pull request #35 from NickHackman/fix-test-parsing

fix: identify tests

Author: codymikol

lua/neotest-kotlin/init.lua

@@ -8,57 +8,54 @@ local filter = require("neotest-kotlin.src.filter")
 local treesitter_query = require("neotest-kotlin.kotest-treesitter-query")
 local output_parser = require("neotest-kotlin.src.output-parser")
 
-local adapter = { name = "neotest-kotest" }
+local M = {}
 
-function adapter.root(dir)
+---@class neotest.Adapter
+---@field name string
+M.Adapter = { name = "neotest-kotest" }
+
+---Find the project root directory given a current directory to work from.
+---Should no root be found, the adapter can still be used in a non-project context if a test file matches.
+---@async
+---@param dir string @Directory to treat as cwd
+---@return string | nil @Absolute root dir of test suite
+function M.Adapter.root(dir)
   return lib.files.match_root_pattern("gradlew")(dir)
 end
 
-function adapter.filter_dir(name, rel_path, root)
+---Filter directories when searching for test files
+---@async
+---@param name string Name of directory
+---@param rel_path string Path to directory, relative to root
+---@param root string Root directory of project
+---@return boolean
+function M.Adapter.filter_dir(name, rel_path, root)
   return filter.test_directory(name)
 end
 
-function adapter.is_test_file(file_path)
+---@async
+---@param file_path string
+---@return boolean
+function M.Adapter.is_test_file(file_path)
   return filter.is_test_file(file_path)
 end
 
-local function get_match_type(captured_nodes)
-  if captured_nodes["namespace.name"] then
-    return "namespace"
-  end
-  if captured_nodes["test.name"] then
-    return "test"
-  end
-end
-
-function adapter.build_position(file_path, source, captured_nodes)
-  local match_type = get_match_type(captured_nodes)
-  local definition = captured_nodes[match_type .. ".definition"]
-
-  local build_position = {
-    type = match_type,
-    path = file_path,
-    range = { definition:range() },
-  }
-
-  return build_position
-end
-
---- a file path, parse all the tests within it.
+---Given a file path, parse all the tests within it.
 ---@async
 ---@param file_path string Absolute file path
 ---@return neotest.Tree | nil
-function adapter.discover_positions(path)
-  local positions = lib.treesitter.parse_positions(path, treesitter_query.value, {
+function M.Adapter.discover_positions(file_path)
+  local positions = lib.treesitter.parse_positions(file_path, treesitter_query, {
     nested_namespaces = true,
     nested_tests = false,
   })
+
   return positions
 end
 
----@param args neotest.run.RunArgs
+---@param args neotest.RunArgs
 ---@return nil | neotest.RunSpec | neotest.RunSpec[]
-function adapter.build_spec(args)
+function M.Adapter.build_spec(args)
   local results_path = async.fn.tempname() .. ".json"
 
   -- Write something so there is a place to stream to...
@@ -72,7 +69,7 @@ function adapter.build_spec(args)
 
   local pos = tree:data()
 
-  local root = adapter.root(pos.path)
+  local root = M.Adapter.root(pos.path)
   local pkg = position_parser.get_first_match_string(pos.path, package_query)
   local className = position_parser.get_first_match_string(pos.path, class_query)
   local specPackage = pkg .. "." .. className
@@ -124,9 +121,9 @@ end
 ---@param result neotest.StrategyResult
 ---@param tree neotest.Tree
 ---@return table<string, neotest.Result>
-function adapter.results(spec, result, tree)
+function M.Adapter.results(spec, result, tree)
   spec.context.stop_stream()
   return spec.context.all_results
 end
 
-return adapter
+return M.Adapter

lua/neotest-kotlin/kotest-treesitter-query.lua

@@ -1,46 +1,39 @@
-local TreesitterQuery = {}
-
--- These are treesitter queries for pulling data of of the AST,
+-- These are treesitter queries for pulling data out of the AST,
 -- More information on how this works over here: https://neovim.io/doc/user/treesitter.html
--- And you can interactively play around with these kotlin queries here: https://fwcd.dev/tree-sitter-kotlin/
-
-TreesitterQuery.value = [[
+-- And you can interactively play around with these kotlin queries here: https://fwcd.github.io/tree-sitter-kotlin/
+return [[
 
 ;; --- DESCRIBE SPEC ---
 
 ; Matches namespace describe("context") { /** body **/ }
 
 (call_expression 
-	(call_expression 
-	  (simple_identifier) @func_name (#eq? @func_name "describe")
-      (call_suffix
-        (value_arguments
-          (value_argument
-            (string_literal) @namespace.name
-          ) 
+  (simple_identifier) @function_name (#eq? @function_name "describe")
+    (call_suffix 
+      (value_arguments 
+        (value_argument 
+          (string_literal) @namespace.name
         )
-      )
+      ) (annotated_lambda)
     )
 ) @namespace.definition
 
 ; Matches test it("context") { /** body **/ }
 
 (call_expression 
-	(call_expression 
-	  (simple_identifier) @func_name (#eq? @func_name "it")
-      (call_suffix
-        (value_arguments
-          (value_argument
-            (string_literal) @test.name
-          ) 
+  (simple_identifier) @function_name (#eq? @function_name "it")
+    (call_suffix 
+      (value_arguments 
+        (value_argument 
+          (string_literal) @test.name 
         )
-      )
-    )
+      ) (annotated_lambda)
+    ) 
 ) @test.definition
 
-; todo Mathes xdescribe("context") { /** body **/ }
+; todo Matches xdescribe("context") { /** body **/ }
 
-; todo Mathes xit("context") { /** body **/ }
+; todo Matches xit("context") { /** body **/ }
 
 ;; -- todo FUN SPEC --
 ;; -- todo SHOULD SPEC --
@@ -53,5 +46,3 @@ TreesitterQuery.value = [[
 ;; -- todo ANNOTATION SPEC --
 
 ]]
-
-return TreesitterQuery

lua/neotest-kotlin/src/position-parser.lua

@@ -3,74 +3,60 @@ local lib = require("neotest.lib")
 local M = {}
 
 M.parse = function(path, query)
-  local positions = lib.treesitter.parse_positions(path, query, {
-    nested_namespaces = true,
-    nested_tests = false,
-    fast = false,
-  })
+	local positions = lib.treesitter.parse_positions(path, query, {
+		nested_namespaces = true,
+		nested_tests = false,
+		fast = false,
+	})
 
-  return positions
+	return positions
 end
 
 M.get_all_matches_as_string = function(path, query)
-  local results = {}
+	local language = "kotlin"
 
-  local file = io.open(path)
+	local bufnr = vim.api.nvim_create_buf(false, true)
+	local content = vim.fn.readfile(path)
+	vim.api.nvim_buf_set_lines(bufnr, 0, -1, false, content)
+	vim.api.nvim_set_option_value("filetype", language, { buf = bufnr })
 
-  if file == nil then
-    error("File not found at path: " .. path)
-  end
+	local parser = vim.treesitter.get_parser(bufnr, language, {})
+	if not parser then
+		error("Kotlin parser is not available. Please ensure it's installed.")
+	end
 
-  local code = file:read("*all")
+	local tree = parser:parse()[1]
 
-  local new_buffer_number = vim.api.nvim_create_buf(false, true)
-  vim.api.nvim_buf_set_lines(new_buffer_number, 1, -1, false, vim.split(code, "\n"))
+	---@type vim.treesitter.Query
+	local treesitter_query = vim.treesitter.query.parse(language, query)
+	local results = {}
 
-  file:close()
+	for _, match, _ in treesitter_query:iter_matches(tree:root(), bufnr, 0, -1) do
+		for _, nodes in pairs(match) do
+			for _, node in ipairs(nodes) do
+				local text = vim.treesitter.get_node_text(node, bufnr)
 
-  local language = "kotlin"
+				if type(text) == "table" then
+					table.insert(results, table.concat(text, "\n"))
+				else
+					table.insert(results, text)
+				end
+			end
+		end
+	end
 
-  local parser = vim.treesitter.get_string_parser(code, language)
-  local tree = parser:parse()
-  local root = tree[1]:root()
+	vim.api.nvim_buf_delete(bufnr, { force = true })
 
-  local query = vim.treesitter.query.parse(language, query)
-
-  for _, match, _ in query:iter_matches(root, new_buffer_number, root:start(), root:end_(), {}) do
-    for _, node in pairs(match) do
-      local start_row, start_col = node:start()
-      local end_row, end_col = node:end_()
-
-      local row_lines = vim.api.nvim_buf_get_lines(new_buffer_number, start_row + 1, end_row + 2, false)
-
-      if #row_lines == 0 then
-        print("Error: position parser could not match the passed query.")
-        return ""
-      end
-
-      if #row_lines > 1 then
-        print("Error: position parser currently only supports single line results.")
-        return ""
-      end
-
-      local found_line = row_lines[1]
-
-      local result = found_line:sub(start_col + 1, end_col)
-
-      results[#results + 1] = result
-    end
-  end
-
-  return results
+	return results
 end
 
 -- This will take in a path to a file, run a treesitter query on it, and return the first match as a string.
 M.get_first_match_string = function(path, query)
-  local results = M.get_all_matches_as_string(path, query)
-  if #results > 0 then
-    return results[1]
-  end
-  return nil
+	local results = M.get_all_matches_as_string(path, query)
+	if #results > 0 then
+		return results[1]
+	end
+	return nil
 end
 
 return M

lua/neotest-kotlin/src/treesitter/class-query.lua

@@ -1,3 +1 @@
-local M = "(class_declaration (type_identifier) @package.class)"
-
-return M
+return "(class_declaration (type_identifier) @package.class)"

lua/neotest-kotlin/src/treesitter/package-query.lua

@@ -1,3 +1 @@
-local M = "(package_header (identifier) @package.name)"
-
-return M
+return "(package_header (identifier) @package.name)"

lua/neotest-kotlin/src/treesitter/spec-query.lua

@@ -1,10 +1,8 @@
-local M = {}
-
--- These are treesitter queries for pulling data of of the AST,
+-- These are treesitter queries for pulling data out of the AST,
 -- More information on how this works over here: https://neovim.io/doc/user/treesitter.html
--- And you can interactively play around with these kotlin queries here: https://fwcd.dev/tree-sitter-kotlin/
+-- And you can interactively play around with these kotlin queries here: https://fwcd.github.io/tree-sitter-kotlin/
 
-M.value = [[
+return [[
 
 ;; --- DESCRIBE SPEC ---
 
@@ -137,5 +135,3 @@ M.value = [[
 ;; -- todo ANNOTATION SPEC --
 
 ]]
-
-return M

lua/tests/example_project/app/build.gradle.kts

@@ -22,16 +22,12 @@ repositories {
 dependencies {
     // This dependency is used by the application.
     implementation(libs.guava)
+    testImplementation("io.kotest:kotest-runner-junit5:5.9.0")
+    testImplementation("io.kotest:kotest-assertions-core:5.9.0")
 }
 
-testing {
-    suites {
-        // Configure the built-in test suite
-        val test by getting(JvmTestSuite::class) {
-            // Use Kotlin Test test framework
-            useKotlinTest("1.9.22")
-        }
-    }
+tasks.withType<Test>().configureEach {
+    useJUnitPlatform()
 }
 
 // Apply a specific Java toolchain to ease working on different environments.

lua/tests/example_project/app/src/main/kotlin/org/example/App.kt

@@ -1,6 +1,3 @@
-/*
- * This source file was generated by the Gradle 'init' task
- */
 package org.example
 
 class App {

lua/tests/example_project/app/src/test/kotlin/org/example/KotestDescribeExample.kt

@@ -1,5 +1,5 @@
 
-package kotlin.org.example
+package org.example
 
 import io.kotest.core.spec.style.DescribeSpec
 import io.kotest.matchers.collections.shouldHaveSize