Fix invalid files being listed in "log" command (#1361)

Ignores output from other processes during the SSH connection

src/Command/Environment/EnvironmentLogCommand.php

@@ -3,6 +3,7 @@
 
 use Platformsh\Cli\Command\CommandBase;
 use Platformsh\Cli\Util\OsUtil;
+use Platformsh\Cli\Util\StringUtil;
 use Stecman\Component\Symfony\Console\BashCompletion\Completion\CompletionAwareInterface;
 use Stecman\Component\Symfony\Console\BashCompletion\CompletionContext;
 use Symfony\Component\Console\Exception\InvalidArgumentException;
@@ -73,7 +74,10 @@ protected function execute(InputInterface $input, OutputInterface $output)
             /** @var \Doctrine\Common\Cache\CacheProvider $cache */
             $cache = $this->getService('cache');
             if (!$result = $cache->fetch($cacheKey)) {
-                $result = $host->runCommand('ls -1 ' . $logDir . '/*.log');
+                $result = $host->runCommand('echo -n _BEGIN_FILE_LIST_; ls -1 ' . $logDir . '/*.log; echo -n _END_FILE_LIST_');
+                if (is_string($result)) {
+                    $result = trim(StringUtil::between($result, '_BEGIN_FILE_LIST_', '_END_FILE_LIST_'));
+                }
 
                 // Cache the list for 1 day.
                 $cache->save($cacheKey, $result, 86400);
@@ -84,7 +88,7 @@ protected function execute(InputInterface $input, OutputInterface $output)
                 $logDir . '/access.log',
                 $logDir . '/error.log',
             ];
-            $files = $result ? explode("\n", $result) : $defaultFiles;
+            $files = $result && is_string($result) ? explode("\n", $result) : $defaultFiles;
 
             // Ask the user to choose a file.
             $files = array_combine($files, array_map(function ($file) {

src/Service/RemoteEnvVars.php

@@ -5,6 +5,7 @@
 use Doctrine\Common\Cache\CacheProvider;
 use Platformsh\Cli\Model\Host\HostInterface;
 use Platformsh\Cli\Model\Host\LocalHost;
+use Platformsh\Cli\Util\StringUtil;
 
 /**
  * A service for reading environment variables on a host.
@@ -61,7 +62,7 @@ public function getEnvVar($variable, HostInterface $host, $refresh = false, $ttl
         $data = $this->cache->fetch($cacheKey);
         if ($refresh || $data === false || $data['last_changed'] !== $host->lastChanged()) {
             $output = $host->runCommand(\sprintf('echo -n \'%s\'"$%s"\'%s\'', $begin, $varName, $end));
-            $value = $this->extractResult($output, $begin, $end);
+            $value = StringUtil::between((string) $output, $begin, $end);
             $data = ['last_changed' => $host->lastChanged(), 'value' => $value];
             $this->cache->save($cacheKey, $data, $ttl);
         } else {
@@ -71,27 +72,6 @@ public function getEnvVar($variable, HostInterface $host, $refresh = false, $ttl
         return $value ?: '';
     }
 
-    /**
-     * Extracts a result from 'echo' output between beginning and ending delimiters.
-     *
-     * @param string $output
-     * @param string $begin
-     * @param string $end
-     *
-     * @return string
-     */
-    private function extractResult($output, $begin, $end)
-    {
-        $first = \strpos($output, $begin);
-        $last = \strrpos($output, $end, $first);
-        if ($first === false || $last === false) {
-            return $output;
-        }
-        $offset = $first + \strlen($begin);
-        $length = $last - $first - \strlen($begin);
-        return \substr($output, $offset, $length);
-    }
-
     /**
      * Read a complex environment variable (an associative array) from the application.
      *

src/Util/StringUtil.php

@@ -0,0 +1,28 @@
+<?php
+
+namespace Platformsh\Cli\Util;
+
+class StringUtil
+{
+    /**
+     * Finds a substring between two delimiters.
+     *
+     * @param string $str
+     * @param string $begin
+     * @param string $end
+     *
+     * @return string|null
+     *   The substring, or null if the delimiters are not found.
+     */
+    public static function between($str, $begin, $end)
+    {
+        $first = \strpos($str, $begin);
+        $last = \strrpos($str, $end, $first);
+        if ($first === false || $last === false) {
+            return null;
+        }
+        $offset = $first + \strlen($begin);
+        $length = $last - $first - \strlen($begin);
+        return \substr($str, $offset, $length);
+    }
+}

tests/Util/StringUtilTest.php

@@ -0,0 +1,24 @@
+<?php
+
+namespace Platformsh\Cli\Tests\Util;
+
+use Platformsh\Cli\Util\StringUtil;
+
+class StringUtilTest extends \PHPUnit_Framework_TestCase
+{
+    public function testBetween()
+    {
+        $cases = [
+            ['_BEGIN_foo_END_', '_BEGIN_', '_END_', 'foo'],
+            ['_BEGIN_foo bar', '_BEGIN_', '_END_', null],
+            ['_BEGIN_foo bar_END_', '_BEGIN_', '_END_', 'foo bar'],
+            ["_BEGIN_\nfoo\n_END_", '_BEGIN_', '_END_', "\nfoo\n"],
+            ["_BEGIN_\nfoo\n_END_", "_BEGIN_\n", '_END_', "foo\n"],
+            ["_BEGIN_\nfoo\n_END_", "_BEGIN_\n", "\n_END_", 'foo'],
+        ];
+        foreach ($cases as $key => $case) {
+            list($str, $begin, $end, $result) = $case;
+            $this->assertEquals($result, StringUtil::between($str, $begin, $end), "case $key");
+        }
+    }
+}