You are here

class AcquiaSearchOverrideTest in Acquia Search 2.x

Tests for Acquia Search override cores.

@group Acquia search

Hierarchy

Expanded class hierarchy of AcquiaSearchOverrideTest

File

tests/src/Kernel/AcquiaSearchOverrideTest.php, line 17

Namespace

Drupal\Tests\acquia_search\Kernel
View source
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'];
  }

}

Members

Namesort descending Modifiers Type Description Overrides
AcquiaSearchOverrideTest::$modules public static property Modules to enable. Overrides KernelTestBase::$modules
AcquiaSearchOverrideTest::assertGetUpdateQueryException protected function Asserts if the Solr Connector getUpdateQuery() method throws exception.
AcquiaSearchOverrideTest::assertGetUpdateQueryNoException protected function Helper method to test SearchApiSolrAcquiaConnector::getUpdateQuery.
AcquiaSearchOverrideTest::getDbName protected function Returns the current DB name.
AcquiaSearchOverrideTest::getSiteFolderName protected function Returns the folder name of the current site folder.
AcquiaSearchOverrideTest::setAvailableSearchCores protected function Sets available search cores into the subscription heartbeat data.
AcquiaSearchOverrideTest::setUp protected function Overrides KernelTestBase::setUp
AcquiaSearchOverrideTest::testAcquiaHostingEnvironmentDetected public function Tests Acquia Dev hosting environment detected.
AcquiaSearchOverrideTest::testAcquiaHostingEnvironmentDetectedNoAvailableCores public function Tests environment detection without cores available.
AcquiaSearchOverrideTest::testAcquiaHostingProdEnvironmentDetectedWithoutProdFlag public function Tests read-only.
AcquiaSearchOverrideTest::testAcquiaHostingProdEnvironmentDetectedWithProdFlag public function Tests prod environment detection.
AcquiaSearchOverrideTest::testAcquiaSearchV3CoreDetected public function Tests Acquia Dev hosting environment and search v3 core detected.
AcquiaSearchOverrideTest::testApacheSolrOverrideWhenCoreWithDbNameNotAvailable public function Test core override when a core with db name is unavailable.
AcquiaSearchOverrideTest::testNonAcquiaHosted public function No Acquia hosting and DB detected - should override into Readonly.
AssertContentTrait::$content protected property The current raw content.
AssertContentTrait::$drupalSettings protected property The drupalSettings value from the current raw $content.
AssertContentTrait::$elements protected property The XML structure parsed from the current raw $content. 1
AssertContentTrait::$plainTextContent protected property The plain-text content of raw $content (text nodes).
AssertContentTrait::assertEscaped protected function Passes if the raw text IS found escaped on the loaded page, fail otherwise.
AssertContentTrait::assertField protected function Asserts that a field exists with the given name or ID.
AssertContentTrait::assertFieldById protected function Asserts that a field exists with the given ID and value.
AssertContentTrait::assertFieldByName protected function Asserts that a field exists with the given name and value.
AssertContentTrait::assertFieldByXPath protected function Asserts that a field exists in the current page by the given XPath.
AssertContentTrait::assertFieldChecked protected function Asserts that a checkbox field in the current page is checked.
AssertContentTrait::assertFieldsByValue protected function Asserts that a field exists in the current page with a given Xpath result.
AssertContentTrait::assertLink protected function Passes if a link with the specified label is found.
AssertContentTrait::assertLinkByHref protected function Passes if a link containing a given href (part) is found.
AssertContentTrait::assertNoDuplicateIds protected function Asserts that each HTML ID is used for just a single element.
AssertContentTrait::assertNoEscaped protected function Passes if the raw text IS NOT found escaped on the loaded page, fail otherwise.
AssertContentTrait::assertNoField protected function Asserts that a field does not exist with the given name or ID.
AssertContentTrait::assertNoFieldById protected function Asserts that a field does not exist with the given ID and value.
AssertContentTrait::assertNoFieldByName protected function Asserts that a field does not exist with the given name and value.
AssertContentTrait::assertNoFieldByXPath protected function Asserts that a field does not exist or its value does not match, by XPath.
AssertContentTrait::assertNoFieldChecked protected function Asserts that a checkbox field in the current page is not checked.
AssertContentTrait::assertNoLink protected function Passes if a link with the specified label is not found.
AssertContentTrait::assertNoLinkByHref protected function Passes if a link containing a given href (part) is not found.
AssertContentTrait::assertNoLinkByHrefInMainRegion protected function Passes if a link containing a given href is not found in the main region.
AssertContentTrait::assertNoOption protected function Asserts that a select option in the current page does not exist.
AssertContentTrait::assertNoOptionSelected protected function Asserts that a select option in the current page is not checked.
AssertContentTrait::assertNoPattern protected function Triggers a pass if the perl regex pattern is not found in raw content.
AssertContentTrait::assertNoRaw protected function Passes if the raw text is NOT found on the loaded page, fail otherwise.
AssertContentTrait::assertNoText protected function Passes if the page (with HTML stripped) does not contains the text.
AssertContentTrait::assertNoTitle protected function Pass if the page title is not the given string.
AssertContentTrait::assertNoUniqueText protected function Passes if the text is found MORE THAN ONCE on the text version of the page.
AssertContentTrait::assertOption protected function Asserts that a select option in the current page exists.
AssertContentTrait::assertOptionByText protected function Asserts that a select option with the visible text exists.
AssertContentTrait::assertOptionSelected protected function Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionSelectedWithDrupalSelector protected function Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionWithDrupalSelector protected function Asserts that a select option in the current page exists.
AssertContentTrait::assertPattern protected function Triggers a pass if the Perl regex pattern is found in the raw content.
AssertContentTrait::assertRaw protected function Passes if the raw text IS found on the loaded page, fail otherwise.
AssertContentTrait::assertText protected function Passes if the page (with HTML stripped) contains the text.
AssertContentTrait::assertTextHelper protected function Helper for assertText and assertNoText.
AssertContentTrait::assertTextPattern protected function Asserts that a Perl regex pattern is found in the plain-text content.
AssertContentTrait::assertThemeOutput protected function Asserts themed output.
AssertContentTrait::assertTitle protected function Pass if the page title is the given string.
AssertContentTrait::assertUniqueText protected function Passes if the text is found ONLY ONCE on the text version of the page.
AssertContentTrait::assertUniqueTextHelper protected function Helper for assertUniqueText and assertNoUniqueText.
AssertContentTrait::buildXPathQuery protected function Builds an XPath query.
AssertContentTrait::constructFieldXpath protected function Helper: Constructs an XPath for the given set of attributes and value.
AssertContentTrait::cssSelect protected function Searches elements using a CSS selector in the raw content.
AssertContentTrait::getAllOptions protected function Get all option elements, including nested options, in a select.
AssertContentTrait::getDrupalSettings protected function Gets the value of drupalSettings for the currently-loaded page.
AssertContentTrait::getRawContent protected function Gets the current raw content.
AssertContentTrait::getSelectedItem protected function Get the selected value from a select field.
AssertContentTrait::getTextContent protected function Retrieves the plain-text content from the current raw content.
AssertContentTrait::getUrl protected function Get the current URL from the cURL handler. 1
AssertContentTrait::parse protected function Parse content returned from curlExec using DOM and SimpleXML.
AssertContentTrait::removeWhiteSpace protected function Removes all white-space between HTML tags from the raw content.
AssertContentTrait::setDrupalSettings protected function Sets the value of drupalSettings for the currently-loaded page.
AssertContentTrait::setRawContent protected function Sets the raw content (e.g. HTML).
AssertContentTrait::xpath protected function Performs an xpath search on the contents of the internal browser.
AssertLegacyTrait::assert Deprecated protected function
AssertLegacyTrait::assertEqual Deprecated protected function
AssertLegacyTrait::assertIdentical Deprecated protected function
AssertLegacyTrait::assertIdenticalObject Deprecated protected function
AssertLegacyTrait::assertNotEqual Deprecated protected function
AssertLegacyTrait::assertNotIdentical Deprecated protected function
AssertLegacyTrait::pass Deprecated protected function
AssertLegacyTrait::verbose Deprecated protected function
ConfigTestTrait::configImporter protected function Returns a ConfigImporter object to import test configuration.
ConfigTestTrait::copyConfig protected function Copies configuration objects from source storage to target storage.
ExtensionListTestTrait::getModulePath protected function Gets the path for the specified module.
ExtensionListTestTrait::getThemePath protected function Gets the path for the specified theme.
KernelTestBase::$backupGlobals protected property Back up and restore any global variables that may be changed by tests.
KernelTestBase::$backupStaticAttributes protected property Back up and restore static class properties that may be changed by tests.
KernelTestBase::$backupStaticAttributesBlacklist protected property Contains a few static class properties for performance.
KernelTestBase::$classLoader protected property
KernelTestBase::$configImporter protected property @todo Move into Config test base class. 7
KernelTestBase::$configSchemaCheckerExclusions protected static property An array of config object names that are excluded from schema checking.
KernelTestBase::$container protected property
KernelTestBase::$databasePrefix protected property
KernelTestBase::$preserveGlobalState protected property Do not forward any global state from the parent process to the processes that run the actual tests.
KernelTestBase::$root protected property The app root.
KernelTestBase::$runTestInSeparateProcess protected property Kernel tests are run in separate processes because they allow autoloading of code from extensions. Running the test in a separate process isolates this behavior from other tests. Subclasses should not override this property.
KernelTestBase::$siteDirectory protected property
KernelTestBase::$strictConfigSchema protected property Set to TRUE to strict check all configuration saved. 6
KernelTestBase::$vfsRoot protected property The virtual filesystem root directory.
KernelTestBase::assertPostConditions protected function 1
KernelTestBase::bootEnvironment protected function Bootstraps a basic test environment.
KernelTestBase::bootKernel private function Bootstraps a kernel for a test.
KernelTestBase::config protected function Configuration accessor for tests. Returns non-overridden configuration.
KernelTestBase::disableModules protected function Disables modules for this test.
KernelTestBase::enableModules protected function Enables modules for this test.
KernelTestBase::getConfigSchemaExclusions protected function Gets the config schema exclusions for this test.
KernelTestBase::getDatabaseConnectionInfo protected function Returns the Database connection info to be used for this test. 3
KernelTestBase::getDatabasePrefix public function
KernelTestBase::getExtensionsForModules private function Returns Extension objects for $modules to enable.
KernelTestBase::getModulesToEnable private static function Returns the modules to enable for this test.
KernelTestBase::initFileCache protected function Initializes the FileCache component.
KernelTestBase::installConfig protected function Installs default configuration for a given list of modules.
KernelTestBase::installEntitySchema protected function Installs the storage schema for a specific entity type.
KernelTestBase::installSchema protected function Installs database tables from a module schema definition.
KernelTestBase::prepareTemplate protected function
KernelTestBase::register public function Registers test-specific services. Overrides ServiceProviderInterface::register 24
KernelTestBase::render protected function Renders a render array. 1
KernelTestBase::setInstallProfile protected function Sets the install profile and rebuilds the container to update it.
KernelTestBase::setSetting protected function Sets an in-memory Settings variable.
KernelTestBase::setUpBeforeClass public static function 1
KernelTestBase::setUpFilesystem protected function Sets up the filesystem, so things like the file directory. 2
KernelTestBase::stop protected function Stops test execution.
KernelTestBase::tearDown protected function 4
KernelTestBase::tearDownCloseDatabaseConnection public function @after
KernelTestBase::vfsDump protected function Dumps the current state of the virtual filesystem to STDOUT.
KernelTestBase::__sleep public function Prevents serializing any properties.
PhpUnitWarnings::$deprecationWarnings private static property Deprecation warnings from PHPUnit to raise with @trigger_error().
PhpUnitWarnings::addWarning public function Converts PHPUnit deprecation warnings to E_USER_DEPRECATED.
RandomGeneratorTrait::$randomGenerator protected property The random generator.
RandomGeneratorTrait::getRandomGenerator protected function Gets the random generator for the utility methods.
RandomGeneratorTrait::randomMachineName protected function Generates a unique random string containing letters and numbers. 1
RandomGeneratorTrait::randomObject public function Generates a random PHP object.
RandomGeneratorTrait::randomString public function Generates a pseudo-random string of ASCII characters of codes 32 to 126.
RandomGeneratorTrait::randomStringValidate public function Callback for random string validation.
StorageCopyTrait::replaceStorageContents protected static function Copy the configuration from one storage to another and remove stale items.
TestRequirementsTrait::checkModuleRequirements private function Checks missing module requirements.
TestRequirementsTrait::checkRequirements protected function Check module requirements for the Drupal use case. 1
TestRequirementsTrait::getDrupalRoot protected static function Returns the Drupal root directory.