[Process] Allow writing portable "prepared" command lines

Amrouche Hamza · Amrouche Hamza · commit c49cbb662140 · 2017-12-16T05:52:45.000+01:00
diff --git a/src/Symfony/Component/Process/Process.php b/src/Symfony/Component/Process/Process.php
@@ -273,7 +273,10 @@ public function start(callable $callback = null, array $env = array())
 
         $options = array('suppress_errors' => true);
 
-        if ('\\' === DIRECTORY_SEPARATOR) {
+        $windows = '\\' === DIRECTORY_SEPARATOR;
+        $commandline = $this->replacePlaceholder($commandline, $windows, $env);
+
+        if ($windows) {
             $options['bypass_shell'] = true;
             $commandline = $this->prepareWindowsCommandLine($commandline, $env);
         } elseif (!$this->useFileHandles && $this->isSigchildEnabled()) {
@@ -1541,6 +1544,35 @@ private function escapeArgument(string $argument): string
         return '"'.str_replace(array('"', '^', '%', '!', "\n"), array('""', '"^^"', '"^%"', '"^!"', '!LF!'), $argument).'"';
     }
 
+    private function replacePlaceholder($commandLine, $windows, $env)
+    {
+        $toReplace = $windows ? array('!', '!') : array('$', '');
+        if (!preg_match_all('/\{([a-zA-Z0-9]+?)\}/', $commandLine, $matches)) {
+            return $commandLine;
+        }
+
+        $patterns = $replacements = array();
+        $isInEnv = false;
+        foreach ($matches as $match) {
+            $patterns[] = sprintf('/{%s}/', $match[0]);
+            $replacements[] = sprintf('%s%s%s', $toReplace[0], $match[0], $toReplace[1]);
+            if (isset($env[$match[0]])) {
+                $isInEnv = true;
+                unset($env[$match[0]]);
+            }
+        }
+
+        if (!$isInEnv) {
+            throw new InvalidArgumentException(sprintf('There are no passed env for the command line "%s", replacement cannot be done.', $commandLine));
+        }
+
+        if (!empty($env)) {
+            throw new InvalidArgumentException(sprintf('Placeholder%s "%s" %s exist.', count($env) > 1 ? 's' : '', implode(',', array_keys($env)), count($env) > 1 ? 'doesn\'t' : 'don\'t'));
+        }
+
+        return preg_replace($patterns, $replacements, $commandLine);
+    }
+
     private function getDefaultEnv()
     {
         $env = getenv();
diff --git a/src/Symfony/Component/Process/Tests/ProcessTest.php b/src/Symfony/Component/Process/Tests/ProcessTest.php
@@ -1474,6 +1474,62 @@ public function provideEscapeArgument()
         yield array('éÉèÈàÀöä');
     }
 
+    public function testPreparedCommand()
+    {
+        $p = new Process('echo {abc}');
+        $p->run(null, array('abc' => 'ABC'));
+
+        $expected = <<<EOTXT
+ABC\n
+EOTXT;
+        $this->assertSame($expected, $p->getOutput());
+    }
+
+    /**
+     * @expectedException \Symfony\Component\Process\Exception\InvalidArgumentException
+     * @expectedExceptionMessage Placeholder "bcd" don't exist
+     */
+    public function testPreparedCommandWithTooMuchEnv()
+    {
+        $p = new Process('echo {abc}');
+        $p->run(null, array('abc' => 'ABC', 'bcd' => 'ABC'));
+
+        $expected = <<<EOTXT
+ABC\n
+EOTXT;
+        $this->assertSame($expected, $p->getOutput());
+    }
+
+    /**
+     * @expectedException \Symfony\Component\Process\Exception\InvalidArgumentException
+     * @expectedExceptionMessage Placeholders "bcd,zaza" doesn't exist
+     */
+    public function testPreparedCommandWithTwoMoreEnvs()
+    {
+        $p = new Process('echo {abc}');
+        $p->run(null, array('abc' => 'ABC', 'bcd' => 'ABC', 'zaza' => 'ABC'));
+
+        $expected = <<<EOTXT
+ABC\n
+EOTXT;
+        $this->assertSame($expected, $p->getOutput());
+    }
+
+    /**
+     * @expectedException \Symfony\Component\Process\Exception\InvalidArgumentException
+     * @expectedExceptionMessage There are no passed env for the command line "echo {abc}", replacement cannot be done.
+     */
+    public function testPreparedCommandWithoutProvidedParam()
+    {
+        $p = new Process('echo {abc}');
+        $p->run(null, array('bcd' => 'ABC'));
+
+        $expected = <<<EOTXT
+ABC
+EOTXT;
+        $this->assertSame($expected, $p->getOutput());
+    }
+
     public function testEnvArgument()
     {
         $env = array('FOO' => 'Foo', 'BAR' => 'Bar');
