AcquiaSearchOverrideTest.php in Acquia Connector 8

Namespace

Drupal\Tests\acquia_search\Kernel

File

acquia_search/tests/src/Kernel/AcquiaSearchOverrideTest.php

<?php

namespace Drupal\Tests\acquia_search\Kernel;

use Drupal\acquia_connector\Helper\Storage;
use Drupal\acquia_search\EventSubscriber\SearchSubscriber;
use Drupal\acquia_search\Plugin\SolrConnector\SearchApiSolrAcquiaConnector;
use Drupal\Core\Database\Database;
use Drupal\KernelTests\KernelTestBase;
use GuzzleHttp\Client;

/**
 * Tests for Acquia Search override cores.
 *
 * @group Acquia search
 */
class AcquiaSearchOverrideTest extends KernelTestBase {

  /**
   * {@inheritdoc}
   */
  public static $modules = [
    'user',
    'path_alias',
    'acquia_connector',
    'search_api',
    'acquia_search',
  ];

  /**
   * {@inheritdoc}
   */
  protected function setUp() {
    parent::setUp();
    $this
      ->installConfig([
      'acquia_connector',
    ]);
    $guzzle = $this
      ->createMock(Client::class);
    $guzzle
      ->expects($this
      ->any())
      ->method('__call')
      ->with('get')
      ->will($this
      ->returnValue(''));
    $client_factory = $this
      ->getMockBuilder('Drupal\\Core\\Http\\ClientFactory')
      ->disableOriginalConstructor()
      ->getMock();
    $client_factory
      ->expects($this
      ->any())
      ->method('fromOptions')
      ->will($this
      ->returnValue($guzzle));
    $this->container
      ->set('http_client_factory', $client_factory);
    $search_subscriber = new SearchSubscriber();

    /** @var \Symfony\Contracts\EventDispatcher\EventDispatcherInterface $event_dispatcher */
    $event_dispatcher = \Drupal::service('event_dispatcher');
    $event_dispatcher
      ->addSubscriber($search_subscriber);
  }

  /**
   * No Acquia hosting and DB detected - should override into Readonly.
   */
  public function testNonAcquiaHosted() {
    $this
      ->setAvailableSearchCores();
    $connector_plugin = new SearchApiSolrAcquiaConnector([], 'foo', [
      'foo',
    ]);
    $solr_connector = $connector_plugin
      ->create($this->container, [], 'foo', [
      'foo',
    ]);
    $config = $solr_connector
      ->defaultConfiguration();
    $this
      ->assertEquals(ACQUIA_SEARCH_AUTO_OVERRIDE_READ_ONLY, $config['overridden_by_acquia_search']);
    $this
      ->assertGetUpdateQueryException($solr_connector);
  }

  /**
   * Tests Acquia Dev hosting environment detected.
   *
   * Configs point to the index on the Dev environment.
   */
  public function testAcquiaHostingEnvironmentDetected() {
    $_ENV['AH_SITE_ENVIRONMENT'] = 'dev';
    $_ENV['AH_SITE_NAME'] = 'testsite1dev';
    $_ENV['AH_SITE_GROUP'] = 'testsite1';
    $this
      ->setAvailableSearchCores();
    $connector_plugin = new SearchApiSolrAcquiaConnector([], 'foo', [
      'foo',
    ]);
    $solr_connector = $connector_plugin
      ->create($this->container, [], 'foo', [
      'foo',
    ]);
    $config = $solr_connector
      ->defaultConfiguration();
    $db_name = $this
      ->getDbName();
    $this
      ->assertEquals(ACQUIA_SEARCH_OVERRIDE_AUTO_SET, $config['overridden_by_acquia_search']);
    $this
      ->assertEquals('WXYZ-12345.dev.' . $db_name, $config['index_id']);
    $this
      ->assertGetUpdateQueryNoException($solr_connector);
  }

  /**
   * Tests Acquia Dev hosting environment and search v3 core detected.
   *
   * Configs point to the index on the Dev environment and host pointing to
   * search v3.
   */
  public function testAcquiaSearchV3CoreDetected() {
    $_ENV['AH_SITE_ENVIRONMENT'] = 'dev';
    $_ENV['AH_SITE_NAME'] = 'testsite1dev';
    $_ENV['AH_SITE_GROUP'] = 'testsite1';
    $this
      ->setAvailableSearchCores();
    $connector_plugin = new SearchApiSolrAcquiaConnector([], 'foo', [
      'foo',
    ]);
    $solr_connector = $connector_plugin
      ->create($this->container, [], 'foo', [
      'foo',
    ]);
    $config = $solr_connector
      ->defaultConfiguration();
    $db_name = $this
      ->getDbName();
    $this
      ->assertEquals(ACQUIA_SEARCH_OVERRIDE_AUTO_SET, $config['overridden_by_acquia_search']);
    $this
      ->assertEquals('WXYZ-12345.dev.' . $db_name, $config['index_id']);
    $this
      ->assertEquals('sr-dev.acquia.com', $config['host']);
    $this
      ->assertGetUpdateQueryNoException($solr_connector);
  }

