You are here

Home » API reference » Search API Solr 8 » SearchApiSolrLocationTest.php

class SearchApiSolrLocationTest in Search API Solr 8

Same name and namespace in other branches
  1. 8.3 tests/src/Kernel/SearchApiSolrLocationTest.php \Drupal\Tests\search_api_solr\Kernel\SearchApiSolrLocationTest
  2. 8.2 tests/src/Kernel/SearchApiSolrLocationTest.php \Drupal\Tests\search_api_solr\Kernel\SearchApiSolrLocationTest
  3. 4.x tests/src/Kernel/SearchApiSolrLocationTest.php \Drupal\Tests\search_api_solr\Kernel\SearchApiSolrLocationTest

Tests location searches and distance facets using the Solr search backend.

@group search_api_solr

Hierarchy

Expanded class hierarchy of SearchApiSolrLocationTest

File

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

Namespace

Drupal\Tests\search_api_solr\Kernel
View source 
class SearchApiSolrLocationTest extends BackendTestBase {

  /**
   * Modules to enable for this test.
   *
   * @var string[]
   */
  public static $modules = [
    'system',
    'search_api',
    'search_api_solr',
    'search_api_location',
    'search_api_test_example_content',
    'search_api_solr_test',
    'entity_test',
    'geofield',
    'field',
  ];

  /**
   * A Search API server ID.
   *
   * @var string
   */
  protected $serverId = 'solr_search_server';

  /**
   * A Search API index ID.
   *
   * @var string
   */
  protected $indexId = 'solr_search_index';

  /**
   * Seconds to wait for a soft commit on Solr.
   *
   * @var int
   */
  protected $waitForCommit = 2;

  /**
   * @var \Drupal\search_api_solr_test\Logger\InMemoryLogger
   */
  protected $logger;

  /**
   * {@inheritdoc}
   */
  public function setUp() {
    parent::setUp();
    $this
      ->installConfig([
      'search_api_solr',
      'search_api_solr_test',
    ]);
    $this
      ->commonSolrBackendSetUp();
  }

  /**
   * Required parts of the setUp() function that are the same for all backends.
   */
  protected function commonSolrBackendSetUp() {
    $this
      ->installEntitySchema('field_storage_config');
    $this
      ->installEntitySchema('field_config');

    // Create a location field and storage for testing.
    FieldStorageConfig::create([
      'field_name' => 'location',
      'entity_type' => 'entity_test_mulrev_changed',
      'type' => 'geofield',
    ])
      ->save();
    FieldConfig::create([
      'entity_type' => 'entity_test_mulrev_changed',
      'field_name' => 'location',
      'bundle' => 'item',
    ])
      ->save();
    $this
      ->insertExampleContent();

    /** @var \Drupal\search_api\Entity\Index $index */
    $index = Index::load($this->indexId);
    $location_info = [
      'datasource_id' => 'entity:entity_test_mulrev_changed',
      'property_path' => 'location',
      'type' => 'location',
    ];
    $rpt_info = [
      'datasource_id' => 'entity:entity_test_mulrev_changed',
      'property_path' => 'location',
      'type' => 'rpt',
    ];
    $fieldsHelper = $this->container
      ->get('search_api.fields_helper');

    // Index location coordinates as location data type.
    $index
      ->addField($fieldsHelper
      ->createField($index, 'location', $location_info));

    // Index location coordinates as rpt data type.
    $index
      ->addField($fieldsHelper
      ->createField($index, 'rpt', $rpt_info));
    $index
      ->save();

    /** @var \Drupal\search_api\Entity\Server $server */
    $server = Server::load($this->serverId);
    $config = $server
      ->getBackendConfig();
    $config['retrieve_data'] = TRUE;
    $server
      ->setBackendConfig($config);
    $server
      ->save();
    $this
      ->indexItems($this->indexId);
    $this->logger = new InMemoryLogger();

    /** @var \Drupal\Core\Logger\LoggerChannelInterface $loggerChannel */
    $loggerChannel = \Drupal::service('logger.factory')
      ->get('search_api_solr');
    $loggerChannel
      ->addLogger($this->logger);
  }
  protected function assertLogMessage($level, $message) {
    $last_message = $this->logger
      ->getLastMessage();
    $this
      ->assertEquals($level, $last_message['level']);
    $this
      ->assertEquals($message, $last_message['message']);
  }

