diogo/symfony
Archived
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

feature #24763 [Process] Allow writing portable "prepared" command lines (Simperfit)

Browse Source 
This PR was merged into the 4.1-dev branch.

Discussion
----------

[Process] Allow writing portable "prepared" command lines

| Q             | A
| ------------- | ---
| Branch?       | 4.1
| Bug fix?      | no
| New feature?  | yes
| BC breaks?    | no
| Deprecations? | no
| Tests pass?   | yes
| Fixed tickets | #23778
| License       | MIT
| Doc PR        | symfony/symfony-docs#9295

This give the opportunity to create process commands that allow to changes only the values instead of changing the code.

Commits
-------

d1e4f489d1 [Process] Allow writing portable "prepared" command lines
This commit is contained in:
Kévin Dunglas 2018-02-19 15:07:44 +01:00
commit 136408937b
No known key found for this signature in database
GPG Key ID: 4D04EBEF06AAF3A6
2 changed files with 57 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
src/Symfony/Component/Process/Process.php
View File

@ -258,6 +258,10 @@ class Process implements \IteratorAggregate
$this->hasCallback = null !== $callback;
$descriptors = $this->getDescriptors();
if ($this->env) {
$env += $this->env;
}
if (is_array($commandline = $this->commandline)) {
$commandline = implode(' ', array_map(array($this, 'escapeArgument'), $commandline));
@ -265,11 +269,10 @@ class Process implements \IteratorAggregate
// exec is mandatory to deal with sending a signal to the process
$commandline = 'exec '.$commandline;
}
} else {
$commandline = $this->replacePlaceholders($commandline, $env);
}
if ($this->env) {
$env += $this->env;
}
$env += $this->getDefaultEnv();
$options = array('suppress_errors' => true);
@ -1549,6 +1552,29 @@ class Process implements \IteratorAggregate
return '"'.str_replace(array('"', '^', '%', '!', "\n"), array('""', '"^^"', '"^%"', '"^!"', '!LF!'), $argument).'"';
}
private function replacePlaceholders(string $commandline, array $env)
{
$pattern = '\\' === DIRECTORY_SEPARATOR ? '!%s!' : '${%s}';
return preg_replace_callback('/\{\{ ?([_a-zA-Z0-9]++) ?\}\}/', function ($m) use ($pattern, $commandline, $env) {
if (!isset($env[$m[1]]) || false === $env[$m[1]]) {
foreach ($env as $k => $v) {
if (false === $v) {
unset($env[$k]);
}
}
if (!$env) {
throw new InvalidArgumentException(sprintf('Invalid command line "%s": no values provided for any placeholders.', $commandline));
}
$env = implode('", "', array_keys($env));
throw new InvalidArgumentException(sprintf('Invalid command line "%s": no value provided for placeholder "%s", did you mean "%s"?', $commandline, $m[1], $env));
}
return sprintf($pattern, $m[1]);
}, $commandline);
}
private function getDefaultEnv()
{
$env = array();

28
src/Symfony/Component/Process/Tests/ProcessTest.php
View File

@ -1474,6 +1474,34 @@ EOTXT;
yield array('éÉèÈàÀöä');
}
public function testPreparedCommand()
{
$p = new Process('echo {{ abc }}DEF');
$p->run(null, array('abc' => 'ABC'));
$this->assertSame('ABCDEF', rtrim($p->getOutput()));
}
/**
* @expectedException \Symfony\Component\Process\Exception\InvalidArgumentException
* @expectedExceptionMessage Invalid command line "echo {{ abc }}": no value provided for placeholder "abc", did you mean "bcd"?
*/
public function testPreparedCommandWithMissingValue()
{
$p = new Process('echo {{ abc }}');
$p->run(null, array('bcd' => 'BCD'));
}
/**
* @expectedException \Symfony\Component\Process\Exception\InvalidArgumentException
* @expectedExceptionMessage Invalid command line "echo {{ abc }}": no values provided for any placeholders.
*/
public function testPreparedCommandWithNoValues()
{
$p = new Process('echo {{ abc }}');
$p->run();
}
public function testEnvArgument()
{
$env = array('FOO' => 'Foo', 'BAR' => 'Bar');