You are here

class SearchApiSolrTest in Search API Solr 8

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

Tests index and search capabilities using the Solr search backend.

@group search_api_solr

Hierarchy

Expanded class hierarchy of SearchApiSolrTest

File

tests/src/Kernel/SearchApiSolrTest.php, line 21

Namespace

Drupal\Tests\search_api_solr\Kernel
View source
class SearchApiSolrTest extends BackendTestBase {
  use InvokeMethodTrait;

  /**
   * Modules to enable for this test.
   *
   * @var string[]
   */
  public static $modules = array(
    'search_api_autocomplete',
    'search_api_solr',
    'search_api_solr_test',
    'user',
  );

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

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

  /**
   * Whether a Solr core is available for testing.
   *
   * Drupal testbots do not support having a solr server, so they can't execute
   * these tests.
   *
   * @var bool
   */
  protected $solrAvailable = FALSE;

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

  /**
   * @var \Drupal\search_api\Utility\FieldsHelperInterface
   */
  protected $fieldsHelper;

  /**
   * {@inheritdoc}
   */
  public function setUp() {
    parent::setUp();
    $this
      ->installEntitySchema('user');
    $this
      ->installConfig([
      'search_api_solr',
      'search_api_solr_test',
    ]);
    $this
      ->detectSolrAvailability();
    $this->fieldsHelper = \Drupal::getContainer()
      ->get('search_api.fields_helper');
  }

  /**
   * Detects the availability of a Solr Server and sets $this->solrAvailable.
   */
  protected function detectSolrAvailability() {

    // Because this is a kernel test, the routing isn't built by default, so
    // we have to force it.
    \Drupal::service('router.builder')
      ->rebuild();
    try {
      $backend = Server::load($this->serverId)
        ->getBackend();
      if ($backend
        ->isAvailable()) {
        $this->solrAvailable = TRUE;
      }
    } catch (\Exception $e) {
    }
  }

  /**
   * Executes a query and skips search_api post processing of results.
   *
   * A light weight alternative to $query->execute() if we don't want to get
   * heavy weight search_api results here, but more or less raw solr results.
   * The data as it is returned by Solr could be accessed by calling
   * getExtraData('search_api_solr_response') on the result set returned here.
   *
   * @param \Drupal\search_api\Query\QueryInterface $query
   *   The query to be executed.
   *
   * @return \Drupal\search_api\Query\ResultSetInterface
   */
  protected function executeQueryWithoutPostProcessing(QueryInterface $query) {

    /** @var \Drupal\search_api\IndexInterface $index */
    $index = Index::load($this->indexId);
    $query
      ->preExecute();
    return $index
      ->getServerInstance()
      ->search($query);
  }

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

  /**
   * Tests various indexing scenarios for the Solr search backend.
   */
  public function testBackend() {

    // Only run the tests if we have a Solr core available.
    if ($this->solrAvailable) {
      parent::testBackend();
    }
    else {
      $this
        ->assertTrue(TRUE, 'Error: The Solr instance could not be found. Please enable a multi-core one on http://localhost:8983/solr/drupal');
    }
  }

  /**
   * {@inheritdoc}
   */
  protected function backendSpecificRegressionTests() {
    $this
      ->regressionTest2888629();
    $this
      ->regressionTest2850160();
  }

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

  /**
   * {@inheritdoc}
   */
  protected function clearIndex() {
    if ($this->solrAvailable) {

      /** @var \Drupal\search_api\IndexInterface $index */
      $index = Index::load($this->indexId);
      $index
        ->clear();

      // Deleting items take at least 1 second for Solr to parse it so that
      // drupal doesn't get timeouts while waiting for Solr. Lets give it 2
      // seconds to make sure we are in bounds.
      sleep(2);
    }
  }

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

