1
0
Fork 0
composer/tests/Composer/Test/Util/ProcessExecutorTest.php

203 lines
7.9 KiB
PHP
Raw Normal View History

2012-01-22 19:08:29 +00:00
<?php
/*
* This file is part of Composer.
*
* (c) Nils Adermann <naderman@naderman.de>
* Jordi Boggiano <j.boggiano@seld.be>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace Composer\Test\Util;
use Composer\IO\ConsoleIO;
2012-01-22 19:08:29 +00:00
use Composer\Util\ProcessExecutor;
use Composer\Test\TestCase;
2016-06-21 10:01:09 +00:00
use Composer\IO\BufferIO;
use Symfony\Component\Console\Helper\HelperSet;
use Symfony\Component\Console\Input\ArrayInput;
use Symfony\Component\Console\Output\BufferedOutput;
use Symfony\Component\Console\Output\OutputInterface;
2016-06-21 10:01:09 +00:00
use Symfony\Component\Console\Output\StreamOutput;
2012-01-22 19:08:29 +00:00
class ProcessExecutorTest extends TestCase
{
public function testExecuteCapturesOutput()
{
$process = new ProcessExecutor;
$process->execute('echo foo', $output);
$this->assertEquals("foo".PHP_EOL, $output);
}
public function testExecuteOutputsIfNotCaptured()
{
$process = new ProcessExecutor;
ob_start();
$process->execute('echo foo');
$output = ob_get_clean();
$this->assertEquals("foo".PHP_EOL, $output);
}
public function testUseIOIsNotNullAndIfNotCaptured()
{
$io = $this->getMockBuilder('Composer\IO\IOInterface')->getMock();
$io->expects($this->once())
->method('write')
2016-12-06 15:03:03 +00:00
->with($this->equalTo('foo'.PHP_EOL), false);
$process = new ProcessExecutor($io);
$process->execute('echo foo');
}
public function testExecuteCapturesStderr()
{
$process = new ProcessExecutor;
$process->execute('cat foo', $output);
$this->assertNotNull($process->getErrorOutput());
}
public function testTimeout()
{
ProcessExecutor::setTimeout(1);
$process = new ProcessExecutor;
$this->assertEquals(1, $process->getTimeout());
ProcessExecutor::setTimeout(60);
}
2019-06-23 17:59:36 +00:00
/**
* @dataProvider hidePasswordProvider
*/
public function testHidePasswords($command, $expectedCommandOutput)
2016-06-21 10:01:09 +00:00
{
$process = new ProcessExecutor($buffer = new BufferIO('', StreamOutput::VERBOSITY_DEBUG));
2019-06-23 17:59:36 +00:00
$process->execute($command, $output);
$this->assertEquals('Executing command (CWD): ' . $expectedCommandOutput, trim($buffer->getOutput()));
}
public function hidePasswordProvider()
{
return array(
array('echo https://foo:bar@example.org/', 'echo https://foo:***@example.org/'),
array('echo http://foo@example.org', 'echo http://foo@example.org'),
array('echo http://abcdef1234567890234578:x-oauth-token@github.com/', 'echo http://***:***@github.com/'),
array("svn ls --verbose --non-interactive --username 'foo' --password 'bar' 'https://foo.example.org/svn/'", "svn ls --verbose --non-interactive --username 'foo' --password '***' 'https://foo.example.org/svn/'"),
array("svn ls --verbose --non-interactive --username 'foo' --password 'bar \'bar' 'https://foo.example.org/svn/'", "svn ls --verbose --non-interactive --username 'foo' --password '***' 'https://foo.example.org/svn/'"),
);
2016-06-21 10:01:09 +00:00
}
2016-09-27 12:45:19 +00:00
public function testDoesntHidePorts()
{
$process = new ProcessExecutor($buffer = new BufferIO('', StreamOutput::VERBOSITY_DEBUG));
$process->execute('echo https://localhost:1234/', $output);
$this->assertEquals('Executing command (CWD): echo https://localhost:1234/', trim($buffer->getOutput()));
}
2012-01-22 19:08:29 +00:00
public function testSplitLines()
{
$process = new ProcessExecutor;
$this->assertEquals(array(), $process->splitLines(''));
$this->assertEquals(array(), $process->splitLines(null));
$this->assertEquals(array('foo'), $process->splitLines('foo'));
$this->assertEquals(array('foo', 'bar'), $process->splitLines("foo\nbar"));
$this->assertEquals(array('foo', 'bar'), $process->splitLines("foo\r\nbar"));
2013-06-19 07:43:02 +00:00
$this->assertEquals(array('foo', 'bar'), $process->splitLines("foo\r\nbar\n"));
2012-01-22 19:08:29 +00:00
}
public function testConsoleIODoesNotFormatSymfonyConsoleStyle()
{
$output = new BufferedOutput(OutputInterface::VERBOSITY_NORMAL, true);
2020-01-13 12:45:04 +00:00
$process = new ProcessExecutor(new ConsoleIO(new ArrayInput(array()), $output, new HelperSet(array())));
2020-02-07 06:52:31 +00:00
$process->execute('php -r "echo \'<error>foo</error>\'.PHP_EOL;"');
$this->assertSame('<error>foo</error>'.PHP_EOL, $output->fetch());
}
2021-10-08 18:55:35 +00:00
/**
* Test various arguments are escaped as expected
*
* @dataProvider dataEscapeArguments
*/
public function testEscapeArgument($argument, $win, $unix)
{
$expected = defined('PHP_WINDOWS_VERSION_BUILD') ? $win : $unix;
$this->assertSame($expected, ProcessExecutor::escape($argument));
}
/**
* Each named test is an array of:
* argument, win-expected, unix-expected
*/
public function dataEscapeArguments()
{
return array(
// empty argument - must be quoted
'empty' => array('', '""', "''"),
// null argument - must be quoted
'empty null' => array(null, '""', "''"),
// false argument - must be quoted
'empty false' => array(false, '""', "''"),
// unix single-quote must be escaped
'unix-sq' => array("a'bc", "a'bc", "'a'\\''bc'"),
// CR LF must be replaced
'crlf' => array("a\r\nb\nc\rd", '"a b c d"', "'a\r\nb\nc\rd'"),
// whitespace <space> must be quoted
'ws space' => array('a b c', '"a b c"', "'a b c'"),
// whitespace <tab> must be quoted
'ws tab' => array("a\tb\tc", "\"a\tb\tc\"", "'a\tb\tc'"),
// no whitespace must not be quoted
'no-ws' => array('abc', 'abc', "'abc'"),
// double-quotes must be backslash-escaped
'dq' => array('a"bc', 'a\^"bc', "'a\"bc'"),
// double-quotes must be backslash-escaped with preceeding backslashes doubled
'dq-bslash' => array('a\\"bc', 'a\\\\\^"bc', "'a\\\"bc'"),
// backslashes not preceeding a double-quote are treated as literal
'bslash' => array('ab\\\\c\\', 'ab\\\\c\\', "'ab\\\\c\\'"),
// trailing backslashes must be doubled up when the argument is quoted
'bslash dq' => array('a b c\\\\', '"a b c\\\\\\\\"', "'a b c\\\\'"),
// meta: outer double-quotes must be caret-escaped as well
'meta dq' => array('a "b" c', '^"a \^"b\^" c^"', "'a \"b\" c'"),
// meta: percent expansion must be caret-escaped
'meta-pc1' => array('%path%', '^%path^%', "'%path%'"),
// meta: expansion must have two percent characters
'meta-pc2' => array('%path', '%path', "'%path'"),
// meta: expansion must have have two surrounding percent characters
'meta-pc3' => array('%%path', '%%path', "'%%path'"),
// meta: bang expansion must be double caret-escaped
'meta-bang1' => array('!path!', '^^!path^^!', "'!path!'"),
// meta: bang expansion must have two bang characters
'meta-bang2' => array('!path', '!path', "'!path'"),
// meta: bang expansion must have two surrounding ang characters
'meta-bang3' => array('!!path', '!!path', "'!!path'"),
// meta: caret-escaping must escape all other meta chars (triggered by double-quote)
'meta-all-dq' => array('<>"&|()^', '^<^>\^"^&^|^(^)^^', "'<>\"&|()^'"),
// other meta: no caret-escaping when whitespace in argument
'other meta' => array('<> &| ()^', '"<> &| ()^"', "'<> &| ()^'"),
// other meta: quote escape chars when no whitespace in argument
'other-meta' => array('<>&|()^', '"<>&|()^"', "'<>&|()^'"),
);
}
2012-01-22 19:08:29 +00:00
}