class AcquiaSearchOverrideTest in Acquia Connector 8
Tests for Acquia Search override cores.
@group Acquia search
Hierarchy
- class \Drupal\KernelTests\KernelTestBase extends \PHPUnit\Framework\TestCase implements ServiceProviderInterface uses AssertContentTrait, AssertLegacyTrait, AssertHelperTrait, ConfigTestTrait, PhpunitCompatibilityTrait, RandomGeneratorTrait, TestRequirementsTrait
- class \Drupal\Tests\acquia_search\Kernel\AcquiaSearchOverrideTest
Expanded class hierarchy of AcquiaSearchOverrideTest
File
- acquia_search/
tests/ src/ Kernel/ AcquiaSearchOverrideTest.php, line 17
Namespace
Drupal\Tests\acquia_search\KernelView 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
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
AcquiaSearchOverrideTest:: |
public static | property |
Modules to enable. Overrides KernelTestBase:: |
|
AcquiaSearchOverrideTest:: |
protected | function | Asserts if the Solr Connector getUpdateQuery() method throws exception. | |
AcquiaSearchOverrideTest:: |
protected | function | Helper method to test SearchApiSolrAcquiaConnector::getUpdateQuery. | |
AcquiaSearchOverrideTest:: |
protected | function | Returns the current DB name. | |
AcquiaSearchOverrideTest:: |
protected | function | Returns the folder name of the current site folder. | |
AcquiaSearchOverrideTest:: |
protected | function | Sets available search cores into the subscription heartbeat data. | |
AcquiaSearchOverrideTest:: |
protected | function |
Overrides KernelTestBase:: |
|
AcquiaSearchOverrideTest:: |
public | function | Tests Acquia Dev hosting environment detected. | |
AcquiaSearchOverrideTest:: |
public | function | Tests environment detection without cores available. | |
AcquiaSearchOverrideTest:: |
public | function | Tests read-only. | |
AcquiaSearchOverrideTest:: |
public | function | Tests prod environment detection. | |
AcquiaSearchOverrideTest:: |
public | function | Tests Acquia Dev hosting environment and search v3 core detected. | |
AcquiaSearchOverrideTest:: |
public | function | Test core override when a core with db name is unavailable. | |
AcquiaSearchOverrideTest:: |
public | function | No Acquia hosting and DB detected - should override into Readonly. | |
AssertContentTrait:: |
protected | property | The current raw content. | |
AssertContentTrait:: |
protected | property | The drupalSettings value from the current raw $content. | |
AssertContentTrait:: |
protected | property | The XML structure parsed from the current raw $content. | 1 |
AssertContentTrait:: |
protected | property | The plain-text content of raw $content (text nodes). | |
AssertContentTrait:: |
protected | function | Passes if the raw text IS found escaped on the loaded page, fail otherwise. | |
AssertContentTrait:: |
protected | function | Asserts that a field exists with the given name or ID. | |
AssertContentTrait:: |
protected | function | Asserts that a field exists with the given ID and value. | |
AssertContentTrait:: |
protected | function | Asserts that a field exists with the given name and value. | |
AssertContentTrait:: |
protected | function | Asserts that a field exists in the current page by the given XPath. | |
AssertContentTrait:: |
protected | function | Asserts that a checkbox field in the current page is checked. | |
AssertContentTrait:: |
protected | function | Asserts that a field exists in the current page with a given Xpath result. | |
AssertContentTrait:: |
protected | function | Passes if a link with the specified label is found. | |
AssertContentTrait:: |
protected | function | Passes if a link containing a given href (part) is found. | |
AssertContentTrait:: |
protected | function | Asserts that each HTML ID is used for just a single element. | |
AssertContentTrait:: |
protected | function | Passes if the raw text IS NOT found escaped on the loaded page, fail otherwise. | |
AssertContentTrait:: |
protected | function | Asserts that a field does not exist with the given name or ID. | |
AssertContentTrait:: |
protected | function | Asserts that a field does not exist with the given ID and value. | |
AssertContentTrait:: |
protected | function | Asserts that a field does not exist with the given name and value. | |
AssertContentTrait:: |
protected | function | Asserts that a field does not exist or its value does not match, by XPath. | |
AssertContentTrait:: |
protected | function | Asserts that a checkbox field in the current page is not checked. | |
AssertContentTrait:: |
protected | function | Passes if a link with the specified label is not found. | |
AssertContentTrait:: |
protected | function | Passes if a link containing a given href (part) is not found. | |
AssertContentTrait:: |
protected | function | Passes if a link containing a given href is not found in the main region. | |
AssertContentTrait:: |
protected | function | Asserts that a select option in the current page does not exist. | |
AssertContentTrait:: |
protected | function | Asserts that a select option in the current page is not checked. | |
AssertContentTrait:: |
protected | function | Triggers a pass if the perl regex pattern is not found in raw content. | |
AssertContentTrait:: |
protected | function | Passes if the raw text is NOT found on the loaded page, fail otherwise. | |
AssertContentTrait:: |
protected | function | Passes if the page (with HTML stripped) does not contains the text. | |
AssertContentTrait:: |
protected | function | Pass if the page title is not the given string. | |
AssertContentTrait:: |
protected | function | Passes if the text is found MORE THAN ONCE on the text version of the page. | |
AssertContentTrait:: |
protected | function | Asserts that a select option in the current page exists. | |
AssertContentTrait:: |
protected | function | Asserts that a select option with the visible text exists. | |
AssertContentTrait:: |
protected | function | Asserts that a select option in the current page is checked. | |
AssertContentTrait:: |
protected | function | Asserts that a select option in the current page is checked. | |
AssertContentTrait:: |
protected | function | Asserts that a select option in the current page exists. | |
AssertContentTrait:: |
protected | function | Triggers a pass if the Perl regex pattern is found in the raw content. | |
AssertContentTrait:: |
protected | function | Passes if the raw text IS found on the loaded page, fail otherwise. | |
AssertContentTrait:: |
protected | function | Passes if the page (with HTML stripped) contains the text. | |
AssertContentTrait:: |
protected | function | Helper for assertText and assertNoText. | |
AssertContentTrait:: |
protected | function | Asserts that a Perl regex pattern is found in the plain-text content. | |
AssertContentTrait:: |
protected | function | Asserts themed output. | |
AssertContentTrait:: |
protected | function | Pass if the page title is the given string. | |
AssertContentTrait:: |
protected | function | Passes if the text is found ONLY ONCE on the text version of the page. | |
AssertContentTrait:: |
protected | function | Helper for assertUniqueText and assertNoUniqueText. | |
AssertContentTrait:: |
protected | function | Builds an XPath query. | |
AssertContentTrait:: |
protected | function | Helper: Constructs an XPath for the given set of attributes and value. | |
AssertContentTrait:: |
protected | function | Searches elements using a CSS selector in the raw content. | |
AssertContentTrait:: |
protected | function | Get all option elements, including nested options, in a select. | |
AssertContentTrait:: |
protected | function | Gets the value of drupalSettings for the currently-loaded page. | |
AssertContentTrait:: |
protected | function | Gets the current raw content. | |
AssertContentTrait:: |
protected | function | Get the selected value from a select field. | |
AssertContentTrait:: |
protected | function | Retrieves the plain-text content from the current raw content. | |
AssertContentTrait:: |
protected | function | Get the current URL from the cURL handler. | 1 |
AssertContentTrait:: |
protected | function | Parse content returned from curlExec using DOM and SimpleXML. | |
AssertContentTrait:: |
protected | function | Removes all white-space between HTML tags from the raw content. | |
AssertContentTrait:: |
protected | function | Sets the value of drupalSettings for the currently-loaded page. | |
AssertContentTrait:: |
protected | function | Sets the raw content (e.g. HTML). | |
AssertContentTrait:: |
protected | function | Performs an xpath search on the contents of the internal browser. | |
AssertHelperTrait:: |
protected static | function | Casts MarkupInterface objects into strings. | |
AssertLegacyTrait:: |
protected | function | Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead. | |
AssertLegacyTrait:: |
protected | function | Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead. | |
AssertLegacyTrait:: |
protected | function | Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertSame() instead. | |
AssertLegacyTrait:: |
protected | function | Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead. | |
AssertLegacyTrait:: |
protected | function | Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotEquals() instead. | |
AssertLegacyTrait:: |
protected | function | Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotSame() instead. | |
AssertLegacyTrait:: |
protected | function | Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead. | |
AssertLegacyTrait:: |
protected | function | ||
ConfigTestTrait:: |
protected | function | Returns a ConfigImporter object to import test configuration. | |
ConfigTestTrait:: |
protected | function | Copies configuration objects from source storage to target storage. | |
KernelTestBase:: |
protected | property | Back up and restore any global variables that may be changed by tests. | |
KernelTestBase:: |
protected | property | Back up and restore static class properties that may be changed by tests. | |
KernelTestBase:: |
protected | property | Contains a few static class properties for performance. | |
KernelTestBase:: |
protected | property | ||
KernelTestBase:: |
protected | property | @todo Move into Config test base class. | 7 |
KernelTestBase:: |
protected static | property | An array of config object names that are excluded from schema checking. | |
KernelTestBase:: |
protected | property | ||
KernelTestBase:: |
protected | property | ||
KernelTestBase:: |
protected | property | Do not forward any global state from the parent process to the processes that run the actual tests. | |
KernelTestBase:: |
protected | property | The app root. | |
KernelTestBase:: |
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:: |
protected | property | ||
KernelTestBase:: |
protected | property | Set to TRUE to strict check all configuration saved. | 6 |
KernelTestBase:: |
protected | property | The virtual filesystem root directory. | |
KernelTestBase:: |
protected | function | 1 | |
KernelTestBase:: |
protected | function | Bootstraps a basic test environment. | |
KernelTestBase:: |
private | function | Bootstraps a kernel for a test. | |
KernelTestBase:: |
protected | function | Configuration accessor for tests. Returns non-overridden configuration. | |
KernelTestBase:: |
protected | function | Disables modules for this test. | |
KernelTestBase:: |
protected | function | Enables modules for this test. | |
KernelTestBase:: |
protected | function | Gets the config schema exclusions for this test. | |
KernelTestBase:: |
protected | function | Returns the Database connection info to be used for this test. | 1 |
KernelTestBase:: |
public | function | ||
KernelTestBase:: |
private | function | Returns Extension objects for $modules to enable. | |
KernelTestBase:: |
private static | function | Returns the modules to enable for this test. | |
KernelTestBase:: |
protected | function | Initializes the FileCache component. | |
KernelTestBase:: |
protected | function | Installs default configuration for a given list of modules. | |
KernelTestBase:: |
protected | function | Installs the storage schema for a specific entity type. | |
KernelTestBase:: |
protected | function | Installs database tables from a module schema definition. | |
KernelTestBase:: |
protected | function | Returns whether the current test method is running in a separate process. | |
KernelTestBase:: |
protected | function | ||
KernelTestBase:: |
public | function |
Registers test-specific services. Overrides ServiceProviderInterface:: |
26 |
KernelTestBase:: |
protected | function | Renders a render array. | 1 |
KernelTestBase:: |
protected | function | Sets the install profile and rebuilds the container to update it. | |
KernelTestBase:: |
protected | function | Sets an in-memory Settings variable. | |
KernelTestBase:: |
public static | function | 1 | |
KernelTestBase:: |
protected | function | Sets up the filesystem, so things like the file directory. | 2 |
KernelTestBase:: |
protected | function | Stops test execution. | |
KernelTestBase:: |
protected | function | 6 | |
KernelTestBase:: |
public | function | @after | |
KernelTestBase:: |
protected | function | Dumps the current state of the virtual filesystem to STDOUT. | |
KernelTestBase:: |
public | function | BC: Automatically resolve former KernelTestBase class properties. | |
KernelTestBase:: |
public | function | Prevents serializing any properties. | |
PhpunitCompatibilityTrait:: |
public | function | Returns a mock object for the specified class using the available method. | |
PhpunitCompatibilityTrait:: |
public | function | Compatibility layer for PHPUnit 6 to support PHPUnit 4 code. | |
RandomGeneratorTrait:: |
protected | property | The random generator. | |
RandomGeneratorTrait:: |
protected | function | Gets the random generator for the utility methods. | |
RandomGeneratorTrait:: |
protected | function | Generates a unique random string containing letters and numbers. | 1 |
RandomGeneratorTrait:: |
public | function | Generates a random PHP object. | |
RandomGeneratorTrait:: |
public | function | Generates a pseudo-random string of ASCII characters of codes 32 to 126. | |
RandomGeneratorTrait:: |
public | function | Callback for random string validation. | |
StorageCopyTrait:: |
protected static | function | Copy the configuration from one storage to another and remove stale items. | |
TestRequirementsTrait:: |
private | function | Checks missing module requirements. | |
TestRequirementsTrait:: |
protected | function | Check module requirements for the Drupal use case. | 1 |
TestRequirementsTrait:: |
protected static | function | Returns the Drupal root directory. |