You are here

Home » API reference » Zircon Profile 8.0

AbstractProcessTest.php in Zircon Profile 8.0

Same filename and directory in other branches
  1. 8 vendor/symfony/process/Tests/AbstractProcessTest.php

Namespace

Symfony\Component\Process\Tests

File

vendor/symfony/process/Tests/AbstractProcessTest.php
View source 
<?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\Tests;

use Symfony\Component\Process\Exception\LogicException;
use Symfony\Component\Process\Exception\ProcessTimedOutException;
use Symfony\Component\Process\Exception\RuntimeException;
use Symfony\Component\Process\PhpExecutableFinder;
use Symfony\Component\Process\Pipes\PipesInterface;
use Symfony\Component\Process\Process;

/**
 * @author Robert Schönthal <seroscho@googlemail.com>
 */
abstract class AbstractProcessTest extends \PHPUnit_Framework_TestCase {
  protected static $phpBin;
  public static function setUpBeforeClass() {
    $phpBin = new PhpExecutableFinder();
    self::$phpBin = $phpBin
      ->find();
  }
  public function testThatProcessDoesNotThrowWarningDuringRun() {
    @trigger_error('Test Error', E_USER_NOTICE);
    $process = $this
      ->getProcess(self::$phpBin . " -r 'sleep(3)'");
    $process
      ->run();
    $actualError = error_get_last();
    $this
      ->assertEquals('Test Error', $actualError['message']);
    $this
      ->assertEquals(E_USER_NOTICE, $actualError['type']);
  }

  /**
   * @expectedException \Symfony\Component\Process\Exception\InvalidArgumentException
   */
  public function testNegativeTimeoutFromConstructor() {
    $this
      ->getProcess('', null, null, null, -1);
  }

  /**
   * @expectedException \Symfony\Component\Process\Exception\InvalidArgumentException
   */
  public function testNegativeTimeoutFromSetter() {
    $p = $this
      ->getProcess('');
    $p
      ->setTimeout(-1);
  }
  public function testFloatAndNullTimeout() {
    $p = $this
      ->getProcess('');
    $p
      ->setTimeout(10);
    $this
      ->assertSame(10.0, $p
      ->getTimeout());
    $p
      ->setTimeout(null);
    $this
      ->assertNull($p
      ->getTimeout());
    $p
      ->setTimeout(0.0);
    $this
      ->assertNull($p
      ->getTimeout());
  }
  public function testStopWithTimeoutIsActuallyWorking() {
    $this
      ->verifyPosixIsEnabled();

    // exec is mandatory here since we send a signal to the process
    // see https://github.com/symfony/symfony/issues/5030 about prepending
    // command with exec
    $p = $this
      ->getProcess('exec php ' . __DIR__ . '/NonStopableProcess.php 3');
    $p
      ->start();
    usleep(100000);
    $start = microtime(true);
    $p
      ->stop(1.1, SIGKILL);
    while ($p
      ->isRunning()) {
      usleep(1000);
    }
    $duration = microtime(true) - $start;
    $this
      ->assertLessThan(4, $duration);
  }
  public function testAllOutputIsActuallyReadOnTermination() {

    // this code will result in a maximum of 2 reads of 8192 bytes by calling
    // start() and isRunning().  by the time getOutput() is called the process
    // has terminated so the internal pipes array is already empty. normally
    // the call to start() will not read any data as the process will not have
    // generated output, but this is non-deterministic so we must count it as
    // a possibility.  therefore we need 2 * PipesInterface::CHUNK_SIZE plus
    // another byte which will never be read.
    $expectedOutputSize = PipesInterface::CHUNK_SIZE * 2 + 2;
    $code = sprintf('echo str_repeat(\'*\', %d);', $expectedOutputSize);
    $p = $this
      ->getProcess(sprintf('%s -r %s', self::$phpBin, escapeshellarg($code)));
    $p
      ->start();

    // Let's wait enough time for process to finish...
    // Here we don't call Process::run or Process::wait to avoid any read of pipes
    usleep(500000);
    if ($p
      ->isRunning()) {
      $this
        ->markTestSkipped('Process execution did not complete in the required time frame');
    }
    $o = $p
      ->getOutput();
    $this
      ->assertEquals($expectedOutputSize, strlen($o));
  }
  public function testCallbacksAreExecutedWithStart() {
    $data = '';
    $process = $this
      ->getProcess('echo foo && php -r "sleep(1);" && echo foo');
    $process
      ->start(function ($type, $buffer) use (&$data) {
      $data .= $buffer;
    });
    while ($process
      ->isRunning()) {
      usleep(10000);
    }
    $this
      ->assertEquals(2, preg_match_all('/foo/', $data, $matches));
  }

  /**
   * tests results from sub processes.
   *
   * @dataProvider responsesCodeProvider
   */
  public function testProcessResponses($expected, $getter, $code) {
    $p = $this
      ->getProcess(sprintf('%s -r %s', self::$phpBin, escapeshellarg($code)));
    $p
      ->run();
    $this
      ->assertSame($expected, $p
      ->{$getter}());
  }

  /**
   * tests results from sub processes.
   *
   * @dataProvider pipesCodeProvider
   */
  public function testProcessPipes($code, $size) {
    $expected = str_repeat(str_repeat('*', 1024), $size) . '!';
    $expectedLength = 1024 * $size + 1;
    $p = $this
      ->getProcess(sprintf('%s -r %s', self::$phpBin, escapeshellarg($code)));
    $p
      ->setInput($expected);
    $p
      ->run();
    $this
      ->assertEquals($expectedLength, strlen($p
      ->getOutput()));
    $this
      ->assertEquals($expectedLength, strlen($p
      ->getErrorOutput()));
  }

