[10.x] Minor fixes on the process module (#46033)

* Applies minor fixes on process module

* Removes non-used class

* Improves testing

* Apply fixes from StyleCI

---------

Co-authored-by: StyleCI Bot <[email protected]>

Author: nunomaduro

src/Illuminate/Console/Process/Factory.php

@@ -123,7 +123,7 @@ public function isRecording()
     /**
      * Record the given process if processes should be recorded.
      *
-     * @param  \Illuminate\Console\Process\PendignProcess  $process
+     * @param  \Illuminate\Console\Process\PendingProcess  $process
      * @param  \Illuminate\Contracts\Console\Process\ProcessResult  $result
      * @return $this
      */
@@ -139,7 +139,7 @@ public function recordIfRecording(PendingProcess $process, ProcessResultContract
     /**
      * Record the given process.
      *
-     * @param  \Illuminate\Console\Process\PendignProcess  $process
+     * @param  \Illuminate\Console\Process\PendingProcess  $process
      * @param  \Illuminate\Contracts\Console\Process\ProcessResult  $result
      * @return $this
      */

src/Illuminate/Console/Process/FakeInvokedProcess.php

@@ -31,14 +31,14 @@ class FakeInvokedProcess implements InvokedProcessContract
     /**
      * The number of times the process should indicate that it is "running".
      *
-     * @var int
+     * @var int|null
      */
     protected $remainingRunIterations;
 
     /**
      * The general output handler callback.
      *
-     * @var null
+     * @var callable|null
      */
     protected $outputHandler;
 
@@ -135,7 +135,6 @@ public function running()
     /**
      * Invoke the asynchronous output handler with the next single line of output if necessary.
      *
-     * @param  callable  $until
      * @return array|false
      */
     protected function invokeOutputHandlerWithNextLineOfOutput()
@@ -258,7 +257,7 @@ public function latestErrorOutput()
      * Wait for the process to finish.
      *
      * @param  callable|null  $output
-     * @return \Illuminate\Console\Process\ProcessResult
+     * @return \Illuminate\Contracts\Console\Process\ProcessResult
      */
     public function wait(callable $output = null)
     {

src/Illuminate/Console/Process/FakeProcessResult.php

@@ -4,7 +4,6 @@
 
 use Illuminate\Console\Process\Exceptions\ProcessFailedException;
 use Illuminate\Contracts\Console\Process\ProcessResult as ProcessResultContract;
-use Symfony\Component\Process\Process;
 
 class FakeProcessResult implements ProcessResultContract
 {

src/Illuminate/Console/Process/PendingProcess.php

@@ -3,6 +3,7 @@
 namespace Illuminate\Console\Process;
 
 use Closure;
+use Illuminate\Console\Process\Exceptions\ProcessTimedOutException;
 use Illuminate\Support\Str;
 use LogicException;
 use RuntimeException;
@@ -28,7 +29,7 @@ class PendingProcess
     /**
      * The working directory of the process.
      *
-     * @var string
+     * @var string|null
      */
     public $path;
 
@@ -56,7 +57,7 @@ class PendingProcess
     /**
      * Indicates whether output should be disabled for the process.
      *
-     * @var array
+     * @var bool
      */
     public $quietly = false;
 
@@ -160,6 +161,7 @@ public function forever()
      * Set the additional environent variables for the process.
      *
      * @param  array  $environment
+     * @return $this
      */
     public function env(array $environment)
     {
@@ -225,7 +227,7 @@ public function run(array|string $command = null, callable $output = null)
                     $this->factory->recordIfRecording($this, $result);
                 });
             } elseif ($this->factory->isRecording() && $this->factory->preventingStrayProcesses()) {
-                throw new RuntimeException('Attempted process ['.(string) $this->command.'] without a matching fake.');
+                throw new RuntimeException('Attempted process ['.$command.'] without a matching fake.');
             }
 
             return new ProcessResult(tap($process)->run($output));
@@ -252,7 +254,7 @@ public function start(array|string $command = null, callable $output = null)
                 $this->factory->recordIfRecording($this, $process->predictProcessResult());
             });
         } elseif ($this->factory->isRecording() && $this->factory->preventingStrayProcesses()) {
-            throw new RuntimeException('Attempted process ['.(string) $this->command.'] without a matching fake.');
+            throw new RuntimeException('Attempted process ['.$command.'] without a matching fake.');
         }
 
         return new InvokedProcess(tap($process)->start($output));

src/Illuminate/Console/Process/Pool.php

@@ -4,6 +4,10 @@
 
 use InvalidArgumentException;
 
