[Process] add RunProcessContext and RunProcessFailedException

kbond · kbond · commit 6cdc5e22852e · 2023-07-28T08:28:43.000-04:00
diff --git a/src/Symfony/Component/Process/Messenger/RunProcessContext.php b/src/Symfony/Component/Process/Messenger/RunProcessContext.php
@@ -0,0 +1,34 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Process\Messenger;
+
+use Symfony\Component\Process\Process;
+
+/**
+ * @author Kevin Bond <kevinbond@gmail.com>
+ */
+final class RunProcessContext extends RunProcessMessage
+{
+    public readonly ?int $exitCode;
+    public readonly ?string $output;
+    public readonly ?string $errorOutput;
+
+    public function __construct(RunProcessMessage $message, Process $process)
+    {
+        parent::__construct($message->command, $message->cwd, $message->env, $message->input, $message->timeout);
+
+        $this->exitCode = $process->getExitCode();
+        $this->output = $process->isOutputDisabled() ? null : $process->getOutput();
+        $this->errorOutput = $process->isOutputDisabled() ? null : $process->getErrorOutput();
+    }
+
+}
diff --git a/src/Symfony/Component/Process/Messenger/RunProcessFailedException.php b/src/Symfony/Component/Process/Messenger/RunProcessFailedException.php
@@ -0,0 +1,26 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Process\Messenger;
+
+use Symfony\Component\Process\Exception\ProcessFailedException;
+use Symfony\Component\Process\Exception\RuntimeException;
+
+/**
+ * @author Kevin Bond <kevinbond@gmail.com>
+ */
+final class RunProcessFailedException extends RuntimeException
+{
+    public function __construct(ProcessFailedException $exception, public readonly RunProcessContext $context)
+    {
+        parent::__construct($exception->getMessage(), $exception->getCode());
+    }
+}
diff --git a/src/Symfony/Component/Process/Messenger/RunProcessMessage.php b/src/Symfony/Component/Process/Messenger/RunProcessMessage.php
@@ -14,7 +14,7 @@
 /**
  * @author Kevin Bond <kevinbond@gmail.com>
  */
-final class RunProcessMessage implements \Stringable
+class RunProcessMessage implements \Stringable
 {
     public function __construct(
         public readonly string $command,
diff --git a/src/Symfony/Component/Process/Messenger/RunProcessMessageHandler.php b/src/Symfony/Component/Process/Messenger/RunProcessMessageHandler.php
@@ -11,14 +11,15 @@
 
 namespace Symfony\Component\Process\Messenger;
 
+use Symfony\Component\Process\Exception\ProcessFailedException;
 use Symfony\Component\Process\Process;
 
 /**
  * @author Kevin Bond <kevinbond@gmail.com>
  */
 final class RunProcessMessageHandler
 {
-    public function __invoke(RunProcessMessage $message): Process
+    public function __invoke(RunProcessMessage $message): RunProcessContext
     {
         $process = Process::fromShellCommandline(
             $message->command,
@@ -28,6 +29,10 @@ public function __invoke(RunProcessMessage $message): Process
             $message->timeout,
         );
 
-        return $process->mustRun();
+        try {
+            return new RunProcessContext($message, $process->mustRun());
+        } catch (ProcessFailedException $e) {
+            throw new RunProcessFailedException($e, new RunProcessContext($message, $e->getProcess()));
+        }
     }
 }
diff --git a/src/Symfony/Component/Process/Tests/Messenger/RunProcessMessageHandlerTest.php b/src/Symfony/Component/Process/Tests/Messenger/RunProcessMessageHandlerTest.php
@@ -12,16 +12,32 @@
 namespace Symfony\Component\Process\Tests\Messenger;
 
 use PHPUnit\Framework\TestCase;
+use Symfony\Component\Process\Messenger\RunProcessFailedException;
 use Symfony\Component\Process\Messenger\RunProcessMessage;
 use Symfony\Component\Process\Messenger\RunProcessMessageHandler;
 
 class RunProcessMessageHandlerTest extends TestCase
 {
-    public function testCanExecuteProcess()
+    public function testRunSuccessfulProcess()
     {
-        $process = (new RunProcessMessageHandler())(new RunProcessMessage('ls', cwd: __DIR__));
+        $context = (new RunProcessMessageHandler())(new RunProcessMessage('ls', cwd: __DIR__));
 
-        $this->assertTrue($process->isSuccessful());
-        $this->assertStringContainsString(basename(__FILE__), $process->getOutput());
+        $this->assertSame('ls', $context->command);
+        $this->assertSame(0, $context->exitCode);
+        $this->assertStringContainsString(basename(__FILE__), $context->output);
+    }
+
+    public function testRunFailedProcess()
+    {
+        try {
+            (new RunProcessMessageHandler())(new RunProcessMessage('invalid'));
+        } catch (RunProcessFailedException $e) {
+            $this->assertSame('invalid', $e->context->command);
+            $this->assertSame(127, $e->context->exitCode);
+
+            return;
+        }
+
+        $this->fail('Exception not thrown');
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -14,7 +14,7 @@`
`14`	`14`	`/**`
`15`	`15`	`* @author Kevin Bond <kevinbond@gmail.com>`
`16`	`16`	`*/`
`17`		`-final class RunProcessMessage implements \Stringable`
	`17`	`+class RunProcessMessage implements \Stringable`
`18`	`18`	`{`
`19`	`19`	`public function __construct(`
`20`	`20`	`public readonly string $command,`
Original file line number	Diff line number	Diff line change
`@@ -11,14 +11,15 @@`
`11`	`11`
`12`	`12`	`namespace Symfony\Component\Process\Messenger;`
`13`	`13`
	`14`	`+use Symfony\Component\Process\Exception\ProcessFailedException;`
`14`	`15`	`use Symfony\Component\Process\Process;`
`15`	`16`
`16`	`17`	`/**`
`17`	`18`	`* @author Kevin Bond <kevinbond@gmail.com>`
`18`	`19`	`*/`
`19`	`20`	`final class RunProcessMessageHandler`
`20`	`21`	`{`
`21`		`- public function __invoke(RunProcessMessage $message): Process`
	`22`	`+ public function __invoke(RunProcessMessage $message): RunProcessContext`
`22`	`23`	`{`
`23`	`24`	`$process = Process::fromShellCommandline(`
`24`	`25`	`$message->command,`
`@@ -28,6 +29,10 @@ public function __invoke(RunProcessMessage $message): Process`
`28`	`29`	`$message->timeout,`
`29`	`30`	`);`
`30`	`31`
`31`		`- return $process->mustRun();`
	`32`	`+ try {`
	`33`	`+ return new RunProcessContext($message, $process->mustRun());`
	`34`	`+ } catch (ProcessFailedException $e) {`
	`35`	`+ throw new RunProcessFailedException($e, new RunProcessContext($message, $e->getProcess()));`
	`36`	`+ }`
`32`	`37`	`}`
`33`	`38`	`}`