  /**
   * @dataProvider pipesCodeProvider
   */
  public function testSetStreamAsInput($code, $size) {
    if ('\\' === DIRECTORY_SEPARATOR) {
      $this
        ->markTestIncomplete('This test fails with a timeout on Windows, can someone investigate please?');
    }
    $expected = str_repeat(str_repeat('*', 1024), $size) . '!';
    $expectedLength = 1024 * $size + 1;
    $stream = fopen('php://temporary', 'w+');
    fwrite($stream, $expected);
    rewind($stream);
    $p = $this
      ->getProcess(sprintf('%s -r %s', self::$phpBin, escapeshellarg($code)), null, null, null, 5);
    $p
      ->setInput($stream);
    $p
      ->run();
    fclose($stream);
    $this
      ->assertEquals($expectedLength, strlen($p
      ->getOutput()));
    $this
      ->assertEquals($expectedLength, strlen($p
      ->getErrorOutput()));
  }
  public function testSetInputWhileRunningThrowsAnException() {
    $process = $this
      ->getProcess(self::$phpBin . ' -r "usleep(500000);"');
    $process
      ->start();
    try {
      $process
        ->setInput('foobar');
      $process
        ->stop();
      $this
        ->fail('A LogicException should have been raised.');
    } catch (LogicException $e) {
      $this
        ->assertEquals('Input can not be set while the process is running.', $e
        ->getMessage());
    }
    $process
      ->stop();
  }

  /**
   * @dataProvider provideInvalidInputValues
   * @expectedException \Symfony\Component\Process\Exception\InvalidArgumentException
   * @expectedExceptionMessage Symfony\Component\Process\Process::setInput only accepts strings or stream resources.
   */
  public function testInvalidInput($value) {
    $process = $this
      ->getProcess(self::$phpBin . ' -v');
    $process
      ->setInput($value);
  }
  public function provideInvalidInputValues() {
    return array(
      array(
        array(),
      ),
      array(
        new NonStringifiable(),
      ),
    );
  }

  /**
   * @dataProvider provideInputValues
   */
  public function testValidInput($expected, $value) {
    $process = $this
      ->getProcess(self::$phpBin . ' -v');
    $process
      ->setInput($value);
    $this
      ->assertSame($expected, $process
      ->getInput());
  }
  public function provideInputValues() {
    return array(
      array(
        null,
        null,
      ),
      array(
        '24.5',
        24.5,
      ),
      array(
        'input data',
        'input data',
      ),
    );
  }

  /**
   * @dataProvider provideLegacyInputValues
   * @group legacy
   */
  public function testLegacyValidInput($expected, $value) {
    $process = $this
      ->getProcess(self::$phpBin . ' -v');
    $process
      ->setInput($value);
    $this
      ->assertSame($expected, $process
      ->getInput());
  }
  public function provideLegacyInputValues() {
    return array(
      array(
        'stringifiable',
        new Stringifiable(),
      ),
    );
  }
  public function chainedCommandsOutputProvider() {
    if ('\\' === DIRECTORY_SEPARATOR) {
      return array(
        array(
          "2 \r\n2\r\n",
          '&&',
          '2',
        ),
      );
    }
    return array(
      array(
        "1\n1\n",
        ';',
        '1',
      ),
      array(
        "2\n2\n",
        '&&',
        '2',
      ),
    );
  }

