Merge pull request #189 from City-of-Helsinki/UHF-10990

Add elasticsearch connector plugin

composer.json

@@ -24,6 +24,8 @@
         "dealerdirect/phpcodesniffer-composer-installer": "^0.7.0",
         "dg/bypass-finals": "^1.0",
         "drupal/coder": "^8.3",
+        "drupal/search_api": "^1.0",
+        "drupal/elasticsearch_connector": "^8.0@alpha",
         "donatj/mock-webserver": "dev-master"
     }
 }

config/schema/elasticsearch_connector.connector.helfi_connector.schema.yml

@@ -0,0 +1,2 @@
+plugin.plugin_configuration.elasticsearch_connector.helfi_connector:
+  type: plugin.plugin_configuration.elasticsearch_connector.basicauth

src/Plugin/ElasticSearch/Connector/HelfiConnector.php

@@ -0,0 +1,33 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Drupal\helfi_api_base\Plugin\ElasticSearch\Connector;
+
+use Drupal\elasticsearch_connector\Plugin\ElasticSearch\Connector\BasicAuthConnector;
+use Elastic\Elasticsearch\Client;
+use Elastic\Elasticsearch\ClientBuilder;
+
+/**
+ * Provides an ElasticSearch connector that accepts self-signed certificates.
+ *
+ * @ElasticSearchConnector(
+ *   id = "helfi_connector",
+ *   label = @Translation("Helfi Connector"),
+ *   description = @Translation("ElasticSearch connector with HTTP Basic Auth that accepts self signed certificates.")
+ * )
+ */
+class HelfiConnector extends BasicAuthConnector {
+
+  /**
+   * {@inheritdoc}
+   */
+  public function getClient(): Client {
+    return ClientBuilder::create()
+      ->setHosts([$this->configuration['url']])
+      ->setBasicAuthentication($this->configuration['username'], $this->configuration['password'])
+      ->setSSLVerification(FALSE)
+      ->build();
+  }
+
+}

tests/src/Kernel/ElasticsearchConnectorTest.php

@@ -0,0 +1,72 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Drupal\Tests\helfi_api_base\Kernel;
+
+use Drupal\Core\Entity\EntityTypeManagerInterface;
+use Drupal\KernelTests\KernelTestBase;
+use Drupal\elasticsearch_connector\Plugin\search_api\backend\ElasticSearchBackend;
+use Drupal\helfi_api_base\Plugin\ElasticSearch\Connector\HelfiConnector;
+use Elastic\Elasticsearch\Client;
+
+/**
+ * Test for elasticsearch connector plugin.
+ */
+class ElasticsearchConnectorTest extends KernelTestBase {
+
+  /**
+   * {@inheritdoc}
+   */
+  protected static $modules = [
+    'search_api',
+    'elasticsearch_connector',
+    'helfi_api_base',
+  ];
+
+  /**
+   * {@inheritdoc}
+   */
+  public function setUp(): void {
+    parent::setUp();
+
+    $this->installEntitySchema('search_api_server');
+  }
+
+  /**
+   * Tests custom elasticsearch connector.
+   */
+  public function testSearchApiConnector() {
+    // Add elasticsearch server configuration.
+    $config = $this->config('search_api.server.default');
+    $config->setData([
+      'status' => TRUE,
+      'id' => 'default',
+      'name' => 'elasticsearch_server',
+      'description' => 'Test server',
+      'backend' => 'elasticsearch',
+      'backend_config' => [
+        'connector' => 'helfi_connector',
+        'connector_config' => [
+          'url' => 'http://elasticsearch.example.com:9200',
+          'username' => '123',
+          'password' => '456',
+        ],
+      ],
+    ]);
+    $config->save();
+
+    /** @var \Drupal\search_api\ServerInterface $server */
+    $server = $this->container
+      ->get(EntityTypeManagerInterface::class)
+      ->getStorage('search_api_server')
+      ->load('default');
+
+    $backend = $server->getBackend();
+    assert($backend instanceof ElasticSearchBackend);
+    $connector = $backend->getConnector();
+    $this->assertInstanceOf(HelfiConnector::class, $connector);
+    $this->assertInstanceOf(Client::class, $connector->getClient());
+  }
+
+}