MC-37699: Add support to read-only pub/static directory (magento#781)

Author: shiftedreality

src/Config/Environment.php

@@ -24,6 +24,8 @@ class Environment
     public const VAL_DISABLED = 'disabled';
     public const VARIABLE_CRYPT_KEY = 'CRYPT_KEY';
 
+    public const MOUNT_PUB_STATIC = 'pub/static';
+
     /**
      * The environment variable for controlling the directory nesting level for error reporting
      */
@@ -151,4 +153,23 @@ public function isMasterBranch(): bool
         return !empty($branchName)
             && preg_match(self::GIT_MASTER_BRANCH_RE, $branchName);
     }
+
+    /**
+     * Checks whether application has specific mount.
+     *
+     * The name of the mount may have slash in the beginning (env variable)
+     * or does not have it. Method checks both cases.
+     *
+     * @param string $name
+     * @return bool
+     */
+    public function hasMount(string $name): bool
+    {
+        $application = $this->getApplication();
+
+        $name = ltrim($name, '/');
+        $slashName = '/' . $name;
+
+        return isset($application['mounts'][$name]) || isset($application['mounts'][$slashName]);
+    }
 }

src/Config/EnvironmentData.php

@@ -136,31 +136,56 @@ public function getApplication(): array
             return $this->data['application'];
         }
 
-        $application = $this->getEnvVar(SystemConfigInterface::VAR_ENV_APPLICATION, []);
+        $applicationEnvConfig = $this->getEnvVar(SystemConfigInterface::VAR_ENV_APPLICATION, []);
+        $applicationFileConfig = $this->readApplicationConfig();
 
-        if (!$application) {
+        if (!$applicationEnvConfig) {
+            return $this->data['application'] = $applicationFileConfig;
+        }
+
+        /**
+         * Temporary fix for the case when environment data does not accurately represent file configuration.
+         *
+         * @url https://github.com/magento/magento-cloud-docker/issues/292
+         */
+        if (!isset($applicationEnvConfig['mounts']) && isset($applicationFileConfig['mounts'])) {
+            $applicationEnvConfig['mounts'] = $applicationFileConfig['mounts'];
+        }
+
+        return $this->data['application'] = $applicationEnvConfig;
+    }
+
+    /**
+     * Read file config file if exists.
+     *
+     * @return array
+     */
+    private function readApplicationConfig(): array
+    {
+        $configFile = $this->fileList->getAppConfig();
+
+        if ($this->file->isExists($configFile)) {
             try {
-                $application = Yaml::parse(
-                    $this->file->fileGetContents($this->fileList->getAppConfig())
-                );
-            } catch (FileSystemException $e) {
+                return Yaml::parse($this->file->fileGetContents($configFile));
+            } catch (FileSystemException $exception) {
                 // Do nothing as $application needs to be empty
             }
         }
 
-        return $this->data['application'] = $application;
+        return [];
     }
 
     /**
      * Returns name of environment branch
+     *
      * @return string
      *
      */
     public function getBranchName(): string
     {
         $envVarName = $this->systemConfig->get(SystemConfigInterface::VAR_ENV_ENVIRONMENT);
 
-        return $this->getEnv($envVarName) ? (string) $this->getEnv($envVarName) : '';
+        return $this->getEnv($envVarName) ? (string)$this->getEnv($envVarName) : '';
     }
 
     /**

src/Step/Build/BackupData/StaticContent.php

@@ -9,10 +9,12 @@
 
 use Magento\MagentoCloud\App\Error;
 use Magento\MagentoCloud\App\GenericException;
+use Magento\MagentoCloud\Config\Environment;
 use Magento\MagentoCloud\Filesystem\DirectoryList;
 use Magento\MagentoCloud\Filesystem\Driver\File;
 use Magento\MagentoCloud\Filesystem\FileSystemException;
 use Magento\MagentoCloud\Filesystem\Flag\Manager as FlagManager;
+use Magento\MagentoCloud\Package\UndefinedPackageException;
 use Magento\MagentoCloud\Step\StepException;
 use Magento\MagentoCloud\Step\StepInterface;
 use Psr\Log\LoggerInterface;
@@ -42,28 +44,36 @@ class StaticContent implements StepInterface
      */
     private $flagManager;
 
+    /**
+     * @var Environment
+     */
+    private $environment;
+
     /**
      * @param File $file
      * @param LoggerInterface $logger
      * @param DirectoryList $directoryList
      * @param FlagManager $flagManager
+     * @param Environment $environmentData
      */
     public function __construct(
         File $file,
         LoggerInterface $logger,
         DirectoryList $directoryList,
-        FlagManager $flagManager
+        FlagManager $flagManager,
+        Environment $environmentData
     ) {
         $this->file = $file;
         $this->logger = $logger;
         $this->directoryList = $directoryList;
         $this->flagManager = $flagManager;
+        $this->environment = $environmentData;
     }
 
     /**
      * @inheritdoc
      */
