MAGE-1218 Refactor integration tests

Author: cammonro

Test/Integration/Product/ReplicaIndexingTest.php

@@ -216,9 +216,7 @@ public function testReplicaSync(): void
 
         $sorting = $this->populateReplicas(1);
 
-        $currentSettings = $this->algoliaHelper->getSettings($primaryIndexName);
-        $this->assertArrayHasKey('replicas', $currentSettings);
-        $replicas = $currentSettings['replicas'];
+        $replicas = $this->assertReplicasCreated($sorting);
 
         $this->assertEquals(count($sorting), count($replicas));
         $this->assertSortToReplicaConfigParity($primaryIndexName, $sorting, $replicas);
@@ -229,26 +227,14 @@ public function testReplicaSync(): void
      */
     public function testReplicaDelete(): void
     {
-        $primaryIndexName = $this->indexName;
-
         // Make one replica virtual
         $this->mockSortUpdate('price', 'asc', ['virtualReplica' => 1]);
 
-        $sorting = $this->populateReplicas(1);
-
-        $currentSettings = $this->algoliaHelper->getSettings($primaryIndexName);
-        $this->assertArrayHasKey('replicas', $currentSettings);
-        $replicas = $currentSettings['replicas'];
-
-        $this->assertEquals(count($sorting), count($replicas));
+        $replicas = $this->assertReplicasCreated($this->populateReplicas(1));
 
         $this->replicaManager->deleteReplicasFromAlgolia(1);
 
-        $newSettings = $this->algoliaHelper->getSettings($primaryIndexName);
-        $this->assertArrayNotHasKey('replicas', $newSettings);
-        foreach ($replicas as $replica) {
-            $this->assertIndexNotExists($this->extractIndexFromReplicaSetting($replica));
-        }
+        $this->assertReplicasDeleted($replicas);
     }
 
     /**
@@ -257,42 +243,28 @@ public function testReplicaDelete(): void
      */
     public function testReplicaDeleteUnreliable(): void
     {
-        $primaryIndexName = $this->indexName;
-
-        $sorting = $this->populateReplicas(1);
-
-        $currentSettings = $this->algoliaHelper->getSettings($primaryIndexName);
-        $this->assertArrayHasKey('replicas', $currentSettings);
-        $replicas = $currentSettings['replicas'];
-
-        $this->assertEquals(count($sorting), count($replicas));
+        $replicas = $this->assertReplicasCreated($this->populateReplicas(1));
 
         $this->getMustPrevalidateMockReplicaManager()->deleteReplicasFromAlgolia(1);
 
-        $newSettings = $this->algoliaHelper->getSettings($primaryIndexName);
-        $this->assertArrayNotHasKey('replicas', $newSettings);
-        foreach ($replicas as $replica) {
-            $this->assertIndexNotExists($this->extractIndexFromReplicaSetting($replica));
-        }
+        $this->assertReplicasDeleted($replicas);
     }
 
     /**
+     * Test the RebuildReplicasPatch with API failures
      * @magentoConfigFixture current_store algoliasearch_instant/instant/is_instant_enabled 1
      */
     public function testReplicaRebuildPatch(): void
     {
-        $primaryIndexName = $this->indexName;
         $sorting = $this->populateReplicas(1);
-        $currentSettings = $this->algoliaHelper->getSettings($primaryIndexName);
-        $this->assertArrayHasKey('replicas', $currentSettings);
-        $replicas = $currentSettings['replicas'];
+        $replicas = $this->assertReplicasCreated($sorting);
 
-        $this->assertTrue($this->configHelper->credentialsAreConfigured());
+        $this->assertTrue($this->configHelper->credentialsAreConfigured(), "Credentials not available to apply patch.");
 
         $patch = new \Algolia\AlgoliaSearch\Setup\Patch\Data\RebuildReplicasPatch(
             $this->objectManager->get(ModuleDataSetupInterface::class),
             $this->objectManager->get(StoreManagerInterface::class),
-            $this->getTroublesomePatchReplicaManager(),
+            $this->getTroublesomePatchReplicaManager($replicas),
             $this->objectManager->get(ProductHelper::class),
             $this->objectManager->get(AppState::class),
             $this->objectManager->get(ReplicaState::class),
@@ -301,6 +273,10 @@ public function testReplicaRebuildPatch(): void
         );
 
         $patch->apply();
+
+        $this->algoliaHelper->waitLastTask();
+        $this->assertEquals(count($sorting), count($replicas));
+        $this->assertSortToReplicaConfigParity($this->indexName, $sorting, $replicas);
     }
 
     protected function extractIndexFromReplicaSetting(string $setting): string {
@@ -330,8 +306,10 @@ protected function getMustPrevalidateMockReplicaManager(): ReplicaManagerInterfa
     /**
      * This mock is to recreate the scenario where a patch tries to apply up to 3 times but the replicas
      * are never detached which throws a replica delete error until the last attempt which should succeed
+     *
+     * @param array $replicas - replicas that are to be deleted
      */
-    protected function getTroublesomePatchReplicaManager(): ReplicaManager
+    protected function getTroublesomePatchReplicaManager(array $replicas): ReplicaManager
     {
         $mock = $this->getMockReplicaManager([
             'clearReplicasSettingInAlgolia' => null,
@@ -348,9 +326,17 @@ protected function getTroublesomePatchReplicaManager(): ReplicaManager
         $mock
             ->expects($this->any())
             ->method('deleteReplicas')
-            ->willReturnCallback(function(array $replicasToDelete, ...$params) use ($mock) {
+            ->willReturnCallback(function(array $replicasToDelete, ...$params) use ($mock, $replicas) {
                 $originalMethod = new \ReflectionMethod(ReplicaManager::class, 'deleteReplicas');
                 $originalMethod->invoke($mock, $replicasToDelete, false, false);
+                if ($this->patchRetries) return;
+                $this->runOnce(
+                    function() use ($replicas) {
+                        $this->algoliaHelper->waitLastTask();
+                        $this->assertReplicasDeleted($replicas);
+                    },
+                    'patchDeleteTest'
+                );
             });
 
         return $mock;
@@ -384,6 +370,34 @@ protected function getMockReplicaManager($mockedMethods = array()): MockObject &
         return $mockedReplicaManager;
     }
 
+    /**
+     * Setup replicas for testing and assert that they have been synced to Algolia
+     * @param array $sorting - the array of sorts from Magento
+     * @return array - The replica setting from Algolia
+     * @throws AlgoliaException
+     * @throws ExceededRetriesException
+     * @throws \ReflectionException
+     */
+    protected function assertReplicasCreated(array $sorting): array
+    {
+        $currentSettings = $this->algoliaHelper->getSettings($this->indexName);
+        $this->assertArrayHasKey(ReplicaManager::ALGOLIA_SETTINGS_KEY_REPLICAS, $currentSettings);
+        $replicas = $currentSettings[ReplicaManager::ALGOLIA_SETTINGS_KEY_REPLICAS];
+
+        $this->assertEquals(count($sorting), count($replicas));
+
+        return $replicas;
+    }
+
+    protected function assertReplicasDeleted($originalReplicas): void
+    {
+        $newSettings = $this->algoliaHelper->getSettings($this->indexName);
+        $this->assertArrayNotHasKey(ReplicaManager::ALGOLIA_SETTINGS_KEY_REPLICAS, $newSettings);
+        foreach ($originalReplicas as $replica) {
+            $this->assertIndexNotExists($this->extractIndexFromReplicaSetting($replica));
+        }
+    }
+
     /**
      * Populate replica indices for test based on store id and return sorting configuration used
      *

Test/Integration/TestCase.php

@@ -267,4 +267,22 @@ protected function getSerializer()
     {
         return $this->getObjectManager()->get(\Magento\Framework\Serialize\SerializerInterface::class);
     }
+
+    /**
+     * Run a callback once and only once
+     * @param callable $callback
+     * @param string|null $key - a unique key for this operation - if null a unique key will be derived
+     * @return mixed
+     */
+    function runOnce(callable $callback, string $key = null): mixed
+    {
+        static $executed = [];
+        $key ??= is_string($callback) ? $callback : spl_object_hash((object) $callback);
+        if (!isset($executed[$key])) {
+            $executed[$key] = true;
+            return $callback();
+        }
+
+        return null;
+    }
 }