Support RunShell's directory property from spec (#1696)

* Support RunShell's directory property from spec

open-workflow-specification/specification#1191

Signed-off-by: Cristiano Gavião <cvgaviao@gmail.com>

* Review comments

Signed-off-by: Francisco Javier Tirado Sarti <ftirados@ibm.com>

---------

Signed-off-by: Cristiano Gavião <cvgaviao@gmail.com>
Signed-off-by: Francisco Javier Tirado Sarti <ftirados@ibm.com>
Co-authored-by: Francisco Javier Tirado Sarti <ftirados@ibm.com>

Author: cvgaviao

impl/core/src/main/java/io/serverlessworkflow/impl/executors/RunShellExecutor.java

@@ -23,6 +23,7 @@
 import io.serverlessworkflow.impl.WorkflowModel;
 import io.serverlessworkflow.impl.WorkflowValueResolver;
 import io.serverlessworkflow.impl.scripts.ScriptUtils;
+import java.io.File;
 import java.util.ArrayList;
 import java.util.List;
 import java.util.Map;
@@ -32,18 +33,29 @@
 public class RunShellExecutor implements CallableTask {
   private final WorkflowValueResolver<String> shellCommand;
   private final List<WorkflowValueResolver<String>> shellArguments;
+  private final Optional<WorkflowValueResolver<String>> shellDirectory;
   private final Optional<WorkflowValueResolver<Map<String, Object>>> shellEnv;
   private final Optional<ProcessReturnType> returnType;
 
   public RunShellExecutor(
       WorkflowValueResolver<String> shellCommand,
       List<WorkflowValueResolver<String>> shellArguments,
       Optional<WorkflowValueResolver<Map<String, Object>>> shellEnv,
-      Optional<ProcessReturnType> returnType) {
+      Optional<ProcessReturnType> returnType,
+      Optional<WorkflowValueResolver<String>> shellDirectory) {
     this.shellCommand = shellCommand;
     this.shellArguments = shellArguments;
     this.shellEnv = shellEnv;
     this.returnType = returnType;
+    this.shellDirectory = shellDirectory;
+  }
+
+  public RunShellExecutor(
+      WorkflowValueResolver<String> shellCommand,
+      List<WorkflowValueResolver<String>> shellArguments,
+      Optional<WorkflowValueResolver<Map<String, Object>>> shellEnv,
+      Optional<ProcessReturnType> returnType) {
+    this(shellCommand, shellArguments, shellEnv, returnType, Optional.empty());
   }
 
   @Override
@@ -64,6 +76,9 @@ public CompletableFuture<WorkflowModel> apply(
     shellArguments.forEach(f -> commandAndArgs.add(f.apply(workflowContext, taskContext, model)));
 
     ProcessBuilder builder = new ProcessBuilder(commandAndArgs);
+    shellDirectory.ifPresent(
+        directory ->
+            builder.directory(new File(directory.apply(workflowContext, taskContext, model))));
     shellEnv.ifPresent(
         map -> ScriptUtils.addEnviromment(builder, map.apply(workflowContext, taskContext, model)));
 

impl/core/src/main/java/io/serverlessworkflow/impl/executors/RunShellExecutorBuilder.java

@@ -44,8 +44,10 @@ public CallableTask build(RunShell taskConfiguration, WorkflowDefinition definit
                 WorkflowUtils.buildMapResolver(
                     definition.application(), shell.getEnvironment().getAdditionalProperties()))
             : Optional.empty(),
-        taskConfiguration.isAwait()
-            ? Optional.of(taskConfiguration.getReturn())
+        taskConfiguration.isAwait() ? Optional.of(taskConfiguration.getReturn()) : Optional.empty(),
+        shell.getDirectory() != null
+            ? Optional.of(
+                WorkflowUtils.buildStringFilter(definition.application(), shell.getDirectory()))
             : Optional.empty());
   }
 

impl/test/src/test/java/io/serverlessworkflow/impl/test/RunShellExecutorTest.java

@@ -39,7 +39,7 @@ public class RunShellExecutorTest {
 
   @BeforeAll
   static void init() {
-    appl = WorkflowApplication.builder().withAllowedCommands(List.of("ls", "echo")).build();
+    appl = WorkflowApplication.builder().withAllowedCommands(List.of("ls", "echo", "pwd")).build();
   }
 
   @AfterAll
@@ -89,6 +89,21 @@ void testEchoWithJqExpression() throws IOException {
         });
   }
 
+  @Test
+  void testDirectory() throws IOException {
+    Workflow workflow =
+        WorkflowReader.readWorkflowFromClasspath("workflows-samples/run-shell/pwd-directory.yaml");
+    WorkflowModel model = appl.workflowDefinition(workflow).instance(Map.of()).start().join();
+
+    SoftAssertions.assertSoftly(
+        softly -> {
+          ProcessResult result = model.as(ProcessResult.class).orElseThrow();
+          softly.assertThat(result.code()).isEqualTo(0);
+          softly.assertThat(result.stdout().trim()).isEqualTo("/tmp");
+          softly.assertThat(result.stderr()).isEmpty();
+        });
+  }
+
   @Test
   void testMissingShellCommand() throws IOException {
     Workflow workflow =

impl/test/src/test/resources/workflows-samples/run-shell/pwd-directory.yaml

@@ -0,0 +1,12 @@
+document:
+  dsl: '1.0.1'
+  namespace: test
+  name: pwd-directory
+  version: '0.1.0'
+do:
+  - runShell:
+      run:
+        shell:
+          command: pwd
+          directory: /tmp
+        return: all

types/src/main/resources/schema/workflow.yaml

@@ -928,6 +928,10 @@ $defs:
                       description: A list of the arguments, if any, of the shell command to run.
                       items:
                         type: string
+                    directory:
+                      type: string
+                      title: ShellDirectory
+                      description: The working directory, if any, in which to run the shell command.
                     environment:
                       type: object
                       title: ShellEnvironment