feat: add java test run APIs (#10)

Author: s1n7ax

lua/java/ls/adapters/test-adapter.lua

@@ -0,0 +1,96 @@
+local List = require('java.utils.list')
+local Set = require('java.utils.set')
+local JavaTestClient = require('java.ls.clients.java-test-client')
+
+local M = {}
+
+---@class JavaTestLauncherConfig
+---@field name string
+---@field type string
+---@field request string
+---@field mainClass string
+---@field projectName string
+---@field cwd string
+---@field classPaths string[]
+---@field modulePaths string[]
+---@field vmArgs string
+---@field noDebug boolean
+---@field javaExec string
+---@field args string
+---@field env? { [string]: string; }
+---@field envFile? string
+---@field sourcePaths string[]
+---@field preLaunchTask? string
+---@field postDebugTask? string
+
+---Returns the launcher config
+---@param test_details JavaTestDetails | JavaTestDetails[]
+---@param launch_args JavaTestJunitLaunchArguments
+---@param java_exec JavaDebugResolveJavaExecutableResponse
+---@param config { debug: boolean, label: string }
+---@return JavaTestLauncherConfig
+function M.get_dap_launcher_config(launch_args, java_exec, config)
+	return {
+		name = config.label,
+		type = 'java',
+		request = 'launch',
+		mainClass = launch_args.mainClass,
+		projectName = launch_args.projectName,
+		noDebug = not config.debug,
+		javaExec = java_exec,
+		cwd = launch_args.workingDirectory,
+		classPaths = Set:new(launch_args.classpath),
+		modulePaths = Set:new(launch_args.modulepath),
+		vmArgs = List:new(launch_args.vmArguments):join(' '),
+		args = List:new(launch_args.programArguments):join(' '),
+		-- env: config?.env,
+		-- envFile: config?.envFile,
+		-- sourcePaths: config?.sourcePaths,
+		-- preLaunchTask: config?.preLaunchTask,
+		-- postDebugTask: config?.postDebugTask,
+	}
+
+	-- if test_details.testKind == TestKind.TestNG then
+	-- 	path.join(extensionContext.extensionPath, 'server', 'com.microsoft.java.test.runner-jar-with-dependencies.jar'),
+	-- end
+end
+
+---comment
+---@param tests JavaTestDetails | JavaTestDetails[]
+function M.get_junit_launch_argument_params(tests)
+	if not vim.tbl_islist(tests) then
+		return {
+			projectName = tests.projectName,
+			testLevel = tests.testLevel,
+			testKind = tests.testKind,
+			testNames = M.get_test_names({ tests }),
+		}
+	end
+
+	local first_test = tests[1]
+
+	return {
+		projectName = first_test.projectName,
+		testLevel = first_test.testLevel,
+		testKind = first_test.testKind,
+		testNames = M.get_test_names(tests),
+	}
+end
+
+---Returns a list of test names to be passed to test launch arguments resolver
+---@param tests JavaTestDetails[]
+---@return List
+function M.get_test_names(tests)
+	return List:new(tests):map(function(test)
+		if
+			test.testKind == JavaTestClient.TestKind.TestNG
+			or test.testLevel == JavaTestClient.TestLevel.Class
+		then
+			return test.fullName
+		end
+
+		return test.jdtHandler
+	end)
+end
+
+return M

lua/java/ls/clients/java-debug-client.lua

@@ -1,5 +1,6 @@
 local JDTLSClient = require('java.ls.clients.jdtls-client')
 
+---@class JavaDebugClient: JDTLSClient
 local M = JDTLSClient:new()
 
 ---@class JavaDebugResolveMainClassRecord

lua/java/ls/clients/java-test-client.lua

@@ -0,0 +1,135 @@
+local log = require('java.utils.log')
+local JDTLSClient = require('java.ls.clients.jdtls-client')
+
+---@class JavaTestDetails: Configuration
+---@field fullName string
+---@field id string
+---@field jdtHandler string
+---@field label string
+---@field projectName string
+---@field testKind integer
+---@field testLevel integer
+---@field uri string
+
+---@class JavaTestDetailsWithRange: JavaTestDetails
+---@field range Range
+
+---@class JavaTestDetailsWithChildren: JavaTestDetails
+---@field children JavaTestDetailsWithRange[]
+
+---@class JavaTestDetailsWithChildrenAndRange: JavaTestDetails
+---@field range Range
+---@field children JavaTestDetailsWithRange[]
+
+---@class Range
+---@field start CursorPoint
+---@field end CursorPoint
+
+---@class CursorPoint
+---@field line integer
+---@field character integer
+
+---@class JavaTestClient: JDTLSClient
+local M = JDTLSClient:new()
+
+---@alias JavaTestFindJavaProjectsResponse JavaTestDetails[]
+
+---Returns a list of project details in the current root
+---@return Promise
+function M:find_java_projects()
+	return self:execute_command(
+		'vscode.java.test.findJavaProjects',
+		{ vim.uri_from_fname(self.client.config.root_dir) }
+	)
+end
+
+---@alias JavaTestFindTestPackagesAndTypesResponse JavaTestDetailsWithChildren[]
+
+---Returns a list of test package details
+---@param token any
+---@return Promise
+function M:find_test_packages_and_types(handler, token)
+	return self:execute_command(
+		'vscode.java.test.findTestPackagesAndTypes',
+		{ handler, token }
+	)
+end
+
+---@alias JavaTestFindTestTypesAndMethodsResponse JavaTestDetailsWithChildrenAndRange[]
+
+---Returns test informations in a given file
+---@param file_uri string
+---@param token any
+---@return Promise
+function M:find_test_types_and_methods(file_uri, token)
+	return self:execute_command(
+		'vscode.java.test.findTestTypesAndMethods',
+		{ file_uri, token }
+	)
+end
+
+---@class JavaTestJunitLaunchArguments
+---@field classpath string[]
+---@field mainClass string
+---@field modulepath string[]
+---@field programArguments string[]
+---@field projectName string
+---@field vmArguments string[]
+---@field workingDirectory string
+
+---@class JavaTestResolveJUnitLaunchArgumentsParams
+---@field project_name string
+---@field test_names string[]
+---@field test_level TestLevel
+---@field test_kind TestKind
+
+---Returns junit launch arguments
+---@param args JavaTestResolveJUnitLaunchArgumentsParams
+---@return Promise
+function M:resolve_junit_launch_arguments(args)
+	return self
+		:execute_command(
+			'vscode.java.test.junit.argument',
+			vim.fn.json_encode(args)
+		)
+		:thenCall(
+
+			---@class JavaTestJunitLaunchArgumentsResponse
+			---@field body JavaTestJunitLaunchArguments
+			---@field status integer
+
+			---@param res JavaTestJunitLaunchArgumentsResponse
+			function(res)
+				if not res.body then
+					local msg = 'Failed to retrive JUnit launch arguments'
+
+					log.error(msg, res)
+					error(msg)
+				end
+
+				return res.body
+			end
+		)
+end
+
+---@enum TestKind
+M.TestKind = {
+	JUnit5 = 0,
+	JUnit = 1,
+	TestNG = 2,
+	None = 100,
+}
+
+---@enum TestLevel
+M.TestLevel = {
+	Root = 0,
+	Workspace = 1,
+	WorkspaceFolder = 2,
+	Project = 3,
+	Package = 4,
+	Class = 5,
+	Method = 6,
+	Invocation = 7,
+}
+
+return M