Template resetter tests and doc adjustments.

Author: biozshock

doc/templates.md

@@ -37,7 +37,7 @@ Index template is similar to index configuration and has the same fields like `s
 To apply templates changes, you should run `fos:elastica:reset-templates` command:
 
 * `--index` - index template name to reset. If no index template name specified than all templates will be reset
-* `--force-delete` - will delete all indexes that match index templates patterns. Aware that pattern may match various indexes.
+* `--force-delete` - will delete all indexes that match index templates patterns. Aware that pattern may match various indexes. Note that in order to use this feature in Elasticsearch 8+ you *MUST* set the configuration option `action.destructive_requires_name` to `false`.
 
 You must run the following command to sync templates configuration on ES server with YAML configurations:
 ```bash

src/Index/TemplateResetter.php

@@ -12,8 +12,6 @@
 namespace FOS\ElasticaBundle\Index;
 
 use Elastic\Elasticsearch\Exception\ClientResponseException;
-use Elastica\Client;
-use Elastica\IndexTemplate;
 use FOS\ElasticaBundle\Configuration\IndexTemplateConfig;
 use FOS\ElasticaBundle\Configuration\ManagerInterface;
 use Symfony\Component\HttpFoundation\Response;
@@ -56,7 +54,7 @@ public function resetIndex(string $indexName, bool $deleteIndexes = false): void
 
         $mapping = $this->mappingBuilder->buildIndexTemplateMapping($indexTemplateConfig);
         if ($deleteIndexes) {
-            $this->deleteTemplateIndexes($indexTemplateConfig, $indexTemplate->getClient());
+            $this->deleteTemplateIndexes($indexTemplateConfig);
 
             try {
                 $indexTemplate->delete();
@@ -74,13 +72,14 @@ public function resetIndex(string $indexName, bool $deleteIndexes = false): void
     /**
      * Delete all template indexes.
      */
-    public function deleteTemplateIndexes(IndexTemplateConfig $template, Client $client): void
+    public function deleteTemplateIndexes(IndexTemplateConfig $template): void
     {
+        $indexTemplate = $this->indexTemplateManager->getIndexTemplate($template->getName());
         foreach ($template->getIndexPatterns() as $pattern) {
             try {
-                $client->indices()->delete(['index' => $pattern . '/']);
+                $indexTemplate->getClient()->indices()->delete(['index' => $pattern.'/']);
             } catch (ClientResponseException $e) {
-                if ($e->getResponse()->getStatusCode() === 404) {
+                if (404 === $e->getResponse()->getStatusCode()) {
                     // Index does not exist, so can not be removed.
                 } else {
                     throw $e;

tests/Functional/ResetTemplatesCommandTest.php

@@ -78,6 +78,7 @@ public function testResetAllTemplatesAndForceDelete()
         $this->assertStringContainsString('Resetting all templates', $output);
 
         $templates = $this->fetchAllTemplates();
+        $this->assertArrayHasKey('index_template_3_name', $templates);
         $this->assertArrayHasKey('index_template_2_name', $templates);
         $this->assertArrayHasKey('index_template_1_name', $templates);
     }
@@ -110,17 +111,17 @@ public function testResetExactTemplateAndForceDelete()
         $commandTester->setInputs(['yes']);
         $commandTester->execute([
             'command' => $command->getName(),
-            '--index' => 'index_template_example_1',
+            '--index' => 'index_template_example_3',
             '--force-delete' => true,
         ]);
 
         $output = $commandTester->getDisplay();
         $this->assertStringContainsString('You are going to remove all template indexes. Are you sure?', $output);
         $this->assertStringContainsString('Resetting template', $output);
-        $this->assertStringContainsString('index_template_example_1', $output);
+        $this->assertStringContainsString('index_template_example_3', $output);
 
         $templates = $this->fetchAllTemplates();
-        $this->assertArrayHasKey('index_template_1_name', $templates);
+        $this->assertArrayHasKey('index_template_3_name', $templates);
     }
 
     private function clearTemplates()

tests/Functional/app/Basic/config.yml

@@ -7,15 +7,15 @@ twig:
 fos_elastica:
     clients:
         default:
-            hosts: [http://%fos_elastica.host%:%fos_elastica.port%, http://%fos_elastica.host%:%fos_elastica.port%]
+            hosts: ['http://%fos_elastica.host%:%fos_elastica.port%', 'http://%fos_elastica.host%:%fos_elastica.port%']
             client_config:
                 ssl_verify: false
             connection_strategy: RoundRobin
         second_server:
-            hosts: [http://%fos_elastica.host%:%fos_elastica.port%]
+            hosts: ['http://%fos_elastica.host%:%fos_elastica.port%']
             connection_strategy: RoundRobin
         third:
-            hosts: [http://%fos_elastica.host%:%fos_elastica.port%]
+            hosts: ['http://%fos_elastica.host%:%fos_elastica.port%']
     indexes:
         index:
             index_name: foselastica_basic_test_%kernel.environment%
@@ -99,3 +99,13 @@ fos_elastica:
                 number_of_replicas: 0
             properties:
                 document_name_field_2: { type: text, index: false }
+        index_template_example_3:
+            client: 'default'
+            template_name: 'index_template_3_name'
+            index_patterns: ['index_template_3_name_index']
+            settings:
+                # templates should accept custom settings
+                number_of_shards: 2
+                number_of_replicas: 0
+            properties:
+                document_name_field_2: { type: text, index: false }

tests/Unit/Index/TemplateResetterTest.php

@@ -111,24 +111,28 @@ public function testResetAllIndexes()
     public function testResetAllIndexesAndDelete()
     {
         // assemble
-        $indexName = 'templated_index';
-        $templateNames = ['first_template'];
-        $names = [$indexName];
+        $templateName = 'index_template';
+        $indexPatterns = ['first_template_index'];
+        $names = [$templateName];
         $mapping = ['properties' => []];
         $this->configManager
             ->method('getIndexNames')
             ->willReturn($names)
         ;
         $indexTemplateConfig = $this->createMock(IndexTemplateConfig::class);
+        $indexTemplateConfig
+            ->method('getName')
+            ->willReturn($templateName)
+        ;
         $this->configManager
             ->method('getIndexConfiguration')
-            ->with($indexName)
+            ->with($templateName)
             ->willReturn($indexTemplateConfig)
         ;
         $indexTemplate = $this->createMock(IndexTemplate::class);
         $this->templateManager
             ->method('getIndexTemplate')
-            ->with($indexName)
+            ->with($templateName)
             ->willReturn($indexTemplate)
         ;
         $this->mappingBuilder
@@ -151,18 +155,21 @@ public function testResetAllIndexesAndDelete()
         $indices = $this->createMock(Indices::class);
         $indices->expects($this->once())
             ->method('delete')
-            ->with(['index' => $templateNames[0].'/']);
+            ->with(['index' => $indexPatterns[0].'/'])
+        ;
         $client = $this->createMock(Client::class);
         $client->expects($this->once())
             ->method('indices')
-            ->willReturn($indices);
+            ->willReturn($indices)
+        ;
         $indexTemplate->expects($this->once())
             ->method('getClient')
-            ->willReturn($client);
+            ->willReturn($client)
+        ;
         $indexTemplateConfig
             ->expects($this->once())
             ->method('getIndexPatterns')
-            ->willReturn($templateNames)
+            ->willReturn($indexPatterns)
         ;
 
         // act
@@ -209,19 +216,19 @@ public function testResetIndex()
     public function testResetIndexIndexeAndDelete()
     {
         // assemble
-        $indexName = 'templated_index';
-        $templateNames = ['first_template'];
+        $templateName = 'index_template';
+        $indexPatterns = ['first_template_index'];
         $mapping = ['properties' => []];
         $indexTemplateConfig = $this->createMock(IndexTemplateConfig::class);
         $this->configManager
             ->method('getIndexConfiguration')
-            ->with($indexName)
+            ->with($templateName)
             ->willReturn($indexTemplateConfig)
         ;
         $indexTemplate = $this->createMock(IndexTemplate::class);
         $this->templateManager
             ->method('getIndexTemplate')
-            ->with($indexName)
+            ->with($templateName)
             ->willReturn($indexTemplate)
         ;
         $this->mappingBuilder
@@ -244,12 +251,16 @@ public function testResetIndexIndexeAndDelete()
         $indexTemplateConfig
             ->expects($this->once())
             ->method('getIndexPatterns')
-            ->willReturn($templateNames)
+            ->willReturn($indexPatterns)
+        ;
+        $indexTemplateConfig
+            ->method('getName')
+            ->willReturn($templateName)
         ;
         $indices = $this->createMock(Indices::class);
         $indices->expects($this->once())
             ->method('delete')
-            ->with(['index' => $templateNames[0].'/'])
+            ->with(['index' => $indexPatterns[0].'/'])
         ;
         $client = $this->createMock(Client::class);
         $client->expects($this->once())
@@ -262,33 +273,50 @@ public function testResetIndexIndexeAndDelete()
         ;
 
         // act
-        $this->resetter->resetIndex($indexName, true);
+        $this->resetter->resetIndex($templateName, true);
     }
 
     public function testDeleteTemplateIndexes()
     {
         // assemble
-        $templateNames = ['some_template'];
+        $templateName = 'some_template';
+        $indexPatterns = ['some_template_index'];
         $template = $this->createMock(IndexTemplateConfig::class);
 
         // assert
         $template
             ->expects($this->once())
             ->method('getIndexPatterns')
-            ->willReturn($templateNames)
+            ->willReturn($indexPatterns)
+        ;
+        $template
+            ->expects($this->once())
+            ->method('getName')
+            ->willReturn($templateName)
         ;
 
         $indices = $this->createMock(Indices::class);
         $indices->expects($this->once())
             ->method('delete')
-            ->with(['index' => $templateNames[0].'/'])
+            ->with(['index' => $indexPatterns[0].'/'])
         ;
         $client = $this->createMock(Client::class);
         $client->expects($this->once())
             ->method('indices')
             ->willReturn($indices)
         ;
 
-        $this->resetter->deleteTemplateIndexes($template, $client);
+        $indexTemplate = $this->createMock(IndexTemplate::class);
+        $indexTemplate->expects($this->once())
+            ->method('getClient')
+            ->willReturn($client)
+        ;
+        $this->templateManager
+            ->method('getIndexTemplate')
+            ->with($templateName)
+            ->willReturn($indexTemplate)
+        ;
+
+        $this->resetter->deleteTemplateIndexes($template);
     }
 }