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

alexandre-daubois · alexandre-daubois · commit 79bb9bd53a94 · 2023-03-26T20:08:32.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 with code %d is not valid, make sure to use a signal defined in the `pcntl` extension by using a SIG* predefined constant.', $signal));
+                }
+            }
+
             if (Terminal::hasSttyAvailable()) {
                 $sttyMode = shell_exec('stty -g');
 
diff --git a/src/Symfony/Component/Console/CHANGELOG.md b/src/Symfony/Component/Console/CHANGELOG.md
@@ -7,6 +7,7 @@ CHANGELOG
  * Add support for choosing exit code while handling signal, or to not exit at all
  * Add `ProgressBar::setPlaceholderFormatter` to set a placeholder attached to a instance, instead of being global.
  * Add `ReStructuredTextDescriptor`
+ * Make sure signals registered by `SignalableCommandInterface` commands are defined in the PCNTL extension
 
 6.2
 ---
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 = null;
+
     public function __construct()
     {
         if (\function_exists('pcntl_async_signals')) {
@@ -42,6 +44,15 @@ public static function isSupported(): bool
         return \function_exists('pcntl_signal');
     }
 
+    public static function isValidSignal(int $signal): bool
+    {
+        if (null === static::$availableSignals) {
+            static::$availableSignals = get_defined_constants(true)['pcntl'];
+        }
+
+        return \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 with code 40 is not valid, make sure to use a signal defined in the `pcntl` extension by using a SIG* predefined constant.');
+
+        $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 with code 40 is not valid, make sure to use a signal defined in the `pcntl` extension by using a SIG* predefined constant.');
+
+        $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
 {
