Add global timeout

Author: steevanb

changelog.md

@@ -3,6 +3,7 @@
 - [#227](https://github.com/steevanb/php-parallel-processes/issues/227) Fix TearDownProcess who never start in some cases
 - [#226](https://github.com/steevanb/php-parallel-processes/issues/226) Add compatibility with Symfony 6.3
 - [#228](https://github.com/steevanb/php-parallel-processes/issues/228) Execute phpstan for each Symfony version
+- [#224](https://github.com/steevanb/php-parallel-processes/issues/224) Add global timeout with ParallelProcessesApplication::setTimeout()
 
 ### [0.11.0](../../compare/0.10.0...0.11.0) - 2023-04-05
 

src/Console/Application/ParallelProcessesApplication.php

@@ -36,6 +36,13 @@ class ParallelProcessesApplication extends SingleCommandApplication implements S
 
     protected bool $canceled = false;
 
+    /** Timeout in seconds, null for no timeout */
+    protected ?int $timeout = null;
+
+    protected ?int $startTime = null;
+
+    protected ?int $exitCode = null;
+
     public function __construct(string $name = null)
     {
         parent::__construct($name);
@@ -80,6 +87,18 @@ public function getProcesses(): ProcessInterfaceArray
         return $this->processes;
     }
 
+    public function setTimeout(?int $timeout): static
+    {
+        $this->timeout = $timeout;
+
+        return $this;
+    }
+
+    public function getTimeout(): ?int
+    {
+        return $this->timeout;
+    }
+
     public function setTheme(ThemeInterface $theme): static
     {
         $this->theme = $theme;
@@ -177,6 +196,8 @@ protected function isCanceled(): bool
 
     protected function runProcessesInParallel(InputInterface $input, OutputInterface $output): int
     {
+        $this->startTime = time();
+
         $this
             ->defineThemeFromInput($input)
             ->defineRefreshIntervalFromInput($input);
@@ -309,6 +330,11 @@ protected function waitProcessesTermination(OutputInterface $output): static
                 break;
             }
 
+            if (is_int($this->getTimeout()) && $this->getStartTime() + $this->getTimeout() < time()) {
+                $this->setExitCode(static::FAILURE);
+                $this->handleSignal(SIGINT);
+            }
+
             $terminated = 0;
 
             $this
@@ -365,8 +391,19 @@ protected function startReadyProcesses(): static
         return $this;
     }
 
+    protected function setExitCode(?int $exitCode): static
+    {
+        $this->exitCode = $exitCode;
+
+        return $this;
+    }
+
     protected function getExitCode(): int
     {
+        if (is_int($this->exitCode)) {
+            return $this->exitCode;
+        }
+
         $return = static::SUCCESS;
 
         foreach ($this->getProcesses()->toArray() as $process) {
@@ -393,4 +430,13 @@ protected function createDefaultOutput(): OutputInterface
     {
         return new ConsoleBufferedOutput();
     }
+
+    protected function getStartTime(): int
+    {
+        if (is_int($this->startTime) === false) {
+            throw new ParallelProcessException('Call ' . static::class . '::run() before getStartTime().');
+        }
+
+        return $this->startTime;
+    }
 }

tests/Console/Application/ParallelProcessesApplication/ConstructorTest.php

@@ -21,5 +21,6 @@ public function testSetTheme(): void
         static::assertInstanceOf(DefaultTheme::class, $application->getTheme());
         static::assertSame(10000, $application->getRefreshInterval());
         static::assertNull($application->getMaximumParallelProcesses());
+        static::assertNull($application->getTimeout());
     }
 }

tests/Console/Application/ParallelProcessesApplication/TimeoutTest.php

@@ -0,0 +1,51 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Steevanb\ParallelProcess\Tests\Console\Application\ParallelProcessesApplication;
+
+use PHPUnit\Framework\TestCase;
+use Steevanb\ParallelProcess\{
+    Console\Application\ParallelProcessesApplication,
+    Process\Process,
+};
+use Symfony\Component\Console\{
+    Input\ArrayInput,
+    Output\NullOutput
+};
+
+final class TimeoutTest extends TestCase
+{
+    /**
+     * @covers \Steevanb\ParallelProcess\Console\Application\ParallelProcessesApplication::setTimeout
+     * @covers \Steevanb\ParallelProcess\Console\Application\ParallelProcessesApplication::getTimeout
+     */
+    public function testAccessors(): void
+    {
+        $application = (new ParallelProcessesApplication())
+            ->setTimeout(10);
+
+        static::assertSame(10, $application->getTimeout());
+    }
+
+    /**
+     * @covers \Steevanb\ParallelProcess\Console\Application\ParallelProcessesApplication::setTimeout
+     * @covers \Steevanb\ParallelProcess\Console\Application\ParallelProcessesApplication::waitProcessesTermination
+     */
+    public function testTimeout(): void
+    {
+        $process = new Process(['sleep', '10'], dirname(__DIR__, 4));
+
+        $time = time();
+
+        $exitCode = (new ParallelProcessesApplication())
+            ->setTimeout(1)
+            ->setAutoExit(false)
+            ->addProcess($process)
+            ->run(new ArrayInput([]), new NullOutput());
+
+        static::assertSame(1, $exitCode);
+        static::assertTrue(time() >= $time + 1);
+        static::assertTrue(time() <= $time + 2);
+    }
+}