Add Integration tests to cover url_key and url_path management

lbajsarowicz · lbajsarowicz · commit 3d3e19cfcc91 · 2020-03-21T21:50:38.000+01:00
diff --git a/dev/tests/integration/testsuite/Magento/Catalog/Controller/Adminhtml/Category/Save/AbstractSaveCategoryTest.php b/dev/tests/integration/testsuite/Magento/Catalog/Controller/Adminhtml/Category/Save/AbstractSaveCategoryTest.php
@@ -39,6 +39,7 @@ protected function setUp()
     protected function performSaveCategoryRequest(array $data): array
     {
         $data['return_session_messages_only'] = true;
+        $this->getRequest()->setDispatched(false);
         $this->getRequest()->setMethod(HttpRequest::METHOD_POST);
         $this->getRequest()->setPostValue($data);
         $this->dispatch('backend/catalog/category/save');
diff --git a/dev/tests/integration/testsuite/Magento/Catalog/Controller/Adminhtml/Category/Save/SaveCategoryDifferentScopesTest.php b/dev/tests/integration/testsuite/Magento/Catalog/Controller/Adminhtml/Category/Save/SaveCategoryDifferentScopesTest.php
@@ -10,18 +10,18 @@
 use Magento\Catalog\Api\CategoryRepositoryInterface;
 use Magento\Catalog\Api\Data\CategoryInterface;
 use Magento\Catalog\Model\Category;
+use Magento\Framework\App\ResourceConnection;
+use Magento\Framework\DB\Adapter\AdapterInterface;
+use Magento\Framework\Exception\NoSuchEntityException;
 use Magento\Store\Model\StoreManagerInterface;
 
 /**
  * @magentoAppArea adminhtml
  */
 class SaveCategoryDifferentScopesTest extends AbstractSaveCategoryTest
 {
-    private const DEFAULT_STORE_ID = 1;
-    private const FIXTURE_CATEGORY_ID = 333;
     private const GLOBAL_SCOPE_ID = 0;
-
-    private const FIXTURE_URL_KEY = 'category-1';
+    private const DEFAULT_STORE_ID = 1;
 
     private const FIXTURE_CATEGORY_ROOT = 400;
     private const FIXTURE_CATEGORY_CHILD = 401;
@@ -35,6 +35,9 @@ class SaveCategoryDifferentScopesTest extends AbstractSaveCategoryTest
     /** @var StoreManagerInterface */
     private $storeManager;
 
+    /** @var AdapterInterface */
+    private $dbConnection;
+
     /**
      * @inheritDoc
      */
@@ -43,6 +46,8 @@ protected function setUp()
         parent::setUp();
         $this->categoryRepository = $this->_objectManager->get(CategoryRepositoryInterface::class);
         $this->storeManager = $this->_objectManager->get(StoreManagerInterface::class);
+
+
     }
 
     /**
@@ -55,53 +60,117 @@ protected function tearDown()
         parent::tearDown();
     }
 
+    /**
+     * For Test purposes you may need FRESH Category repository without internal cache
+     *
+     * @return CategoryRepositoryInterface
+     */
+    private function createCategoryRepository(): CategoryRepositoryInterface
+    {
+        return $this->_objectManager->create(CategoryRepositoryInterface::class);
+    }
+
     /**
      * Change of `url_key` for specific store should not affect global value of `url_path`
      *
      * @magentoDbIsolation enabled
-     * @magentoDataFixture Magento/Catalog/_files/category.php
+     * @magentoDataFixture Magento/Catalog/_files/category_tree.php
+     * @magentoDataFixture Magento/Store/_files/core_fixturestore.php
      */
-    public function testChangeUrlKeyForSpecificStoreShouldNotChangeGlobalUrlPath()
+    public function testUrlKeyUpdateInCustomStoreDoesNotChangeGlobalUrlPath()
     {
-        $expectedStoreScopeUrlKey = 'url-key-store-1';
-        $expectedGlobalScopeUrlKey = self::FIXTURE_URL_KEY;
+        $secondStoreId = $this->getStoreId(self::FIXTURE_SECOND_STORE_CODE);
+
+        $storeScopeUrlKey = 'url-key-store-1';
 
-        $postData = [
-            'entity_id' => self::FIXTURE_CATEGORY_ID,
-            'store_id' => self::DEFAULT_STORE_ID,
-            'url_key' => $expectedStoreScopeUrlKey
+        $updateCategoryStoreScope = [
+            'entity_id' => self::FIXTURE_CATEGORY_LEAF,
+            'store_id' => $secondStoreId,
+            'url_key' => $storeScopeUrlKey,
+            'use_config' => [
+                'available_sort_by' => 1,
+            ]
         ];
-        $responseData = $this->performSaveCategoryRequest($postData);
+        $responseData = $this->performSaveCategoryRequest($updateCategoryStoreScope);
         $this->assertRequestIsSuccessfullyPerformed($responseData);
 
-        /** @var CategoryInterface|Category $storeScopeCategory */
-        $storeScopeCategory = $this->categoryRepository->get(self::FIXTURE_CATEGORY_ID, self::DEFAULT_STORE_ID);
-        $this->assertSame($expectedStoreScopeUrlKey, $storeScopeCategory->getData('url_path'));
+        $this->assertCategoryUrlPathForStore(
+            self::FIXTURE_CATEGORY_LEAF,
+            $secondStoreId,
+            $this->getExpectedUrlPath([2 => $storeScopeUrlKey])
+        );
 
-        $globalScopeCategory = $this->categoryRepository->get(self::FIXTURE_CATEGORY_ID, self::GLOBAL_SCOPE_ID);
-        $this->assertSame($expectedGlobalScopeUrlKey, $globalScopeCategory->getData('url_path'));
+        $this->assertCategoryUrlPathForStore(
+            self::FIXTURE_CATEGORY_LEAF,
+            self::GLOBAL_SCOPE_ID,
+            $this->getExpectedUrlPath()
+        );
     }
 
     /**
-     * Change of `url_key` for root category in specific store should change all the children `url_path`
+     * Magento EAV should not create entries for Default store (1) when Custom Store values are saved
      *
      * @magentoDbIsolation enabled
      * @magentoDataFixture Magento/Catalog/_files/category_tree.php
      * @magentoDataFixture Magento/Store/_files/core_fixturestore.php
      */
-    public function testChangeUrlKeyAffectsAllChildrenUrlPath()
+    public function testUrlKeyUpdateInCustomStoreDoesNotCreateEntriesForDefaultStore()
     {
         $secondStoreId = $this->getStoreId(self::FIXTURE_SECOND_STORE_CODE);
+        $storeScopeUrlKey = 'url-key-store-1';
 
-        $urlKeys = [
-            1 => 'category-1',
-            2 => 'category-1-1',
-            3 => 'category-1-1-1'
+        $updateCategoryStoreScope = [
+            'entity_id' => self::FIXTURE_CATEGORY_LEAF,
+            'store_id' => $secondStoreId,
+            'url_key' => $storeScopeUrlKey,
+            'use_config' => [
+                'available_sort_by' => 1,
+            ]
         ];
+        $responseData = $this->performSaveCategoryRequest($updateCategoryStoreScope);
+        $this->assertRequestIsSuccessfullyPerformed($responseData);
+
+        $attributeValues = $this->getCategoryVarcharAttributeValuesPerScope(self::FIXTURE_CATEGORY_LEAF, 'url_path');
+        $this->assertArrayNotHasKey(self::DEFAULT_STORE_ID, $attributeValues);
+    }
 
-        /** @var CategoryInterface|Category $leafOriginal */
-        $leafOriginal = $this->categoryRepository->get(self::FIXTURE_CATEGORY_LEAF);
-        $this->assertSame(implode('/', $urlKeys), $leafOriginal->getData('url_path'));
+    /**
+     * Magento EAV should not create entries for Default store (1) when Global scope (0) values are saved
+     *
+     * @magentoDbIsolation enabled
+     * @magentoDataFixture Magento/Catalog/_files/category_tree.php
+     * @magentoDataFixture Magento/Store/_files/core_fixturestore.php
+     */
+    public function testUrlKeyUpdateInGlobalScopeDoesNotCreateEntriesForDefaultStore()
+    {
+        $storeScopeUrlKey = 'url-key-store-1';
+
+        $updateCategoryStoreScope = [
+            'entity_id' => self::FIXTURE_CATEGORY_LEAF,
+            'url_key' => $storeScopeUrlKey,
+            'use_config' => [
+                'available_sort_by' => 1,
+            ]
+        ];
+        $responseData = $this->performSaveCategoryRequest($updateCategoryStoreScope);
+        $this->assertRequestIsSuccessfullyPerformed($responseData);
+
+        $attributeValues = $this->getCategoryVarcharAttributeValuesPerScope(self::FIXTURE_CATEGORY_LEAF, 'url_path');
+        $this->assertArrayNotHasKey(self::DEFAULT_STORE_ID, $attributeValues);
+    }
+
+    /**
+     * Change of `url_key` for root category in specific store should change all the children `url_path`
+     *
+     * @magentoDbIsolation enabled
+     * @magentoDataFixture Magento/Catalog/_files/category_tree.php
+     * @magentoDataFixture Magento/Store/_files/core_fixturestore.php
+     */
+    public function testUpdateRootUrlKeyAffectsAllChildrenUrlPath()
+    {
+        $secondStoreId = $this->getStoreId(self::FIXTURE_SECOND_STORE_CODE);
+
+        $this->assertCategoryUrlPathForStore(self::FIXTURE_CATEGORY_LEAF, $secondStoreId, $this->getExpectedUrlPath());
 
         $updateRootData = [
             'entity_id' => self::FIXTURE_CATEGORY_ROOT,
@@ -114,16 +183,13 @@ public function testChangeUrlKeyAffectsAllChildrenUrlPath()
         $responseData = $this->performSaveCategoryRequest($updateRootData);
         $this->assertRequestIsSuccessfullyPerformed($responseData);
 
-        $newUrlKeys = $urlKeys;
-        $newUrlKeys[1] = 'store-root';
-
-        /** @var CategoryInterface|Category $leafStoreScope */
-        $leafStoreScope = $this->categoryRepository->get(self::FIXTURE_CATEGORY_LEAF, $secondStoreId);
-        $this->assertSame(implode('/', $newUrlKeys), $leafStoreScope->getData('url_path'));
+        $this->categoryRepository = $this->createCategoryRepository();
+        $this->assertCategoryUrlPathForStore(self::FIXTURE_CATEGORY_LEAF, $secondStoreId,
+            $this->getExpectedUrlPath([0 => 'store-root']));
 
-        /** @var CategoryInterface|Category $leafGlobalScope */
-        $leafGlobalScope = $this->categoryRepository->get(self::FIXTURE_CATEGORY_LEAF);
-        $this->assertSame(implode('/', $urlKeys), $leafGlobalScope->getData('url_path'));
+        // Verify the potential side effects to Global Scope
+        $this->assertCategoryUrlPathForStore(self::FIXTURE_CATEGORY_LEAF, self::DEFAULT_STORE_ID,
+            $this->getExpectedUrlPath());
     }
 
     /**
@@ -133,24 +199,27 @@ public function testChangeUrlKeyAffectsAllChildrenUrlPath()
      * @magentoDataFixture Magento/Store/_files/core_fixturestore.php
      * @magentoDataFixture Magento/Catalog/_files/category_tree.php
      */
-    public function testCategoryUrlPathUsesGlobalUrlKey()
+    public function testStoreScopeCategoryUrlPathUsesGlobalScopeUrlKey()
     {
+        $this->markTestIncomplete('Still in Magento');
         $secondStoreId = $this->getStoreId(self::FIXTURE_SECOND_STORE_CODE);
 
-        $setSecondStoreCategoryUrlKey = [
+        $updateSecondStoreCategoryUrlKey = [
             'entity_id' => self::FIXTURE_CATEGORY_CHILD,
             'url_key' => 'second-store-child',
             'store_id' => $secondStoreId,
             'use_config' => [
                 'available_sort_by' => 1,
             ]
         ];
-        $responseData = $this->performSaveCategoryRequest($setSecondStoreCategoryUrlKey);
+        $responseData = $this->performSaveCategoryRequest($updateSecondStoreCategoryUrlKey);
         $this->assertRequestIsSuccessfullyPerformed($responseData);
 
-        /** @var CategoryInterface|Category $categoryWithCustomUrlKey */
-        $categoryWithCustomUrlKey = $this->categoryRepository->get(self::FIXTURE_CATEGORY_CHILD, $secondStoreId);
-        $this->assertSame('category-1/second-store-child', $categoryWithCustomUrlKey->getData('url_path'));
+        // Temporary solution to reset Request object.
+        $this->getRequest()->setDispatched(false);
+
+        $this->assertCategoryUrlPathForStore(self::FIXTURE_CATEGORY_LEAF, $secondStoreId,
+            $this->getExpectedUrlPath([1 => 'second-store-child']));
 
         $useDefaultUrlKey = [
             'entity_id' => self::FIXTURE_CATEGORY_CHILD,
@@ -165,19 +234,81 @@ public function testCategoryUrlPathUsesGlobalUrlKey()
         $responseData = $this->performSaveCategoryRequest($useDefaultUrlKey);
         $this->assertRequestIsSuccessfullyPerformed($responseData);
 
-        $categoryWithDefaultUrlKey = $this->categoryRepository->get(self::FIXTURE_CATEGORY_LEAF, $secondStoreId);
-        $this->assertSame('category-1/category-1-1/category-1-1-1', $categoryWithDefaultUrlKey->getData('url_path'));
+        $this->assertCategoryUrlPathForStore(self::FIXTURE_CATEGORY_LEAF, $secondStoreId, $this->getExpectedUrlPath());
     }
 
     /**
      * Returns StoreID by Code
      *
      * @param string $code
      * @return int
-     * @throws \Magento\Framework\Exception\NoSuchEntityException
+     * @throws NoSuchEntityException
      */
     private function getStoreId(string $code): int
     {
         return (int)$this->storeManager->getStore($code)->getId();
     }
+
+    /**
+     * Returns
+     * @param array $replacements
+     * @return string
+     */
+    private function getExpectedUrlPath(array $replacements = []): string
+    {
+        $basicUrlPath = ['category-1', 'category-1-1', 'category-1-1-1'];
+
+        return implode('/', array_replace($basicUrlPath, $replacements));
+    }
+
+    /**
+     * Returns array of attribute values per scope
+     *
+     * @param int $categoryId
+     * @param string $attributeCode
+     */
+    private function getCategoryVarcharAttributeValuesPerScope(int $categoryId, string $attributeCode)
+    {
+        $selectValues = $this->getConnection()->select()
+            ->from(
+                ['ccev' => $this->getConnection()->getTableName('catalog_category_entity_varchar')],
+                ['store_id', 'value']
+            )
+            ->join(
+                ['ea' => $this->getConnection()->getTableName('eav_attribute')],
+                'ccev.attribute_id = ea.attribute_id',
+                []
+            )
+            ->where('entity_id = ?', $categoryId)
+            ->where('ea.attribute_code = ?', $attributeCode);
+
+        return $this->getConnection()->fetchPairs($selectValues);
+    }
+
+    /**
+     * Asserts the URL path for the Category in specified Store scope
+     *
+     * @param int $categoryId
+     * @param int $storeId
+     * @param string $expectedPath
+     * @throws NoSuchEntityException
+     */
+    private function assertCategoryUrlPathForStore(int $categoryId, int $storeId, string $expectedPath)
+    {
+        /** @var CategoryInterface|Category $storeScopeCategory */
+        $storeScopeCategory = $this->categoryRepository->get($categoryId, $storeId);
+        $this->assertSame($storeId, $storeScopeCategory->getStoreId());
+        $this->assertSame($expectedPath, $storeScopeCategory->getData('url_path'));
+    }
+
+    private function getConnection(): AdapterInterface
+    {
+        if (null === $this->dbConnection) {
+            /** @var ResourceConnection $resourceConnection */
+            $resourceConnection = $this->_objectManager->create(ResourceConnection::class);
+            $this->dbConnection = $resourceConnection->getConnection();
+        }
+
+        return $this->dbConnection;
+    }
 }

Original file line number	Diff line number	Diff line change
`@@ -39,6 +39,7 @@ protected function setUp()`
`39`	`39`	`protected function performSaveCategoryRequest(array $data): array`
`40`	`40`	`{`
`41`	`41`	`$data['return_session_messages_only'] = true;`
	`42`	`+ $this->getRequest()->setDispatched(false);`
`42`	`43`	`$this->getRequest()->setMethod(HttpRequest::METHOD_POST);`
`43`	`44`	`$this->getRequest()->setPostValue($data);`
`44`	`45`	`$this->dispatch('backend/catalog/category/save');`