MAGE-1060: POC for multi-store indexing testing (#1622)

* MAGE-1060: POC for multi-store bootstrap

* MAGE-1056: adding a asbtract class for multiple stores scenario + starting of the category class

* MAGE-1056: cleaning

Author: damcou

Test/Integration/MultiStoreCategoriesTest.php

@@ -0,0 +1,34 @@
+<?php
+
+namespace Algolia\AlgoliaSearch\Test\Integration;
+
+use Algolia\AlgoliaSearch\Model\Indexer\Category;
+
+/**
+ * @magentoDataFixture Magento/Store/_files/second_website_with_two_stores.php
+ * @magentoDbIsolation disabled
+ * @magentoAppIsolation enabled
+ */
+class MultiStoreCategoriesTest extends MultiStoreTestCase
+{
+    /** @var Category */
+    protected $categoriesIndexer;
+
+    public function setUp():void
+    {
+        parent::setUp();
+
+        /** @var Category $categoriesIndexer */
+        $this->categoriesIndexer = $this->getObjectManager()->create(Category::class);
+
+        $this->categoriesIndexer->executeFull();
+        $this->algoliaHelper->waitLastTask();
+    }
+
+    public function testMultiStoreCategoryIndices()
+    {
+        foreach ($this->storeManager->getStores() as $store) {
+            $this->assertNbOfRecordsPerStore($store->getCode(), 'categories', $this->assertValues->expectedCategory);
+        }
+    }
+}

Test/Integration/MultiStoreConfigTest.php

@@ -0,0 +1,37 @@
+<?php
+
+namespace Algolia\AlgoliaSearch\Test\Integration;
+
+/**
+ * @magentoDataFixture Magento/Store/_files/second_website_with_two_stores.php
+ */
+class MultiStoreConfigTest extends MultiStoreTestCase
+{
+    public function testMultiStoreIndicesCreation()
+    {
+        $websites = $this->storeManager->getWebsites();
+        $stores = $this->storeManager->getStores();
+
+        // Check that stores and websites are properly created
+        $this->assertEquals(count($websites), 2);
+        $this->assertEquals(count($stores), 3);
+
+        foreach ($stores as $store) {
+            $this->setupStore($store);
+        }
+
+        $indicesCreatedByTest = 0;
+        $indices = $this->algoliaHelper->listIndexes();
+
+        foreach ($indices['items'] as $index) {
+            $name = $index['name'];
+
+            if (mb_strpos($name, $this->indexPrefix) === 0) {
+                $indicesCreatedByTest++;
+            }
+        }
+
+        // Check that the configuration created the appropriate number of indices (4 per store => 3*4=12)
+        $this->assertEquals($indicesCreatedByTest, 12);
+    }
+}

Test/Integration/MultiStoreTestCase.php

@@ -0,0 +1,84 @@
+<?php
+
+namespace Algolia\AlgoliaSearch\Test\Integration;
+
+use Algolia\AlgoliaSearch\Exceptions\AlgoliaException;
+use Algolia\AlgoliaSearch\Model\IndicesConfigurator;
+use Magento\Framework\Exception\LocalizedException;
+use Magento\Framework\Exception\NoSuchEntityException;
+use Magento\Store\Api\Data\StoreInterface;
+use Magento\Store\Model\StoreManager;
+
+abstract class MultiStoreTestCase extends IndexingTestCase
+{
+    /** @var StoreManager */
+    protected $storeManager;
+
+    /** @var IndicesConfigurator */
+    protected $indicesConfigurator;
+
+    public function setUp():void
+    {
+        /** @var StoreManager $storeManager */
+        $this->storeManager = $this->getObjectManager()->create(StoreManager::class);
+
+        /** @var IndicesConfigurator $indicesConfigurator */
+        $this->indicesConfigurator = $this->getObjectManager()->create(IndicesConfigurator::class);
+
+        parent::setUp();
+
+        foreach ($this->storeManager->getStores() as $store) {
+            $this->setupStore($store);
+        }
+    }
+
+    /**
+     * @param string $storeCode
+     * @param string $entity
+     * @param int $expectedNumber
+     *
+     * @return void
+     * @throws AlgoliaException
+     */
+    protected function assertNbOfRecordsPerStore(string $storeCode, string $entity, int $expectedNumber): void
+    {
+        $resultsDefault = $this->algoliaHelper->query($this->indexPrefix .  $storeCode . '_' . $entity, '', []);
+
+        $this->assertEquals($expectedNumber, $resultsDefault['results'][0]['nbHits']);
+    }
+
+    /**
+     * @param StoreInterface $store
+     *
+     * @return void
+     * @throws AlgoliaException
+     * @throws LocalizedException
+     * @throws NoSuchEntityException
+     */
+    protected function setupStore(StoreInterface $store): void
+    {
+        $this->setConfig(
+            'algoliasearch_credentials/credentials/application_id',
+            getenv('ALGOLIA_APPLICATION_ID'),
+            $store->getCode()
+        );
+        $this->setConfig(
+            'algoliasearch_credentials/credentials/search_only_api_key',
+            getenv('ALGOLIA_SEARCH_KEY_1') ?: getenv('ALGOLIA_SEARCH_API_KEY'),
+            $store->getCode()
+        );
+        $this->setConfig(
+            'algoliasearch_credentials/credentials/api_key',
+            getenv('ALGOLIA_API_KEY'),
+            $store->getCode()
+        );
+        $this->setConfig(
+            'algoliasearch_credentials/credentials/index_prefix',
+            $this->indexPrefix,
+            $store->getCode()
+        );
+
+        $this->indicesConfigurator->saveConfigurationToAlgolia($store->getId());
+    }
+
+}

Test/Integration/TestCase.php

@@ -58,13 +58,16 @@ protected function resetConfigs($configs = [])
         }
     }
 
-    protected function setConfig($path, $value)
-    {
+    protected function setConfig(
+        $path,
+        $value,
+        $scopeCode = 'default'
+    ) {
         $this->getObjectManager()->get(\Magento\Framework\App\Config\MutableScopeConfigInterface::class)->setValue(
             $path,
             $value,
             ScopeInterface::SCOPE_STORE,
-            'default'
+            $scopeCode
         );
     }