[Messenger][Process] add fromShellCommandline to RunProcessMessage

Staormin · Staormin · commit 243baf17a973 · 2025-02-13T14:40:36.000+01:00
Allows using the Process::fromShellCommandline when using a RunProcessMessage
diff --git a/src/Symfony/Component/Process/CHANGELOG.md b/src/Symfony/Component/Process/CHANGELOG.md
@@ -1,6 +1,11 @@
 CHANGELOG
 =========
 
+
+7.3
+---
+ * Add `RunProcessMessage::fromShellCommandline()` to instantiate a Process via the fromShellCommandline method
+
 7.1
 ---
 
diff --git a/src/Symfony/Component/Process/Messenger/RunProcessMessage.php b/src/Symfony/Component/Process/Messenger/RunProcessMessage.php
@@ -22,11 +22,22 @@ public function __construct(
         public readonly ?array $env = null,
         public readonly mixed $input = null,
         public readonly ?float $timeout = 60.0,
+        public readonly ?string $commandLine = null,
     ) {
     }
 
     public function __toString(): string
     {
-        return implode(' ', $this->command);
+        return $this->commandLine ?? implode(' ', $this->command);
+    }
+
+    /**
+     * Create a process message instance that will instantiate a Process using the fromShellCommandline method.
+     *
+     * @see Process::fromShellCommandline
+     */
+    public static function fromShellCommandline(string $command, ?string $cwd = null, ?array $env = null, mixed $input = null, ?float $timeout = 60): static
+    {
+        return new static([], $cwd, $env, $input, $timeout, $command);
     }
 }
diff --git a/src/Symfony/Component/Process/Messenger/RunProcessMessageHandler.php b/src/Symfony/Component/Process/Messenger/RunProcessMessageHandler.php
@@ -22,7 +22,10 @@ final class RunProcessMessageHandler
 {
     public function __invoke(RunProcessMessage $message): RunProcessContext
     {
-        $process = new Process($message->command, $message->cwd, $message->env, $message->input, $message->timeout);
+        match ($message->commandLine) {
+            null => $process = new Process($message->command, $message->cwd, $message->env, $message->input, $message->timeout),
+            default => $process = Process::fromShellCommandline($message->commandLine, $message->cwd, $message->env, $message->input, $message->timeout),
+        };
 
         try {
             return new RunProcessContext($message, $process->mustRun());
diff --git a/src/Symfony/Component/Process/Tests/Messenger/RunProcessMessageHandlerTest.php b/src/Symfony/Component/Process/Tests/Messenger/RunProcessMessageHandlerTest.php
@@ -44,4 +44,31 @@ public function testRunFailedProcess()
 
         $this->fail('Exception not thrown');
     }
+
+    public function testRunSuccessfulProcessFromShellCommandline()
+    {
+        $context = (new RunProcessMessageHandler())(RunProcessMessage::fromShellCommandline('ls | grep Test', cwd: __DIR__));
+
+        $this->assertSame('ls | grep Test', $context->message->commandLine);
+        $this->assertSame(0, $context->exitCode);
+        $this->assertStringContainsString(basename(__FILE__), $context->output);
+    }
+
+    public function testRunFailedProcessFromShellCommandline()
+    {
+        try {
+            (new RunProcessMessageHandler())(RunProcessMessage::fromShellCommandline('invalid'));
+        } catch (RunProcessFailedException $e) {
+            $this->assertSame('invalid', $e->context->message->commandLine);
+            $this->assertContains(
+                $e->context->exitCode,
+                [null, '\\' === \DIRECTORY_SEPARATOR ? 1 : 127],
+                'Exit code should be 1 on Windows, 127 on other systems, or null',
+            );
+
+            return;
+        }
+
+        $this->fail('Exception not thrown');
+    }
 }

Original file line number	Diff line number	Diff line change
`@@ -22,11 +22,22 @@ public function __construct(`
`22`	`22`	`public readonly ?array $env = null,`
`23`	`23`	`public readonly mixed $input = null,`
`24`	`24`	`public readonly ?float $timeout = 60.0,`
	`25`	`+ public readonly ?string $commandLine = null,`
`25`	`26`	`) {`
`26`	`27`	`}`
`27`	`28`
`28`	`29`	`public function __toString(): string`
`29`	`30`	`{`
`30`		`- return implode(' ', $this->command);`
	`31`	`+ return $this->commandLine ?? implode(' ', $this->command);`
	`32`	`+ }`
	`33`	`+`
	`34`	`+ /**`
	`35`	`+ * Create a process message instance that will instantiate a Process using the fromShellCommandline method.`
	`36`	`+ *`
	`37`	`+ * @see Process::fromShellCommandline`
	`38`	`+ */`
	`39`	`+ public static function fromShellCommandline(string $command, ?string $cwd = null, ?array $env = null, mixed $input = null, ?float $timeout = 60): static`
	`40`	`+ {`
	`41`	`+ return new static([], $cwd, $env, $input, $timeout, $command);`
`31`	`42`	`}`
`32`	`43`	`}`
Original file line number	Diff line number	Diff line change
`@@ -22,7 +22,10 @@ final class RunProcessMessageHandler`
`22`	`22`	`{`
`23`	`23`	`public function __invoke(RunProcessMessage $message): RunProcessContext`
`24`	`24`	`{`
`25`		`- $process = new Process($message->command, $message->cwd, $message->env, $message->input, $message->timeout);`
	`25`	`+ match ($message->commandLine) {`
	`26`	`+ null => $process = new Process($message->command, $message->cwd, $message->env, $message->input, $message->timeout),`
	`27`	`+ default => $process = Process::fromShellCommandline($message->commandLine, $message->cwd, $message->env, $message->input, $message->timeout),`
	`28`	`+ };`
`26`	`29`
`27`	`30`	`try {`
`28`	`31`	`return new RunProcessContext($message, $process->mustRun());`