You are here

Home » API reference » Monitoring 8 » MonitoringSearchAPITest.php

class MonitoringSearchAPITest in Monitoring 8

Tests for search API sensor.

@group monitoring @dependencies search_api

Hierarchy

Expanded class hierarchy of MonitoringSearchAPITest

File

tests/src/Kernel/MonitoringSearchAPITest.php, line 16

Namespace

Drupal\Tests\monitoring\Kernel
View source 
class MonitoringSearchAPITest extends MonitoringUnitTestBase {

  /**
   * Modules to enable.
   *
   * @var array
   */
  public static $modules = array(
    'field',
    'search_api',
    'search_api_db',
    'search_api_test_db',
    'node',
    'entity_test',
    'text',
    'taxonomy',
    'search_api_solr',
  );

  /**
   * {@inheritdoc}
   */
  public function setUp() {
    parent::setUp();

    // Install required database tables for each module.
    $this
      ->installSchema('search_api', [
      'search_api_item',
    ]);
    $this
      ->installEntitySchema('search_api_task');
    $this
      ->installSchema('system', [
      'key_value_expire',
    ]);
    $this
      ->installSchema('user', [
      'users_data',
    ]);

    // Install the schema for entity entity_test_mulrev_changed.
    $this
      ->installEntitySchema('entity_test_mulrev_changed');

    // Set up the required bundles.
    $this
      ->createEntityTestBundles();

    // Install the test search API index and server used by the test.
    $this
      ->installConfig([
      'search_api',
      'search_api_test_db',
    ]);
    \Drupal::service('search_api.index_task_manager')
      ->addItemsAll(Index::load('database_search_index'));
  }

  /**
   * Tests individual sensors.
   */
  public function testSensors() {

    // Create content first to avoid a Division by zero error.
    // Two new articles, none indexed.
    $entity = EntityTestMulRevChanged::create(array(
      'type' => 'article',
    ));
    $entity
      ->save();
    $entity = EntityTestMulRevChanged::create(array(
      'type' => 'article',
    ));
    $entity
      ->save();
    $result = $this
      ->runSensor('search_api_database_search_index');
    $this
      ->assertEqual($result
      ->getValue(), 2);

    // Update the index to test sensor result.
    $index = Index::load('database_search_index');
    $index
      ->indexItems();
    $entity = EntityTestMulRevChanged::create(array(
      'type' => 'article',
    ));
    $entity
      ->save();
    $entity = EntityTestMulRevChanged::create(array(
      'type' => 'article',
    ));
    $entity
      ->save();
    $entity = EntityTestMulRevChanged::create(array(
      'type' => 'article',
    ));
    $entity
      ->save();

    // New articles are not yet indexed.
    $result = $this
      ->runSensor('search_api_database_search_index');
    $this
      ->assertEqual($result
      ->getValue(), 3);
    $index = Index::load('database_search_index');
    $index
      ->indexItems();

    // Everything should be indexed.
    $result = $this
      ->runSensor('search_api_database_search_index');
    $this
      ->assertEqual($result
      ->getValue(), 0);

    // Verify that hooks do not break when sensors unexpectedly do exist or
    // don't exist.
    $sensor = SensorConfig::create(array(
      'id' => 'search_api_existing',
      'label' => 'Existing sensor',
      'plugin_id' => 'search_api_unindexed',
      'settings' => array(
        'index_id' => 'existing',
      ),
    ));
    $sensor
      ->save();
    $index_existing = Index::create([
      'id' => 'existing',
      'status' => FALSE,
      'name' => 'Existing',
      'tracker' => 'default',
    ]);
    $index_existing
      ->save();

    // Manually delete the sensor and then the index.
    $sensor
      ->delete();
    $index_existing
      ->delete();
  }

