fix(process-directory): Add ability to pass custom working directory to ProcessRunner (#1801)

franklinfollis · web-flow · commit 9fa459031012 · 2025-12-19T02:01:53.000+08:00
* fix(process-directory): add option to change working directory for subprocesses

* test(process-directory): custom working directory tests for ProcessRunner and SubprocessRunner

* fix(process-directory): update api pins
diff --git a/packages/builder/api/builder.api b/packages/builder/api/builder.api
@@ -2704,14 +2704,16 @@ public final class elide/tooling/runner/ProcessRunner {
 }
 
 public final class elide/tooling/runner/ProcessRunner$ProcessOptions : java/lang/Record {
-	public fun <init> (Lelide/tooling/runner/ProcessRunner$ProcessShell;)V
+	public fun <init> (Lelide/tooling/runner/ProcessRunner$ProcessShell;Ljava/nio/file/Path;)V
 	public final fun component1 ()Lelide/tooling/runner/ProcessRunner$ProcessShell;
-	public final fun copy (Lelide/tooling/runner/ProcessRunner$ProcessShell;)Lelide/tooling/runner/ProcessRunner$ProcessOptions;
-	public static synthetic fun copy$default (Lelide/tooling/runner/ProcessRunner$ProcessOptions;Lelide/tooling/runner/ProcessRunner$ProcessShell;ILjava/lang/Object;)Lelide/tooling/runner/ProcessRunner$ProcessOptions;
+	public final fun component2 ()Ljava/nio/file/Path;
+	public final fun copy (Lelide/tooling/runner/ProcessRunner$ProcessShell;Ljava/nio/file/Path;)Lelide/tooling/runner/ProcessRunner$ProcessOptions;
+	public static synthetic fun copy$default (Lelide/tooling/runner/ProcessRunner$ProcessOptions;Lelide/tooling/runner/ProcessRunner$ProcessShell;Ljava/nio/file/Path;ILjava/lang/Object;)Lelide/tooling/runner/ProcessRunner$ProcessOptions;
 	public fun equals (Ljava/lang/Object;)Z
 	public fun hashCode ()I
 	public final fun shell ()Lelide/tooling/runner/ProcessRunner$ProcessShell;
 	public fun toString ()Ljava/lang/String;
+	public final fun workingDirectory ()Ljava/nio/file/Path;
 }
 
 public abstract interface class elide/tooling/runner/ProcessRunner$ProcessShell {
diff --git a/packages/builder/src/main/kotlin/elide/tooling/runner/ProcessRunner.kt b/packages/builder/src/main/kotlin/elide/tooling/runner/ProcessRunner.kt
@@ -42,6 +42,7 @@ public object ProcessRunner {
    */
   @JvmRecord public data class ProcessOptions(
     public val shell: ProcessShell,
+    public val workingDirectory: Path,
   )
 
   /**
@@ -128,6 +129,9 @@ public object ProcessRunner {
       }
     }
     val procBuilder = ProcessBuilder(resolvedArgs).apply {
+      // handle working directory
+      directory(task.options.workingDirectory.toFile())
+
       // handle task environment
       when (task.env) {
         // inject host environment
@@ -185,7 +189,10 @@ public object ProcessRunner {
     val mutEnv = env.toMutable()
     var executablePath: Path = exec
     var effectiveStreams: StdStreams = streams ?: StdStreams.Defaults
-    var effectiveOptions: ProcessOptions = options ?: ProcessOptions(ProcessShell.None)
+    var effectiveOptions: ProcessOptions = options ?: ProcessOptions(
+      shell = ProcessShell.None,
+      workingDirectory = Path.of(System.getProperty("user.dir")),
+    )
 
     return object : ProcessTaskBuilder {
       override var executable: Path = executablePath
diff --git a/packages/builder/src/test/kotlin/elide/tooling/runner/ProcessRunnerTest.kt b/packages/builder/src/test/kotlin/elide/tooling/runner/ProcessRunnerTest.kt
@@ -0,0 +1,94 @@
+/*
+ * Copyright (c) 2024-2025 Elide Technologies, Inc.
+ *
+ * Licensed under the MIT license (the "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ *   https://opensource.org/license/mit/
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
+ * an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+ * License for the specific language governing permissions and limitations under the License.
+ */
+package elide.tooling.runner
+
+import java.nio.file.Path
+import kotlin.test.*
+import elide.tooling.runner.ProcessRunner.ProcessOptions
+import elide.tooling.runner.ProcessRunner.ProcessShell
+
+class ProcessRunnerTest {
+  @Test fun `ProcessOptions should allow specifying a custom working directory`() {
+    val customDir = Path.of("/tmp")
+    val options = ProcessOptions(
+      shell = ProcessShell.None,
+      workingDirectory = customDir,
+    )
+
+    assertEquals(customDir, options.workingDirectory)
+  }
+
+  @Test fun `ProcessRunner build should accept a custom working directory`() {
+    val customDir = Path.of("/tmp")
+    val exec = Path.of("/bin/ls")
+
+    val builder = ProcessRunner.build(exec) {
+      options = ProcessOptions(
+        shell = ProcessShell.None,
+        workingDirectory = customDir,
+      )
+    }
+
+    assertEquals(customDir, builder.options.workingDirectory)
+    assertEquals(exec, builder.executable)
+  }
+
+  @Test fun `ProcessRunner build should allow changing the working directory after building`() {
+    val initialDir = Path.of("/tmp")
+    val newDir = Path.of("/var")
+    val exec = Path.of("/bin/echo")
+
+    val builder = ProcessRunner.build(exec) {
+      options = ProcessOptions(
+        shell = ProcessShell.None,
+        workingDirectory = initialDir,
+      )
+    }
+
+    assertEquals(initialDir, builder.options.workingDirectory)
+
+    // Change the working directory
+    builder.options = ProcessOptions(
+      shell = ProcessShell.None,
+      workingDirectory = newDir,
+    )
+
+    assertEquals(newDir, builder.options.workingDirectory)
+  }
+
+  @Test fun `ProcessRunner buildFrom should use current working directory by default`() {
+    val exec = Path.of("/bin/echo")
+    val args = elide.tooling.Arguments.empty()
+    val env = elide.tooling.Environment.empty()
+
+    val builder = ProcessRunner.buildFrom(exec, args, env)
+
+    assertNotNull(builder.options.workingDirectory)
+    assertEquals(Path.of(System.getProperty("user.dir")), builder.options.workingDirectory)
+  }
+
+  @Test fun `ProcessRunner buildFrom should accept custom working directory`() {
+    val exec = Path.of("/bin/echo")
+    val args = elide.tooling.Arguments.empty()
+    val env = elide.tooling.Environment.empty()
+    val customDir = Path.of("/tmp")
+    val customOptions = ProcessOptions(
+      shell = ProcessShell.None,
+      workingDirectory = customDir,
+    )
+
+    val builder = ProcessRunner.buildFrom(exec, args, env, options = customOptions)
+
+    assertEquals(customDir, builder.options.workingDirectory)
+  }
+}
diff --git a/packages/cli/src/main/kotlin/elide/tool/cli/cmd/repl/ToolShellCommand.kt b/packages/cli/src/main/kotlin/elide/tool/cli/cmd/repl/ToolShellCommand.kt
@@ -2926,7 +2926,10 @@ internal class ToolShellCommand : ProjectAwareSubcommand<ToolState, CommandConte
             env = Environment.HostEnv
 
             // activate shell support
-            options = ProcessRunner.ProcessOptions(shell = ProcessRunner.ProcessShell.Active)
+            options = ProcessRunner.ProcessOptions(
+              shell = ProcessRunner.ProcessShell.Active,
+              workingDirectory = Path.of(System.getProperty("user.dir")),
+            )
 
             // copy in the provided arguments
             runnableArgs.takeIf { it.isNotEmpty() }?.let { arguments ->
diff --git a/packages/cli/src/main/kotlin/elide/tool/exec/SubprocessRunner.kt b/packages/cli/src/main/kotlin/elide/tool/exec/SubprocessRunner.kt
@@ -59,7 +59,9 @@ object SubprocessRunner {
   @JvmStatic suspend fun CommandContext.stringToTask(
     spec: String,
     shell: ProcessRunner.ProcessShell = ProcessRunner.ProcessShell.Active,
+    workingDirectory: Path = Path.of(System.getProperty("user.dir")),
   ): CommandLineProcessTaskBuilder {
+    val cwd = Path.of(System.getProperty("user.dir"))
     val toolname = spec.substringBefore(' ')
     val argsStr = spec.substringAfter(' ')
     val argsArr = argsStr.split(' ')
@@ -69,7 +71,7 @@ object SubprocessRunner {
       // use an identical path to elide so that versions always match.
       // @TODO in jvm mode, this falls through and calls into native elide
       toolname == "elide" && ImageInfo.inImageCode() -> Statics.binPath
-      toolname.startsWith(".") -> Path.of(System.getProperty("user.dir")).resolve(toolpath)
+      toolname.startsWith(".") -> cwd.resolve(toolpath)
       else -> toolpath
     }
     suspend fun resolvedTool(): Path {
@@ -79,7 +81,7 @@ object SubprocessRunner {
         which(resolvedToolpath) ?: resolvedToolpath
       }
     }
-    return subprocess(resolvedTool(), shell = shell) {
+    return subprocess(resolvedTool(), shell = shell, workingDirectory = workingDirectory) {
       // add all cli args
       args.addAllStrings(argsTrimmed.toList())
     }
@@ -115,13 +117,12 @@ object SubprocessRunner {
   @JvmStatic fun CommandContext.subprocess(
     exec: Path,
     shell: ProcessRunner.ProcessShell = ProcessRunner.ProcessShell.None,
+    workingDirectory: Path = Path.of(System.getProperty("user.dir")),
     block: CommandLineProcessTaskBuilder.() -> Unit,
   ): CommandLineProcessTaskBuilder {
     val out = ProcessRunner.build(exec) {
-      // by default, user shell access is off; if turned on, activate it from env
-      if (shell != ProcessRunner.ProcessShell.None) {
-        options = ProcessRunner.ProcessOptions(shell = shell)
-      }
+      // set process options with shell and working directory
+      options = ProcessRunner.ProcessOptions(shell = shell, workingDirectory = workingDirectory)
 
       // default environment overrides PATH
       env = Environment.HostEnv.extend(
diff --git a/packages/cli/src/test/kotlin/elide/tool/exec/SubprocessRunnerTest.kt b/packages/cli/src/test/kotlin/elide/tool/exec/SubprocessRunnerTest.kt
@@ -0,0 +1,96 @@
+/*
+ * Copyright (c) 2024-2025 Elide Technologies, Inc.
+ *
+ * Licensed under the MIT license (the "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ *   https://opensource.org/license/mit/
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
+ * an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+ * License for the specific language governing permissions and limitations under the License.
+ */
+package elide.tool.exec
+
+import java.nio.file.Path
+import kotlin.test.*
+import kotlinx.coroutines.Dispatchers
+import kotlinx.coroutines.test.runTest
+import elide.tool.cli.CommandContext
+import elide.tool.cli.state.CommandOptions
+import elide.tool.cli.state.CommandState
+import elide.tool.exec.SubprocessRunner.stringToTask
+import elide.tool.exec.SubprocessRunner.subprocess
+import elide.tooling.runner.ProcessRunner
+
+class SubprocessRunnerTest {
+  private fun testContext(): CommandContext {
+    val options = CommandOptions.of(
+      args = emptyList(),
+      debug = false,
+      verbose = false,
+      quiet = false,
+      pretty = false,
+    )
+    val state = CommandState.of(options)
+    return CommandContext.default(state, Dispatchers.Default)
+  }
+
+  @Test fun `stringToTask should use current working directory by default`() = runTest {
+    val expectedCwd = Path.of(System.getProperty("user.dir"))
+    val context = testContext()
+
+    with(context) {
+      val builder = stringToTask("echo test")
+      assertEquals(expectedCwd, builder.options.workingDirectory)
+    }
+  }
+
+  @Test fun `stringToTask should accept custom working directory`() = runTest {
+    val customDir = Path.of("/tmp")
+    val context = testContext()
+
+    with(context) {
+      val builder = stringToTask("echo test", workingDirectory = customDir)
+      assertEquals(customDir, builder.options.workingDirectory)
+    }
+  }
+
+  @Test fun `should use current working directory by default when creating subprocess`() {
+    val expectedCwd = Path.of(System.getProperty("user.dir"))
+    val context = testContext()
+    val exec = Path.of("/bin/echo")
+
+    with(context) {
+      val builder = subprocess(exec) {}
+      assertEquals(expectedCwd, builder.options.workingDirectory)
+    }
+  }
+
+  @Test fun `should be able to pass custom working directory when creating subprocess`() {
+    val customDir = Path.of("/var")
+    val context = testContext()
+    val exec = Path.of("/bin/ls")
+
+    with(context) {
+      val builder = subprocess(exec, workingDirectory = customDir) {}
+      assertEquals(customDir, builder.options.workingDirectory)
+    }
+  }
+
+  @Test fun `should be able to pass custom working directory through to ProcessRunner options`() {
+    val customDir = Path.of("/usr")
+    val context = testContext()
+    val exec = Path.of("/bin/pwd")
+
+    with(context) {
+      val builder = subprocess(exec, workingDirectory = customDir) {
+        args.addAllStrings(listOf("arg1"))
+      }
+
+      assertEquals(customDir, builder.options.workingDirectory)
+      assertEquals(exec, builder.executable)
+      assertTrue(builder.args.asArgumentList().contains("arg1"))
+    }
+  }
+}
