MCLOUD-6939: Errors occur running magento commands in composer cloud docker installation (#2)

Author: oshmyheliuk

config/schema.yaml

@@ -176,6 +176,17 @@ variables:
       - stage:
           global:
             SKIP_HTML_MINIFICATION: true
+  SKIP_COMPOSER_DUMP_AUTOLOAD:
+    description: Skip running compose dump-autoload command
+    type: boolean
+    stages:
+      - build
+    default:
+      build: false
+    examples:
+      - stage:
+          build:
+            SKIP_COMPOSER_DUMP_AUTOLOAD: true
   SCD_ON_DEMAND:
     description: Enable generation of static content when requested by a user.
       Pre-loading the cache using the post_deploy hook reduces site downtime.

src/Config/Stage/BuildInterface.php

@@ -30,4 +30,9 @@ interface BuildInterface extends StageConfigInterface
      * Magento quality patches list
      */
     public const VAR_QUALITY_PATCHES = 'QUALITY_PATCHES';
+
+    /**
+     * Skip composer dump-autoload
+     */
+    public const VAR_SKIP_COMPOSER_DUMP_AUTOLOAD = 'SKIP_COMPOSER_DUMP_AUTOLOAD';
 }

src/Step/Build/ComposerDumpAutoload.php

@@ -8,10 +8,13 @@
 namespace Magento\MagentoCloud\Step\Build;
 
 use Magento\MagentoCloud\App\Error;
+use Magento\MagentoCloud\Config\ConfigException;
 use Magento\MagentoCloud\Step\StepException;
 use Magento\MagentoCloud\Step\StepInterface;
 use Magento\MagentoCloud\Shell\ShellException;
 use Magento\MagentoCloud\Shell\ShellInterface;
+use Magento\MagentoCloud\Config\Stage\BuildInterface;
+use Psr\Log\LoggerInterface;
 
 /**
  * @inheritdoc
@@ -23,12 +26,25 @@ class ComposerDumpAutoload implements StepInterface
      */
     private $shell;
 
+    /**
+     * @var BuildInterface
+     */
+    private $stageConfig;
+    /**
+     * @var LoggerInterface
+     */
+    private $logger;
+
     /**
      * @param ShellInterface $shell
+     * @param BuildInterface $stageConfig
+     * @param LoggerInterface $logger
      */
-    public function __construct(ShellInterface $shell)
+    public function __construct(ShellInterface $shell, BuildInterface $stageConfig, LoggerInterface $logger)
     {
         $this->shell = $shell;
+        $this->stageConfig = $stageConfig;
+        $this->logger = $logger;
     }
 
     /**
@@ -37,7 +53,17 @@ public function __construct(ShellInterface $shell)
     public function execute()
     {
         try {
+            if ($this->stageConfig->get(BuildInterface::VAR_SKIP_COMPOSER_DUMP_AUTOLOAD)) {
+                $this->logger->info(sprintf(
+                    'The composer dump-autoload command was skipped as %s variable is set to true',
+                    BuildInterface::VAR_SKIP_COMPOSER_DUMP_AUTOLOAD
+                ));
+
+                return;
+            }
             $this->shell->execute('composer dump-autoload -o --ansi --no-interaction');
+        } catch (ConfigException $e) {
+            throw new StepException($e->getMessage(), $e->getCode(), $e);
         } catch (ShellException $e) {
             throw new StepException($e->getMessage(), Error::BUILD_COMPOSER_DUMP_AUTOLOAD_FAILED, $e);
         }

src/Test/Unit/Config/SchemaTest.php

@@ -77,7 +77,8 @@ public function testGetDefaultsForBuild(): void
                 BuildInterface::VAR_SCD_MAX_EXEC_TIME => null,
                 BuildInterface::VAR_ERROR_REPORT_DIR_NESTING_LEVEL => 1,
                 BuildInterface::VAR_SCD_USE_BALER => false,
-                BuildInterface::VAR_QUALITY_PATCHES => []
+                BuildInterface::VAR_QUALITY_PATCHES => [],
+                BuildInterface::VAR_SKIP_COMPOSER_DUMP_AUTOLOAD => false,
             ],
             $this->schema->getDefaults(StageConfigInterface::STAGE_BUILD)
         );

src/Test/Unit/Step/Build/ComposerDumpAutoloadTest.php

@@ -8,12 +8,15 @@
 namespace Magento\MagentoCloud\Test\Unit\Step\Build;
 
 use Magento\MagentoCloud\App\Error;
+use Magento\MagentoCloud\Config\ConfigException;
+use Magento\MagentoCloud\Config\Stage\BuildInterface;
 use Magento\MagentoCloud\Step\Build\ComposerDumpAutoload;
 use Magento\MagentoCloud\Shell\ShellException;
 use Magento\MagentoCloud\Shell\ShellInterface;
 use Magento\MagentoCloud\Step\StepException;
 use PHPUnit\Framework\MockObject\MockObject;
 use PHPUnit\Framework\TestCase;
+use Psr\Log\LoggerInterface;
 
 /**
  * @inheritdoc
@@ -28,18 +31,31 @@ class ComposerDumpAutoloadTest extends TestCase
     /**
      * @var ShellInterface|MockObject
      */
