MCLOUD-7015: The ece-tool should be able to handle the situation when the opcache.enable_cli is enabled. (#13)

Author: arhiopterecs

scenario/deploy.xml

@@ -1,5 +1,6 @@
 <?xml version="1.0"?>
 <scenario xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:ece-tools:config/scenario.xsd">
+    <step name="php-opcache-reset" type="Magento\MagentoCloud\Step\Deploy\PhpOpcacheReset" priority="50"/>
     <step name="remove-deploy-failed-flag" type="Magento\MagentoCloud\Step\Deploy\RemoveDeployFailedFlag" priority="100"/>
     <step name="pre-deploy" type="Magento\MagentoCloud\Step\Deploy\PreDeploy" priority="200">
         <arguments>

src/Service/Php.php

@@ -31,4 +31,24 @@ public function getVersion(): string
     {
         return $this->getConfiguration()['version'];
     }
+
+    /**
+     * Checks if opcache is enabled for PHP CLI
+     *
+     * @return bool
+     */
+    public function isOpcacheCliEnabled(): bool
+    {
+        return (bool)ini_get('opcache.enable_cli');
+    }
+
+    /**
+     * Resets the contents of the opcache
+     *
+     * @return bool
+     */
+    public function resetOpcache(): bool
+    {
+        return opcache_reset();
+    }
 }

src/Step/Deploy/PhpOpcacheReset.php

@@ -0,0 +1,51 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\MagentoCloud\Step\Deploy;
+
+use Magento\MagentoCloud\Service\Php;
+use Magento\MagentoCloud\Step\StepInterface;
+use Psr\Log\LoggerInterface;
+
+/**
+ * Flushes the contents of the opcache if the PHP CLI opcache is enabled
+ */
+class PhpOpcacheReset implements StepInterface
+{
+    /**
+     * @var LoggerInterface
+     */
+    private $logger;
+
+    /**
+     * @var Php
+     */
+    private $php;
+
+    /**
+     * @param LoggerInterface $logger
+     * @param Php $php
+     */
+    public function __construct(
+        LoggerInterface $logger,
+        Php $php
+    ) {
+        $this->logger = $logger;
+        $this->php = $php;
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function execute()
+    {
+        if ($this->php->isOpcacheCliEnabled()) {
+            $this->logger->notice('Reset the contents of the opcache');
+            $this->php->resetOpcache();
+        }
+    }
+}

src/Test/Unit/Step/Deploy/PhpOpcacheResetTest.php

@@ -0,0 +1,81 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\MagentoCloud\Test\Unit\Step\Deploy;
+
+use Magento\MagentoCloud\Service\Php;
+use Magento\MagentoCloud\Step\Deploy\PhpOpcacheReset;
+use PHPUnit\Framework\MockObject\MockObject;
+use PHPUnit\Framework\TestCase;
+use Psr\Log\LoggerInterface;
+
+/**
+ * @inheritdoc
+ */
+class PhpOpcacheResetTest extends TestCase
+{
+    /**
+     * @var PhpOpcacheReset
+     */
+    private $step;
+
+    /**
+     * @var LoggerInterface|MockObject
+     */
+    private $loggerMock;
+
+    /**
+     * @var Php|MockObject
+     */
+    private $phpMock;
+
+    /**
+     * @inheritdoc
+     */
+    protected function setUp(): void
+    {
+        $this->loggerMock = $this->getMockForAbstractClass(LoggerInterface::class);
+        $this->phpMock = $this->createMock(Php::class);
+
+        $this->step = new PhpOpcacheReset(
+            $this->loggerMock,
+            $this->phpMock
+        );
+    }
+
+    /**
+     * Opcache Cli Enabled
+     */
+    public function testExecuteOpcacheCliEnabled(): void
+    {
+        $this->phpMock->expects($this->once())
+            ->method('isOpcacheCliEnabled')
+            ->willReturn(true);
+        $this->loggerMock->expects($this->once())
+            ->method('notice')
+            ->with('Reset the contents of the opcache');
+        $this->phpMock->expects($this->once())
+            ->method('resetOpcache');
+        $this->step->execute();
+    }
+
+    /**
+     * Opcache Cli No Enabled
+     */
+    public function testExecuteOpcacheCliNoEnabled(): void
+    {
+        $this->phpMock->expects($this->once())
+            ->method('isOpcacheCliEnabled')
+            ->willReturn(false);
+        $this->loggerMock->expects($this->never())
+            ->method('notice');
+        $this->phpMock->expects($this->never())
+            ->method('resetOpcache');
+
+        $this->step->execute();
+    }
+}