[Process] add RunProcessMessage and RunProcessMessageHandler

kbond · kbond · commit 7077601103f5 · 2023-07-28T08:14:27.000-04:00
diff --git a/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php b/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php
@@ -129,6 +129,7 @@
 use Symfony\Component\Notifier\Recipient\Recipient;
 use Symfony\Component\Notifier\TexterInterface;
 use Symfony\Component\Notifier\Transport\TransportFactoryInterface as NotifierTransportFactoryInterface;
+use Symfony\Component\Process\Messenger\RunProcessMessageHandler;
 use Symfony\Component\PropertyAccess\PropertyAccessor;
 use Symfony\Component\PropertyInfo\Extractor\PhpDocExtractor;
 use Symfony\Component\PropertyInfo\Extractor\PhpStanExtractor;
@@ -240,6 +241,12 @@ public function load(array $configs, ContainerBuilder $container)
 
         $container->registerAliasForArgument('parameter_bag', PsrContainerInterface::class);
 
+        $loader->load('process.php');
+
+        if (!class_exists(RunProcessMessageHandler::class)) {
+            $container->removeDefinition('process.messenger.process_message_handler');
+        }
+
         if ($this->hasConsole()) {
             $loader->load('console.php');
 
diff --git a/src/Symfony/Bundle/FrameworkBundle/Resources/config/process.php b/src/Symfony/Bundle/FrameworkBundle/Resources/config/process.php
@@ -0,0 +1,22 @@
+<?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\DependencyInjection\Loader\Configurator;
+
+use Symfony\Component\Process\Messenger\RunProcessMessageHandler;
+
+return static function (ContainerConfigurator $container) {
+    $container
+        ->services()
+            ->set('process.messenger.process_message_handler', RunProcessMessageHandler::class)
+                ->tag('messenger.message_handler')
+    ;
+};
diff --git a/src/Symfony/Component/Process/CHANGELOG.md b/src/Symfony/Component/Process/CHANGELOG.md
@@ -1,6 +1,11 @@
 CHANGELOG
 =========
 
+6.4
+---
+
+ * Add `RunProcessMessage` and `RunProcessMessageHandler`
+
 5.2.0
 -----
 
diff --git a/src/Symfony/Component/Process/Messenger/RunProcessMessage.php b/src/Symfony/Component/Process/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.
+ */
+
+namespace Symfony\Component\Process\Messenger;
+
+/**
+ * @author Kevin Bond <kevinbond@gmail.com>
+ */
+final class RunProcessMessage implements \Stringable
+{
+    public function __construct(
+        public readonly string $command,
+        public readonly ?string $cwd = null,
+        public readonly ?array $env = null,
+        public readonly mixed $input = null,
+        public readonly ?float $timeout = 60,
+    ) {
+    }
+
+    public function __toString(): string
+    {
+        return $this->command;
+    }
+}
diff --git a/src/Symfony/Component/Process/Messenger/RunProcessMessageHandler.php b/src/Symfony/Component/Process/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.
+ */
+
+namespace Symfony\Component\Process\Messenger;
+
+use Symfony\Component\Process\Process;
+
+/**
+ * @author Kevin Bond <kevinbond@gmail.com>
+ */
+final class RunProcessMessageHandler
+{
+    public function __invoke(RunProcessMessage $message): Process
+    {
+        $process = Process::fromShellCommandline(
+            $message->command,
+            $message->cwd,
+            $message->env,
+            $message->input,
+            $message->timeout,
+        );
+
+        return $process->mustRun();
+    }
+}
diff --git a/src/Symfony/Component/Process/Tests/Messenger/RunProcessMessageHandlerTest.php b/src/Symfony/Component/Process/Tests/Messenger/RunProcessMessageHandlerTest.php
@@ -0,0 +1,27 @@
+<?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\Tests\Messenger;
+
+use PHPUnit\Framework\TestCase;
+use Symfony\Component\Process\Messenger\RunProcessMessage;
+use Symfony\Component\Process\Messenger\RunProcessMessageHandler;
+
+class RunProcessMessageHandlerTest extends TestCase
+{
+    public function testCanExecuteProcess()
+    {
+        $process = (new RunProcessMessageHandler())(new RunProcessMessage('ls', cwd: __DIR__));
+
+        $this->assertTrue($process->isSuccessful());
+        $this->assertStringContainsString(basename(__FILE__), $process->getOutput());
+    }
+}