    // The Solr backend doesn't create any database tables.
  }

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

    // The parent assertions don't make sense for the Solr backend.
  }

  /**
   * Second server.
   */
  protected function checkSecondServer() {

    // @todo
  }

  /**
   * {@inheritdoc}
   */
  protected function checkIndexWithoutFields() {
    $index = parent::checkIndexWithoutFields();
    $index
      ->clear();
    sleep(2);
  }

  /**
   * Regression tests for #2469547.
   */
  protected function regressionTest2469547() {
    $query = $this
      ->buildSearch();
    $facets = array();
    $facets['body'] = array(
      'field' => 'body',
      'limit' => 0,
      'min_count' => 1,
      'missing' => FALSE,
    );
    $query
      ->setOption('search_api_facets', $facets);
    $query
      ->addCondition('id', 5, '<>');
    $query
      ->range(0, 0);
    $results = $query
      ->execute();
    $expected = $this
      ->getExpectedFacetsOfRegressionTest2469547();

    // We can't guarantee the order of returned facets, since "bar" and "foobar"
    // both occur once, so we have to manually sort the returned facets first.
    $facets = $results
      ->getExtraData('search_api_facets', array())['body'];
    usort($facets, array(
      $this,
      'facetCompare',
    ));
    $this
      ->assertEquals($expected, $facets, 'Correct facets were returned for a fulltext field.');
  }

  /**
   * Regression tests for #2888629.
   */
  protected function regressionTest2888629() {
    $query = $this
      ->buildSearch();
    $query
      ->addCondition('category', NULL);
    $results = $query
      ->execute();
    $this
      ->assertResults([
      3,
    ], $results, 'comparing against NULL');
    $query = $this
      ->buildSearch();
    $conditions = $query
      ->createConditionGroup('OR');
    $conditions
      ->addCondition('category', 'article_category', '<>');
    $conditions
      ->addCondition('category', NULL);
    $query
      ->addConditionGroup($conditions);
    $results = $query
      ->execute();
    $this
      ->assertResults([
      1,
      2,
      3,
    ], $results, 'group comparing against category NOT article_category OR category NULL');
    $query = $this
      ->buildSearch();
    $conditions = $query
      ->createConditionGroup('AND');
    $conditions
      ->addCondition('body', NULL, '<>');
    $conditions
      ->addCondition('category', 'article_category', '<>');
    $conditions
      ->addCondition('category', NULL, '<>');
    $query
      ->addConditionGroup($conditions);
    $results = $query
      ->execute();
    $this
      ->assertResults([
      1,
      2,
    ], $results, 'group comparing against body NOT NULL AND category NOT article_category AND category NOT NULL');
  }

  /**
   *  Regression tests for #2850160.
   */
  public function regressionTest2850160() {

    // Only run the tests if we have a Solr core available.
    if ($this->solrAvailable) {
      $backend = Server::load($this->serverId)
        ->getBackend();
      $index = $this
        ->getIndex();

      // Load existing test entity.
      $entity = \Drupal::entityTypeManager()
        ->getStorage('entity_test_mulrev_changed')
        ->load(1);

      // Prepare Search API item.
      $id = Utility::createCombinedId('entity:entity_test_mulrev_changed', $entity
        ->id());

      /** @var \Drupal\search_api\Item\ItemInterface $item */
      $item = \Drupal::getContainer()
        ->get('search_api.fields_helper')
        ->createItemFromObject($index, $entity
        ->getTypedData(), $id);
      $item
        ->setBoost('3.0');

      // Get Solr document.

      /** @var \Solarium\QueryType\Update\Query\Document $document */
      $document = $this
        ->invokeMethod($backend, 'getDocument', [
        $index,
        $item,
      ]);

      // Compare boost values.
      $this
        ->assertEquals($item
        ->getBoost(), $document
        ->getBoost());
    }
  }

  /**
   * Return the expected facets for regression test 2469547.
   *
   * The facets differ for Solr backends because of case-insensitive filters.
   *
   * @return array
   */
  protected function getExpectedFacetsOfRegressionTest2469547() {
    return [
      [
        'count' => 4,
        'filter' => '"test"',
      ],
      [
        'count' => 3,
        'filter' => '"case"',
      ],
      [
        'count' => 1,
        'filter' => '"bar"',
      ],
      [
        'count' => 1,
        'filter' => '"foobar"',
      ],
    ];
  }

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

    // See whether clearing the server works.
    // Regression test for #2156151.

    /** @var \Drupal\search_api\ServerInterface $server */
    $server = Server::load($this->serverId);

    /** @var \Drupal\search_api\IndexInterface $index */
    $index = Index::load($this->indexId);
    $server
      ->deleteAllIndexItems($index);

    // Deleting items take at least 1 second for Solr to parse it so that drupal
    // doesn't get timeouts while waiting for Solr. Lets give it 2 seconds to
    // make sure we are in bounds.
    sleep(2);
    $query = $this
      ->buildSearch();
    $results = $query
      ->execute();
    $this
      ->assertEquals(0, $results
      ->getResultCount(), 'Clearing the server worked correctly.');
  }

  /**
   * {@inheritdoc}
   */
  protected function assertIgnored(ResultSetInterface $results, array $ignored = array(), $message = 'No keys were ignored.') {

    // Nothing to do here since the Solr backend doesn't keep a list of ignored
    // fields.
  }

  /**
   * Checks backend specific features.
   */
  protected function checkBackendSpecificFeatures() {
    $this
      ->indexItems($this->indexId);
    $this
      ->checkSearchResultGrouping();
    $this
      ->clearIndex();
  }

  /**
   * Gets the Drupal Fields and their Solr mapping.
   *
   * @param \Drupal\search_api_solr\SolrBackendInterface $backend
   *   The backend the mapping is used for.
   *
   * @return array
   *   [$fields, $mapping]
   */
  protected function getFieldsAndMapping(SolrBackendInterface $backend) {

    /** @var \Drupal\search_api\IndexInterface $index */
    $index = Index::load($this->indexId);
    $fields = $index
      ->getFields();
    $fields += $this
      ->invokeMethod($backend, 'getSpecialFields', [
      $index,
    ]);
    $field_info = array(
      'type' => 'string',
      'original type' => 'string',
    );
    $fields['x'] = $this->fieldsHelper
      ->createField($index, 'x', $field_info);
    $fields['y'] = $this->fieldsHelper
      ->createField($index, 'y', $field_info);
    $fields['z'] = $this->fieldsHelper
      ->createField($index, 'z', $field_info);
    $mapping = $backend
      ->getSolrFieldNames($index) + [
      'x' => 'solr_x',
      'y' => 'solr_y',
      'z' => 'solr_z',
    ];
    return [
      $fields,
      $mapping,
    ];
  }

  /**
   * Tests the conversion of Search API queries into Solr queries.
   */
  public function testQueryConditions() {

    /** @var \Drupal\search_api_solr\SolrBackendInterface $backend */
    $backend = Server::load($this->serverId)
      ->getBackend();
    list($fields, $mapping) = $this
      ->getFieldsAndMapping($backend);
    $options = [];
    $query = $this
      ->buildSearch();
    $query
      ->addCondition('x', 5, '=');
    $fq = $this
      ->invokeMethod($backend, 'getFilterQueries', [
      $query,
      $mapping,
      $fields,
      &$options,
    ]);
    $this
      ->assertEquals('solr_x:"5"', $fq[0]['query']);
    $this
      ->assertFalse(isset($fq[1]));
    $query = $this
      ->buildSearch();
    $query
      ->addCondition('x', 5, '<>');
    $fq = $this
      ->invokeMethod($backend, 'getFilterQueries', [
      $query,
      $mapping,
      $fields,
      &$options,
    ]);
    $this
      ->assertEquals('(*:* -solr_x:"5")', $fq[0]['query']);
    $this
      ->assertFalse(isset($fq[1]));
    $query = $this
      ->buildSearch();
    $query
      ->addCondition('x', 3, '<>');
    $query
      ->addCondition('x', 5, '<>');
    $fq = $this
      ->invokeMethod($backend, 'getFilterQueries', [
      $query,
      $mapping,
      $fields,
      &$options,
    ]);
    $this
      ->assertEquals('(*:* -solr_x:"3")', $fq[0]['query']);
    $this
      ->assertEquals('(*:* -solr_x:"5")', $fq[1]['query']);
    $query = $this
      ->buildSearch();
    $condition_group = $query
      ->createConditionGroup();
    $condition_group
      ->addCondition('x', 3, '<>');
    $condition_group
      ->addCondition('x', 5, '<>');
    $query
      ->addConditionGroup($condition_group);
    $fq = $this
      ->invokeMethod($backend, 'getFilterQueries', [
      $query,
      $mapping,
      $fields,
      &$options,
    ]);
    $this
      ->assertEquals('(+(*:* -solr_x:"3") +(*:* -solr_x:"5"))', $fq[0]['query']);
    $this
      ->assertFalse(isset($fq[1]));
    $query = $this
      ->buildSearch();
    $condition_group = $query
      ->createConditionGroup();
    $condition_group
      ->addCondition('x', 5, '<>');
    $condition_group
      ->addCondition('y', 3);
    $condition_group
      ->addCondition('z', 7);
    $query
      ->addConditionGroup($condition_group);
    $fq = $this
      ->invokeMethod($backend, 'getFilterQueries', [
      $query,
      $mapping,
      $fields,
      &$options,
    ]);
    $this
      ->assertEquals('(+(*:* -solr_x:"5") +solr_y:"3" +solr_z:"7")', $fq[0]['query']);
    $this
      ->assertFalse(isset($fq[1]));
    $query = $this
      ->buildSearch();
    $condition_group = $query
      ->createConditionGroup();
    $inner_condition_group = $query
      ->createConditionGroup('OR');
    $condition_group
      ->addCondition('x', 5, '<>');
    $inner_condition_group
      ->addCondition('y', 3);
    $inner_condition_group
      ->addCondition('z', 7);
    $condition_group
      ->addConditionGroup($inner_condition_group);
    $query
      ->addConditionGroup($condition_group);
    $fq = $this
      ->invokeMethod($backend, 'getFilterQueries', [
      $query,
      $mapping,
      $fields,
      &$options,
    ]);
    $this
      ->assertEquals('(+(*:* -solr_x:"5") +(solr_y:"3" solr_z:"7"))', $fq[0]['query']);
    $this
      ->assertFalse(isset($fq[1]));

    // Condition groups with null value queries are special snowflakes.
    // @see https://www.drupal.org/node/2888629
    $query = $this
      ->buildSearch();
    $condition_group = $query
      ->createConditionGroup();
    $inner_condition_group = $query
      ->createConditionGroup('OR');
    $condition_group
      ->addCondition('x', 5, '<>');
    $inner_condition_group
      ->addCondition('y', 3);
    $inner_condition_group
      ->addCondition('z', NULL);
    $condition_group
      ->addConditionGroup($inner_condition_group);
    $query
      ->addConditionGroup($condition_group);
    $fq = $this
      ->invokeMethod($backend, 'getFilterQueries', [
      $query,
      $mapping,
      $fields,
      &$options,
    ]);
    $this
      ->assertEquals('(+(*:* -solr_x:"5") +(solr_y:"3" (*:* -solr_z:[* TO *])))', $fq[0]['query']);
    $this
      ->assertFalse(isset($fq[1]));
    $query = $this
      ->buildSearch();
    $condition_group = $query
      ->createConditionGroup();
    $inner_condition_group_or = $query
      ->createConditionGroup('OR');
    $inner_condition_group_or
      ->addCondition('x', 3);
    $inner_condition_group_or
      ->addCondition('y', 7, '<>');
    $inner_condition_group_and = $query
      ->createConditionGroup();
    $inner_condition_group_and
      ->addCondition('x', 1);
    $inner_condition_group_and
      ->addCondition('y', 2, '<>');
    $inner_condition_group_and
      ->addCondition('z', 5, '<');
    $condition_group
      ->addConditionGroup($inner_condition_group_or);
    $condition_group
      ->addConditionGroup($inner_condition_group_and);
    $query
      ->addConditionGroup($condition_group);
    $fq = $this
      ->invokeMethod($backend, 'getFilterQueries', [
      $query,
      $mapping,
      $fields,
      &$options,
    ]);
    $this
      ->assertEquals('(+(solr_x:"3" (*:* -solr_y:"7")) +(+solr_x:"1" +(*:* -solr_y:"2") +solr_z:{* TO "5"}))', $fq[0]['query']);
    $this
      ->assertFalse(isset($fq[1]));
    $query = $this
      ->buildSearch();
    $condition_group = $query
      ->createConditionGroup();
    $condition_group
      ->addCondition('x', 5);
    $condition_group
      ->addCondition('y', [
      1,
      2,
      3,
    ], 'NOT IN');
    $query
      ->addConditionGroup($condition_group);
    $fq = $this
      ->invokeMethod($backend, 'getFilterQueries', [
      $query,
      $mapping,
      $fields,
      &$options,
    ]);
    $this
      ->assertEquals('(+solr_x:"5" +(*:* -solr_y:"1" -solr_y:"2" -solr_y:"3"))', $fq[0]['query']);
    $this
      ->assertFalse(isset($fq[1]));
    $query = $this
      ->buildSearch();
    $condition_group = $query
      ->createConditionGroup();
    $condition_group
      ->addCondition('x', 5);
    $inner_condition_group = $query
      ->createConditionGroup();
    $inner_condition_group
      ->addCondition('y', [
      1,
      2,
      3,
    ], 'NOT IN');
    $condition_group
      ->addConditionGroup($inner_condition_group);
    $query
      ->addConditionGroup($condition_group);
    $fq = $this
      ->invokeMethod($backend, 'getFilterQueries', [
      $query,
      $mapping,
      $fields,
      &$options,
    ]);
    $this
      ->assertEquals('(+solr_x:"5" +(*:* -solr_y:"1" -solr_y:"2" -solr_y:"3"))', $fq[0]['query']);
    $this
      ->assertFalse(isset($fq[1]));

    // Test tagging of a single filter query of a facet query.
    $query = $this
      ->buildSearch();
    $conditions = $query
      ->createConditionGroup('OR', array(
      'facet:' . 'tagtosearchfor',
    ));
    $conditions
      ->addCondition('category', 'article_category');
    $query
      ->addConditionGroup($conditions);
    $conditions = $query
      ->createConditionGroup('AND');
    $conditions
      ->addCondition('category', NULL, '<>');
    $query
      ->addConditionGroup($conditions);
    $facets['category'] = array(
      'field' => 'category',
      'limit' => 0,
      'min_count' => 1,
      'missing' => TRUE,
      'operator' => 'or',
    );
    $query
      ->setOption('search_api_facets', $facets);
    $fq = $this
      ->invokeMethod($backend, 'getFilterQueries', [
      $query,
      $mapping,
      $fields,
      &$options,
    ]);
    $this
      ->assertEquals('ss_category:"article_category"', $fq[0]['query'], 'Condition found in tagged first filter query');
    $this
      ->assertEquals([
      'facet:tagtosearchfor' => 'facet:tagtosearchfor',
    ], $fq[0]['tags'], 'Tag found in tagged first filter query');
    $this
      ->assertEquals('ss_category:[* TO *]', $fq[1]['query'], 'Condition found in unrelated second filter query');
    $this
      ->assertEquals([], $fq[1]['tags'], 'No tag found in second filter query');

    // @see https://www.drupal.org/node/2753917
    $query = $this
      ->buildSearch();
    $conditions = $query
      ->createConditionGroup('OR', array(
      'facet:x',
    ));
    $conditions
      ->addCondition('x', 'A');
    $conditions
      ->addCondition('x', 'B');
    $query
      ->addConditionGroup($conditions);
    $fq = $this
      ->invokeMethod($backend, 'getFilterQueries', [
      $query,
      $mapping,
      $fields,
      &$options,
    ]);
    $this
      ->assertEquals(1, count($fq));
    $this
      ->assertEquals([
      'facet:x' => 'facet:x',
    ], $fq[0]['tags']);
    $this
      ->assertEquals('(solr_x:"A" solr_x:"B")', $fq[0]['query']);
    $query = $this
      ->buildSearch();
    $conditions = $query
      ->createConditionGroup('AND', array(
      'facet:x',
    ));
    $conditions
      ->addCondition('x', 'A');
    $conditions
      ->addCondition('x', 'B');
    $query
      ->addConditionGroup($conditions);
    $fq = $this
      ->invokeMethod($backend, 'getFilterQueries', [
      $query,
      $mapping,
      $fields,
      &$options,
    ]);
    $this
      ->assertEquals(1, count($fq));
    $this
      ->assertEquals([
      'facet:x' => 'facet:x',
    ], $fq[0]['tags']);
    $this
      ->assertEquals('(+solr_x:"A" +solr_x:"B")', $fq[0]['query']);
  }

  /**
   * Tests the conversion of language aware queries into Solr queries.
   */
  public function testQueryConditionsAndLanguageFilter() {

    /** @var \Drupal\search_api_solr\SolrBackendInterface $backend */
    $backend = Server::load($this->serverId)
      ->getBackend();
    list($fields, $mapping) = $this
      ->getFieldsAndMapping($backend);
    $options = [];
    $query = $this
      ->buildSearch();
    $query
      ->setLanguages([
      'en',
    ]);
    $query
      ->addCondition('x', 5, '=');
    $fq = $this
      ->invokeMethod($backend, 'getFilterQueries', [
      $query,
      $mapping,
      $fields,
      &$options,
    ]);
    $this
      ->assertEquals('solr_x:"5"', $fq[0]['query']);
    $this
      ->assertEquals('ss_search_api_language:"en"', $fq[1]['query']);
    $query = $this
      ->buildSearch();
    $query
      ->setLanguages([
      'en',
      'de',
    ]);
    $condition_group = $query
      ->createConditionGroup();
    $condition_group
      ->addCondition('x', 5);
    $inner_condition_group = $query
      ->createConditionGroup();
    $inner_condition_group
      ->addCondition('y', [
      1,
      2,
      3,
    ], 'NOT IN');
    $condition_group
      ->addConditionGroup($inner_condition_group);
    $query
      ->addConditionGroup($condition_group);
    $fq = $this
      ->invokeMethod($backend, 'getFilterQueries', [
      $query,
      $mapping,
      $fields,
      &$options,
    ]);
    $this
      ->assertEquals('(+solr_x:"5" +(*:* -solr_y:"1" -solr_y:"2" -solr_y:"3"))', $fq[0]['query']);
    $this
      ->assertEquals('(ss_search_api_language:"en" ss_search_api_language:"de")', $fq[1]['query']);
  }

  /**
   * Tests highlight and excerpt options.
   */
  public function testHighlightAndExcerpt() {

    // Only run the tests if we have a Solr core available.
    if ($this->solrAvailable) {
      $config = $this
        ->getIndex()
        ->getServerInstance()
        ->getBackendConfig();
      $this
        ->insertExampleContent();
      $this
        ->indexItems($this->indexId);
      $config['retrieve_data'] = TRUE;
      $config['highlight_data'] = TRUE;
      $config['excerpt'] = FALSE;
      $query = $this
        ->buildSearch('foobar');
      $query
        ->getIndex()
        ->getServerInstance()
        ->setBackendConfig($config);
      $results = $query
        ->execute();
      $this
        ->assertEquals(1, $results
        ->getResultCount(), 'Search for »foobar« returned correct number of results.');

      /** @var \Drupal\search_api\Item\ItemInterface $result */
      foreach ($results as $result) {
        $this
          ->assertStringContainsString('<strong>foobar</strong>', (string) $result
          ->getField('body')
          ->getValues()[0]);
        $this
          ->assertNull($result
          ->getExcerpt());
      }
      $config['highlight_data'] = FALSE;
      $config['excerpt'] = TRUE;
      $query = $this
        ->buildSearch('foobar');
      $query
        ->getIndex()
        ->getServerInstance()
        ->setBackendConfig($config);
      $results = $query
        ->execute();
      $this
        ->assertEquals(1, $results
        ->getResultCount(), 'Search for »foobar« returned correct number of results.');

      /** @var \Drupal\search_api\Item\ItemInterface $result */
      foreach ($results as $result) {
        $this
          ->assertStringNotContainsString('<strong>foobar</strong>', (string) $result
          ->getField('body')
          ->getValues()[0]);
        $this
          ->assertStringContainsString('<strong>foobar</strong>', $result
          ->getExcerpt());
      }
      $config['highlight_data'] = TRUE;
      $config['excerpt'] = TRUE;
      $query = $this
        ->buildSearch('foobar');
      $query
        ->getIndex()
        ->getServerInstance()
        ->setBackendConfig($config);
      $results = $query
        ->execute();
      $this
        ->assertEquals(1, $results
        ->getResultCount(), 'Search for »foobar« returned correct number of results.');

      /** @var \Drupal\search_api\Item\ItemInterface $result */
      foreach ($results as $result) {
        $this
          ->assertStringContainsString('<strong>foobar</strong>', (string) $result
          ->getField('body')
          ->getValues()[0]);
        $this
          ->assertStringContainsString('<strong>foobar</strong>', $result
          ->getExcerpt());
      }
    }
    else {
      $this
        ->assertTrue(TRUE, 'Error: The Solr instance could not be found. Please enable a multi-core one on http://localhost:8983/solr/drupal');
    }
  }

  /**
   * Test that basic auth config gets passed to Solarium.
   */
  public function testBasicAuth() {
    $server = $this
      ->getServer();
    $config = $server
      ->getBackendConfig();
    $config['connector_config']['username'] = 'foo';
    $config['connector_config']['password'] = 'bar';
    $server
      ->setBackendConfig($config);

    /** @var \Drupal\search_api_solr\SolrBackendInterface $backend */
    $backend = $server
      ->getBackend();
    $auth = $backend
      ->getSolrConnector()
      ->getEndpoint()
      ->getAuthentication();
    $this
      ->assertEquals([
      'username' => 'foo',
      'password' => 'bar',
    ], $auth);
  }

  /**
   * Tests addition and deletion of a data source.
   */
  public function testDatasourceAdditionAndDeletion() {

    // Only run the tests if we have a Solr core available.
    if ($this->solrAvailable) {
      $this
        ->insertExampleContent();
      $this
        ->indexItems($this->indexId);
      $results = $this
        ->buildSearch()
        ->execute();
      $this
        ->assertEquals(5, $results
        ->getResultCount(), 'Number of indexed entities is correct.');
      try {
        $results = $this
          ->buildSearch()
          ->addCondition('uid', 0, '>')
          ->execute();
        $this
          ->fail('Field uid must not yet exists in this index.');
      } catch (\Exception $e) {
        $this
          ->assertEquals('Filter term on unknown or unindexed field uid.', $e
          ->getMessage());
      }
      $index = $this
        ->getIndex();
      $index
        ->set('datasource_settings', $index
        ->get('datasource_settings') + [
        'entity:user' => [],
      ]);
      $info = [
        'label' => 'uid',
        'type' => 'integer',
        'datasource_id' => 'entity:user',
        'property_path' => 'uid',
      ];
      $index
        ->addField($this->fieldsHelper
        ->createField($index, 'uid', $info));
      $index
        ->save();
      User::create([
        'uid' => 1,
        'name' => 'root',
        'langcode' => 'en',
      ])
        ->save();
      $this
        ->indexItems($this->indexId);
      $results = $this
        ->buildSearch()
        ->execute();
      $this
        ->assertEquals(6, $results
        ->getResultCount(), 'Number of indexed entities in multi datasource index is correct.');
      $results = $this
        ->buildSearch()
        ->addCondition('uid', 0, '>')
        ->execute();
      $this
        ->assertEquals(1, $results
        ->getResultCount(), 'Search for users returned correct number of results.');
      $this
        ->getIndex()
        ->removeDatasource('entity:user')
        ->save();

      // Wait for the commitWithin 1 second to complete the deletion.
      sleep(2);
      $results = $this
        ->buildSearch()
        ->execute();
      $this
        ->assertEquals(5, $results
        ->getResultCount(), 'Number of indexed entities is correct.');
      try {
        $results = $this
          ->buildSearch()
          ->addCondition('uid', 0, '>')
          ->execute();
        $this
          ->fail('Field uid must not yet exists in this index.');
      } catch (\Exception $e) {
        $this
          ->assertEquals('Filter term on unknown or unindexed field uid.', $e
          ->getMessage());
      }
    }
    else {
      $this
        ->assertTrue(TRUE, 'Error: The Solr instance could not be found. Please enable a multi-core one on http://localhost:8983/solr/drupal');
    }
  }

  /**
   * Produces a string of given comprising diverse chars.
   *
   * @param int $length
   *   Length of the string.
   *
   * @return string
   */
  protected function getLongText($length) {
    $sequence = 'abcdefghijklmnopqrstuwxyz1234567890,./;\'[]\\<>?:"{}|~!@#$%^&*()_+`1234567890-=ööążźćęółńABCDEFGHIJKLMNOPQRSTUWXYZ';
    $result = '';
    $i = 0;
    $sequenceLength = strlen($sequence);
    while ($i++ != $length) {
      $result .= $sequence[$i % $sequenceLength];
    }
    return $result;
  }

  /**
   * Tests search result grouping.
   */
  public function checkSearchResultGrouping() {
    if (in_array('search_api_grouping', $this
      ->getIndex()
      ->getServerInstance()
      ->getBackend()
      ->getSupportedFeatures())) {
      $query = $this
        ->buildSearch(NULL, [], [], FALSE);
      $query
        ->setOption('search_api_grouping', [
        'use_grouping' => TRUE,
        'fields' => [
          'type',
        ],
      ]);
      $results = $query
        ->execute();
      $this
        ->assertEquals(2, $results
        ->getResultCount(), 'Get the results count grouping by type.');
      $data = $results
        ->getExtraData('search_api_solr_response');
      $this
        ->assertEquals(5, $data['grouped']['ss_type']['matches'], 'Get the total documents after grouping.');
      $this
        ->assertEquals(2, $data['grouped']['ss_type']['ngroups'], 'Get the number of groups after grouping.');
      $this
        ->assertResults([
        1,
        4,
      ], $results, 'Grouping by type');
    }
    else {
      $this
        ->markTestSkipped("The selected backend/connector doesn't support the *search_api_grouping* feature.");
    }
  }

  /**
   * Tests search result sorts.
   */
  public function testSearchResultSorts() {

    // Only run the tests if we have a Solr core available.
    if ($this->solrAvailable) {
      $this
        ->insertExampleContent();

      // Add node with body length just above the solr limit for search fields.
      // It's exceeded by just a single char to simulate an edge case.
      $this
        ->addTestEntity(6, [
        'name' => 'Long text',
        'body' => $this
          ->getLongText(32767),
        'type' => 'article',
      ]);

      // Add another node with body length equal to the limit.
      $this
        ->addTestEntity(7, [
        'name' => 'Z long',
        'body' => $this
          ->getLongText(32766),
        'type' => 'article',
      ]);
      $this
        ->indexItems($this->indexId);

      // Type text.
      $results = $this
        ->buildSearch(NULL, [], [], FALSE)
        ->sort('name')
        ->sort('search_api_id')
        ->execute();
      $this
        ->assertResults([
        3,
        5,
        1,
        4,
        2,
        6,
        7,
      ], $results, 'Sort by name.');
      $results = $this
        ->buildSearch(NULL, [], [], FALSE)
        ->sort('name', QueryInterface::SORT_DESC)
        ->sort('search_api_id')
        ->execute();
      $this
        ->assertResults([
        7,
        6,
        2,
        4,
        1,
        5,
        3,
      ], $results, 'Sort by name descending.');

      // Type string.
      $results = $this
        ->buildSearch(NULL, [], [], FALSE)
        ->sort('type')
        ->sort('search_api_id')
        ->execute();
      $this
        ->assertResults([
        4,
        5,
        6,
        7,
        1,
        2,
        3,
      ], $results, 'Sort by type.');
      $results = $this
        ->buildSearch(NULL, [], [], FALSE)
        ->sort('type', QueryInterface::SORT_DESC)
        ->sort('search_api_id')
        ->execute();
      $this
        ->assertResults([
        1,
        2,
        3,
        4,
        5,
        6,
        7,
      ], $results, 'Sort by type descending.');

      // Type multi-value string. Uses first value.
      $results = $this
        ->buildSearch(NULL, [], [], FALSE)
        ->sort('keywords')
        ->sort('search_api_id')
        ->execute();
      $this
        ->assertResults([
        3,
        6,
        7,
        4,
        1,
        2,
        5,
      ], $results, 'Sort by keywords.');
      $results = $this
        ->buildSearch(NULL, [], [], FALSE)
        ->sort('keywords', QueryInterface::SORT_DESC)
        ->sort('search_api_id')
        ->execute();
      $this
        ->assertResults([
        1,
        2,
        5,
        4,
        3,
        6,
        7,
      ], $results, 'Sort by keywords descending.');

      // Type decimal.
      $results = $this
        ->buildSearch(NULL, [], [], FALSE)
        ->sort('width')
        ->sort('search_api_id')
        ->execute();
      $this
        ->assertResults([
        1,
        2,
        3,
        6,
        7,
        4,
        5,
      ], $results, 'Sort by width.');
      $results = $this
        ->buildSearch(NULL, [], [], FALSE)
        ->sort('width', QueryInterface::SORT_DESC)
        ->sort('search_api_id')
        ->execute();
      $this
        ->assertResults([
        5,
        4,
        1,
        2,
        3,
        6,
        7,
      ], $results, 'Sort by width descending.');
      $results = $this
        ->buildSearch(NULL, [], [], FALSE)
        ->sort('changed')
        ->execute();
      $this
        ->assertResults([
        1,
        2,
        3,
        4,
        5,
        6,
        7,
      ], $results, 'Sort by last update date');
      $results = $this
        ->buildSearch(NULL, [], [], FALSE)
        ->sort('changed', QueryInterface::SORT_DESC)
        ->execute();
      $this
        ->assertResults([
        7,
        6,
        5,
        4,
        3,
        2,
        1,
      ], $results, 'Sort by last update date descending');
    }
    else {
      $this
        ->assertTrue(TRUE, 'Error: The Solr instance could not be found. Please enable a multi-core one on http://localhost:8983/solr/drupal');
    }
  }

  /**
   * Tests the autocomplete support.
   */
  public function testAutocomplete() {

    // Only run the tests if we have a Solr core available.
    if ($this->solrAvailable) {
      $this
        ->addTestEntity(1, [
        'name' => 'Test Article 1',
        'body' => 'The test article number 1 about cats, dogs and trees.',
        'type' => 'article',
      ]);

      // Add another node with body length equal to the limit.
      $this
        ->addTestEntity(2, [
        'name' => 'Test Article 1',
        'body' => 'The test article number 2 about a tree.',
        'type' => 'article',
      ]);
      $this
        ->indexItems($this->indexId);

      /** @var \Drupal\search_api_solr\Plugin\search_api\backend\SearchApiSolrBackend $backend */
      $backend = Server::load($this->serverId)
        ->getBackend();
      $autocompleteSearch = new Search([], 'search_api_autocomplete_search');
      $query = $this
        ->buildSearch([
        'artic',
      ], [], [
        'body',
      ], FALSE);
      $suggestions = $backend
        ->getAutocompleteSuggestions($query, $autocompleteSearch, 'artic', 'artic');
      $this
        ->assertEquals(1, count($suggestions));
      $this
        ->assertEquals('le', $suggestions[0]
        ->getSuggestionSuffix());
      $this
        ->assertEquals(2, $suggestions[0]
        ->getResultsCount());
      $query = $this
        ->buildSearch([
        'articel',
      ], [], [
        'body',
      ], FALSE);
      $suggestions = $backend
        ->getAutocompleteSuggestions($query, $autocompleteSearch, 'articel', 'articel');
      $this
        ->assertEquals(1, count($suggestions));
      $this
        ->assertEquals('article', $suggestions[0]
        ->getSuggestedKeys());
      $this
        ->assertEquals(0, $suggestions[0]
        ->getResultsCount());
      $query = $this
        ->buildSearch([
        'articel doks',
      ], [], [
        'body',
      ], FALSE);
      $suggestions = $backend
        ->getAutocompleteSuggestions($query, $autocompleteSearch, 'doks', 'articel doks');
      $this
        ->assertEquals(1, count($suggestions));
      $this
        ->assertEquals('article dogs', $suggestions[0]
        ->getSuggestedKeys());

      /* Spell check plus suffixes don't quite work in Solarium 6 yet
         $query = $this->buildSearch(['articel tre'], [], ['body'], FALSE);
         $suggestions = $backend->getAutocompleteSuggestions($query, $autocompleteSearch, 'tre', 'articel tre');
         $this->assertEquals(5, count($suggestions));
         $this->assertEquals('e', $suggestions[0]->getSuggestionSuffix());
         $this->assertEquals(1, $suggestions[0]->getResultsCount());
         $this->assertEquals('es', $suggestions[1]->getSuggestionSuffix());
         $this->assertEquals(1, $suggestions[1]->getResultsCount());
         $this->assertEquals('article tre', $suggestions[2]->getSuggestedKeys());
         $this->assertEquals(0, $suggestions[2]->getResultsCount());
         $this->assertEquals('article tree', $suggestions[3]->getSuggestedKeys());
         $this->assertEquals(0, $suggestions[3]->getResultsCount());
         $this->assertEquals('article trees', $suggestions[4]->getSuggestedKeys());
         $this->assertEquals(0, $suggestions[4]->getResultsCount());
         */
    }
    else {
      $this
        ->assertTrue(TRUE, 'Error: The Solr instance could not be found. Please enable a multi-core one on http://localhost:8983/solr/drupal');
    }
  }

  /**
   * Test tika extension PDF extraction.
   */
  public function testExtract() {
    $filepath = drupal_get_path('module', 'search_api_solr_test') . '/assets/test_extraction.pdf';

    /** @var \Drupal\search_api_solr\Plugin\search_api\backend\SearchApiSolrBackend $backend */
    $backend = Server::load($this->serverId)
      ->getBackend();
    $content = $backend
      ->extractContentFromFile($filepath);
    $this
      ->assertStringContainsString('The extraction seems working!', $content);
  }

  /**
   * Tests ngram search result.
   */
  public function testNgramResult() {

    // Only run the tests if we have a Solr core available.
    if ($this->solrAvailable) {
      $this
        ->addTestEntity(1, [
        'name' => 'Test Article 1',
        'body' => 'The test article number 1 about cats, dogs and trees.',
        'type' => 'article',
        'category' => 'dogs and trees',
      ]);

      // Add another node with body length equal to the limit.
      $this
        ->addTestEntity(2, [
        'name' => 'Test Article 1',
        'body' => 'The test article number 2 about a tree.',
        'type' => 'article',
        'category' => 'trees',
      ]);
      $this
        ->indexItems($this->indexId);
      $results = $this
        ->buildSearch([
        'tre',
      ], [], [
        'category_ngram',
      ])
        ->execute();
      $this
        ->assertResults([
        1,
        2,
      ], $results, 'Ngram text "tre".');
      $results = $this
        ->buildSearch([], [], [])
        ->addCondition('category_ngram_string', 'tre')
        ->execute();
      $this
        ->assertResults([
        2,
      ], $results, 'Ngram string "tre".');
      $results = $this
        ->buildSearch([
        'Dog',
      ], [], [
        'category_ngram',
      ])
        ->execute();
      $this
        ->assertResults([
        1,
      ], $results, 'Ngram text "Dog".');
      $results = $this
        ->buildSearch([], [], [])
        ->addCondition('category_ngram_string', 'Dog')
        ->execute();
      $this
        ->assertResults([
        1,
      ], $results, 'Ngram string "Dog".');
    }
    else {
      $this
        ->assertTrue(TRUE, 'Error: The Solr instance could not be found. Please enable a multi-core one on http://localhost:8983/solr/drupal');
    }
  }

}

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::buildSearch protected function Builds a search query for testing purposes.
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::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::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::insertExampleContent protected function Creates several test entities.
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.
InvokeMethodTrait::invokeMethod protected function Calls protected/private method of a class.
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.
SearchApiSolrTest::$fieldsHelper protected property
SearchApiSolrTest::$indexId protected property A Search API index ID. Overrides BackendTestBase::$indexId
SearchApiSolrTest::$modules public static property Modules to enable for this test. Overrides BackendTestBase::$modules
SearchApiSolrTest::$serverId protected property A Search API server ID. Overrides BackendTestBase::$serverId
SearchApiSolrTest::$solrAvailable protected property Whether a Solr core is available for testing.
SearchApiSolrTest::$waitForCommit protected property Seconds to wait for a soft commit on Solr.
SearchApiSolrTest::assertIgnored protected function
SearchApiSolrTest::backendSpecificRegressionTests protected function Runs backend specific regression tests. Overrides BackendTestBase::backendSpecificRegressionTests
SearchApiSolrTest::checkBackendSpecificFeatures protected function Checks backend specific features. Overrides BackendTestBase::checkBackendSpecificFeatures
SearchApiSolrTest::checkIndexWithoutFields protected function Checks the correct handling of an index without fields. Overrides BackendTestBase::checkIndexWithoutFields
SearchApiSolrTest::checkModuleUninstall protected function Tests whether removing the configuration again works as it should. Overrides BackendTestBase::checkModuleUninstall
SearchApiSolrTest::checkSearchResultGrouping public function Tests search result grouping.
SearchApiSolrTest::checkSecondServer protected function Second server. Overrides BackendTestBase::checkSecondServer
SearchApiSolrTest::checkServerBackend protected function Tests the correct setup of the server backend. Overrides BackendTestBase::checkServerBackend
SearchApiSolrTest::clearIndex protected function Clears the test index. Overrides BackendTestBase::clearIndex
SearchApiSolrTest::detectSolrAvailability protected function Detects the availability of a Solr Server and sets $this->solrAvailable.
SearchApiSolrTest::executeQueryWithoutPostProcessing protected function Executes a query and skips search_api post processing of results.
SearchApiSolrTest::getExpectedFacetsOfRegressionTest2469547 protected function Return the expected facets for regression test 2469547.
SearchApiSolrTest::getFieldsAndMapping protected function Gets the Drupal Fields and their Solr mapping.
SearchApiSolrTest::getLongText protected function Produces a string of given comprising diverse chars.
SearchApiSolrTest::indexItems protected function Indexes all (unindexed) items on the specified index. Overrides ExampleContentTrait::indexItems
SearchApiSolrTest::regressionTest2469547 protected function Regression tests for #2469547. Overrides BackendTestBase::regressionTest2469547
SearchApiSolrTest::regressionTest2850160 public function Regression tests for #2850160.
SearchApiSolrTest::regressionTest2888629 protected function Regression tests for #2888629.
SearchApiSolrTest::setUp public function Overrides BackendTestBase::setUp
SearchApiSolrTest::tearDown public function Clear the index after every test. Overrides KernelTestBase::tearDown
SearchApiSolrTest::testAutocomplete public function Tests the autocomplete support.
SearchApiSolrTest::testBackend public function Tests various indexing scenarios for the Solr search backend. Overrides BackendTestBase::testBackend
SearchApiSolrTest::testBasicAuth public function Test that basic auth config gets passed to Solarium.
SearchApiSolrTest::testDatasourceAdditionAndDeletion public function Tests addition and deletion of a data source.
SearchApiSolrTest::testExtract public function Test tika extension PDF extraction.
SearchApiSolrTest::testHighlightAndExcerpt public function Tests highlight and excerpt options.
SearchApiSolrTest::testNgramResult public function Tests ngram search result.
SearchApiSolrTest::testQueryConditions public function Tests the conversion of Search API queries into Solr queries.
SearchApiSolrTest::testQueryConditionsAndLanguageFilter public function Tests the conversion of language aware queries into Solr queries.
SearchApiSolrTest::testSearchResultSorts public function Tests search result sorts.
SearchApiSolrTest::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.