  /**
   * Tests environment detection without cores available.
   *
   * Acquia Test environment and a DB name. According to the mock, no cores
   * available for the Test environment so it is read only.
   */
  public function testAcquiaHostingEnvironmentDetectedNoAvailableCores() {
    $_ENV['AH_SITE_ENVIRONMENT'] = 'test';
    $_ENV['AH_SITE_NAME'] = 'testsite1test';
    $_ENV['AH_SITE_GROUP'] = 'testsite1';
    $this
      ->setAvailableSearchCores();
    $connector_plugin = new SearchApiSolrAcquiaConnector([], 'foo', [
      'foo',
    ]);
    $solr_connector = $connector_plugin
      ->create($this->container, [], 'foo', [
      'foo',
    ]);
    $config = $solr_connector
      ->defaultConfiguration();
    $this
      ->assertEquals(ACQUIA_SEARCH_AUTO_OVERRIDE_READ_ONLY, $config['overridden_by_acquia_search']);
    $this
      ->assertGetUpdateQueryException($solr_connector);
  }

  /**
   * Tests read-only.
   *
   * Acquia Prod environment and a DB name but AH_PRODUCTION isn't set - so read
   * only.
   */
  public function testAcquiaHostingProdEnvironmentDetectedWithoutProdFlag() {
    $_ENV['AH_SITE_ENVIRONMENT'] = 'prod';
    $_ENV['AH_SITE_NAME'] = 'testsite1prod';
    $_ENV['AH_SITE_GROUP'] = 'testsite1';
    $this
      ->setAvailableSearchCores();
    $connector_plugin = new SearchApiSolrAcquiaConnector([], 'foo', [
      'foo',
    ]);
    $solr_connector = $connector_plugin
      ->create($this->container, [], 'foo', [
      'foo',
    ]);
    $config = $solr_connector
      ->defaultConfiguration();
    $this
      ->assertEquals(ACQUIA_SEARCH_AUTO_OVERRIDE_READ_ONLY, $config['overridden_by_acquia_search']);
    $this
      ->assertGetUpdateQueryException($solr_connector);
  }

  /**
   * Tests prod environment detection.
   *
   * Acquia Prod environment and a DB name and AH_PRODUCTION is set - so it
   * should override to connect to the prod index.
   */
  public function testAcquiaHostingProdEnvironmentDetectedWithProdFlag() {
    $_ENV['AH_SITE_ENVIRONMENT'] = 'prod';
    $_ENV['AH_SITE_NAME'] = 'testsite1prod';
    $_ENV['AH_SITE_GROUP'] = 'testsite1';
    $_SERVER['AH_PRODUCTION'] = TRUE;
    $this
      ->setAvailableSearchCores();
    $connector_plugin = new SearchApiSolrAcquiaConnector([], 'foo', [
      'foo',
    ]);
    $solr_connector = $connector_plugin
      ->create($this->container, [], 'foo', [
      'foo',
    ]);
    $config = $solr_connector
      ->defaultConfiguration();
    $this
      ->assertEquals(ACQUIA_SEARCH_OVERRIDE_AUTO_SET, $config['overridden_by_acquia_search']);
    $this
      ->assertEquals('WXYZ-12345', $config['index_id']);
    $this
      ->assertGetUpdateQueryNoException($solr_connector);
  }