  /**
   * @dataProvider chainedCommandsOutputProvider
   */
  public function testChainedCommandsOutput($expected, $operator, $input) {
    $process = $this
      ->getProcess(sprintf('echo %s %s echo %s', $input, $operator, $input));
    $process
      ->run();
    $this
      ->assertEquals($expected, $process
      ->getOutput());
  }
  public function testCallbackIsExecutedForOutput() {
    $p = $this
      ->getProcess(sprintf('%s -r %s', self::$phpBin, escapeshellarg('echo \'foo\';')));
    $called = false;
    $p
      ->run(function ($type, $buffer) use (&$called) {
      $called = $buffer === 'foo';
    });
    $this
      ->assertTrue($called, 'The callback should be executed with the output');
  }
  public function testGetErrorOutput() {
    $p = $this
      ->getProcess(sprintf('%s -r %s', self::$phpBin, escapeshellarg('$n = 0; while ($n < 3) { file_put_contents(\'php://stderr\', \'ERROR\'); $n++; }')));
    $p
      ->run();
    $this
      ->assertEquals(3, preg_match_all('/ERROR/', $p
      ->getErrorOutput(), $matches));
  }
  public function testGetIncrementalErrorOutput() {

    // use a lock file to toggle between writing ("W") and reading ("R") the
    // error stream
    $lock = tempnam(sys_get_temp_dir(), get_class($this) . 'Lock');
    file_put_contents($lock, 'W');
    $p = $this
      ->getProcess(sprintf('%s -r %s', self::$phpBin, escapeshellarg('$n = 0; while ($n < 3) { if (\'W\' === file_get_contents(' . var_export($lock, true) . ')) { file_put_contents(\'php://stderr\', \'ERROR\'); $n++; file_put_contents(' . var_export($lock, true) . ', \'R\'); } usleep(100); }')));
    $p
      ->start();
    while ($p
      ->isRunning()) {
      if ('R' === file_get_contents($lock)) {
        $this
          ->assertLessThanOrEqual(1, preg_match_all('/ERROR/', $p
          ->getIncrementalErrorOutput(), $matches));
        file_put_contents($lock, 'W');
      }
      usleep(100);
    }
    unlink($lock);
  }
  public function testFlushErrorOutput() {
    $p = $this
      ->getProcess(sprintf('%s -r %s', self::$phpBin, escapeshellarg('$n = 0; while ($n < 3) { file_put_contents(\'php://stderr\', \'ERROR\'); $n++; }')));
    $p
      ->run();
    $p
      ->clearErrorOutput();
    $this
      ->assertEmpty($p
      ->getErrorOutput());
  }
  public function testGetEmptyIncrementalErrorOutput() {

    // use a lock file to toggle between writing ("W") and reading ("R") the
    // output stream
    $lock = tempnam(sys_get_temp_dir(), get_class($this) . 'Lock');
    file_put_contents($lock, 'W');
    $p = $this
      ->getProcess(sprintf('%s -r %s', self::$phpBin, escapeshellarg('$n = 0; while ($n < 3) { if (\'W\' === file_get_contents(' . var_export($lock, true) . ')) { file_put_contents(\'php://stderr\', \'ERROR\'); $n++; file_put_contents(' . var_export($lock, true) . ', \'R\'); } usleep(100); }')));
    $p
      ->start();
    $shouldWrite = false;
    while ($p
      ->isRunning()) {
      if ('R' === file_get_contents($lock)) {
        if (!$shouldWrite) {
          $this
            ->assertLessThanOrEqual(1, preg_match_all('/ERROR/', $p
            ->getIncrementalOutput(), $matches));
          $shouldWrite = true;
        }
        else {
          $this
            ->assertSame('', $p
            ->getIncrementalOutput());
          file_put_contents($lock, 'W');
          $shouldWrite = false;
        }
      }
      usleep(100);
    }
    unlink($lock);
  }
  public function testGetOutput() {
    $p = $this
      ->getProcess(sprintf('%s -r %s', self::$phpBin, escapeshellarg('$n = 0; while ($n < 3) { echo \' foo \'; $n++; }')));
    $p
      ->run();
    $this
      ->assertEquals(3, preg_match_all('/foo/', $p
      ->getOutput(), $matches));
  }
  public function testGetIncrementalOutput() {

    // use a lock file to toggle between writing ("W") and reading ("R") the
    // output stream
    $lock = tempnam(sys_get_temp_dir(), get_class($this) . 'Lock');
    file_put_contents($lock, 'W');
    $p = $this
      ->getProcess(sprintf('%s -r %s', self::$phpBin, escapeshellarg('$n = 0; while ($n < 3) { if (\'W\' === file_get_contents(' . var_export($lock, true) . ')) { echo \' foo \'; $n++; file_put_contents(' . var_export($lock, true) . ', \'R\'); } usleep(100); }')));
    $p
      ->start();
    while ($p
      ->isRunning()) {
      if ('R' === file_get_contents($lock)) {
        $this
          ->assertLessThanOrEqual(1, preg_match_all('/foo/', $p
          ->getIncrementalOutput(), $matches));
        file_put_contents($lock, 'W');
      }
      usleep(100);
    }
    unlink($lock);
  }
  public function testFlushOutput() {
    $p = $this
      ->getProcess(sprintf('%s -r %s', self::$phpBin, escapeshellarg('$n=0;while ($n<3) {echo \' foo \';$n++;}')));
    $p
      ->run();
    $p
      ->clearOutput();
    $this
      ->assertEmpty($p
      ->getOutput());
  }
  public function testGetEmptyIncrementalOutput() {

    // use a lock file to toggle between writing ("W") and reading ("R") the
    // output stream
    $lock = tempnam(sys_get_temp_dir(), get_class($this) . 'Lock');
    file_put_contents($lock, 'W');
    $p = $this
      ->getProcess(sprintf('%s -r %s', self::$phpBin, escapeshellarg('$n = 0; while ($n < 3) { if (\'W\' === file_get_contents(' . var_export($lock, true) . ')) { echo \' foo \'; $n++; file_put_contents(' . var_export($lock, true) . ', \'R\'); } usleep(100); }')));
    $p
      ->start();
    $shouldWrite = false;
    while ($p
      ->isRunning()) {
      if ('R' === file_get_contents($lock)) {
        if (!$shouldWrite) {
          $this
            ->assertLessThanOrEqual(1, preg_match_all('/foo/', $p
            ->getIncrementalOutput(), $matches));
          $shouldWrite = true;
        }
        else {
          $this
            ->assertSame('', $p
            ->getIncrementalOutput());
          file_put_contents($lock, 'W');
          $shouldWrite = false;
        }
      }
      usleep(100);
    }
    unlink($lock);
  }
  public function testZeroAsOutput() {
    if ('\\' === DIRECTORY_SEPARATOR) {

      // see http://stackoverflow.com/questions/7105433/windows-batch-echo-without-new-line
      $p = $this
        ->getProcess('echo | set /p dummyName=0');
    }
    else {
      $p = $this
        ->getProcess('printf 0');
    }
    $p
      ->run();
    $this
      ->assertSame('0', $p
      ->getOutput());
  }
  public function testExitCodeCommandFailed() {
    if ('\\' === DIRECTORY_SEPARATOR) {
      $this
        ->markTestSkipped('Windows does not support POSIX exit code');
    }

    // such command run in bash return an exitcode 127
    $process = $this
      ->getProcess('nonexistingcommandIhopeneversomeonewouldnameacommandlikethis');
    $process
      ->run();
    $this
      ->assertGreaterThan(0, $process
      ->getExitCode());
  }
  public function testTTYCommand() {
    if ('\\' === DIRECTORY_SEPARATOR) {
      $this
        ->markTestSkipped('Windows does have /dev/tty support');
    }
    $process = $this
      ->getProcess('echo "foo" >> /dev/null && php -r "usleep(100000);"');
    $process
      ->setTty(true);
    $process
      ->start();
    $this
      ->assertTrue($process
      ->isRunning());
    $process
      ->wait();
    $this
      ->assertSame(Process::STATUS_TERMINATED, $process
      ->getStatus());
  }
  public function testTTYCommandExitCode() {
    if ('\\' === DIRECTORY_SEPARATOR) {
      $this
        ->markTestSkipped('Windows does have /dev/tty support');
    }
    $process = $this
      ->getProcess('echo "foo" >> /dev/null');
    $process
      ->setTty(true);
    $process
      ->run();
    $this
      ->assertTrue($process
      ->isSuccessful());
  }
  public function testTTYInWindowsEnvironment() {
    if ('\\' !== DIRECTORY_SEPARATOR) {
      $this
        ->markTestSkipped('This test is for Windows platform only');
    }
    $process = $this
      ->getProcess('echo "foo" >> /dev/null');
    $process
      ->setTty(false);
    $this
      ->setExpectedException('Symfony\\Component\\Process\\Exception\\RuntimeException', 'TTY mode is not supported on Windows platform.');
    $process
      ->setTty(true);
  }
  public function testExitCodeTextIsNullWhenExitCodeIsNull() {
    $process = $this
      ->getProcess('');
    $this
      ->assertNull($process
      ->getExitCodeText());
  }
  public function testPTYCommand() {
    if (!Process::isPtySupported()) {
      $this
        ->markTestSkipped('PTY is not supported on this operating system.');
    }
    $process = $this
      ->getProcess('echo "foo"');
    $process
      ->setPty(true);
    $process
      ->run();
    $this
      ->assertSame(Process::STATUS_TERMINATED, $process
      ->getStatus());
    $this
      ->assertEquals("foo\r\n", $process
      ->getOutput());
  }
  public function testMustRun() {
    $process = $this
      ->getProcess('echo foo');
    $this
      ->assertSame($process, $process
      ->mustRun());
    $this
      ->assertEquals('foo' . PHP_EOL, $process
      ->getOutput());
  }
  public function testSuccessfulMustRunHasCorrectExitCode() {
    $process = $this
      ->getProcess('echo foo')
      ->mustRun();
    $this
      ->assertEquals(0, $process
      ->getExitCode());
  }