-    public function execute()
+    public function execute(): void
     {
         try {
             $this->flagManager->delete(FlagManager::FLAG_REGENERATE);
@@ -73,17 +83,25 @@ public function execute()
 
                 return;
             }
+        } catch (GenericException $e) {
+            throw new StepException($e->getMessage(), $e->getCode(), $e);
+        }
+
+        if (!$this->environment->hasMount(Environment::MOUNT_PUB_STATIC)) {
+            $this->logger->info('Static content was not moved to ./init directory');
 
+            return;
+        }
+
+        try {
             $initPubStatic = $this->directoryList->getPath(DirectoryList::DIR_INIT) . '/pub/static';
             $originalPubStatic = $this->directoryList->getPath(DirectoryList::DIR_STATIC);
-
-            $this->cleanInitPubStatic($initPubStatic);
-            $this->moveStaticContent($originalPubStatic, $initPubStatic);
-        } catch (StepException $e) {
-            throw $e;
-        } catch (GenericException $e) {
-            throw new StepException($e->getMessage(), $e->getCode(), $e);
+        } catch (UndefinedPackageException $exception) {
+            throw new StepException($exception->getMessage(), $exception->getCode(), $exception);
         }
+
+        $this->cleanInitPubStatic($initPubStatic);
+        $this->moveStaticContent($originalPubStatic, $initPubStatic);
     }
 
     /**

src/Step/Deploy/PreDeploy/CleanStaticContent.php

@@ -27,7 +27,7 @@ class CleanStaticContent implements StepInterface
     /**
      * @var Environment
      */
-    private $env;
+    private $environment;
 
     /**
      * @var LoggerInterface
@@ -56,22 +56,22 @@ class CleanStaticContent implements StepInterface
 
     /**
      * @param LoggerInterface $logger
-     * @param Environment $env
+     * @param Environment $environment
      * @param File $file
      * @param DirectoryList $directoryList
      * @param FlagManager $flagManager
      * @param DeployInterface $stageConfig
      */
     public function __construct(
         LoggerInterface $logger,
-        Environment $env,
+        Environment $environment,
         File $file,
         DirectoryList $directoryList,
         FlagManager $flagManager,
         DeployInterface $stageConfig
     ) {
         $this->logger = $logger;
-        $this->env = $env;
+        $this->environment = $environment;
         $this->file = $file;
         $this->directoryList = $directoryList;
         $this->flagManager = $flagManager;
@@ -83,11 +83,13 @@ public function __construct(
      *
      * {@inheritdoc}
      */
-    public function execute()
+    public function execute(): void
     {
         try {
             if (!$this->flagManager->exists(FlagManager::FLAG_STATIC_CONTENT_DEPLOY_IN_BUILD)
-                || !$this->stageConfig->get(DeployInterface::VAR_CLEAN_STATIC_FILES)) {
+                || !$this->stageConfig->get(DeployInterface::VAR_CLEAN_STATIC_FILES)
+                || !$this->environment->hasMount(Environment::MOUNT_PUB_STATIC)
+            ) {
                 return;
             }
 

src/Test/Unit/Config/EnvironmentDataTest.php

@@ -153,6 +153,9 @@ public function testGetApplicationWithNoSystemVariablesFileExists(): void
     {
         $_ENV = null;
 
+        $this->fileMock->expects($this->once())
+            ->method('isExists')
+            ->willReturn(true);
         $this->fileMock->expects($this->once())
             ->method('fileGetContents')
             ->willReturn('[]');
@@ -165,6 +168,9 @@ public function testGetApplicationWithNoSystemVariablesFileNotExists(): void
         $_ENV = null;
         $exception = new FilesystemException('.magento.app.yaml not exist');
 
+        $this->fileMock->expects($this->once())
+            ->method('isExists')
+            ->willReturn(true);
         $this->fileMock->expects($this->once())
             ->method('fileGetContents')
             ->willThrowException($exception);

src/Test/Unit/Config/EnvironmentTest.php

@@ -148,4 +148,22 @@ public function testGetEnvVarMageErrorReportDirNestingLevel(): void
 
         $this->assertSame(1, $this->environment->getEnvVarMageErrorReportDirNestingLevel());
     }
+
+    public function testHasMount(): void
+    {
+        $this->environmentDataMock->method('getApplication')
+            ->willReturn([
+                'mounts' => [
+                    'test' => [],
+                    '/test_with_slash' => []
+                ]
+            ]);
+
+        self::assertTrue($this->environment->hasMount('test'));
+        self::assertTrue($this->environment->hasMount('/test'));
+        self::assertTrue($this->environment->hasMount('test_with_slash'));
+        self::assertTrue($this->environment->hasMount('/test_with_slash'));
+        self::assertFalse($this->environment->hasMount('/unknown'));
+        self::assertFalse($this->environment->hasMount('unknown'));
+    }
 }