  /**
   * Tests the solr disk usage sensor.
   */
  public function testSolrDiskUsage() {
    $sensor_config = SensorConfig::create([
      'id' => 'solr_disk_usage',
      'label' => 'Solr disk usage',
      'plugin_id' => 'solr_disk_usage',
      'value_label' => 'mb',
      'caching_time' => 86400,
      'value_type' => 'number',
      'thresholds' => [
        'type' => 'exceeds',
        'warning' => 20,
        'critical' => 50,
      ],
      'settings' => [
        'server' => '',
      ],
    ]);
    $sensor_config
      ->save();
    $sensor_result = $this
      ->runSensor('solr_disk_usage');
    $this
      ->assertTrue($sensor_result
      ->isCritical());
    $this
      ->assertEquals($sensor_result
      ->getMessage(), 'RuntimeException: Solr server is not configured.');
    $sensor_config = SensorConfig::load('solr_disk_usage');
    $settings = $sensor_config
      ->getSettings();
    $settings['server'] = 'search_api_server';
    $sensor_config->settings = $settings;
    $sensor_config
      ->save();
    $sensor_result = $this
      ->runSensor('solr_disk_usage');
    $this
      ->assertTrue($sensor_result
      ->isCritical());
    $this
      ->assertEquals($sensor_result
      ->getMessage(), "RuntimeException: Solr server doesn't exist.");
    $server = Server::create([
      'name' => 'Solr server',
      'status' => TRUE,
      'id' => 'search_api_server',
      'backend' => 'search_api_solr',
      'backend_config' => [
        'connector' => 'standard',
        'connector_config' => [
          'scheme' => 'http',
          'host' => 'localhost',
          'port' => '8983',
          'path' => '/solr',
          'core' => 'd8',
        ],
      ],
    ]);
    $server
      ->save();
    $sensor_config->settings['server'] = 'search_api_server';
    $sensor_config
      ->save();
    \Drupal::state()
      ->set('monitoring.test_solr_index_size', '5 MB');
    $solr_info = [
      'server_name' => $server
        ->label(),
      'host' => $server
        ->getBackend()
        ->getConfiguration()['connector_config']['host'],
      'core' => $server
        ->getBackend()
        ->getConfiguration()['connector_config']['core'],
      'total_physical_memory' => 10000000,
      'free_physical_memory' => 8000000,
      'total_swap_memory' => 10000000,
      'free_swap_memory' => 5000000,
      'indexed_docs' => 100,
    ];
    \Drupal::state()
      ->set('monitoring.test_solr_info', $solr_info);
    $sensor_result = $this
      ->runSensor('solr_disk_usage');
    $this
      ->assertTrue($sensor_result
      ->isOk());
    $this
      ->assertEquals($sensor_result
      ->getMessage(), "5 MB");
    $verbose_output = $sensor_result
      ->getVerboseOutput();
    $plain = \Drupal::getContainer()
      ->get('renderer')
      ->renderPlain($verbose_output);
    $this
      ->setRawContent($plain);
    $this
      ->assertText('Solr server: Solr server, host: localhost, core: d8');
    $this
      ->assertText('Solr server: Solr server, host: localhost, core: d8');
    $this
      ->assertText('Physical memory (9.54 MB available)');
    $this
      ->assertText('Swap memory (9.54 MB available)');
    $this
      ->assertText('1.91 MB (20.00%) used');
    $this
      ->assertText('4.77 MB (50.00%) used');
    \Drupal::state()
      ->set('monitoring.test_solr_index_size', '21 MB');
    $sensor_result = $this
      ->runSensor('solr_disk_usage');
    $this
      ->assertTrue($sensor_result
      ->isWarning());
    $this
      ->assertEquals($sensor_result
      ->getMessage(), "21 MB");
    \Drupal::state()
      ->set('monitoring.test_solr_index_size', '51 MB');
    $sensor_result = $this
      ->runSensor('solr_disk_usage');
    $this
      ->assertTrue($sensor_result
      ->isCritical());
    $this
      ->assertEquals($sensor_result
      ->getMessage(), "51 MB");

    // Check that we correctly convert GB to MB so we get the right state.
    \Drupal::state()
      ->set('monitoring.test_solr_index_size', '1 GB');
    $sensor_result = $this
      ->runSensor('solr_disk_usage');
    $this
      ->assertTrue($sensor_result
      ->isCritical());
    $this
      ->assertEquals($sensor_result
      ->getMessage(), "1 GB");
    \Drupal::state()
      ->set('monitoring.test_solr_index_size', '100 bytes');
    $sensor_result = $this
      ->runSensor('solr_disk_usage');
    $this
      ->assertTrue($sensor_result
      ->isOk());
    $this
      ->assertEquals($sensor_result
      ->getMessage(), "100 bytes");
  }

  /**
   * Sets up the necessary bundles on the test entity type.
   */
  protected function createEntityTestBundles() {
    entity_test_create_bundle('item', NULL, 'entity_test_mulrev_changed');
    entity_test_create_bundle('article', NULL, 'entity_test_mulrev_changed');
  }

}

Members

Namesort descending Modifiers Type Description Overrides
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.
AssertHelperTrait::castSafeStrings protected static function Casts MarkupInterface objects into strings.
AssertLegacyTrait::assert protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead.
AssertLegacyTrait::assertEqual protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead.
AssertLegacyTrait::assertIdentical protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertSame() instead.
AssertLegacyTrait::assertIdenticalObject protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead.
AssertLegacyTrait::assertNotEqual protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotEquals() instead.
AssertLegacyTrait::assertNotIdentical protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotSame() instead.
AssertLegacyTrait::pass protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead.
AssertLegacyTrait::verbose 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.
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. 1
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::isTestInIsolation Deprecated protected function Returns whether the current test method is running in a separate process.
KernelTestBase::prepareTemplate protected function
KernelTestBase::register public function Registers test-specific services. Overrides ServiceProviderInterface::register 26
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 6
KernelTestBase::tearDownCloseDatabaseConnection public function @after
KernelTestBase::vfsDump protected function Dumps the current state of the virtual filesystem to STDOUT.
KernelTestBase::__get Deprecated public function BC: Automatically resolve former KernelTestBase class properties.
KernelTestBase::__sleep public function Prevents serializing any properties.
MonitoringSearchAPITest::$modules public static property Modules to enable. Overrides MonitoringUnitTestBase::$modules
MonitoringSearchAPITest::createEntityTestBundles protected function Sets up the necessary bundles on the test entity type.
MonitoringSearchAPITest::setUp public function Overrides MonitoringUnitTestBase::setUp
MonitoringSearchAPITest::testSensors public function Tests individual sensors.
MonitoringSearchAPITest::testSolrDiskUsage public function Tests the solr disk usage sensor.
MonitoringUnitTestBase::runSensor protected function Executes a sensor and returns the result.
PhpunitCompatibilityTrait::getMock Deprecated public function Returns a mock object for the specified class using the available method.
PhpunitCompatibilityTrait::setExpectedException Deprecated public function Compatibility layer for PHPUnit 6 to support PHPUnit 4 code.
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.