Issue 667 : Extend environment data to be read from local file (magento#722)

Author: Barny Shergold

src/Config/EnvironmentData.php

@@ -9,6 +9,10 @@
 
 use Magento\MagentoCloud\Config\System\Variables;
 use Magento\MagentoCloud\PlatformVariable\DecoderInterface;
+use Magento\MagentoCloud\Filesystem\FileList;
+use Magento\MagentoCloud\Filesystem\Driver\File;
+use Magento\MagentoCloud\Filesystem\FileSystemException;
+use Symfony\Component\Yaml\Yaml;
 
 /**
  * Returns cloud environment data.
@@ -30,16 +34,34 @@ class EnvironmentData implements EnvironmentDataInterface
      */
     private $data = [];
 
+    /**
+     * @var FileList
+     */
+    private $fileList;
+
+    /**
+     * @var File
+     */
+    private $file;
+
     /**
      * Environment constructor.
      *
      * @param Variables $systemConfig
      * @param DecoderInterface $decoder
+     * @param FileList $fileList
+     * @param File $file
      */
-    public function __construct(Variables $systemConfig, DecoderInterface $decoder)
-    {
+    public function __construct(
+        Variables $systemConfig,
+        DecoderInterface $decoder,
+        FileList $fileList,
+        File $file
+    ) {
         $this->systemConfig = $systemConfig;
         $this->decoder = $decoder;
+        $this->fileList = $fileList;
+        $this->file = $file;
     }
 
     /**
@@ -114,13 +136,25 @@ public function getApplication(): array
             return $this->data['application'];
         }
 
-        return $this->data['application'] = $this->getEnvVar(SystemConfigInterface::VAR_ENV_APPLICATION, []);
+        $application = $this->getEnvVar(SystemConfigInterface::VAR_ENV_APPLICATION, []);
+
+        if (!$application) {
+            try {
+                $application = Yaml::parse(
+                    $this->file->fileGetContents($this->fileList->getAppConfig())
+                );
+            } catch (FileSystemException $e) {
+                // Do nothing as $application needs to be empty
+            }
+        }
+
+        return $this->data['application'] = $application;
     }
 
     /**
      * Returns name of environment branch
-     *
      * @return string
+     *
      */
     public function getBranchName(): string
     {

src/Test/Unit/Config/EnvironmentDataTest.php

@@ -13,6 +13,9 @@
 use Magento\MagentoCloud\Config\System\Variables;
 use Magento\MagentoCloud\Config\SystemConfigInterface;
 use Magento\MagentoCloud\PlatformVariable\DecoderInterface;
+use Magento\MagentoCloud\Filesystem\FileList;
+use Magento\MagentoCloud\Filesystem\Driver\File;
+use Magento\MagentoCloud\Filesystem\FileSystemException;
 use phpmock\phpunit\PHPMock;
 use PHPStan\Testing\TestCase;
 use PHPUnit\Framework\MockObject\MockObject;
@@ -39,6 +42,16 @@ class EnvironmentDataTest extends TestCase
      */
     private $decoderMock;
 
+    /**
+     * @var FileList|MockObject
+     */
+    private $fileListMock;
+
+    /**
+     * @var File|MockObject
+     */
+    private $fileMock;
+
     /**
      * @inheritDoc
      */
@@ -65,8 +78,15 @@ protected function setUp(): void
         );
 
         $this->decoderMock = $this->getMockForAbstractClass(DecoderInterface::class);
-
-        $this->environmentData = new EnvironmentData($this->variable, $this->decoderMock);
+        $this->fileListMock = $this->createMock(FileList::class);
+        $this->fileMock = $this->createMock(File::class);
+
+        $this->environmentData = new EnvironmentData(
+            $this->variable,
+            $this->decoderMock,
+            $this->fileListMock,
+            $this->fileMock
+        );
     }
 
     public function testGetEnv(): void
@@ -127,4 +147,28 @@ public function testGetBranchName(): void
 
         $this->assertEquals('production', $this->environmentData->getBranchName());
     }
+
+    // Following tests to see if .magento.app.yaml can be read (includes file missing)
+    public function testGetApplicationWithNoSystemVariablesFileExists(): void
+    {
+        $_ENV = null;
+
+        $this->fileMock->expects($this->once())
+            ->method('fileGetContents')
+            ->willReturn('[]');
+
+        $this->assertEquals([], $this->environmentData->getApplication());
+    }
+
+    public function testGetApplicationWithNoSystemVariablesFileNotExists(): void
+    {
+        $_ENV = null;
+        $exception = new FilesystemException('.magento.app.yaml not exist');
+
+        $this->fileMock->expects($this->once())
+            ->method('fileGetContents')
+            ->willThrowException($exception);
+
+        $this->assertEquals([], $this->environmentData->getApplication());
+    }
 }