[Console] Make sure signals registered by SignalableCommandInterface commands are defined in the PCNTL extension

alexandre-daubois · alexandre-daubois · commit 3da83d01206f · 2023-03-27T15:58:40.000+02:00
diff --git a/src/Symfony/Component/Console/Application.php b/src/Symfony/Component/Console/Application.php
@@ -28,6 +28,7 @@
 use Symfony\Component\Console\Event\ConsoleTerminateEvent;
 use Symfony\Component\Console\Exception\CommandNotFoundException;
 use Symfony\Component\Console\Exception\ExceptionInterface;
+use Symfony\Component\Console\Exception\InvalidArgumentException;
 use Symfony\Component\Console\Exception\LogicException;
 use Symfony\Component\Console\Exception\NamespaceNotFoundException;
 use Symfony\Component\Console\Exception\RuntimeException;
@@ -1006,6 +1007,12 @@ protected function doRunCommand(Command $command, InputInterface $input, OutputI
                 throw new RuntimeException('Unable to subscribe to signal events. Make sure that the `pcntl` extension is installed and that "pcntl_*" functions are not disabled by your php.ini\'s "disable_functions" directive.');
             }
 
+            foreach (array_merge($commandSignals, $this->signalsToDispatchEvent) as $signal) {
+                if (!SignalRegistry::isValidSignal($signal)) {
+                    throw new InvalidArgumentException(sprintf('Signal "%d" is not valid, make sure to use one of the "SIG*" constants as defined by the "pcntl" extension.', $signal));
+                }
+            }
+
             if (Terminal::hasSttyAvailable()) {
                 $sttyMode = shell_exec('stty -g');
 
diff --git a/src/Symfony/Component/Console/SignalRegistry/SignalRegistry.php b/src/Symfony/Component/Console/SignalRegistry/SignalRegistry.php
@@ -15,6 +15,8 @@ final class SignalRegistry
 {
     private array $signalHandlers = [];
 
+    private static array $availableSignals;
+
     public function __construct()
     {
         if (\function_exists('pcntl_async_signals')) {
@@ -42,6 +44,13 @@ public static function isSupported(): bool
         return \function_exists('pcntl_signal');
     }
 
+    public static function isValidSignal(int $signal): bool
+    {
+        static::$availableSignals ??= get_defined_constants(true)['pcntl'] ?? [];
+
+        return $signal < 32 && \in_array($signal, static::$availableSignals, true);
+    }
+
     /**
      * @internal
      */
diff --git a/src/Symfony/Component/Console/Tests/ApplicationTest.php b/src/Symfony/Component/Console/Tests/ApplicationTest.php
@@ -27,6 +27,7 @@
 use Symfony\Component\Console\Event\ConsoleSignalEvent;
 use Symfony\Component\Console\Event\ConsoleTerminateEvent;
 use Symfony\Component\Console\Exception\CommandNotFoundException;
+use Symfony\Component\Console\Exception\InvalidArgumentException;
 use Symfony\Component\Console\Exception\NamespaceNotFoundException;
 use Symfony\Component\Console\Helper\FormatterHelper;
 use Symfony\Component\Console\Helper\HelperSet;
@@ -2137,6 +2138,37 @@ public function testSignalableWithEventCommandDoesNotInterruptedOnTermSignals()
         $this->assertSame($expected, $tester->getDisplay(true));
     }
 
+    /**
+     * @requires extension pcntl
+     */
+    public function testSignalIsNotAvailableInPcntlExtension()
+    {
+        $this->expectException(InvalidArgumentException::class);
+        $this->expectExceptionMessage('Signal "40" is not valid, make sure to use one of the "SIG*" constants as defined by the "pcntl" extension.');
+
+        $command = new InvalidSignalableCommand();
+        $application = $this->createSignalableApplication($command, null);
+        $application->setCatchExceptions(false);
+
+        $application->run(new ArrayInput(['signal']));
+    }
+
+    /**
+     * @requires extension pcntl
+     */
+    public function testSignalToDispatchIsNotAvailableInPcntlExtension()
+    {
+        $this->expectException(InvalidArgumentException::class);
+        $this->expectExceptionMessage('Signal "40" is not valid, make sure to use one of the "SIG*" constants as defined by the "pcntl" extension.');
+
+        $command = new SignableCommand();
+        $application = $this->createSignalableApplication($command, null);
+        $application->setSignalsToDispatchEvent(40);
+        $application->setCatchExceptions(false);
+
+        $application->run(new ArrayInput(['signal']));
+    }
+
     /**
      * @group tty
      */
@@ -2283,6 +2315,23 @@ public function handleSignal(int $signal, int|false $previousExitCode = 0): int|
     }
 }
 
+#[AsCommand(name: 'signal')]
+class InvalidSignalableCommand extends BaseSignableCommand implements SignalableCommandInterface
+{
+    public function getSubscribedSignals(): array
+    {
+        return [40];
+    }
+
+    public function handleSignal(int $signal, int|false $previousExitCode = 0): int|false
+    {
+        $this->signaled = true;
+        $this->signalHandlers[] = __CLASS__;
+
+        return false;
+    }
+}
+
 #[AsCommand(name: 'signal')]
 class TerminatableCommand extends BaseSignableCommand implements SignalableCommandInterface
 {
diff --git a/src/Symfony/Component/Console/Tests/SignalRegistry/SignalRegistryTest.php b/src/Symfony/Component/Console/Tests/SignalRegistry/SignalRegistryTest.php
@@ -131,4 +131,19 @@ public function testTwoCallbacksForASignalPreviousCallbackFromAnotherRegistry()
         $this->assertTrue($isHandled1);
         $this->assertTrue($isHandled2);
     }
+
+    public function testIsValidSignalWithPcntlConstantButValueIsTooHigh()
+    {
+        $this->assertFalse(SignalRegistry::isValidSignal(\PCNTL_ENAMETOOLONG));
+    }
+
+    public function testIsValidSignalWithInvalidSignalCode()
+    {
+        $this->assertFalse(SignalRegistry::isValidSignal(-12));
+    }
+
+    public function testIsValidSignal()
+    {
+        $this->assertTrue(SignalRegistry::isValidSignal(\SIGINT));
+    }
 }
