MAGECLOUD-3470: Add validator for SearchEngine config integrity (#449)

Author: oshmyheliuk

src/App/Container.php

@@ -248,6 +248,7 @@ function () {
                             'validators' => [
                                 ValidatorInterface::LEVEL_CRITICAL => [
                                     $this->container->make(ConfigValidator\Deploy\DatabaseConfiguration::class),
+                                    $this->container->make(ConfigValidator\Deploy\SearchConfiguration::class),
                                     $this->container->make(ConfigValidator\Deploy\ResourceConfiguration::class),
                                     $this->container->make(ConfigValidator\Deploy\SessionConfiguration::class),
                                     $this->container->make(ConfigValidator\Deploy\ElasticSuiteIntegrity::class),

src/Config/Validator/Deploy/SearchConfiguration.php

@@ -0,0 +1,72 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\MagentoCloud\Config\Validator\Deploy;
+
+use Magento\MagentoCloud\Config\ConfigMerger;
+use Magento\MagentoCloud\Config\Stage\DeployInterface;
+use Magento\MagentoCloud\Config\Validator;
+use Magento\MagentoCloud\Config\Validator\ResultFactory;
+use Magento\MagentoCloud\Config\ValidatorInterface;
+
+/**
+ * Validates SEARCH_CONFIGURATION variable
+ */
+class SearchConfiguration implements ValidatorInterface
+{
+    /**
+     * @var ResultFactory
+     */
+    private $resultFactory;
+
+    /**
+     * @var DeployInterface
+     */
+    private $stageConfig;
+
+    /**
+     * @var ConfigMerger
+     */
+    private $configMerger;
+
+    /**
+     * @param ResultFactory $resultFactory
+     * @param DeployInterface $stageConfig
+     * @param ConfigMerger $configMerger
+     */
+    public function __construct(
+        ResultFactory $resultFactory,
+        DeployInterface $stageConfig,
+        ConfigMerger $configMerger
+    ) {
+        $this->resultFactory = $resultFactory;
+        $this->stageConfig = $stageConfig;
+        $this->configMerger = $configMerger;
+    }
+
+    /**
+     * Checks that SEARCH_CONFIGURATION variable contains at least 'engine' option if _merge was not set
+     *
+     * @return Validator\ResultInterface
+     */
+    public function validate(): Validator\ResultInterface
+    {
+        $searchConfig = $this->stageConfig->get(DeployInterface::VAR_SEARCH_CONFIGURATION);
+        if ($this->configMerger->isEmpty($searchConfig) || $this->configMerger->isMergeRequired($searchConfig)) {
+            return $this->resultFactory->success();
+        }
+
+        if (!isset($searchConfig['engine'])) {
+            return $this->resultFactory->error(
+                sprintf('Variable "%s" is not configured properly', DeployInterface::VAR_SEARCH_CONFIGURATION),
+                'At least engine option must be configured'
+            );
+        }
+
+        return $this->resultFactory->success();
+    }
+}

src/Test/Unit/Config/Validator/Deploy/SearchConfigurationTest.php

@@ -0,0 +1,119 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\MagentoCloud\Test\Unit\Config\Validator\Deploy;
+
+use Magento\MagentoCloud\Config\ConfigMerger;
+use Magento\MagentoCloud\Config\Stage\DeployInterface;
+use Magento\MagentoCloud\Config\Validator\Deploy\SearchConfiguration;
+use Magento\MagentoCloud\Config\Validator\Result\Error;
+use Magento\MagentoCloud\Config\Validator\Result\Success;
+use Magento\MagentoCloud\Config\Validator\ResultFactory;
+use PHPUnit\Framework\MockObject\MockObject;
+use PHPUnit\Framework\TestCase;
+
+/**
+ * @inheritdoc
+ */
+class SearchConfigurationTest extends TestCase
+{
+    /**
+     * @var SearchConfiguration
+     */
+    private $validator;
+
+    /**
+     * @var ResultFactory|MockObject
+     */
+    private $resultFactoryMock;
+
+    /**
+     * @var DeployInterface|MockObject
+     */
+    private $stageConfigMock;
+
+    /**
+     * @inheritdoc
+     */
+    protected function setUp()
+    {
+        $this->resultFactoryMock = $this->createConfiguredMock(ResultFactory::class, [
+            'success' => $this->createMock(Success::class),
+            'error' => $this->createMock(Error::class)
+        ]);
+        $this->stageConfigMock = $this->getMockForAbstractClass(DeployInterface::class);
+
+        $this->validator = new SearchConfiguration(
+            $this->resultFactoryMock,
+            $this->stageConfigMock,
+            new ConfigMerger()
+        );
+    }
+
+    /**
+     * @param array $searchConfiguration
+     * @param string $expectedResultClass
+     * @dataProvider validateDataProvider
+     */
+    public function testValidate(array $searchConfiguration, string $expectedResultClass)
+    {
+        $this->stageConfigMock->expects($this->once())
+            ->method('get')
+            ->with(DeployInterface::VAR_SEARCH_CONFIGURATION)
+            ->willReturn($searchConfiguration);
+
+        $this->assertInstanceOf($expectedResultClass, $this->validator->validate());
+    }
+
+    /**
+     * @return array
+     */
+    public function validateDataProvider(): array
+    {
+        return [
+            [
+                [],
+                Success::class,
+            ],
+            [
+                [
+                    '_merge' => true
+                ],
+                Success::class,
+            ],
+            [
+                [
+                    'elasticsearh_host' => '9200',
+                ],
+                Error::class,
+            ],
+            [
+
+                [
+                    'elasticsearh_host' => '9200',
+                    '_merge' => true,
+                ],
+                Success::class,
+            ],
+            [
+
+                [
+                    'engine' => 'mysql',
+                ],
+                Success::class,
+            ],
+            [
+
+                [
+                    'engine' => 'mysql',
+                    '_merge' => true,
+                ],
+                Success::class,
+            ],
+        ];
+    }
+}