  /**
   * Test core override when a core with db name is unavailable.
   *
   * Tests that it selects the correct preferred search core ID for the
   * override URL when limited number of core ID is available.
   */
  public function testApacheSolrOverrideWhenCoreWithDbNameNotAvailable() {

    // When the core ID with the DB name in it is not available, it should
    // override the URL value with the core ID that has the site folder name
    // in it.
    $_ENV['AH_SITE_ENVIRONMENT'] = 'dev';
    $_ENV['AH_SITE_NAME'] = 'testsite1dev';
    $_ENV['AH_SITE_GROUP'] = 'testsite1';
    $this
      ->setAvailableSearchCores(TRUE);
    $connector_plugin = new SearchApiSolrAcquiaConnector([], 'foo', [
      'foo',
    ]);
    $solr_connector = $connector_plugin
      ->create($this->container, [], 'foo', [
      'foo',
    ]);
    $config = $solr_connector
      ->defaultConfiguration();
    $site_folder = $this
      ->getSiteFolderName();
    $this
      ->assertEquals(ACQUIA_SEARCH_OVERRIDE_AUTO_SET, $config['overridden_by_acquia_search']);
    $this
      ->assertEquals('WXYZ-12345.dev.' . $site_folder, $config['index_id']);
    $this
      ->assertGetUpdateQueryNoException($solr_connector);
  }

  /**
   * Asserts if the Solr Connector getUpdateQuery() method throws exception.
   *
   * @param \Drupal\acquia_search\Plugin\SolrConnector\SearchApiSolrAcquiaConnector $solr_connector
   *   SearchApiSolrAcquiaConnector.
   *
   * @throws \Exception
   *   If the Search API Server is currently in read-only mode.
   */
  protected function assertGetUpdateQueryException(SearchApiSolrAcquiaConnector $solr_connector) {

    // Set the expectation for exception.
    $this
      ->expectExceptionMessage('The Search API Server serving this index is currently in read-only mode.');

    // Run the code that should throw the exception.
    // If exception occurred - test passes. If no exception occurred - test
    // fails.
    $solr_connector
      ->getUpdateQuery();
  }

  /**
   * Helper method to test SearchApiSolrAcquiaConnector::getUpdateQuery.
   *
   * Asserts if the Solr Connector getUpdateQuery() method doesn't throw
   * an exception.
   *
   * @param \Drupal\acquia_search\Plugin\SolrConnector\SearchApiSolrAcquiaConnector $solr_connector
   *   SearchApiSolrAcquiaConnector.
   */
  protected function assertGetUpdateQueryNoException(SearchApiSolrAcquiaConnector $solr_connector) {
    try {
      $solr_connector
        ->getUpdateQuery();
    } catch (\Exception $e) {
      $this
        ->fail('getUpdateQuery() should not throw exception');
    }
  }

  /**
   * Sets available search cores into the subscription heartbeat data.
   *
   * @param bool $no_db_flag
   *   Allows to set a limited number of search cores by excluding the one that
   *   contains the DB name.
   */
  protected function setAvailableSearchCores($no_db_flag = FALSE) {
    $acquia_identifier = 'WXYZ-12345';
    $solr_hostname = 'mock.acquia-search.com';
    $site_folder = $this
      ->getSiteFolderName();
    $ah_db_name = $this
      ->getDbName();
    $core_with_folder_name = [
      'balancer' => $solr_hostname,
      'core_id' => "{$acquia_identifier}.dev.{$site_folder}",
    ];
    $core_with_db_name = [
      'balancer' => $solr_hostname,
      'core_id' => "{$acquia_identifier}.dev.{$ah_db_name}",
    ];
    $core_with_acquia_identifier = [
      'balancer' => $solr_hostname,
      'core_id' => "{$acquia_identifier}",
    ];
    $search_v3_core = [
      'balancer' => 'sr-dev.acquia.com',
      'core_id' => "{$acquia_identifier}.dev.{$ah_db_name}",
      'version' => "v3",
    ];
    if ($no_db_flag) {
      $available_cores = [
        $core_with_folder_name,
        $core_with_acquia_identifier,
      ];
    }
    else {
      $available_cores = [
        $core_with_folder_name,
        $core_with_db_name,
        $core_with_acquia_identifier,
        $search_v3_core,
      ];
    }
    $storage = new Storage();
    $storage
      ->setIdentifier($acquia_identifier);
    \Drupal::state()
      ->set('acquia_subscription_data', [
      'heartbeat_data' => [
        'search_cores' => $available_cores,
      ],
    ]);
  }

  /**
   * Returns the folder name of the current site folder.
   */
  protected function getSiteFolderName() {
    $conf_path = \Drupal::service('site.path');
    return substr($conf_path, strrpos($conf_path, '/') + 1);
  }

  /**
   * Returns the current DB name.
   */
  protected function getDbName() {
    $db_conn_options = Database::getConnection()
      ->getConnectionOptions();
    return $db_conn_options['database'];
  }

}

Classes

Name	Description
AcquiaSearchOverrideTest	Tests for Acquia Search override cores.