-    private $shell;
+    private $shellMock;
+
+    /**
+     * @var BuildInterface|MockObject
+     */
+    private $stageConfigMock;
+
+    /**
+     * @var LoggerInterface|MockObject
+     */
+    private $loggerMock;
 
     /**
      * @inheritdoc
      */
     protected function setUp(): void
     {
-        $this->shell = $this->getMockBuilder(ShellInterface::class)
-            ->getMockForAbstractClass();
+        $this->shellMock = $this->getMockForAbstractClass(ShellInterface::class);
+        $this->stageConfigMock = $this->getMockForAbstractClass(BuildInterface::class);
+        $this->loggerMock = $this->getMockForAbstractClass(LoggerInterface::class);
 
         $this->step = new ComposerDumpAutoload(
-            $this->shell
+            $this->shellMock,
+            $this->stageConfigMock,
+            $this->loggerMock
         );
     }
 
@@ -48,13 +64,37 @@ protected function setUp(): void
      */
     public function testExecute(): void
     {
-        $this->shell->expects($this->once())
+        $this->stageConfigMock->expects($this->once())
+            ->method('get')
+            ->with(BuildInterface::VAR_SKIP_COMPOSER_DUMP_AUTOLOAD)
+            ->willReturn(false);
+        $this->shellMock->expects($this->once())
             ->method('execute')
             ->with('composer dump-autoload -o --ansi --no-interaction');
 
         $this->step->execute();
     }
 
+    /**
+     * @throws StepException
+     */
+    public function testExecuteDumpSkipped(): void
+    {
+        $this->stageConfigMock->expects($this->once())
+            ->method('get')
+            ->with(BuildInterface::VAR_SKIP_COMPOSER_DUMP_AUTOLOAD)
+            ->willReturn(true);
+        $this->loggerMock->expects($this->once())
+            ->method('info')
+            ->with(
+                'The composer dump-autoload command was skipped as SKIP_COMPOSER_DUMP_AUTOLOAD variable is set to true'
+            );
+        $this->shellMock->expects($this->never())
+            ->method('execute');
+
+        $this->step->execute();
+    }
+
     /**
      * @throws StepException
      */
@@ -64,11 +104,29 @@ public function testExecuteWithException(): void
         $this->expectExceptionMessage('something went wrong');
         $this->expectExceptionCode(Error::BUILD_COMPOSER_DUMP_AUTOLOAD_FAILED);
 
-        $this->shell->expects($this->once())
+        $this->shellMock->expects($this->once())
             ->method('execute')
             ->with('composer dump-autoload -o --ansi --no-interaction')
             ->willThrowException(new ShellException('something went wrong'));
 
         $this->step->execute();
     }
+
+    /**
+     * @throws StepException
+     */
+    public function testExecuteWithConfigException(): void
+    {
+        $this->expectException(StepException::class);
+        $this->expectExceptionMessage('something went wrong');
+        $this->expectExceptionCode(10);
+
+        $this->stageConfigMock->expects($this->once())
+            ->method('get')
+            ->willThrowException(new ConfigException('something went wrong', 10));
+        $this->shellMock->expects($this->never())
+            ->method('execute');
+
+        $this->step->execute();
+    }
 }