  /**
   * @expectedException \Symfony\Component\Process\Exception\ProcessFailedException
   */
  public function testMustRunThrowsException() {
    $process = $this
      ->getProcess('exit 1');
    $process
      ->mustRun();
  }
  public function testExitCodeText() {
    $process = $this
      ->getProcess('');
    $r = new \ReflectionObject($process);
    $p = $r
      ->getProperty('exitcode');
    $p
      ->setAccessible(true);
    $p
      ->setValue($process, 2);
    $this
      ->assertEquals('Misuse of shell builtins', $process
      ->getExitCodeText());
  }
  public function testStartIsNonBlocking() {
    $process = $this
      ->getProcess(self::$phpBin . ' -r "usleep(500000);"');
    $start = microtime(true);
    $process
      ->start();
    $end = microtime(true);
    $this
      ->assertLessThan(0.4, $end - $start);
    $process
      ->wait();
  }
  public function testUpdateStatus() {
    $process = $this
      ->getProcess(self::$phpBin . ' -v');
    $process
      ->run();
    $this
      ->assertTrue(strlen($process
      ->getOutput()) > 0);
  }
  public function testGetExitCodeIsNullOnStart() {
    $process = $this
      ->getProcess(self::$phpBin . ' -r "usleep(200000);"');
    $this
      ->assertNull($process
      ->getExitCode());
    $process
      ->start();
    $this
      ->assertNull($process
      ->getExitCode());
    $process
      ->wait();
    $this
      ->assertEquals(0, $process
      ->getExitCode());
  }
  public function testGetExitCodeIsNullOnWhenStartingAgain() {
    $process = $this
      ->getProcess(self::$phpBin . ' -r "usleep(200000);"');
    $process
      ->run();
    $this
      ->assertEquals(0, $process
      ->getExitCode());
    $process
      ->start();
    $this
      ->assertNull($process
      ->getExitCode());
    $process
      ->wait();
    $this
      ->assertEquals(0, $process
      ->getExitCode());
  }
  public function testGetExitCode() {
    $process = $this
      ->getProcess(self::$phpBin . ' -v');
    $process
      ->run();
    $this
      ->assertSame(0, $process
      ->getExitCode());
  }
  public function testStatus() {
    $process = $this
      ->getProcess(self::$phpBin . ' -r "usleep(500000);"');
    $this
      ->assertFalse($process
      ->isRunning());
    $this
      ->assertFalse($process
      ->isStarted());
    $this
      ->assertFalse($process
      ->isTerminated());
    $this
      ->assertSame(Process::STATUS_READY, $process
      ->getStatus());
    $process
      ->start();
    $this
      ->assertTrue($process
      ->isRunning());
    $this
      ->assertTrue($process
      ->isStarted());
    $this
      ->assertFalse($process
      ->isTerminated());
    $this
      ->assertSame(Process::STATUS_STARTED, $process
      ->getStatus());
    $process
      ->wait();
    $this
      ->assertFalse($process
      ->isRunning());
    $this
      ->assertTrue($process
      ->isStarted());
    $this
      ->assertTrue($process
      ->isTerminated());
    $this
      ->assertSame(Process::STATUS_TERMINATED, $process
      ->getStatus());
  }
  public function testStop() {
    $process = $this
      ->getProcess(self::$phpBin . ' -r "sleep(4);"');
    $process
      ->start();
    $this
      ->assertTrue($process
      ->isRunning());
    $process
      ->stop();
    $this
      ->assertFalse($process
      ->isRunning());
  }
  public function testIsSuccessful() {
    $process = $this
      ->getProcess(self::$phpBin . ' -v');
    $process
      ->run();
    $this
      ->assertTrue($process
      ->isSuccessful());
  }
  public function testIsSuccessfulOnlyAfterTerminated() {
    $process = $this
      ->getProcess(self::$phpBin . ' -r "sleep(1);"');
    $process
      ->start();
    $this
      ->assertFalse($process
      ->isSuccessful());
    while ($process
      ->isRunning()) {
      usleep(300000);
    }
    $this
      ->assertTrue($process
      ->isSuccessful());
  }
  public function testIsNotSuccessful() {
    $process = $this
      ->getProcess(self::$phpBin . ' -r "usleep(500000);throw new \\Exception(\'BOUM\');"');
    $process
      ->start();
    $this
      ->assertTrue($process
      ->isRunning());
    $process
      ->wait();
    $this
      ->assertFalse($process
      ->isSuccessful());
  }
  public function testProcessIsNotSignaled() {
    if ('\\' === DIRECTORY_SEPARATOR) {
      $this
        ->markTestSkipped('Windows does not support POSIX signals');
    }
    $process = $this
      ->getProcess(self::$phpBin . ' -v');
    $process
      ->run();
    $this
      ->assertFalse($process
      ->hasBeenSignaled());
  }
  public function testProcessWithoutTermSignalIsNotSignaled() {
    if ('\\' === DIRECTORY_SEPARATOR) {
      $this
        ->markTestSkipped('Windows does not support POSIX signals');
    }
    $process = $this
      ->getProcess(self::$phpBin . ' -v');
    $process
      ->run();
    $this
      ->assertFalse($process
      ->hasBeenSignaled());
  }
  public function testProcessWithoutTermSignal() {
    if ('\\' === DIRECTORY_SEPARATOR) {
      $this
        ->markTestSkipped('Windows does not support POSIX signals');
    }
    $process = $this
      ->getProcess(self::$phpBin . ' -v');
    $process
      ->run();
    $this
      ->assertEquals(0, $process
      ->getTermSignal());
  }
  public function testProcessIsSignaledIfStopped() {
    if ('\\' === DIRECTORY_SEPARATOR) {
      $this
        ->markTestSkipped('Windows does not support POSIX signals');
    }
    $process = $this
      ->getProcess(self::$phpBin . ' -r "sleep(4);"');
    $process
      ->start();
    $process
      ->stop();
    $this
      ->assertTrue($process
      ->hasBeenSignaled());
  }
  public function testProcessWithTermSignal() {
    if ('\\' === DIRECTORY_SEPARATOR) {
      $this
        ->markTestSkipped('Windows does not support POSIX signals');
    }

    // SIGTERM is only defined if pcntl extension is present
    $termSignal = defined('SIGTERM') ? SIGTERM : 15;
    $process = $this
      ->getProcess(self::$phpBin . ' -r "sleep(4);"');
    $process
      ->start();
    $process
      ->stop();
    $this
      ->assertEquals($termSignal, $process
      ->getTermSignal());
  }
  public function testProcessThrowsExceptionWhenExternallySignaled() {
    if ('\\' === DIRECTORY_SEPARATOR) {
      $this
        ->markTestSkipped('Windows does not support POSIX signals');
    }
    if (!function_exists('posix_kill')) {
      $this
        ->markTestSkipped('posix_kill is required for this test');
    }
    $termSignal = defined('SIGKILL') ? SIGKILL : 9;
    $process = $this
      ->getProcess('exec php -r "while (true) {}"');
    $process
      ->start();
    posix_kill($process
      ->getPid(), $termSignal);
    $this
      ->setExpectedException('Symfony\\Component\\Process\\Exception\\RuntimeException', 'The process has been signaled with signal "9".');
    $process
      ->wait();
  }
  public function testRestart() {
    $process1 = $this
      ->getProcess(self::$phpBin . ' -r "echo getmypid();"');
    $process1
      ->run();
    $process2 = $process1
      ->restart();
    $process2
      ->wait();

    // wait for output
    // Ensure that both processed finished and the output is numeric
    $this
      ->assertFalse($process1
      ->isRunning());
    $this
      ->assertFalse($process2
      ->isRunning());
    $this
      ->assertTrue(is_numeric($process1
      ->getOutput()));
    $this
      ->assertTrue(is_numeric($process2
      ->getOutput()));

    // Ensure that restart returned a new process by check that the output is different
    $this
      ->assertNotEquals($process1
      ->getOutput(), $process2
      ->getOutput());
  }
  public function testPhpDeadlock() {
    $this
      ->markTestSkipped('Can cause PHP to hang');

    // Sleep doesn't work as it will allow the process to handle signals and close
    // file handles from the other end.
    $process = $this
      ->getProcess(self::$phpBin . ' -r "while (true) {}"');
    $process
      ->start();

    // PHP will deadlock when it tries to cleanup $process
  }
  public function testRunProcessWithTimeout() {
    $timeout = 0.5;
    $process = $this
      ->getProcess(self::$phpBin . ' -r "usleep(600000);"');
    $process
      ->setTimeout($timeout);
    $start = microtime(true);
    try {
      $process
        ->run();
      $this
        ->fail('A RuntimeException should have been raised');
    } catch (RuntimeException $e) {
    }
    $duration = microtime(true) - $start;
    if ('\\' === DIRECTORY_SEPARATOR) {

      // Windows is a bit slower as it read file handles, then allow twice the precision
      $maxDuration = $timeout + 2 * Process::TIMEOUT_PRECISION;
    }
    else {
      $maxDuration = $timeout + Process::TIMEOUT_PRECISION;
    }
    $this
      ->assertLessThan($maxDuration, $duration);
  }
  public function testCheckTimeoutOnNonStartedProcess() {
    $process = $this
      ->getProcess(self::$phpBin . ' -r "sleep(3);"');
    $process
      ->checkTimeout();
  }
  public function testCheckTimeoutOnTerminatedProcess() {
    $process = $this
      ->getProcess(self::$phpBin . ' -v');
    $process
      ->run();
    $process
      ->checkTimeout();
  }
  public function testCheckTimeoutOnStartedProcess() {
    $timeout = 0.5;
    $precision = 100000;
    $process = $this
      ->getProcess(self::$phpBin . ' -r "sleep(3);"');
    $process
      ->setTimeout($timeout);
    $start = microtime(true);
    $process
      ->start();
    try {
      while ($process
        ->isRunning()) {
        $process
          ->checkTimeout();
        usleep($precision);
      }
      $this
        ->fail('A RuntimeException should have been raised');
    } catch (RuntimeException $e) {
    }
    $duration = microtime(true) - $start;
    $this
      ->assertLessThan($timeout + $precision, $duration);
    $this
      ->assertFalse($process
      ->isSuccessful());
  }
  public function testIdleTimeout() {
    $process = $this
      ->getProcess(self::$phpBin . ' -r "sleep(3);"');
    $process
      ->setTimeout(10);
    $process
      ->setIdleTimeout(0.5);
    try {
      $process
        ->run();
      $this
        ->fail('A timeout exception was expected.');
    } catch (ProcessTimedOutException $ex) {
      $this
        ->assertTrue($ex
        ->isIdleTimeout());
      $this
        ->assertFalse($ex
        ->isGeneralTimeout());
      $this
        ->assertEquals(0.5, $ex
        ->getExceededTimeout());
    }
  }
  public function testIdleTimeoutNotExceededWhenOutputIsSent() {
    if ('\\' === DIRECTORY_SEPARATOR) {
      $this
        ->markTestIncomplete('This test fails with a timeout on Windows, can someone investigate please?');
    }
    $process = $this
      ->getProcess(sprintf('%s -r %s', self::$phpBin, escapeshellarg('$n = 30; while ($n--) {echo "foo\\n"; usleep(100000); }')));
    $process
      ->setTimeout(2);
    $process
      ->setIdleTimeout(1);
    try {
      $process
        ->run();
      $this
        ->fail('A timeout exception was expected.');
    } catch (ProcessTimedOutException $ex) {
      $this
        ->assertTrue($ex
        ->isGeneralTimeout(), 'A general timeout is expected.');
      $this
        ->assertFalse($ex
        ->isIdleTimeout(), 'No idle timeout is expected.');
      $this
        ->assertEquals(2, $ex
        ->getExceededTimeout());
    }
  }
  public function testStartAfterATimeout() {
    $process = $this
      ->getProcess(sprintf('%s -r %s', self::$phpBin, escapeshellarg('$n = 1000; while ($n--) {echo \'\'; usleep(1000); }')));
    $process
      ->setTimeout(0.1);
    try {
      $process
        ->run();
      $this
        ->fail('A RuntimeException should have been raised.');
    } catch (RuntimeException $e) {
    }
    $process
      ->start();
    usleep(1000);
    $process
      ->stop();
  }
  public function testGetPid() {
    $process = $this
      ->getProcess(self::$phpBin . ' -r "usleep(500000);"');
    $process
      ->start();
    $this
      ->assertGreaterThan(0, $process
      ->getPid());
    $process
      ->wait();
  }
  public function testGetPidIsNullBeforeStart() {
    $process = $this
      ->getProcess(self::$phpBin . ' -r "sleep(1);"');
    $this
      ->assertNull($process
      ->getPid());
  }
  public function testGetPidIsNullAfterRun() {
    $process = $this
      ->getProcess(self::$phpBin . ' -v');
    $process
      ->run();
    $this
      ->assertNull($process
      ->getPid());
  }
  public function testSignal() {
    $this
      ->verifyPosixIsEnabled();
    $process = $this
      ->getProcess('exec php -f ' . __DIR__ . '/SignalListener.php');
    $process
      ->start();
    usleep(500000);
    $process
      ->signal(SIGUSR1);
    while ($process
      ->isRunning() && false === strpos($process
      ->getOutput(), 'Caught SIGUSR1')) {
      usleep(10000);
    }
    $this
      ->assertEquals('Caught SIGUSR1', $process
      ->getOutput());
  }
  public function testExitCodeIsAvailableAfterSignal() {
    $this
      ->verifyPosixIsEnabled();
    $process = $this
      ->getProcess('sleep 4');
    $process
      ->start();
    $process
      ->signal(SIGKILL);
    while ($process
      ->isRunning()) {
      usleep(10000);
    }
    $this
      ->assertFalse($process
      ->isRunning());
    $this
      ->assertTrue($process
      ->hasBeenSignaled());
    $this
      ->assertFalse($process
      ->isSuccessful());
    $this
      ->assertEquals(137, $process
      ->getExitCode());
  }

