[10.x] Standard Input can be applied to PendingProcess (#46119)

* StdInput can be applied to PendingProcess * Change test * PHPdoc tags * clean up * added space for doc tag * Fix styles * formatting --------- Co-authored-by: Taylor Otwell <[email protected]>
laravel · Feb 15, 2023 · a518fde · a518fde
1 parent d327eb9
commit a518fde
Show file tree

Hide file tree

Showing 3 changed files with 37 additions and 0 deletions.
diff --git a/src/Illuminate/Process/PendingProcess.php b/src/Illuminate/Process/PendingProcess.php
@@ -54,6 +54,13 @@ class PendingProcess
      */
     public $environment = [];
 
+    /**
+     * The standard input data that should be piped into the command.
+     *
+     * @var string|int|float|bool|resource|\Traversable|null
+     */
+    public $input;
+
     /**
      * Indicates whether output should be disabled for the process.
      *
@@ -170,6 +177,19 @@ public function env(array $environment)
         return $this;
     }
 
+    /**
+     * Set the standard input that should be provided when invoking the process.
+     *
+     * @param  \Traversable|resource|string|int|float|bool|null  $input
+     * @return $this
+     */
+    public function input($input)
+    {
+        $this->input = $input;
+
+        return $this;
+    }
+
     /**
      * Disable output for the process.
      *
@@ -281,6 +301,10 @@ protected function toSymfonyProcess(array|string|null $command)
             $process->setIdleTimeout($this->idleTimeout);
         }
 
+        if ($this->input) {
+            $process->setInput($this->input);
+        }
+
         if ($this->quietly) {
             $process->disableOutput();
         }

diff --git a/src/Illuminate/Support/Facades/Process.php b/src/Illuminate/Support/Facades/Process.php
@@ -15,6 +15,7 @@
  * @method static \Illuminate\Process\PendingProcess quietly()
  * @method static \Illuminate\Process\PendingProcess tty(bool $tty = true)
  * @method static \Illuminate\Process\PendingProcess options(array $options)
+ * @method static \Illuminate\Process\PendingProcess input(\Traversable|resource|string|int|float|bool|null $input)
  * @method static \Illuminate\Contracts\Process\ProcessResult run(array|string|null $command = null, callable|null $output = null)
  * @method static \Illuminate\Process\InvokedProcess start(array|string|null $command = null, callable $output = null)
  * @method static \Illuminate\Process\PendingProcess withFakeHandlers(array $fakeHandlers)

diff --git a/tests/Process/ProcessTest.php b/tests/Process/ProcessTest.php
@@ -470,6 +470,18 @@ public function testRealProcessesDoesntThrowIfFalse()
         $this->assertTrue(true);
     }
 
+    public function testRealProcessesCanUseStandardInput()
+    {
+        if (windows_os()) {
+            $this->markTestSkipped('Requires Linux.');
+        }
+
+        $factory = new Factory();
+        $result = $factory->input('foobar')->run('cat');
+
+        $this->assertSame('foobar', $result->output());
+    }
+
     public function testFakeInvokedProcessOutputWithLatestOutput()
     {
         $factory = new Factory;