MCLOUD-7400: Add logic to avoid memory limit error with large cloud.log file (#26)

Author: oshmyheliuk

src/App/Logger.php

@@ -102,11 +102,21 @@ private function prepare(): void
      * @param string $deployLogPath deploy log path
      * @param string $buildPhaseLogContent build log content
      * @return bool
-     *
-     * @throws FileSystemException
      */
     private function isBuildLogApplied(string $deployLogPath, string $buildPhaseLogContent): bool
     {
-        return false !== strpos($this->file->fileGetContents($deployLogPath), $buildPhaseLogContent);
+        $buildLogLines = explode(PHP_EOL, $buildPhaseLogContent);
+        if (!isset($buildLogLines[0])) {
+            return true;
+        }
+
+        $needle = strtr(addslashes($buildLogLines[0]), [
+            '[' => '\[',
+            ']' => '\]',
+        ]);
+
+        $result = @shell_exec(sprintf('grep "%s" %s', $needle, $deployLogPath));
+
+        return !empty($result);
     }
 }

src/Test/Unit/App/LoggerTest.php

@@ -15,6 +15,7 @@
 use Magento\MagentoCloud\Filesystem\Driver\File;
 use Magento\MagentoCloud\App\Logger\Pool;
 use Magento\MagentoCloud\Package\UndefinedPackageException;
+use phpmock\phpunit\PHPMock;
 use PHPUnit\Framework\MockObject\MockObject;
 use PHPUnit\Framework\TestCase;
 use Magento\MagentoCloud\App\Logger\Processor\SanitizeProcessor;
@@ -24,6 +25,8 @@
  */
 class LoggerTest extends TestCase
 {
+    use PHPMock;
+
     /**
      * @var File|MockObject
      */
@@ -59,6 +62,8 @@ class LoggerTest extends TestCase
      */
     protected function setUp()
     {
+        self::defineFunctionMock('Magento\MagentoCloud\App', 'shell_exec');
+
         $this->fileMock = $this->createMock(File::class);
         $this->directoryListMock = $this->createMock(DirectoryList::class);
         $this->fileListMock = $this->createMock(FileList::class);
@@ -71,7 +76,6 @@ protected function setUp()
      * @param int $fileMockFileGetContentsExpects
      * @param string $buildPhaseLogContent
      * @param bool $buildLogFileExists
-     * @param string $deployLogContent
      * @param bool $deployLogFileExists
      * @param int $fileMockFilePutContentsExpects
      * @param int $fileMockCopyExpects
@@ -83,7 +87,6 @@ public function testExecute(
         $fileMockFileGetContentsExpects,
         $buildPhaseLogContent,
         $buildLogFileExists,
-        $deployLogContent,
         $deployLogFileExists,
         $fileMockFilePutContentsExpects,
         $fileMockCopyExpects
@@ -107,8 +110,7 @@ public function testExecute(
         $this->fileMock->expects($this->exactly($fileMockFileGetContentsExpects))
             ->method('fileGetContents')
             ->willReturnMap([
-                [$buildPhaseLogPath, false, null, $buildPhaseLogContent],
-                [$deployLogPath, false, null, $deployLogContent],
+                [$buildPhaseLogPath, false, null, $buildPhaseLogContent]
             ]);
         $this->fileMock->expects($this->exactly(2))
             ->method('isExists')
@@ -126,6 +128,14 @@ public function testExecute(
         $this->poolMock->expects($this->once())
             ->method('getHandlers')
             ->willReturn([]);
+        if ($buildLogFileExists && $deployLogFileExists) {
+            $shellExecMock = $this->getFunctionMock(
+                'Magento\MagentoCloud\App',
+                'shell_exec'
+            );
+            $shellExecMock->expects($this->once())
+                ->willReturn($fileMockFilePutContentsExpects ? null : 'some match');
+        }
 
         new Logger(
             $this->fileMock,
@@ -147,25 +157,22 @@ public function executeDataProvider(): array
                 'fileMockFileGetContentsExpects' => 1,
                 'buildPhaseLogContent' => 'the build phase log was not applied',
                 'buildLogFileExists' => true,
-                'deployLogContent' => null,
                 'deployLogFileExists' => false,
                 'fileMockFilePutContentsExpects' => 0,
                 'fileMockCopyExpects' => 1,
             ],
             [
-                'fileMockFileGetContentsExpects' => 2,
+                'fileMockFileGetContentsExpects' => 1,
                 'buildPhaseLogContent' => 'the build phase log was applied',
                 'buildLogFileExists' => true,
-                'deployLogContent' => 'some log the build phase log was applied some log',
                 'deployLogFileExists' => true,
                 'fileMockFilePutContentsExpects' => 0,
                 'fileMockCopyExpects' => 0,
             ],
             [
-                'fileMockFileGetContentsExpects' => 2,
+                'fileMockFileGetContentsExpects' => 1,
                 'buildPhaseLogContent' => 'the build phase log was not applied',
                 'buildLogFileExists' => true,
-                'deployLogContent' => 'some log the build phase log was applied some log',
                 'deployLogFileExists' => true,
                 'fileMockFilePutContentsExpects' => 1,
                 'fileMockCopyExpects' => 0,
@@ -174,7 +181,6 @@ public function executeDataProvider(): array
                 'fileMockFileGetContentsExpects' => 0,
                 'buildPhaseLogContent' => '',
                 'buildLogFileExists' => false,
-                'deployLogContent' => 'some log the build phase log was applied some log',
                 'deployLogFileExists' => true,
                 'fileMockFilePutContentsExpects' => 0,
                 'fileMockCopyExpects' => 0,

src/Test/Unit/Filesystem/FileListTest.php

@@ -166,4 +166,19 @@ public function testGetErrorSchema(): void
     {
         $this->assertSame('root/config/schema.error.yaml', $this->fileList->getErrorSchema());
     }
+
+    public function testGetPatchLog(): void
+    {
+        $this->assertSame('magento_root/var/log/patch.log', $this->fileList->getPatchLog());
+    }
+
+    public function testGetInitPatchLog(): void
+    {
+        $this->assertSame('magento_root/init/var/log/patch.log', $this->fileList->getInitPatchLog());
+    }
+
+    public function testGetErrorDistConfig(): void
+    {
+        $this->assertSame('root/dist/error-codes.md', $this->fileList->getErrorDistConfig());
+    }
 }