  /**
   * Clear the index after every test.
   */
  public function tearDown() {
    $this
      ->clearIndex();
    parent::tearDown();
  }

  /**
   * {@inheritdoc}
   */
  protected function indexItems($index_id) {
    $index_status = parent::indexItems($index_id);
    sleep($this->waitForCommit);
    return $index_status;
  }

  /**
   * {@inheritdoc}
   */
  public function insertExampleContent() {
    $this
      ->addTestEntity(1, [
      'name' => 'London',
      'body' => 'London',
      'type' => 'item',
      'location' => 'POINT(-0.076132 51.508530)',
    ]);
    $this
      ->addTestEntity(2, [
      'name' => 'New York',
      'body' => 'New York',
      'type' => 'item',
      'location' => 'POINT(-73.138260 40.792240)',
    ]);
    $this
      ->addTestEntity(3, [
      'name' => 'Brussels',
      'body' => 'Brussels',
      'type' => 'item',
      'location' => 'POINT(4.355607 50.878899)',
    ]);
    $count = \Drupal::entityQuery('entity_test_mulrev_changed')
      ->count()
      ->execute();
    $this
      ->assertEquals(3, $count, "{$count} items inserted.");
  }

  /**
   * Tests location searches and distance facets.
   */
  public function testBackend() {
    $solr_version = $this
      ->getServer()
      ->getBackend()
      ->getSolrConnector()
      ->getSolrVersion();

    // Search 500km from Antwerp.
    $location_options = [
      [
        'field' => 'location',
        'lat' => '51.260197',
        'lon' => '4.402771',
        'radius' => '500',
      ],
    ];

    /** @var \Drupal\search_api\Query\ResultSet $result */
    $query = $this
      ->buildSearch(NULL, [], NULL, FALSE)
      ->sort('location__distance');
    $query
      ->setOption('search_api_location', $location_options);
    $result = $query
      ->execute();
    $this
      ->assertResults([
      3,
      1,
    ], $result, 'Search for 500km from Antwerp ordered by distance');

    /** @var \Drupal\search_api\Item\Item $item */
    $item = $result
      ->getResultItems()['entity:entity_test_mulrev_changed/3:en'];
    $distance = $item
      ->getField('location__distance')
      ->getValues()[0];
    $this
      ->assertEquals(42.5263374675, $distance, 'The distance is correctly returned');

    // Search between 100km and 6000km from Antwerp.
    $location_options = [
      [
        'field' => 'location',
        'lat' => '51.260197',
        'lon' => '4.402771',
      ],
    ];
    $query = $this
      ->buildSearch(NULL, [], NULL, FALSE)
      ->addCondition('location', [
      '100',
      '6000',
    ], 'BETWEEN')
      ->sort('location__distance', 'DESC');
    $query
      ->setOption('search_api_location', $location_options);
    $result = $query
      ->execute();
    $this
      ->assertResults([
      2,
      1,
    ], $result, 'Search between 100 and 6000km from Antwerp ordered by distance descending');
    $facets_options['location__distance'] = [
      'field' => 'location__distance',
      'limit' => 10,
      'min_count' => 0,
      'missing' => TRUE,
    ];

    // Search 1000km from Antwerp.
    $location_options = [
      [
        'field' => 'location',
        'lat' => '51.260197',
        'lon' => '4.402771',
        'radius' => '1000',
      ],
    ];
    $query = $this
      ->buildSearch(NULL, [], NULL, FALSE)
      ->sort('location__distance');
    $query
      ->setOption('search_api_location', $location_options);
    $query
      ->setOption('search_api_facets', $facets_options);
    $result = $query
      ->execute();
    $facets = $result
      ->getExtraData('search_api_facets', [])['location__distance'];
    $expected = [
      [
        'filter' => '[0 199]',
        'count' => 1,
      ],
      [
        'filter' => '[200 399]',
        'count' => 1,
      ],
      [
        'filter' => '[400 599]',
        'count' => 0,
      ],
      [
        'filter' => '[600 799]',
        'count' => 0,
      ],
      [
        'filter' => '[800 999]',
        'count' => 0,
      ],
    ];
    $this
      ->assertEquals($expected, $facets, 'The correct location facets are returned');
    $facets_options['location__distance'] = [
      'field' => 'location__distance',
      'limit' => 3,
      'min_count' => 1,
      'missing' => TRUE,
    ];

    // Search between 100km and 1000km from Antwerp.
    $location_options = [
      [
        'field' => 'location',
        'lat' => '51.260197',
        'lon' => '4.402771',
        'radius' => '1000',
      ],
    ];
    $query = $this
      ->buildSearch(NULL, [], NULL, FALSE)
      ->addCondition('location', [
      '100',
      '1000',
    ], 'BETWEEN')
      ->sort('location__distance');
    $query
      ->setOption('search_api_location', $location_options);
    $query
      ->setOption('search_api_facets', $facets_options);
    $result = $query
      ->execute();
    $facets = $result
      ->getExtraData('search_api_facets', [])['location__distance'];
    $expected = [
      [
        'filter' => '[100 399]',
        'count' => 1,
      ],
    ];
    $this
      ->assertEquals($expected, $facets, 'The correct location facets are returned');

    // Tests the RPT data type of SearchApiSolrBackend.
    $query = $this
      ->buildSearch(NULL, [], NULL, FALSE);
    $options =& $query
      ->getOptions();
    $options['search_api_facets']['rpt'] = [
      'field' => 'rpt',
      'limit' => 3,
      'operator' => 'and',
      'min_count' => 1,
      'missing' => FALSE,
    ];
    $options['search_api_rpt']['rpt'] = [
      'field' => 'rpt',
      'geom' => '["-180 -90" TO "180 90"]',
      'gridLevel' => '2',
      'maxCells' => '35554432',
      'distErrPct' => '',
      'distErr' => '',
      'format' => 'ints2D',
    ];
    $result = $query
      ->execute();
    $expected = [
      [
        'filter' => [
          "gridLevel",
          2,
          "columns",
          32,
          "rows",
          32,
          "minX",
          -180.0,
          "maxX",
          180.0,
          "minY",
          -90.0,
          "maxY",
          90.0,
          "counts_ints2D",
          [
            NULL,
            NULL,
            NULL,
            NULL,
            NULL,
            NULL,
            [
              0,
              0,
              0,
              0,
              0,
              0,
              0,
              0,
              0,
              0,
              0,
              0,
              0,
              0,
              0,
              1,
              1,
              0,
              0,
              0,
              0,
              0,
              0,
              0,
              0,
              0,
              0,
              0,
              0,
              0,
              0,
              0,
            ],
            NULL,
            [
              0,
              0,
              0,
              0,
              0,
              0,
              0,
              0,
              0,
              1,
              0,
              0,
              0,
              0,
              0,
              0,
              0,
              0,
              0,
              0,
              0,
              0,
              0,
              0,
              0,
              0,
              0,
              0,
              0,
              0,
              0,
              0,
            ],
            NULL,
            NULL,
            NULL,
            NULL,
            NULL,
            NULL,
            NULL,
            NULL,
            NULL,
            NULL,
            NULL,
            NULL,
            NULL,
            NULL,
            NULL,
            NULL,
            NULL,
            NULL,
            NULL,
            NULL,
            NULL,
            NULL,
            NULL,
          ],
        ],
        'count' => 3,
      ],
    ];
    if (version_compare($solr_version, 5.1, '>=')) {
      $facets = $result
        ->getExtraData('search_api_facets', [])['rpt'];
      $this
        ->assertEquals($expected, $facets, 'The correct location facets are returned');
    }
    else {
      $this
        ->assertLogMessage(LOG_ERR, 'Rpt data type feature is only supported by Solr version 5.1 or higher.');
    }
    $query = $this
      ->buildSearch(NULL, [], NULL, FALSE);
    $options =& $query
      ->getOptions();
    $options['search_api_facets']['rpt'] = [
      'field' => 'rpt',
      'limit' => 4,
      'operator' => 'or',
      'min_count' => 1,
      'missing' => FALSE,
    ];
    $options['search_api_rpt']['rpt'] = [
      'field' => 'rpt',
      'geom' => '["-60 -85" TO "130 70"]',
      'gridLevel' => '2',
      'maxCells' => '35554432',
      'distErrPct' => '',
      'distErr' => '',
      'format' => 'ints2D',
    ];
    $result = $query
      ->execute();
    $expected = [
      [
        'filter' => [
          "gridLevel",
          2,
          "columns",
          18,
          "rows",
          29,
          "minX",
          -67.5,
          "maxX",
          135.0,
          "minY",
          -90.0,
          "maxY",
          73.125,
          "counts_ints2D",
          [
            NULL,
            NULL,
            NULL,
            [
              0,
              0,
              0,
              0,
              0,
              1,
              1,
              0,
              0,
              0,
              0,
              0,
              0,
              0,
              0,
              0,
              0,
              0,
            ],
            NULL,
            NULL,
            NULL,
            NULL,
            NULL,
            NULL,
            NULL,
            NULL,
            NULL,
            NULL,
            NULL,
            NULL,
            NULL,
            NULL,
            NULL,
            NULL,
            NULL,
            NULL,
            NULL,
            NULL,
            NULL,
            NULL,
            NULL,
            NULL,
            NULL,
          ],
        ],
        'count' => 2,
      ],
    ];
    if (version_compare($solr_version, 5.1, '>=')) {
      $facets = $result
        ->getExtraData('search_api_facets', [])['rpt'];
      $this
        ->assertEquals($expected, $facets, 'The correct location facets are returned');
    }
    else {
      $this
        ->assertLogMessage(LOG_ERR, 'Rpt data type feature is only supported by Solr version 5.1 or higher.');
    }
  }

