[Messenger][Process] add RunProcessMessage and RunProcessMessageHandler

Author: kbond

CHANGELOG.md

@@ -1,6 +1,11 @@
 CHANGELOG
 =========
 
+6.4
+---
+
+* Add `RunProcessMessage` and `RunProcessMessageHandler`
+
 5.2.0
 -----
 

Exception/RunProcessFailedException.php

@@ -0,0 +1,25 @@
+<?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.
+ */
+
+namespaceSymfony\Component\Process\Exception;
+
+useSymfony\Component\Process\Messenger\RunProcessContext;
+
+/**
+ * @author Kevin Bond <kevinbond@gmail.com>
+ */
+finalclass RunProcessFailedException extends RuntimeException
+{
+publicfunction__construct(ProcessFailedException$exception, publicreadonlyRunProcessContext$context)
+ {
+parent::__construct($exception->getMessage(), $exception->getCode());
+ }
+}

Messenger/RunProcessContext.php

@@ -0,0 +1,33 @@
+<?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.
+ */
+
+namespaceSymfony\Component\Process\Messenger;
+
+useSymfony\Component\Process\Process;
+
+/**
+ * @author Kevin Bond <kevinbond@gmail.com>
+ */
+finalclass RunProcessContext extends RunProcessMessage
+{
+publicreadonly ?int$exitCode;
+publicreadonly ?string$output;
+publicreadonly ?string$errorOutput;
+
+publicfunction__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();
+ }
+}

Messenger/RunProcessMessage.php

@@ -0,0 +1,32 @@
+<?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.
+ */
+
+namespaceSymfony\Component\Process\Messenger;
+
+/**
+ * @author Kevin Bond <kevinbond@gmail.com>
+ */
+class RunProcessMessage implements \Stringable
+{
+publicfunction__construct(
+publicreadonlyarray$command,
+publicreadonly ?string$cwd = null,
+publicreadonly ?array$env = null,
+publicreadonlymixed$input = null,
+publicreadonly ?float$timeout = 60.0,
+ ) {
+ }
+
+publicfunction__toString(): string
+ {
+return\implode('', $this->command);
+ }
+}

Messenger/RunProcessMessageHandler.php

@@ -0,0 +1,33 @@
+<?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.
+ */
+
+namespaceSymfony\Component\Process\Messenger;
+
+useSymfony\Component\Process\Exception\ProcessFailedException;
+useSymfony\Component\Process\Exception\RunProcessFailedException;
+useSymfony\Component\Process\Process;
+
+/**
+ * @author Kevin Bond <kevinbond@gmail.com>
+ */
+finalclass RunProcessMessageHandler
+{
+publicfunction__invoke(RunProcessMessage$message): RunProcessContext
+ {
+$process = newProcess($message->command, $message->cwd, $message->env, $message->input, $message->timeout);
+
+try {
+returnnewRunProcessContext($message, $process->mustRun());
+ } catch (ProcessFailedException$e) {
+thrownewRunProcessFailedException($e, newRunProcessContext($message, $e->getProcess()));
+ }
+ }
+}

Tests/Messenger/RunProcessMessageHandlerTest.php

@@ -0,0 +1,43 @@
+<?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.
+ */
+
+namespaceSymfony\Component\Process\Tests\Messenger;
+
+usePHPUnit\Framework\TestCase;
+useSymfony\Component\Process\Exception\RunProcessFailedException;
+useSymfony\Component\Process\Messenger\RunProcessMessage;
+useSymfony\Component\Process\Messenger\RunProcessMessageHandler;
+
+class RunProcessMessageHandlerTest extends TestCase
+{
+publicfunctiontestRunSuccessfulProcess()
+ {
+$context = (newRunProcessMessageHandler())(newRunProcessMessage(['ls'], cwd: __DIR__));
+
+$this->assertSame(['ls'], $context->command);
+$this->assertSame(0, $context->exitCode);
+$this->assertStringContainsString(basename(__FILE__), $context->output);
+ }
+
+publicfunctiontestRunFailedProcess()
+ {
+try {
+ (newRunProcessMessageHandler())(newRunProcessMessage(['invalid']));
+ } catch (RunProcessFailedException$e) {
+$this->assertSame(['invalid'], $e->context->command);
+$this->assertSame(127, $e->context->exitCode);
+
+return;
+ }
+
+$this->fail('Exception not thrown');
+ }
+}