MAGECLOUD-4127: Build fails with empty config.php (magento#651)

Author: shiftedreality

composer.json

@@ -68,19 +68,19 @@
     }
   },
   "scripts": {
-    "test": [
-      "@phpstan",
-      "@phpcs",
-      "@phpmd",
-      "@phpunit",
-      "@coverage"
+    "test:all": [
+      "@test:phpstan",
+      "@test:phpcs",
+      "@test:phpmd",
+      "@test:phpunit",
+      "@test:coverage"
     ],
-    "phpstan": "phpstan analyse -c tests/static/phpstan.neon",
-    "phpcs": "phpcs src --standard=tests/static/phpcs-ruleset.xml -p -n",
-    "phpmd": "phpmd src xml tests/static/phpmd-ruleset.xml",
-    "phpunit": "phpunit --configuration tests/unit",
-    "coverage": "phpunit --configuration tests/unit --coverage-clover tests/unit/tmp/clover.xml && php tests/unit/code-coverage.php tests/unit/tmp/clover.xml",
-    "coverage-generate": "phpunit --configuration tests/unit --coverage-html tests/unit/tmp/coverage",
+    "test:phpstan": "phpstan analyse -c tests/static/phpstan.neon",
+    "test:phpcs": "phpcs src --standard=tests/static/phpcs-ruleset.xml -p -n",
+    "test:phpmd": "phpmd src xml tests/static/phpmd-ruleset.xml",
+    "test:phpunit": "phpunit --configuration tests/unit",
+    "test:coverage": "phpunit --configuration tests/unit --coverage-clover tests/unit/tmp/clover.xml && php tests/unit/code-coverage.php tests/unit/tmp/clover.xml",
+    "test:coverage-generate": "phpunit --configuration tests/unit --coverage-html tests/unit/tmp/coverage",
     "pre-autoload-dump": [
       "Magento\\MagentoCloud\\Composer\\ClearAutoload::preAutoloadDump"
     ]

src/Command/ConfigDump/Generate.php

@@ -10,7 +10,7 @@
 use Magento\MagentoCloud\DB\ConnectionInterface;
 use Magento\MagentoCloud\Filesystem\Driver\File;
 use Magento\MagentoCloud\Filesystem\FileSystemException;
-use Magento\MagentoCloud\Filesystem\Resolver\SharedConfig;
+use Magento\MagentoCloud\Config\Magento\Shared\Resolver;
 use Magento\MagentoCloud\Package\MagentoVersion;
 use Magento\MagentoCloud\Package\UndefinedPackageException;
 use Magento\MagentoCloud\Util\ArrayManager;
@@ -53,9 +53,9 @@ class Generate
     private $arrayManager;
 
     /**
-     * @var SharedConfig
+     * @var Resolver
      */
-    private $sharedConfig;
+    private $resolver;
 
     /**
      * @var MagentoVersion
@@ -72,21 +72,21 @@ class Generate
      * @param File $file
      * @param ArrayManager $arrayManager
      * @param MagentoVersion $magentoVersion
-     * @param SharedConfig $sharedConfig
+     * @param Resolver $resolver
      * @param PhpFormatter $phpFormatter
      */
     public function __construct(
         ConnectionInterface $connection,
         File $file,
         ArrayManager $arrayManager,
         MagentoVersion $magentoVersion,
-        SharedConfig $sharedConfig,
+        Resolver $resolver,
         PhpFormatter $phpFormatter
     ) {
         $this->connection = $connection;
         $this->file = $file;
         $this->arrayManager = $arrayManager;
-        $this->sharedConfig = $sharedConfig;
+        $this->resolver = $resolver;
         $this->magentoVersion = $magentoVersion;
         $this->phpFormatter = $phpFormatter;
     }
@@ -97,14 +97,15 @@ public function __construct(
      * @throws UndefinedPackageException
      * @throws FileSystemException
      */
-    public function execute()
+    public function execute(): void
     {
         if ($this->magentoVersion->isGreaterOrEqual('2.2')) {
             $this->configKeys[] = 'modules';
         }
 
-        $configFile = $this->sharedConfig->resolve();
-        $oldConfig = require $configFile;
+        $configFile = $this->resolver->getPath();
+        $oldConfig = $this->resolver->read();
+
         $newConfig = [];
 
         foreach ($this->configKeys as $requiredConfigKey) {
@@ -165,7 +166,7 @@ public function execute()
      * @param string $scope Name of scope: websites or stores
      * @return array Result of config data after filtering
      */
-    private function filterSystemData($config, $scope)
+    private function filterSystemData($config, $scope): array
     {
         $scopeCodes = isset($config['system'][$scope])
             ? array_keys($config['system'][$scope])

src/Config/Environment.php

@@ -26,7 +26,7 @@ class Environment
     /**
      * The environment variable for controlling the directory nesting level for error reporting
      */
-    private const ENV_MAGE_ERROR_REPORT_DIR_NESTING_LEVEL = 'MAGE_ERROR_REPORT_DIR_NESTING_LEVEL';
+    public const ENV_MAGE_ERROR_REPORT_DIR_NESTING_LEVEL = 'MAGE_ERROR_REPORT_DIR_NESTING_LEVEL';
 
     /**
      * @var EnvironmentDataInterface

src/Config/Magento/Shared/Reader.php

@@ -46,6 +46,8 @@ public function read(): array
             return [];
         }
 
-        return require $configPath;
+        $content = $this->file->requireFile($configPath);
+
+        return is_array($content) ? $content : [];
     }
 }

src/Config/Magento/Shared/Resolver.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\Config\Magento\Shared;
+
+use Magento\MagentoCloud\Filesystem\ConfigFileList;
+use Magento\MagentoCloud\Filesystem\Driver\File;
+use Magento\MagentoCloud\Package\MagentoVersion;
+use Magento\MagentoCloud\Package\UndefinedPackageException;
+
+/**
+ * Resolves the correct config file depending on Magento version
+ *
+ * Possible files: app/etc/config.php or app/etc/config.php.local
+ *
+ * @deprecated should be removed with dropping Magento 2.1 support
+ */
+class Resolver
+{
+    /**
+     * @var ConfigFileList
+     */
+    private $configFileList;
+
+    /**
+     * @var MagentoVersion
+     */
+    private $magentoVersion;
+
+    /**
+     * @var File
+     */
+    private $file;
+
+    /**
+     * @param ConfigFileList $configFileList
+     * @param MagentoVersion $magentoVersion
+     * @param File $file
+     */
+    public function __construct(ConfigFileList $configFileList, MagentoVersion $magentoVersion, File $file)
+    {
+        $this->configFileList = $configFileList;
+        $this->magentoVersion = $magentoVersion;
+        $this->file = $file;
+    }
+
+    /**
+     * Get the resolved config path according to Magento version
+     *
+     * @throws UndefinedPackageException
+     */
+    public function getPath(): string
+    {
+        return $this->magentoVersion->isGreaterOrEqual('2.2')
+            ? $this->configFileList->getConfig()
+            : $this->configFileList->getConfigLocal();
+    }
+
+    /**
+     * Read the contents of resolved config according to Magento version
+     *
+     * @return array
+     * @throws UndefinedPackageException
+     */
+    public function read(): array
+    {
+        $configPath = $this->getPath();
+
+        if (!$this->file->isExists($configPath)) {
+            return [];
+        }
+
+        $content = $this->file->requireFile($configPath);
+
+        return is_array($content) ? $content : [];
+    }
+}

src/Config/Module.php

@@ -55,6 +55,9 @@ public function __construct(ReaderInterface $reader, WriterInterface $writer, Sh
      */
     public function refresh(): array
     {
+        // Update initial config file to avoid broken file error.
+        $this->writer->update(['modules' => []]);
+
         $moduleConfig = $this->reader->read()['modules'] ?? [];
 
         $this->magentoShell->execute('module:enable --all');

src/Config/Validator/Build/ConfigFileStructure.php

@@ -9,8 +9,8 @@
 
 use Magento\MagentoCloud\Config\Validator;
 use Magento\MagentoCloud\Config\ValidatorInterface;
-use Magento\MagentoCloud\Filesystem\Driver\File;
-use Magento\MagentoCloud\Filesystem\Resolver\SharedConfig;
+use Magento\MagentoCloud\Config\Magento\Shared\Resolver;
+use Magento\MagentoCloud\Package\UndefinedPackageException;
 use Magento\MagentoCloud\Util\ArrayManager;
 
 /**
@@ -26,47 +26,42 @@ class ConfigFileStructure implements ValidatorInterface
      */
     private $arrayManager;
 
-    /**
-     * @var File
-     */
-    private $file;
-
     /**
      * @var Validator\ResultFactory
      */
     private $resultFactory;
 
     /**
-     * @var SharedConfig
+     * @var Resolver
      */
-    private $configResolver;
+    private $resolver;
 
     /**
      * @param ArrayManager $arrayManager
-     * @param File $file
      * @param Validator\ResultFactory $resultFactory
-     * @param SharedConfig $configResolver
+     * @param Resolver $resolver
      */
     public function __construct(
         ArrayManager $arrayManager,
-        File $file,
         Validator\ResultFactory $resultFactory,
-        SharedConfig $configResolver
+        Resolver $resolver
     ) {
         $this->arrayManager = $arrayManager;
-        $this->file = $file;
         $this->resultFactory = $resultFactory;
-        $this->configResolver = $configResolver;
+        $this->resolver = $resolver;
     }
 
     /**
-     * @inheritdoc
+     * {@inheritdoc}
+     *
+     * @throws UndefinedPackageException
      */
     public function validate(): Validator\ResultInterface
     {
-        $configFile = $this->configResolver->resolve();
+        $configFile = $this->resolver->getPath();
+        $config = $this->resolver->read();
+
         $configFileName = basename($configFile);
-        $config = $this->file->isExists($configFile) ? $this->file->requireFile($configFile) : [];
 
         $flattenedConfig = $this->arrayManager->flatten($config);
         $websites = $this->arrayManager->filter($flattenedConfig, 'scopes/websites', false);