  /**
   * @expectedException \Symfony\Component\Process\Exception\LogicException
   */
  public function testSignalProcessNotRunning() {
    $this
      ->verifyPosixIsEnabled();
    $process = $this
      ->getProcess(self::$phpBin . ' -v');
    $process
      ->signal(SIGHUP);
  }

  /**
   * @dataProvider provideMethodsThatNeedARunningProcess
   */
  public function testMethodsThatNeedARunningProcess($method) {
    $process = $this
      ->getProcess(self::$phpBin . ' -v');
    $this
      ->setExpectedException('Symfony\\Component\\Process\\Exception\\LogicException', sprintf('Process must be started before calling %s.', $method));
    $process
      ->{$method}();
  }
  public function provideMethodsThatNeedARunningProcess() {
    return array(
      array(
        'getOutput',
      ),
      array(
        'getIncrementalOutput',
      ),
      array(
        'getErrorOutput',
      ),
      array(
        'getIncrementalErrorOutput',
      ),
      array(
        'wait',
      ),
    );
  }

  /**
   * @dataProvider provideMethodsThatNeedATerminatedProcess
   */
  public function testMethodsThatNeedATerminatedProcess($method) {
    $process = $this
      ->getProcess(self::$phpBin . ' -r "sleep(1);"');
    $process
      ->start();
    try {
      $process
        ->{$method}();
      $process
        ->stop(0);
      $this
        ->fail('A LogicException must have been thrown');
    } catch (\Exception $e) {
      $this
        ->assertInstanceOf('Symfony\\Component\\Process\\Exception\\LogicException', $e);
      $this
        ->assertEquals(sprintf('Process must be terminated before calling %s.', $method), $e
        ->getMessage());
    }
    $process
      ->stop(0);
  }
  public function provideMethodsThatNeedATerminatedProcess() {
    return array(
      array(
        'hasBeenSignaled',
      ),
      array(
        'getTermSignal',
      ),
      array(
        'hasBeenStopped',
      ),
      array(
        'getStopSignal',
      ),
    );
  }
  private function verifyPosixIsEnabled() {
    if ('\\' === DIRECTORY_SEPARATOR) {
      $this
        ->markTestSkipped('POSIX signals do not work on Windows');
    }
    if (!defined('SIGUSR1')) {
      $this
        ->markTestSkipped('The pcntl extension is not enabled');
    }
  }