  /**
   * {@inheritdoc}
   */
  protected function checkServerBackend() {
  }

  /**
   * {@inheritdoc}
   */
  protected function updateIndex() {
  }

  /**
   * {@inheritdoc}
   */
  protected function checkSecondServer() {
  }

  /**
   * {@inheritdoc}
   */
  protected function checkModuleUninstall() {
  }

}

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
BackendTestBase::addField protected function Adds a field to a search index.
BackendTestBase::assertResults protected function Asserts that the given result set complies with expectations.
BackendTestBase::backendSpecificRegressionTests protected function Runs backend specific regression tests. 1
BackendTestBase::buildSearch protected function Builds a search query for testing purposes.
BackendTestBase::checkBackendSpecificFeatures protected function Checks backend specific features. 1
BackendTestBase::checkDefaultIndex protected function Tests the index that was installed through default configuration files.
BackendTestBase::checkDefaultServer protected function Tests the server that was installed through default configuration files.
BackendTestBase::checkFacets protected function Tests whether facets work correctly.
BackendTestBase::checkIndexWithoutFields protected function Checks the correct handling of an index without fields. 1
BackendTestBase::clearIndex protected function Clears the test index.
BackendTestBase::disableHtmlFilter protected function Disables the "HTML Filter" processor for the index.
BackendTestBase::enableHtmlFilter protected function Enables the "HTML Filter" processor for the index.
BackendTestBase::facetCompare protected function Compares two facet filters to determine their order.
BackendTestBase::getIndex protected function Retrieves the search index used by this test.
BackendTestBase::getServer protected function Retrieves the search server used by this test.
BackendTestBase::regressionTest1403916 protected function Regression tests for multi word search results sets and wrong facet counts.
BackendTestBase::regressionTest1658964 protected function Regression tests for facets with counts of 0.
BackendTestBase::regressionTest1863672 protected function Regression tests for same content multiple times in the search result.
BackendTestBase::regressionTest1916474 protected function Regression tests for correctly indexing multiple float/decimal fields.
BackendTestBase::regressionTest2007872 protected function Regression tests for missing results when using OR filters.
BackendTestBase::regressionTest2040543 protected function Regression tests for (none) facet shown when feature is set to "no".
BackendTestBase::regressionTest2111753 protected function Regression tests for searching for multiple words using "OR" condition.
BackendTestBase::regressionTest2127001 protected function Regression tests for non-working operator "contains none of these words".
BackendTestBase::regressionTest2136409 protected function Regression tests for handling of NULL filters.
BackendTestBase::regressionTest2284199 protected function Regression tests for problems with taxonomy term parent.
BackendTestBase::regressionTest2469547 protected function Regression tests for facets on fulltext fields.
BackendTestBase::regressionTest2471509 protected function Regression tests for strings longer than 50 chars.
BackendTestBase::regressionTest2616804 protected function Regression tests for multibyte characters exceeding 50 byte.
BackendTestBase::regressionTest2745655 protected function Tests (NOT) NULL conditions on fulltext fields.
BackendTestBase::regressionTest2767609 protected function Regression test for conditions with empty strings as values.
BackendTestBase::regressionTest2783987 protected function Regression test for facet with "min_count" greater than 1.
BackendTestBase::regressionTest2809753 protected function Regression test for multiple facets.
BackendTestBase::regressionTests protected function Executes regression tests for issues that were already fixed.
BackendTestBase::regressionTests2 protected function Executes regression tests which are unpractical to run in between.
BackendTestBase::resetEntityCache protected function Resets the entity cache for the specified entity.
BackendTestBase::searchNoResults protected function Tests that a search on the index doesn't have any results.
BackendTestBase::searchSuccess protected function Tests whether some test searches have the correct results.
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.
ExampleContentTrait::$entities protected property The generated test entities, keyed by ID.
ExampleContentTrait::$ids protected property The Search API item IDs of the generated entities.
ExampleContentTrait::addTestEntity protected function Creates and saves a test entity with the given values.
ExampleContentTrait::getItemIds protected function Returns the item IDs for the given entity IDs. 1
ExampleContentTrait::removeTestEntity protected function Deletes the test entity with the given ID.
ExampleContentTrait::setUpExampleStructure protected function Sets up the necessary bundles on the test entity type.
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::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.
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.
SearchApiSolrLocationTest::$indexId protected property A Search API index ID. Overrides BackendTestBase::$indexId
SearchApiSolrLocationTest::$logger protected property
SearchApiSolrLocationTest::$modules public static property Modules to enable for this test. Overrides BackendTestBase::$modules
SearchApiSolrLocationTest::$serverId protected property A Search API server ID. Overrides BackendTestBase::$serverId
SearchApiSolrLocationTest::$waitForCommit protected property Seconds to wait for a soft commit on Solr.
SearchApiSolrLocationTest::assertLogMessage protected function
SearchApiSolrLocationTest::checkModuleUninstall protected function Tests whether removing the configuration again works as it should. Overrides BackendTestBase::checkModuleUninstall
SearchApiSolrLocationTest::checkSecondServer protected function Tests that a second server doesn't interfere with the first. Overrides BackendTestBase::checkSecondServer
SearchApiSolrLocationTest::checkServerBackend protected function Tests the correct setup of the server backend. Overrides BackendTestBase::checkServerBackend
SearchApiSolrLocationTest::commonSolrBackendSetUp protected function Required parts of the setUp() function that are the same for all backends.
SearchApiSolrLocationTest::indexItems protected function Indexes all (unindexed) items on the specified index. Overrides ExampleContentTrait::indexItems
SearchApiSolrLocationTest::insertExampleContent public function Creates several test entities. Overrides ExampleContentTrait::insertExampleContent
SearchApiSolrLocationTest::setUp public function Overrides BackendTestBase::setUp
SearchApiSolrLocationTest::tearDown public function Clear the index after every test. Overrides KernelTestBase::tearDown
SearchApiSolrLocationTest::testBackend public function Tests location searches and distance facets. Overrides BackendTestBase::testBackend
SearchApiSolrLocationTest::updateIndex protected function Checks whether changes to the index's fields are picked up by the server. Overrides BackendTestBase::updateIndex
StorageCopyTrait::replaceStorageContents protected static function Copy the configuration from one storage to another and remove stale items.
StringTranslationTrait::$stringTranslation protected property The string translation service. 1
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.
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.