feat: support cwd and env variable using sun jdi

[thunderz99]

An enhance for #39

Done

• cwd

  • Add "cwd" for LaunchConfiguration
    • default to ${projectRoot} if null or blank
  • Add a custom KDACommandLineLauncher which implements LaunchingConnector
    • The implementation is in original code written in Kotlin
  • Add unit test for cwd

• env variables

  • Add "envs" for LaunchConfiguration
  • Change "envs" config from List<String> to Map<String, String> style for more friendly user experience
  • Add unit test for envs

• support for jdk1.8

• support for jdk11

  • SunCommandLineLauncher cannot be extended under jdk11, so KDACommandLineLauncher implements
    LaunchingConnector directly
  • SocketTransportService cannot be constructed under jdk11, so it is newed by Class.forName

Linked pullreq

• Add cwd / envs support in vscode-kotlin
  feat: add cwd and env variables support vscode-kotlin#42

[bkleiner]

any update on this? what needs to be done to get this merged?

[fwcd]

Sorry for the long delay here, thanks for looking into this! I have left a few comments (mostly concerning style) below, so we can get this moving.

[fwcd]

If possible, I would like to avoid introducing a new dependency here. For splitting the command line args, I think just splitting by spaces would be fine for now.

[fwcd]

Is there a specific reason to make this open, e.g. do we need to do so for interop with Java/JDI? If not, I would suggest removing the modifier.

[fwcd]

Style nit: Please remove the blank lines inbetween.

Suggested change

	defaultArguments[ARG_HOME] = StringArgument(ARG_HOME, description = "Java home", value = System.getProperty("java.home"))
	defaultArguments[ARG_OPTIONS] = StringArgument(ARG_OPTIONS, description = "Jvm arguments")
	defaultArguments[ARG_MAIN] = StringArgument(ARG_MAIN, description = "Main class name and parameters", mustSpecify = true)
	defaultArguments[ARG_SUSPEND] = StringArgument(ARG_SUSPEND, description = "Whether launch the debugee in suspend mode", value = "true")
	defaultArguments[ARG_QUOTE] = StringArgument(ARG_QUOTE, description = "Quote char", value = "\"")
	defaultArguments[ARG_VM_EXEC] = StringArgument(ARG_VM_EXEC, description = "The java exec", value = "java")
	defaultArguments[ARG_CWD] = StringArgument(ARG_CWD, description = "Current working directory")
	defaultArguments[ARG_ENVS] = StringArgument(ARG_ENVS, description = "Environment variables")
	defaultArguments[ARG_HOME] = StringArgument(ARG_HOME, description = "Java home", value = System.getProperty("java.home"))
	defaultArguments[ARG_OPTIONS] = StringArgument(ARG_OPTIONS, description = "Jvm arguments")
	defaultArguments[ARG_MAIN] = StringArgument(ARG_MAIN, description = "Main class name and parameters", mustSpecify = true)
	defaultArguments[ARG_SUSPEND] = StringArgument(ARG_SUSPEND, description = "Whether launch the debugee in suspend mode", value = "true")
	defaultArguments[ARG_QUOTE] = StringArgument(ARG_QUOTE, description = "Quote char", value = "\"")
	defaultArguments[ARG_VM_EXEC] = StringArgument(ARG_VM_EXEC, description = "The java exec", value = "java")
	defaultArguments[ARG_CWD] = StringArgument(ARG_CWD, description = "Current working directory")
	defaultArguments[ARG_ENVS] = StringArgument(ARG_ENVS, description = "Environment variables")

[fwcd]

Same here, I think it looks a bit nicer with less whitespace.

Suggested change

	command.append(wrapWhitespace(exe))
	command.append(" $options")
	//debug options
	command.append(" -agentlib:jdwp=transport=${transport.name()},address=$address,server=n,suspend=${if (suspend) 'y' else 'n'}")
	command.append(" $main")
	command.append(wrapWhitespace(exe))
	command.append(" $options")
	// debug options
	command.append(" -agentlib:jdwp=transport=${transport.name()},address=$address,server=n,suspend=${if (suspend) 'y' else 'n'}")
	command.append(" $main")

[fwcd]

I think this would read better if we moved the parameters to individual lines:

Suggested change

	fun launch(commandArray: Array<String>,
	listenKey: TransportService.ListenKey,
	ts: TransportService, cwd: String, envs: Array<String>? = null): VirtualMachine {
	fun launch(
	commandArray: Array<String>,
	listenKey: TransportService.ListenKey,
	ts: TransportService,
	cwd: String,
	envs: Array<String>? = null
	): VirtualMachine {

[fwcd]

Since we already have a bunch of longer lines, I think not breaking would be fine here.

Suggested change

	return Bootstrap.virtualMachineManager().createVirtualMachine(connection,
	process)
	return Bootstrap.virtualMachineManager().createVirtualMachine(connection, process)

[fwcd]

Suggested change

	protected fun launchAndConnect(commandArray: Array<String>, listenKey: TransportService.ListenKey,
	ts: TransportService, cwd: String = "", envs: Array<String>? = null): Pair<Connection, Process>{
	protected fun launchAndConnect(
	commandArray: Array<String>,
	listenKey: TransportService.ListenKey,
	ts: TransportService,
	cwd: String = "",
	envs: Array<String>? = null
	): Pair<Connection, Process> {

[fwcd]

Could we omit the constructor here, since it is the primary constructor?

Suggested change

	class StringArgument constructor(private val name: String, private val description: String = "", private val label: String = name,
	private var value:String = "", private val mustSpecify: Boolean = false) : Connector.Argument {
	class StringArgument(
	private val name: String,
	private val description: String = "",
	private val label: String = name,
	private var value:String = "",
	private val mustSpecify: Boolean = false
	) : Connector.Argument {

[fwcd]

It would be great if you could make sure that all edited files have trailing newlines (by Unix convention). Most editors should be configurable to do so, e.g. in VSCode you can set

"files.insertFinalNewline": true

in your settings.

[thunderz99]

@fwcd Thank you for the advices, I will update this PR

[aharoldk]

@thunderz99 please update the MR.