  /**
   * @expectedException \Symfony\Component\Process\Exception\RuntimeException
   */
  public function testSignalWithWrongIntSignal() {
    if ('\\' === DIRECTORY_SEPARATOR) {
      $this
        ->markTestSkipped('POSIX signals do not work on Windows');
    }
    $process = $this
      ->getProcess(self::$phpBin . ' -r "sleep(3);"');
    $process
      ->start();
    $process
      ->signal(-4);
  }

  /**
   * @expectedException \Symfony\Component\Process\Exception\RuntimeException
   */
  public function testSignalWithWrongNonIntSignal() {
    if ('\\' === DIRECTORY_SEPARATOR) {
      $this
        ->markTestSkipped('POSIX signals do not work on Windows');
    }
    $process = $this
      ->getProcess(self::$phpBin . ' -r "sleep(3);"');
    $process
      ->start();
    $process
      ->signal('Céphalopodes');
  }
  public function testDisableOutputDisablesTheOutput() {
    $p = $this
      ->getProcess(self::$phpBin . ' -r "usleep(500000);"');
    $this
      ->assertFalse($p
      ->isOutputDisabled());
    $p
      ->disableOutput();
    $this
      ->assertTrue($p
      ->isOutputDisabled());
    $p
      ->enableOutput();
    $this
      ->assertFalse($p
      ->isOutputDisabled());
  }
  public function testDisableOutputWhileRunningThrowsException() {
    $p = $this
      ->getProcess(self::$phpBin . ' -r "usleep(500000);"');
    $p
      ->start();
    $this
      ->setExpectedException('Symfony\\Component\\Process\\Exception\\RuntimeException', 'Disabling output while the process is running is not possible.');
    $p
      ->disableOutput();
  }
  public function testEnableOutputWhileRunningThrowsException() {
    $p = $this
      ->getProcess(self::$phpBin . ' -r "usleep(500000);"');
    $p
      ->disableOutput();
    $p
      ->start();
    $this
      ->setExpectedException('Symfony\\Component\\Process\\Exception\\RuntimeException', 'Enabling output while the process is running is not possible.');
    $p
      ->enableOutput();
  }
  public function testEnableOrDisableOutputAfterRunDoesNotThrowException() {
    $p = $this
      ->getProcess(self::$phpBin . ' -r "usleep(500000);"');
    $p
      ->disableOutput();
    $p
      ->start();
    $p
      ->wait();
    $p
      ->enableOutput();
    $p
      ->disableOutput();
  }
  public function testDisableOutputWhileIdleTimeoutIsSet() {
    $process = $this
      ->getProcess('sleep 3');
    $process
      ->setIdleTimeout(1);
    $this
      ->setExpectedException('Symfony\\Component\\Process\\Exception\\LogicException', 'Output can not be disabled while an idle timeout is set.');
    $process
      ->disableOutput();
  }
  public function testSetIdleTimeoutWhileOutputIsDisabled() {
    $process = $this
      ->getProcess('sleep 3');
    $process
      ->disableOutput();
    $this
      ->setExpectedException('Symfony\\Component\\Process\\Exception\\LogicException', 'Idle timeout can not be set while the output is disabled.');
    $process
      ->setIdleTimeout(1);
  }
  public function testSetNullIdleTimeoutWhileOutputIsDisabled() {
    $process = $this
      ->getProcess('sleep 3');
    $process
      ->disableOutput();
    $process
      ->setIdleTimeout(null);
  }

