[Process] Add support for posix signals

romainneutron · romainneutron · commit df0a963dbd0e · 2012-08-31T03:38:00.000+02:00
diff --git a/src/Symfony/Component/Process/Exception/LogicException.php b/src/Symfony/Component/Process/Exception/LogicException.php
@@ -0,0 +1,21 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Process\Exception;
+
+/**
+ * LogicException for the Process Component.
+ *
+ * @author Romain Neutron <imprec@gmail.com>
+ */
+class LogicException extends \LogicException implements ExceptionInterface
+{
+}
diff --git a/src/Symfony/Component/Process/Process.php b/src/Symfony/Component/Process/Process.php
@@ -11,6 +11,9 @@
 
 namespace Symfony\Component\Process;
 
+use Symfony\Component\Process\Exception\LogicException;
+use Symfony\Component\Process\Exception\RuntimeException;
+
 /**
  * Process is a thin wrapper around proc_* functions to ease
  * start independent PHP processes.
@@ -361,7 +364,7 @@ public function wait($callback = null)
         }
         $this->updateStatus();
         if ($this->processInformation['signaled']) {
-            throw new \RuntimeException(sprintf('The process stopped because of a "%s" signal.', $this->processInformation['stopsig']));
+            throw new RuntimeException(sprintf('The process stopped because of a "%s" signal.', $this->processInformation['stopsig']));
         }
 
         $time = 0;
@@ -551,6 +554,33 @@ public function getPid()
         return $this->isRunning() ? $this->processInformation['pid'] : null;
     }
 
+    /**
+     * Send a posix signal to the process
+     *
+     * @param  integer $sig A valid posix signal (see http://www.php.net/manual/en/pcntl.constants.php)
+     * @return Process
+     *
+     * @throws LogicException   In case the process is not running
+     * @throws RuntimeException In case the environment does not support posix signals
+     * @throws RuntimeException In case of failure
+     */
+    public function sendSignal($sig)
+    {
+        if (!$this->isRunning()) {
+            throw new LogicException('Can not send signal on a non running process');
+        }
+
+        if (!extension_loaded('posix')) {
+            throw new RuntimeException('Posix extension is required to send signals');
+        }
+
+        if (true !== posix_kill($this->getPid(), $sig)) {
+            throw new RuntimeException(sprintf('Error while sending signal : %s', posix_strerror(posix_get_last_error())));
+        }
+
+        return $this;
+    }
+
     /**
      * Stops the process.
      *
diff --git a/src/Symfony/Component/Process/Tests/ProcessTest.php b/src/Symfony/Component/Process/Tests/ProcessTest.php
@@ -12,6 +12,7 @@
 namespace Symfony\Component\Process\Tests;
 
 use Symfony\Component\Process\Process;
+use Symfony\Component\Process\Exception\RuntimeException;
 
 /**
  * @author Robert Schönthal <seroscho@googlemail.com>
@@ -151,6 +152,43 @@ public function testGetPid()
         $this->assertNull($process->getPid());
     }
 
+    public function testSendSignal()
+    {
+        $process = new Process('php -r "sleep(1);');
+        $process->start();
+        $process->sendSignal(SIGCONT);
+        $process->stop();
+    }
+
+    /**
+     * @expectedException Symfony\Component\Process\Exception\RuntimeException
+     */
+    public function testSendKillSignal()
+    {
+        $process = new Process('php -r "sleep(1);');
+        $process->start();
+        $process->sendSignal(SIGKILL);
+        $process->wait();
+    }
+
+    public function testSendKillSignalAndCatch()
+    {
+        $process = new Process('php -r "sleep(1);');
+        $process->start();
+        $process->sendSignal(SIGKILL);
+
+        try {
+            $process->wait();
+            $this->fail('Should throw an exception as the signal stops the process');
+        } catch (RuntimeException $e) {
+
+        }
+
+        $this->assertFalse($process->isRunning());
+        $this->assertTrue($process->hasBeenSignaled());
+        $this->assertEquals(SIGKILL, $process->getTermSignal());
+    }
+
     public function testStop()
     {
         $process = new Process('php -r "while (true) {}"');
