feat: Added DeploymentConfig

chore: covered scope config with more tests

Author: IvanChepurnyi

composer.json

@@ -15,6 +15,10 @@
     "phpunit/phpunit": "^11.5",
     "brianium/paratest": "^7.7"
   },
+  "suggest": {
+    "ecomdev/testcontainers-magento-data": "Database Containers pre-populated with various data",
+    "ext-pdo": "For datbase connections with ResourceConnection implemenation"
+  },
   "license": [
     "MIT"
   ],
@@ -49,5 +53,6 @@
     "allow-plugins": {
       "magento/composer-dependency-version-audit-plugin": false
     }
-  }
+  },
+  "$schema": "https://getcomposer.org/schema.json"
 }

src/ArrayConfig.php

@@ -32,6 +32,10 @@ public function withValue(string $scope, string $path, mixed $value): self
 
     public function getValueByPath(string $scope, string $path): mixed
     {
+        if ($path === '') {
+            return $this->data[$scope] ?? [];
+        }
+
         $parts = explode('/', $path);
         $current = $this->data[$scope] ?? [];
         foreach ($parts as $part) {

src/DeploymentConfig.php

@@ -0,0 +1,57 @@
+<?php
+
+namespace EcomDev\Magento2TestEssentials;
+
+use Magento\Framework\App\DeploymentConfig as MagentoDeploymentConfig;
+use PDO;
+
+final class DeploymentConfig extends MagentoDeploymentConfig
+{
+    private function __construct(
+        private readonly ArrayConfig $data
+    ) {
+        $reader = new class ($data) extends MagentoDeploymentConfig\Reader {
+            public function __construct(private readonly ArrayConfig $data)
+            {
+            }
+
+            public function load($fileKey = null)
+            {
+                return $this->data->getValueByPath('file', '');
+            }
+        };
+
+        parent::__construct($reader);
+    }
+
+    public static function new(): self
+    {
+        return new self(ArrayConfig::new());
+    }
+
+    public function withDatabaseConnection(
+        string $host,
+        string $username,
+        string $password,
+        string $dbname,
+        string $tablePrefix = ''
+    ): self {
+        return $this->withSetting('db/table_prefix', $tablePrefix)
+            ->withSetting('db/connection/default/host', $host)
+            ->withSetting('db/connection/default/username', $username)
+            ->withSetting('db/connection/default/password', $password)
+            ->withSetting('db/connection/default/dbname', $dbname)
+            ->withSetting('db/connection/default/active', 1)
+            ->withSetting('db/connection/default/engine', 'innodb')
+            ->withSetting('db/connection/default/initStatements', ['SET NAMES utf8'])
+            ->withSetting('db/connection/default/driver_options', [
+            PDO::MYSQL_ATTR_SSL_VERIFY_SERVER_CERT => false
+        ]);
+    }
+
+    public function withSetting(string $path, mixed $value): self
+    {
+        $data = $this->data->withValue('file', $path, $value);
+        return new self($data);
+    }
+}

tests/DeploymentConfigTest.php

@@ -0,0 +1,66 @@
+<?php
+
+namespace EcomDev\Magento2TestEssentials;
+
+use PHPUnit\Framework\Attributes\Test;
+use PHPUnit\Framework\TestCase;
+
+class DeploymentConfigTest extends TestCase
+{
+    #[Test]
+    public function availableWhenInstallDateSet()
+    {
+        $this->assertTrue(
+            DeploymentConfig::new()
+                ->withSetting('install/date', (new \DateTime())->format('Y-m-d H:i:s'))
+                ->isAvailable()
+        );
+    }
+
+    #[Test]
+    public function dbIsNotAvailableWhenNoDbConnection()
+    {
+        $this->assertFalse(
+            DeploymentConfig::new()->isDbAvailable()
+        );
+    }
+
+    #[Test]
+    public function reportsDbAvailableWhenSettingsProvided()
+    {
+        $this->assertTrue(
+            DeploymentConfig::new()
+                ->withDatabaseConnection('db', 'magento', 'magento', 'magento')
+                ->isDbAvailable()
+        );
+    }
+
+    #[Test]
+    public function generatesReadyToUseDbConnectionSettings()
+    {
+        $this->assertEquals(
+            [
+                'table_prefix' => 'magento_',
+                'connection' => [
+                    'default' => [
+                        'host' => 'db',
+                        'username' => 'magento',
+                        'password' => 'magento_pwd',
+                        'dbname' => 'magento2',
+                        'engine' => 'innodb',
+                        'initStatements' => [
+                            'SET NAMES utf8',
+                        ],
+                        'active' => 1,
+                        'driver_options' => [
+                            \PDO::MYSQL_ATTR_SSL_VERIFY_SERVER_CERT => false
+                        ],
+                    ]
+                ],
+            ],
+            DeploymentConfig::new()
+                ->withDatabaseConnection('db', 'magento', 'magento_pwd', 'magento2', 'magento_')
+                ->getConfigData('db')
+        );
+    }
+}

tests/ScopeConfigTest.php

@@ -12,7 +12,9 @@
 use EcomDev\Magento2TestEssentials\Store\Store;
 use EcomDev\Magento2TestEssentials\Store\StoreManager;
 use EcomDev\Magento2TestEssentials\Store\Website;
+use Magento\Framework\App\Config\ScopeConfigInterface;
 use Magento\Store\Model\ScopeInterface;
+use PHPUnit\Framework\Attributes\DataProvider;
 use PHPUnit\Framework\TestCase;
 use PHPUnit\Framework\Attributes\Test;
 
@@ -148,4 +150,47 @@ public function castsOnlyTruthyValuesInFlagCheck()
             ]
         );
     }
+
+    #[Test]
+    #[DataProvider('combinations')]
+    public function checkVariousPathCombinations(string $path, string $scope, string $scopeCode, mixed $expectedValue)
+    {
+        $config = ScopeConfig::new()
+            ->withStoreManager(
+                StoreManager::new()
+                    ->withWebsite(
+                        Website::new(1, 'base')
+                    )
+                    ->withStore(
+                        Store::new(1, 'default')
+                            ->withWebsite(1, 1)
+                    )
+                    ->withStore(
+                        Store::new(2, 'english')
+                            ->withWebsite(1, 1)
+                    )
+            )
+            ->withDefaultValue('some/other', 'default_one_value')
+            ->withWebsiteValue('base', 'some/other/path_two', 'base_website_value')
+            ->withStoreValue('default', 'some/other/path_three', 'default_store_value')
+            ->withStoreValue('english', 'some/other', null);
+
+        $this->assertEquals(
+            $expectedValue,
+            $config->getValue($path, $scope, $scopeCode)
+        );
+    }
+
+    public static function combinations()
+    {
+        return [
+            ['some/other/path_three', ScopeInterface::SCOPE_STORE, 'default', 'default_store_value'],
+            ['some/other', ScopeInterface::SCOPE_STORES, 'english', [
+                'path_two' => 'base_website_value'
+            ]],
+            ['some/other/path_two', ScopeInterface::SCOPE_WEBSITE, 'base', 'base_website_value'],
+            ['some/other/path_two', ScopeInterface::SCOPE_WEBSITES, 'default', null],
+            ['some/other', ScopeConfigInterface::SCOPE_TYPE_DEFAULT, '', 'default_one_value'],
+        ];
+    }
 }