  /**
   * @dataProvider provideStartMethods
   */
  public function testStartWithACallbackAndDisabledOutput($startMethod, $exception, $exceptionMessage) {
    $p = $this
      ->getProcess(self::$phpBin . ' -r "usleep(500000);"');
    $p
      ->disableOutput();
    $this
      ->setExpectedException($exception, $exceptionMessage);
    $p
      ->{$startMethod}(function () {
    });
  }
  public function provideStartMethods() {
    return array(
      array(
        'start',
        'Symfony\\Component\\Process\\Exception\\LogicException',
        'Output has been disabled, enable it to allow the use of a callback.',
      ),
      array(
        'run',
        'Symfony\\Component\\Process\\Exception\\LogicException',
        'Output has been disabled, enable it to allow the use of a callback.',
      ),
      array(
        'mustRun',
        'Symfony\\Component\\Process\\Exception\\LogicException',
        'Output has been disabled, enable it to allow the use of a callback.',
      ),
    );
  }

  /**
   * @dataProvider provideOutputFetchingMethods
   */
  public function testGetOutputWhileDisabled($fetchMethod) {
    $p = $this
      ->getProcess(self::$phpBin . ' -r "usleep(500000);"');
    $p
      ->disableOutput();
    $p
      ->start();
    $this
      ->setExpectedException('Symfony\\Component\\Process\\Exception\\LogicException', 'Output has been disabled.');
    $p
      ->{$fetchMethod}();
  }
  public function provideOutputFetchingMethods() {
    return array(
      array(
        'getOutput',
      ),
      array(
        'getIncrementalOutput',
      ),
      array(
        'getErrorOutput',
      ),
      array(
        'getIncrementalErrorOutput',
      ),
    );
  }
  public function responsesCodeProvider() {
    return array(
      //expected output / getter / code to execute

      //array(1,'getExitCode','exit(1);'),

      //array(true,'isSuccessful','exit();'),
      array(
        'output',
        'getOutput',
        'echo \'output\';',
      ),
    );
  }
  public function pipesCodeProvider() {
    $variations = array(
      'fwrite(STDOUT, $in = file_get_contents(\'php://stdin\')); fwrite(STDERR, $in);',
      'include \'' . __DIR__ . '/PipeStdinInStdoutStdErrStreamSelect.php\';',
    );
    if ('\\' === DIRECTORY_SEPARATOR) {

      // Avoid XL buffers on Windows because of https://bugs.php.net/bug.php?id=65650
      $sizes = array(
        1,
        2,
        4,
        8,
      );
    }
    else {
      $sizes = array(
        1,
        16,
        64,
        1024,
        4096,
      );
    }
    $codes = array();
    foreach ($sizes as $size) {
      foreach ($variations as $code) {
        $codes[] = array(
          $code,
          $size,
        );
      }
    }
    return $codes;
  }

  /**
   * provides default method names for simple getter/setter.
   */
  public function methodProvider() {
    $defaults = array(
      array(
        'CommandLine',
      ),
      array(
        'Timeout',
      ),
      array(
        'WorkingDirectory',
      ),
      array(
        'Env',
      ),
      array(
        'Stdin',
      ),
      array(
        'Input',
      ),
      array(
        'Options',
      ),
    );
    return $defaults;
  }

  /**
   * @param string      $commandline
   * @param null|string $cwd
   * @param null|array  $env
   * @param null|string $input
   * @param int         $timeout
   * @param array       $options
   *
   * @return Process
   */
  protected abstract function getProcess($commandline, $cwd = null, array $env = null, $input = null, $timeout = 60, array $options = array());

}
class Stringifiable {
  public function __toString() {
    return 'stringifiable';
  }

}
class NonStringifiable {

}

Classes

Namesort descending Description
AbstractProcessTest @author Robert Schönthal <seroscho@googlemail.com>
NonStringifiable
Stringifiable