Merge pull request #60 from tddwizard/config-fixture

Config fixture

Author: schmengler

README.md

@@ -300,6 +300,17 @@ public function testSomethingWithMultipleProducts()
 
 ```
 
+### Config Fixtures
+
+With the config fixture you can set a configuration value globally, i.e. it will ensure that it is not only set in the default scope but also in all store scopes:
+```
+ConfigFixture::setGlobal('general/store_information/name', 'Ye Olde Wizard Shop');
+```
+
+It uses `MutableScopeConfigInterface`, so the configuration is not persisted in the database. Use `@magentoAppIsolation enabled` in your test to make sure that changes are reverted in subsequent tests.
+
+You can also set configuration values explicitly for stores with `ConfigFixture::setForStore()` 
+
 ## Credits
 
 - [Fabian Schmengler][link-author]

src/Core/ConfigFixture.php

@@ -0,0 +1,50 @@
+<?php
+declare(strict_types=1);
+
+namespace TddWizard\Fixtures\Core;
+
+use Magento\Framework\App\Config\MutableScopeConfigInterface;
+use Magento\Framework\App\Config\ScopeConfigInterface;
+use Magento\Store\Api\StoreRepositoryInterface;
+use Magento\Store\Model\ScopeInterface;
+use Magento\TestFramework\Helper\Bootstrap;
+
+class ConfigFixture
+{
+
+    /**
+     * Sets configuration in default scope AND all stores, no matter what was configured previously
+     *
+     * @param string $path
+     * @param mixed $value
+     */
+    public static function setGlobal(string $path, $value): void
+    {
+        self::scopeConfig()->setValue($path, $value, ScopeConfigInterface::SCOPE_TYPE_DEFAULT);
+        foreach (self::storeRepository()->getList() as $store) {
+            self::scopeConfig()->setValue($path, $value, ScopeInterface::SCOPE_STORE, $store->getCode());
+        }
+    }
+
+    /**
+     * Sets configuration in store scope
+     *
+     * @param string $path
+     * @param mixed $value
+     * @param null $storeCode store code or NULL for current store
+     */
+    public static function setForStore(string $path, $value, $storeCode = null) : void
+    {
+        self::scopeConfig()->setValue($path, $value, ScopeInterface::SCOPE_STORE, $storeCode);
+    }
+
+    private static function scopeConfig(): MutableScopeConfigInterface
+    {
+        return Bootstrap::getObjectManager()->get(MutableScopeConfigInterface::class);
+    }
+
+    private static function storeRepository(): StoreRepositoryInterface
+    {
+        return Bootstrap::getObjectManager()->get(StoreRepositoryInterface::class);
+    }
+}

tests/Core/ConfigFixtureTest.php

@@ -0,0 +1,114 @@
+<?php
+declare(strict_types=1);
+
+namespace TddWizard\Fixtures\Core;
+
+use Magento\Framework\App\Config\MutableScopeConfigInterface;
+use Magento\Framework\App\Config\ScopeConfigInterface;
+use Magento\Store\Model\ScopeInterface;
+use Magento\Store\Model\StoreManagerInterface;
+use Magento\TestFramework\Helper\Bootstrap;
+use PHPUnit\Framework\TestCase;
+
+/**
+ * @magentoAppIsolation enabled
+ * @magentoDbIsolation enabled
+ */
+class ConfigFixtureTest extends TestCase
+{
+    const         STORE_NAME_PATH              = 'general/store_information/name';
+    private const SECOND_STORE_ID_FROM_FIXTURE = 'fixture_second_store';
+    private const FIRST_STORE_ID               = 'default';
+    /**
+     * @var MutableScopeConfigInterface
+     */
+    private $scopeConfig;
+    /**
+     * @var StoreManagerInterface
+     */
+    private $storeManager;
+
+    protected function setUp(): void
+    {
+        $objectManager = Bootstrap::getObjectManager();
+        $this->scopeConfig = $objectManager->get(MutableScopeConfigInterface::class);
+        $this->storeManager = $objectManager->get(StoreManagerInterface::class);
+    }
+
+    public function testSetGlobalChangesDefaultScope()
+    {
+        ConfigFixture::setGlobal(self::STORE_NAME_PATH, 'Ye Olde Wizard Shop');
+        $this->assertConfigValue(
+            'Ye Olde Wizard Shop',
+            self::STORE_NAME_PATH,
+            ScopeConfigInterface::SCOPE_TYPE_DEFAULT
+        );
+    }
+
+    /**
+     * @magentoAppArea frontend
+     */
+    public function testSetGlobalOverridesAllScopes()
+    {
+        $this->givenStoreValue(self::STORE_NAME_PATH, 'Store Override');
+        $this->givenWebsiteValue(self::STORE_NAME_PATH, 'Website Override');
+        ConfigFixture::setGlobal(self::STORE_NAME_PATH, 'Global Value');
+        $this->assertConfigValue('Global Value', self::STORE_NAME_PATH, ScopeInterface::SCOPE_STORE);
+    }
+
+    /**
+     * @magentoAppArea frontend
+     * @magentoDataFixture Magento/Store/_files/second_store.php
+     */
+    public function testSetForStoreWithCurrentStore()
+    {
+        $this->storeManager->setCurrentStore(self::SECOND_STORE_ID_FROM_FIXTURE);
+        ConfigFixture::setForStore(self::STORE_NAME_PATH, 'Store store');
+        $this->assertConfigValue(
+            'Store store',
+            self::STORE_NAME_PATH,
+            ScopeInterface::SCOPE_STORE,
+            self::SECOND_STORE_ID_FROM_FIXTURE
+        );
+    }
+
+    /**
+     * @magentoAppArea frontend
+     * @magentoDataFixture Magento/Store/_files/second_store.php
+     */
+    public function testSetForStoreWithExplicitStore()
+    {
+        ConfigFixture::setForStore(self::STORE_NAME_PATH, 'Store 1', self::FIRST_STORE_ID);
+        ConfigFixture::setForStore(self::STORE_NAME_PATH, 'Store 2', self::SECOND_STORE_ID_FROM_FIXTURE);
+        $this->assertConfigValue(
+            'Store 1',
+            self::STORE_NAME_PATH,
+            ScopeInterface::SCOPE_STORE,
+            self::FIRST_STORE_ID
+        );
+        $this->assertConfigValue(
+            'Store 2',
+            self::STORE_NAME_PATH,
+            ScopeInterface::SCOPE_STORE,
+            self::SECOND_STORE_ID_FROM_FIXTURE
+        );
+    }
+
+    private function givenStoreValue(string $path, string $storeValue): void
+    {
+        $this->scopeConfig->setValue($path, $storeValue, ScopeInterface::SCOPE_STORE);
+    }
+
+    private function givenWebsiteValue(string $path, string $websiteValue): void
+    {
+        $this->scopeConfig->setValue($path, $websiteValue, ScopeInterface::SCOPE_WEBSITE);
+    }
+
+    private function assertConfigValue($expectedValue, string $path, string $scope, string $scopeCode = null): void
+    {
+        $this->assertEquals(
+            $expectedValue,
+            $this->scopeConfig->getValue($path, $scope, $scopeCode)
+        );
+    }
+}