+/**
+ * @mixin \Illuminate\Console\Process\Factory
+ * @mixin \Illuminate\Console\Process\PendingProcess
+ */
 class Pool
 {
     /**

src/Illuminate/Console/Process/ProcessResult.php

@@ -59,7 +59,7 @@ public function failed()
     /**
      * Get the exit code of the process.
      *
-     * @return int
+     * @return int|null
      */
     public function exitCode()
     {

src/Illuminate/Contracts/Console/Process/ProcessResult.php

@@ -28,7 +28,7 @@ public function failed();
     /**
      * Get the exit code of the process.
      *
-     * @return int
+     * @return int|null
      */
     public function exitCode();
 

src/Illuminate/Support/Facades/Process.php

@@ -6,6 +6,18 @@
 use Illuminate\Console\Process\Factory;
 
 /**
+ * @method static \Illuminate\Console\Process\PendingProcess command(array|string $command)
+ * @method static \Illuminate\Console\Process\PendingProcess path(string $path)
+ * @method static \Illuminate\Console\Process\PendingProcess timeout(int $timeout)
+ * @method static \Illuminate\Console\Process\PendingProcess idleTimeout(int $timeout)
+ * @method static \Illuminate\Console\Process\PendingProcess forever()
+ * @method static \Illuminate\Console\Process\PendingProcess env(array $environment)
+ * @method static \Illuminate\Console\Process\PendingProcess quietly()
+ * @method static \Illuminate\Console\Process\PendingProcess tty(bool $tty = true)
+ * @method static \Illuminate\Console\Process\PendingProcess options(array $options)
+ * @method static \Illuminate\Contracts\Console\Process\ProcessResult run(array|string|null $command = null, callable|null $output = null)
+ * @method static \Illuminate\Console\Process\InvokedProcess start(array|string|null $command = null, callable $output = null)
+ * @method static \Illuminate\Console\Process\PendingProcess withFakeHandlers(array $fakeHandlers)
  * @method static \Illuminate\Console\Process\FakeProcessResult result(array|string $output = '', array|string $errorOutput = '', int $exitCode = 0)
  * @method static \Illuminate\Console\Process\FakeProcessDescription describe()
  * @method static \Illuminate\Console\Process\FakeProcessSequence sequence(array $processes = [])
@@ -28,6 +40,7 @@
  * @method static void flushMacros()
  * @method static mixed macroCall(string $method, array $parameters)
  *
+ * @see \Illuminate\Console\Process\PendingProcess
  * @see \Illuminate\Console\Process\Factory
  */
 class Process extends Facade

tests/Console/ProcessTest.php

@@ -3,6 +3,7 @@
 namespace Illuminate\Tests;
 
 use Illuminate\Console\Process\Exceptions\ProcessFailedException;
+use Illuminate\Console\Process\Exceptions\ProcessTimedOutException;
 use Illuminate\Console\Process\Factory;
 use Illuminate\Contracts\Console\Process\ProcessResult;
 use Mockery as m;
@@ -311,10 +312,12 @@ public function testProcessFakeSequencesCanThrowWhenSequenceIsEmpty()
         $result = $factory->run('ls -la');
     }
 
-    public function testStrayProcessesCanBePrevented()
+    public function testStrayProcessesCanBePreventedWithStringComand()
     {
         $this->expectException(RuntimeException::class);
-        $this->expectExceptionMessage('Attempted process');
+        $this->expectExceptionMessage('Attempted process [');
+        $this->expectExceptionMessage('cat composer.json');
+        $this->expectExceptionMessage('] without a matching fake.');
 
         $factory = new Factory;
 
@@ -327,6 +330,24 @@ public function testStrayProcessesCanBePrevented()
         $result = $factory->run('cat composer.json');
     }
 
+    public function testStrayProcessesCanBePreventedWithArrayCommand()
+    {
+        $this->expectException(RuntimeException::class);
+        $this->expectExceptionMessage('Attempted process [');
+        $this->expectExceptionMessage('cat composer.json');
+        $this->expectExceptionMessage('] without a matching fake.');
+
+        $factory = new Factory;
+
+        $factory->preventStrayProcesses();
+
+        $factory->fake([
+            'ls *' => 'ls command',
+        ]);
+
+        $result = $factory->run(['cat composer.json']);
+    }
+
     public function testStrayProcessesActuallyRunByDefault()
     {
         $factory = new Factory;
@@ -396,13 +417,31 @@ public function testRealProcessesCanThrow()
         }
 
         $this->expectException(ProcessFailedException::class);
+        $this->expectExceptionMessage('The process "echo "Hello World" >&2; exit 1;" failed.');
 
         $factory = new Factory;
         $result = $factory->path(__DIR__)->run('echo "Hello World" >&2; exit 1;');
 
         $result->throw();
     }
 
+    public function testRealProcessesCanTimeout()
+    {
+        if (windows_os()) {
+            $this->markTestSkipped('Requires Linux.');
+        }
+
+        $this->expectException(ProcessTimedOutException::class);
+        $this->expectExceptionMessage(
+            'The process "sleep 2; exit 1;" exceeded the timeout of 1 seconds.'
+        );
+
+        $factory = new Factory;
+        $result = $factory->timeout(1)->path(__DIR__)->run('sleep 2; exit 1;');
+
+        $result->throw();
+    }
+
     public function testRealProcessesCanThrowIfTrue()
     {
         if (windows_os()) {