Merge pull request #447 from dmlloyd/batch-again

Hide Windows batch argument escaping behind an option

Author: dmlloyd

process/src/main/java/io/smallrye/common/process/ArgumentRule.java

@@ -14,7 +14,8 @@ void checkArguments(final List<String> arguments) throws IllegalArgumentExceptio
             // no operation (accepts any)
         }
 
-        List<String> formatArguments(final Path command, final List<String> arguments) throws IllegalArgumentException {
+        List<String> formatArguments(final Path command, final List<String> arguments, final boolean specialQuoting)
+                throws IllegalArgumentException {
             return Stream.concat(Stream.of(command.toString()), arguments.stream()).toList();
         }
     },
@@ -42,13 +43,19 @@ void checkArguments(final List<String> arguments) throws IllegalArgumentExceptio
             }
         }
 
-        List<String> formatArguments(final Path command, final List<String> arguments) throws IllegalArgumentException {
+        List<String> formatArguments(final Path command, final List<String> arguments, final boolean specialQuoting)
+                throws IllegalArgumentException {
             // in the future, this will be replaced with a variation which has extra quoting capabilities
             ArrayList<String> list = new ArrayList<>(arguments.size() + 5);
-            StringBuilder sb = new StringBuilder();
-            list.add(quote(command.toString(), sb));
-            for (final String argument : arguments) {
-                list.add(quote(argument, sb));
+            if (specialQuoting) {
+                StringBuilder sb = new StringBuilder();
+                list.add(quote(command.toString(), sb));
+                for (final String argument : arguments) {
+                    list.add(quote(argument, sb));
+                }
+            } else {
+                list.add(command.toString());
+                list.addAll(arguments);
             }
             return list;
         }
@@ -89,7 +96,8 @@ void checkArguments(final List<String> arguments) throws IllegalArgumentExceptio
             // OK
         }
 
-        List<String> formatArguments(final Path command, final List<String> arguments) throws IllegalArgumentException {
+        List<String> formatArguments(final Path command, final List<String> arguments, final boolean specialQuoting)
+                throws IllegalArgumentException {
             return Stream.concat(
                     Stream.of("powershell.exe", "-ExecutionPolicy", "Bypass", "-File", command.toString()),
                     arguments.stream()).toList();
@@ -103,5 +111,6 @@ IllegalArgumentException invalidCharacter(final String argument, final int idx)
 
     abstract void checkArguments(List<String> arguments) throws IllegalArgumentException;
 
-    abstract List<String> formatArguments(Path command, List<String> arguments) throws IllegalArgumentException;
+    abstract List<String> formatArguments(Path command, List<String> arguments, boolean specialQuoting)
+            throws IllegalArgumentException;
 }

process/src/main/java/io/smallrye/common/process/PipelineBuilder.java

@@ -44,6 +44,16 @@ public sealed interface PipelineBuilder<O> permits PipelineBuilder.Error, Pipeli
      */
     PipelineBuilder<O> arguments(String... command);
 
+    /**
+     * Enable special quoting for batch scripts on Windows.
+     * Note that this requires the batch script to use a specific form
+     * of argument expansion.
+     *
+     * @param specialQuoting {@code true} to enable special quoting, or {@code false} to use default quoting
+     * @return this builder
+     */
+    PipelineBuilder<O> specialQuoting(boolean specialQuoting);
+
     /**
      * Set the working directory for this process execution.
      *

process/src/main/java/io/smallrye/common/process/PipelineRunner.java

@@ -597,7 +597,8 @@ ProcessExecutionException newProcessException(String message) {
     int createThreads(final ThreadFactory tf, final ProcessRunner<O> runner, final PipelineRunner<O> nextRunner)
             throws IOException {
         pb = processBuilder.pb;
-        pb.command(processBuilder.argumentRule.formatArguments(processBuilder.command, processBuilder.arguments));
+        pb.command(processBuilder.argumentRule.formatArguments(processBuilder.command, processBuilder.arguments,
+                processBuilder.specialQuoting));
         pb.directory(processBuilder.directory);
         int cnt = createInputThread(tf, runner)
                 + createErrorThreads(tf, runner)

process/src/main/java/io/smallrye/common/process/ProcessBuilder.java

@@ -347,6 +347,9 @@ default ProcessBuilder<O> arguments(String... command) {
         return arguments(List.of(command));
     }
 
+    @Override
+    ProcessBuilder<O> specialQuoting(boolean specialQuoting);
+
     @Override
     ProcessBuilder<O> directory(Path directory);
 

process/src/main/java/io/smallrye/common/process/ProcessBuilderImpl.java

@@ -57,6 +57,7 @@ final class ProcessBuilderImpl<O> implements ProcessBuilder<O> {
     final Path command;
     final ArgumentRule argumentRule;
     File directory;
+    boolean specialQuoting;
     private volatile boolean locked;
     List<String> arguments = List.of();
     IntPredicate exitCodeChecker = e -> e == 0;
@@ -120,6 +121,11 @@ public ProcessBuilder<O> arguments(final List<String> arguments) {
         return this;
     }
 
+    public ProcessBuilder<O> specialQuoting(final boolean specialQuoting) {
+        this.specialQuoting = specialQuoting;
+        return this;
+    }
+
     public ProcessBuilder<O> directory(final Path directory) {
         check();
         this.directory = Assert.checkNotNullParam("directory", directory).toFile();
@@ -234,6 +240,10 @@ public ProcessBuilder<O> arguments(final List<String> command) {
             return ProcessBuilderImpl.this.arguments(command);
         }
 
+        public ProcessBuilder<O> specialQuoting(final boolean specialQuoting) {
+            return ProcessBuilderImpl.this.specialQuoting(specialQuoting);
+        }
+
         public ProcessBuilder<O> directory(final Path directory) {
             return ProcessBuilderImpl.this.directory(directory);
         }

process/src/test/java/io/smallrye/common/process/WindowsSpecificTests.java

@@ -33,18 +33,34 @@ public void testBatchArguments() throws Exception {
         assertEquals(List.of("hello", "world"), output);
 
         output = ProcessBuilder.newBuilder(findScript("batch/echo_2_args.cmd"))
+                .specialQuoting(true)
+                .arguments("--foo=bar", "--foo bar")
+                .output().toStringList(16, 1024)
+                .run();
+        assertEquals(List.of("--foo=bar", "--foo bar"), output);
+
+        output = ProcessBuilder.newBuilder(findScript("batch/echo_2_args.cmd"))
+                .arguments("--foo=bar", "--foo bar")
+                .output().toStringList(16, 1024)
+                .run();
+        assertEquals(List.of("--foo", "bar"), output);
+
+        output = ProcessBuilder.newBuilder(findScript("batch/echo_2_args.cmd"))
+                .specialQuoting(true)
                 .arguments("with spaces", "with ^ caret")
                 .output().toStringList(16, 1024)
                 .run();
         assertEquals(List.of("with spaces", "with ^ caret"), output);
 
         output = ProcessBuilder.newBuilder(findScript("batch/echo_2_args.cmd"))
+                .specialQuoting(true)
                 .arguments("\"withQuotes\"", "\"quotes and spaces\"")
                 .output().toStringList(16, 1024)
                 .run();
         assertEquals(List.of("withQuotes", "quotes and spaces"), output);
 
         output = ProcessBuilder.newBuilder(findScript("batch/echo_2_args.cmd"))
+                .specialQuoting(true)
                 .arguments("\"with \"interior\" quotes\"", "it works!")
                 .output().toStringList(16, 1024)
                 .run();