abstract class BackendTestBase in Search API 8

Provides a base class for backend tests.

Hierarchy

class \Drupal\KernelTests\KernelTestBase extends \PHPUnit\Framework\TestCase implements ServiceProviderInterface uses AssertContentTrait, AssertLegacyTrait, AssertHelperTrait, ConfigTestTrait, PhpunitCompatibilityTrait, RandomGeneratorTrait, TestRequirementsTrait
- class \Drupal\Tests\search_api\Kernel\BackendTestBase uses StringTranslationTrait, ExampleContentTrait

Expanded class hierarchy of BackendTestBase

1 file declares its use of BackendTestBase

BackendTest.php in modules/search_api_db/tests/src/Kernel/BackendTest.php

File

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

Namespace

Drupal\Tests\search_api\Kernel

View source

abstract class BackendTestBase extends KernelTestBase {
  use ExampleContentTrait;
  use StringTranslationTrait;

  /**
   * {@inheritdoc}
   */
  public static $modules = [
    'field',
    'search_api',
    'user',
    'system',
    'entity_test',
    'filter',
    'text',
    'search_api_test_example_content',
  ];

  /**
   * A search server ID.
   *
   * @var string
   */
  protected $serverId = 'search_server';

  /**
   * A search index ID.
   *
   * @var string
   */
  protected $indexId = 'search_index';

  /**
   * {@inheritdoc}
   */
  public function setUp() {
    parent::setUp();
    $this
      ->installSchema('search_api', [
      'search_api_item',
    ]);
    $this
      ->installSchema('user', [
      'users_data',
    ]);
    $this
      ->installEntitySchema('entity_test_mulrev_changed');
    $this
      ->installEntitySchema('search_api_task');
    $this
      ->installConfig('search_api_test_example_content');
    $this
      ->installConfig('search_api');

    // Do not use a batch for tracking the initial items after creating an
    // index when running the tests via the GUI. Otherwise, it seems Drupal's
    // Batch API gets confused and the test fails.
    if (!Utility::isRunningInCli()) {
      \Drupal::state()
        ->set('search_api_use_tracking_batch', FALSE);
    }
    $this
      ->setUpExampleStructure();
  }

  /**
   * Tests various indexing scenarios for the search backend.
   *
   * Uses a single method to save time.
   */
  public function testBackend() {
    $this
      ->insertExampleContent();
    $this
      ->checkDefaultServer();
    $this
      ->checkServerBackend();
    $this
      ->checkDefaultIndex();
    $this
      ->updateIndex();
    $this
      ->searchNoResults();
    $this
      ->indexItems($this->indexId);
    $this
      ->searchSuccess();
    if ($this
      ->getServer()
      ->supportsFeature('search_api_facets')) {
      $this
        ->checkFacets();
    }
    $this
      ->checkSecondServer();
    $this
      ->regressionTests();
    $this
      ->clearIndex();
    $this
      ->indexItems($this->indexId);
    $this
      ->backendSpecificRegressionTests();
    $this
      ->checkBackendSpecificFeatures();
    $this
      ->clearIndex();
    $this
      ->enableHtmlFilter();
    $this
      ->indexItems($this->indexId);
    $this
      ->disableHtmlFilter();
    $this
      ->clearIndex();
    $this
      ->searchNoResults();
    $this
      ->regressionTests2();
    $this
      ->checkIndexWithoutFields();
    $this
      ->checkModuleUninstall();
  }

  /**
   * Tests the correct setup of the server backend.
   */
  protected abstract function checkServerBackend();

  /**
   * Checks whether changes to the index's fields are picked up by the server.
   */
  protected abstract function updateIndex();

  /**
   * Tests that a second server doesn't interfere with the first.
   */
  protected abstract function checkSecondServer();

  /**
   * Tests whether removing the configuration again works as it should.
   */
  protected abstract function checkModuleUninstall();

  /**
   * Checks backend specific features.
   */
  protected function checkBackendSpecificFeatures() {
  }

  /**
   * Runs backend specific regression tests.
   */
  protected function backendSpecificRegressionTests() {
  }

  /**
   * Tests the server that was installed through default configuration files.
   */
  protected function checkDefaultServer() {
    $server = $this
      ->getServer();
    $this
      ->assertInstanceOf(Server::class, $server, 'The server was successfully created.');
  }

  /**
   * Tests the index that was installed through default configuration files.
   */
  protected function checkDefaultIndex() {
    $index = $this
      ->getIndex();
    $this
      ->assertInstanceOf(Index::class, $index, 'The index was successfully created.');
    $this
      ->assertEquals([
      "entity:entity_test_mulrev_changed",
    ], $index
      ->getDatasourceIds(), 'Datasources are set correctly.');
    $this
      ->assertEquals('default', $index
      ->getTrackerId(), 'Tracker is set correctly.');
    $this
      ->assertEquals(5, $index
      ->getTrackerInstance()
      ->getTotalItemsCount(), 'Correct item count.');
    $this
      ->assertEquals(0, $index
      ->getTrackerInstance()
      ->getIndexedItemsCount(), 'All items still need to be indexed.');
  }

  /**
   * Enables the "HTML Filter" processor for the index.
   */
  protected function enableHtmlFilter() {
    $index = $this
      ->getIndex();

    /** @var \Drupal\search_api\Processor\ProcessorInterface $processor */
    $processor = \Drupal::getContainer()
      ->get('search_api.plugin_helper')
      ->createProcessorPlugin($index, 'html_filter');
    $index
      ->addProcessor($processor)
      ->save();
    $this
      ->assertArrayHasKey('html_filter', $index
      ->getProcessors(), 'HTML filter processor is added.');
  }

  /**
   * Disables the "HTML Filter" processor for the index.
   */
  protected function disableHtmlFilter() {
    $index = $this
      ->getIndex();
    $index
      ->removeProcessor('html_filter');
    $index
      ->save();
    $this
      ->assertArrayNotHasKey('html_filter', $index
      ->getProcessors(), 'HTML filter processor is removed.');
  }

  /**
   * Builds a search query for testing purposes.
   *
   * Used as a helper method during testing.
   *
   * @param string|array|null $keys
   *   (optional) The search keys to set, if any.
   * @param string[] $conditions
   *   (optional) Conditions to set on the query, in the format "field,value".
   * @param string[]|null $fields
   *   (optional) Fulltext fields to search for the keys.
   * @param bool $place_id_sort
   *   (optional) Whether to place a default sort on the item ID.
   *
   * @return \Drupal\search_api\Query\QueryInterface
   *   A search query on the test index.
   */
  protected function buildSearch($keys = NULL, array $conditions = [], array $fields = NULL, $place_id_sort = TRUE) {
    static $i = 0;
    $query = $this
      ->getIndex()
      ->query();
    if ($keys) {
      $query
        ->keys($keys);
      if ($fields) {
        $query
          ->setFulltextFields($fields);
      }
    }
    foreach ($conditions as $condition) {
      list($field, $value) = explode(',', $condition, 2);
      $query
        ->addCondition($field, $value);
    }
    $query
      ->range(0, 10);
    if ($place_id_sort) {

      // Use the normal "id" and the magic "search_api_id" field alternately, to
      // make sure both work as expected.
      $query
        ->sort(++$i % 2 ? 'id' : 'search_api_id');
    }
    return $query;
  }

  /**
   * Tests that a search on the index doesn't have any results.
   */
  protected function searchNoResults() {
    $results = $this
      ->buildSearch('test')
      ->execute();
    $this
      ->assertResults([], $results, 'Search before indexing');
  }

  /**
   * Tests whether some test searches have the correct results.
   */
  protected function searchSuccess() {
    $results = $this
      ->buildSearch('test')
      ->range(1, 2)
      ->execute();
    $this
      ->assertEquals(4, $results
      ->getResultCount(), 'Search for »test« returned correct number of results.');
    $this
      ->assertEquals($this
      ->getItemIds([
      2,
      3,
    ]), array_keys($results
      ->getResultItems()), 'Search for »test« returned correct result.');
    $this
      ->assertEmpty($results
      ->getIgnoredSearchKeys());
    $this
      ->assertEmpty($results
      ->getWarnings());
    $id = $this
      ->getItemIds([
      2,
    ])[0];
    $this
      ->assertEquals($id, key($results
      ->getResultItems()));
    $this
      ->assertEquals($id, $results
      ->getResultItems()[$id]
      ->getId());
    $this
      ->assertEquals('entity:entity_test_mulrev_changed', $results
      ->getResultItems()[$id]
      ->getDatasourceId());
    $results = $this
      ->buildSearch('test foo')
      ->execute();
    $this
      ->assertResults([
      1,
      2,
      4,
    ], $results, 'Search for »test foo«');
    $results = $this
      ->buildSearch('foo', [
      'type,item',
    ])
      ->execute();
    $this
      ->assertResults([
      1,
      2,
    ], $results, 'Search for »foo«');
    $keys = [
      '#conjunction' => 'AND',
      'test',
      [
        '#conjunction' => 'OR',
        'baz',
        'foobar',
      ],
      [
        '#conjunction' => 'OR',
        '#negation' => TRUE,
        'bar',
        'fooblob',
      ],
    ];
    $results = $this
      ->buildSearch($keys)
      ->execute();
    $this
      ->assertResults([
      4,
    ], $results, 'Complex search 1');
    $query = $this
      ->buildSearch();
    $conditions = $query
      ->createConditionGroup('OR');
    $conditions
      ->addCondition('name', 'bar');
    $conditions
      ->addCondition('body', 'bar');
    $query
      ->addConditionGroup($conditions);
    $results = $query
      ->execute();
    $this
      ->assertResults([
      1,
      2,
      3,
      5,
    ], $results, 'Search with multi-field fulltext filter');
    $results = $this
      ->buildSearch()
      ->addCondition('keywords', [
      'grape',
      'apple',
    ], 'IN')
      ->execute();
    $this
      ->assertResults([
      2,
      4,
      5,
    ], $results, 'Query with IN filter');
    $results = $this
      ->buildSearch()
      ->addCondition('keywords', [
      'grape',
      'apple',
    ], 'NOT IN')
      ->execute();
    $this
      ->assertResults([
      1,
      3,
    ], $results, 'Query with NOT IN filter');
    $results = $this
      ->buildSearch()
      ->addCondition('width', [
      '0.9',
      '1.5',
    ], 'BETWEEN')
      ->execute();
    $this
      ->assertResults([
      4,
    ], $results, 'Query with BETWEEN filter');
    $results = $this
      ->buildSearch()
      ->addCondition('width', [
      '0.9',
      '1.5',
    ], 'NOT BETWEEN')
      ->execute();
    $this
      ->assertResults([
      1,
      2,
      3,
      5,
    ], $results, 'Query with NOT BETWEEN filter');
    $results = $this
      ->buildSearch()
      ->setLanguages([
      'und',
      'en',
    ])
      ->addCondition('keywords', [
      'grape',
      'apple',
    ], 'IN')
      ->execute();
    $this
      ->assertResults([
      2,
      4,
      5,
    ], $results, 'Query with IN filter');
    $results = $this
      ->buildSearch()
      ->setLanguages([
      'und',
    ])
      ->execute();
    $this
      ->assertResults([], $results, 'Query with languages');
    $query = $this
      ->buildSearch();
    $conditions = $query
      ->createConditionGroup('OR')
      ->addCondition('search_api_language', 'und')
      ->addCondition('width', [
      '0.9',
      '1.5',
    ], 'BETWEEN');
    $query
      ->addConditionGroup($conditions);
    $results = $query
      ->execute();
    $this
      ->assertResults([
      4,
    ], $results, 'Query with search_api_language filter');
    $results = $this
      ->buildSearch()
      ->addCondition('search_api_language', 'und')
      ->addCondition('width', [
      '0.9',
      '1.5',
    ], 'BETWEEN')
      ->execute();
    $this
      ->assertResults([], $results, 'Query with search_api_language filter');
    $results = $this
      ->buildSearch()
      ->addCondition('search_api_language', [
      'und',
      'en',
    ], 'IN')
      ->addCondition('width', [
      '0.9',
      '1.5',
    ], 'BETWEEN')
      ->execute();
    $this
      ->assertResults([
      4,
    ], $results, 'Query with search_api_language filter');
    $results = $this
      ->buildSearch()
      ->addCondition('search_api_language', [
      'und',
      'de',
    ], 'NOT IN')
      ->addCondition('width', [
      '0.9',
      '1.5',
    ], 'BETWEEN')
      ->execute();
    $this
      ->assertResults([
      4,
    ], $results, 'Query with search_api_language "NOT IN" filter');
    $results = $this
      ->buildSearch()
      ->addCondition('search_api_id', $this
      ->getItemIds([
      1,
    ])[0])
      ->execute();
    $this
      ->assertResults([
      1,
    ], $results, 'Query with search_api_id filter');
    $results = $this
      ->buildSearch()
      ->addCondition('search_api_id', $this
      ->getItemIds([
      2,
      4,
    ]), 'NOT IN')
      ->execute();
    $this
      ->assertResults([
      1,
      3,
      5,
    ], $results, 'Query with search_api_id "NOT IN" filter');
    $results = $this
      ->buildSearch()
      ->addCondition('search_api_id', $this
      ->getItemIds([
      3,
    ])[0], '>')
      ->execute();
    $this
      ->assertResults([
      4,
      5,
    ], $results, 'Query with search_api_id "greater than" filter');
    $results = $this
      ->buildSearch()
      ->addCondition('search_api_datasource', 'foobar')
      ->execute();
    $this
      ->assertResults([], $results, 'Query for a non-existing datasource');
    $results = $this
      ->buildSearch()
      ->addCondition('search_api_datasource', [
      'foobar',
      'entity:entity_test_mulrev_changed',
    ], 'IN')
      ->execute();
    $this
      ->assertResults([
      1,
      2,
      3,
      4,
      5,
    ], $results, 'Query with search_api_id "IN" filter');
    $results = $this
      ->buildSearch()
      ->addCondition('search_api_datasource', [
      'foobar',
      'entity:entity_test_mulrev_changed',
    ], 'NOT IN')
      ->execute();
    $this
      ->assertResults([], $results, 'Query with search_api_id "NOT IN" filter');

    // For a query without keys, all of these except for the last one should
    // have no effect. Therefore, we expect results with IDs in descending
    // order.
    $results = $this
      ->buildSearch(NULL, [], [], FALSE)
      ->sort('search_api_relevance')
      ->sort('search_api_datasource', QueryInterface::SORT_DESC)
      ->sort('search_api_language')
      ->sort('search_api_id', QueryInterface::SORT_DESC)
      ->execute();
    $this
      ->assertResults([
      5,
      4,
      3,
      2,
      1,
    ], $results, 'Query with magic sorts');
  }

  /**
   * Tests whether facets work correctly.
   */
  protected function checkFacets() {
    $query = $this
      ->buildSearch();
    $conditions = $query
      ->createConditionGroup('OR', [
      'facet:' . 'category',
    ]);
    $conditions
      ->addCondition('category', 'article_category');
    $query
      ->addConditionGroup($conditions);
    $facets['category'] = [
      'field' => 'category',
      'limit' => 0,
      'min_count' => 1,
      'missing' => TRUE,
      'operator' => 'or',
    ];
    $query
      ->setOption('search_api_facets', $facets);
    $results = $query
      ->execute();
    $this
      ->assertResults([
      4,
      5,
    ], $results, 'OR facets query');
    $expected = [
      [
        'count' => 2,
        'filter' => '"article_category"',
      ],
      [
        'count' => 2,
        'filter' => '"item_category"',
      ],
      [
        'count' => 1,
        'filter' => '!',
      ],
    ];
    $category_facets = $results
      ->getExtraData('search_api_facets')['category'];
    usort($category_facets, [
      $this,
      'facetCompare',
    ]);
    $this
      ->assertEquals($expected, $category_facets, 'Correct OR facets were returned');
    $query = $this
      ->buildSearch();
    $conditions = $query
      ->createConditionGroup('OR', [
      'facet:' . 'category',
    ]);
    $conditions
      ->addCondition('category', 'article_category');
    $query
      ->addConditionGroup($conditions);
    $conditions = $query
      ->createConditionGroup('AND');
    $conditions
      ->addCondition('category', NULL, '<>');
    $query
      ->addConditionGroup($conditions);
    $facets['category'] = [
      'field' => 'category',
      'limit' => 0,
      'min_count' => 1,
      'missing' => TRUE,
      'operator' => 'or',
    ];
    $query
      ->setOption('search_api_facets', $facets);
    $results = $query
      ->execute();
    $this
      ->assertResults([
      4,
      5,
    ], $results, 'OR facets query');
    $expected = [
      [
        'count' => 2,
        'filter' => '"article_category"',
      ],
      [
        'count' => 2,
        'filter' => '"item_category"',
      ],
    ];
    $category_facets = $results
      ->getExtraData('search_api_facets')['category'];
    usort($category_facets, [
      $this,
      'facetCompare',
    ]);
    $this
      ->assertEquals($expected, $category_facets, 'Correct OR facets were returned');
  }

  /**
   * Executes regression tests for issues that were already fixed.
   */
  protected function regressionTests() {
    $this
      ->regressionTest2007872();
    $this
      ->regressionTest1863672();
    $this
      ->regressionTest2040543();
    $this
      ->regressionTest2111753();
    $this
      ->regressionTest2127001();
    $this
      ->regressionTest2136409();
    $this
      ->regressionTest1658964();
    $this
      ->regressionTest2469547();
    $this
      ->regressionTest1403916();
    $this
      ->regressionTest2783987();
    $this
      ->regressionTest2809753();
    $this
      ->regressionTest2767609();
    $this
      ->regressionTest2745655();
  }

  /**
   * Regression tests for missing results when using OR filters.
   *
   * @see https://www.drupal.org/node/2007872
   */
  protected function regressionTest2007872() {
    $results = $this
      ->buildSearch('test', [], [], FALSE)
      ->sort('id')
      ->sort('type')
      ->execute();
    $this
      ->assertResults([
      1,
      2,
      3,
      4,
    ], $results, 'Sorting on field with NULLs');
    $query = $this
      ->buildSearch(NULL, [], [], FALSE);
    $conditions = $query
      ->createConditionGroup('OR');
    $conditions
      ->addCondition('id', 3);
    $conditions
      ->addCondition('type', 'article');
    $query
      ->addConditionGroup($conditions);
    $query
      ->sort('search_api_id', QueryInterface::SORT_DESC);
    $results = $query
      ->execute();
    $this
      ->assertResults([
      5,
      4,
      3,
    ], $results, 'OR filter on field with NULLs');
  }

  /**
   * Regression tests for same content multiple times in the search result.
   *
   * Error was caused by multiple terms for filter.
   *
   * @see https://www.drupal.org/node/1863672
   */
  protected function regressionTest1863672() {
    $query = $this
      ->buildSearch();
    $conditions = $query
      ->createConditionGroup('OR');
    $conditions
      ->addCondition('keywords', 'orange');
    $conditions
      ->addCondition('keywords', 'apple');
    $query
      ->addConditionGroup($conditions);
    $results = $query
      ->execute();
    $this
      ->assertResults([
      1,
      2,
      4,
      5,
    ], $results, 'OR filter on multi-valued field');
    $query = $this
      ->buildSearch();
    $conditions = $query
      ->createConditionGroup('OR');
    $conditions
      ->addCondition('keywords', 'orange');
    $conditions
      ->addCondition('keywords', 'strawberry');
    $query
      ->addConditionGroup($conditions);
    $conditions = $query
      ->createConditionGroup('OR');
    $conditions
      ->addCondition('keywords', 'apple');
    $conditions
      ->addCondition('keywords', 'grape');
    $query
      ->addConditionGroup($conditions);
    $results = $query
      ->execute();
    $this
      ->assertResults([
      2,
      4,
      5,
    ], $results, 'Multiple OR filters on multi-valued field');
    $query = $this
      ->buildSearch();
    $conditions1 = $query
      ->createConditionGroup('OR');
    $conditions = $query
      ->createConditionGroup('AND');
    $conditions
      ->addCondition('keywords', 'orange');
    $conditions
      ->addCondition('keywords', 'apple');
    $conditions1
      ->addConditionGroup($conditions);
    $conditions = $query
      ->createConditionGroup('AND');
    $conditions
      ->addCondition('keywords', 'strawberry');
    $conditions
      ->addCondition('keywords', 'grape');
    $conditions1
      ->addConditionGroup($conditions);
    $query
      ->addConditionGroup($conditions1);
    $results = $query
      ->execute();
    $this
      ->assertResults([
      2,
      4,
      5,
    ], $results, 'Complex nested filters on multi-valued field');
  }

  /**
   * Regression tests for (none) facet shown when feature is set to "no".
   *
   * @see https://www.drupal.org/node/2040543
   */
  protected function regressionTest2040543() {
    $query = $this
      ->buildSearch();
    $facets['category'] = [
      'field' => 'category',
      'limit' => 0,
      'min_count' => 1,
      'missing' => TRUE,
    ];
    $query
      ->setOption('search_api_facets', $facets);
    $query
      ->range(0, 0);
    $results = $query
      ->execute();
    $expected = [
      [
        'count' => 2,
        'filter' => '"article_category"',
      ],
      [
        'count' => 2,
        'filter' => '"item_category"',
      ],
      [
        'count' => 1,
        'filter' => '!',
      ],
    ];
    $type_facets = $results
      ->getExtraData('search_api_facets')['category'];
    usort($type_facets, [
      $this,
      'facetCompare',
    ]);
    $this
      ->assertEquals($expected, $type_facets, 'Correct facets were returned');
    $query = $this
      ->buildSearch();
    $facets['category']['missing'] = FALSE;
    $query
      ->setOption('search_api_facets', $facets);
    $query
      ->range(0, 0);
    $results = $query
      ->execute();
    $expected = [
      [
        'count' => 2,
        'filter' => '"article_category"',
      ],
      [
        'count' => 2,
        'filter' => '"item_category"',
      ],
    ];
    $type_facets = $results
      ->getExtraData('search_api_facets')['category'];
    usort($type_facets, [
      $this,
      'facetCompare',
    ]);
    $this
      ->assertEquals($expected, $type_facets, 'Correct facets were returned');
  }

  /**
   * Regression tests for searching for multiple words using "OR" condition.
   *
   * @see https://www.drupal.org/node/2111753
   */
  protected function regressionTest2111753() {
    $keys = [
      '#conjunction' => 'OR',
      'foo',
      'test',
    ];
    $query = $this
      ->buildSearch($keys, [], [
      'name',
    ]);
    $results = $query
      ->execute();
    $this
      ->assertResults([
      1,
      2,
      4,
    ], $results, 'OR keywords');
    $query = $this
      ->buildSearch($keys, [], [
      'name',
      'body',
    ]);
    $query
      ->range(0, 0);
    $results = $query
      ->execute();
    $this
      ->assertEquals(5, $results
      ->getResultCount(), 'Multi-field OR keywords returned correct number of results.');
    $this
      ->assertEmpty($results
      ->getResultItems(), 'Multi-field OR keywords returned correct result.');
    $this
      ->assertEmpty($results
      ->getIgnoredSearchKeys());
    $this
      ->assertEmpty($results
      ->getWarnings());
    $keys = [
      '#conjunction' => 'OR',
      'foo',
      'test',
      [
        '#conjunction' => 'AND',
        'bar',
        'baz',
      ],
    ];
    $query = $this
      ->buildSearch($keys, [], [
      'name',
    ]);
    $results = $query
      ->execute();
    $this
      ->assertResults([
      1,
      2,
      4,
      5,
    ], $results, 'Nested OR keywords');
    $keys = [
      '#conjunction' => 'OR',
      [
        '#conjunction' => 'AND',
        'foo',
        'test',
      ],
      [
        '#conjunction' => 'AND',
        'bar',
        'baz',
      ],
    ];
    $query = $this
      ->buildSearch($keys, [], [
      'name',
      'body',
    ]);
    $results = $query
      ->execute();
    $this
      ->assertResults([
      1,
      2,
      4,
      5,
    ], $results, 'Nested multi-field OR keywords');
  }

  /**
   * Regression tests for non-working operator "contains none of these words".
   *
   * @see https://www.drupal.org/node/2127001
   */
  protected function regressionTest2127001() {
    $keys = [
      '#conjunction' => 'AND',
      '#negation' => TRUE,
      'foo',
      'bar',
    ];
    $results = $this
      ->buildSearch($keys)
      ->execute();
    $this
      ->assertResults([
      3,
      4,
    ], $results, 'Negated AND fulltext search');
    $keys = [
      '#conjunction' => 'OR',
      '#negation' => TRUE,
      'foo',
      'baz',
    ];
    $results = $this
      ->buildSearch($keys)
      ->execute();
    $this
      ->assertResults([
      3,
    ], $results, 'Negated OR fulltext search');
    $keys = [
      '#conjunction' => 'AND',
      'test',
      [
        '#conjunction' => 'AND',
        '#negation' => TRUE,
        'foo',
        'bar',
      ],
    ];
    $results = $this
      ->buildSearch($keys)
      ->execute();
    $this
      ->assertResults([
      3,
      4,
    ], $results, 'Nested NOT AND fulltext search');
  }

  /**
   * Regression tests for handling of NULL filters.
   *
   * @see https://www.drupal.org/node/2136409
   */
  protected function regressionTest2136409() {
    $query = $this
      ->buildSearch();
    $query
      ->addCondition('category', NULL);
    $results = $query
      ->execute();
    $this
      ->assertResults([
      3,
    ], $results, 'NULL filter');
    $query = $this
      ->buildSearch();
    $query
      ->addCondition('category', NULL, '<>');
    $results = $query
      ->execute();
    $this
      ->assertResults([
      1,
      2,
      4,
      5,
    ], $results, 'NOT NULL filter');
  }

  /**
   * Regression tests for facets with counts of 0.
   *
   * @see https://www.drupal.org/node/1658964
   */
  protected function regressionTest1658964() {
    $query = $this
      ->buildSearch();
    $facets['type'] = [
      'field' => 'type',
      'limit' => 0,
      'min_count' => 0,
      'missing' => TRUE,
    ];
    $query
      ->setOption('search_api_facets', $facets);
    $query
      ->addCondition('type', 'article');
    $query
      ->range(0, 0);
    $results = $query
      ->execute();
    $expected = [
      [
        'count' => 2,
        'filter' => '"article"',
      ],
      [
        'count' => 0,
        'filter' => '!',
      ],
      [
        'count' => 0,
        'filter' => '"item"',
      ],
    ];
    $facets = $results
      ->getExtraData('search_api_facets', [])['type'];
    usort($facets, [
      $this,
      'facetCompare',
    ]);
    $this
      ->assertEquals($expected, $facets, 'Correct facets were returned');
  }

  /**
   * Regression tests for facets on fulltext fields.
   *
   * @see https://www.drupal.org/node/2469547
   */
  protected function regressionTest2469547() {
    $query = $this
      ->buildSearch();
    $facets = [];
    $facets['body'] = [
      '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 = [
      [
        'count' => 4,
        'filter' => '"test"',
      ],
      [
        'count' => 2,
        'filter' => '"Case"',
      ],
      [
        'count' => 2,
        'filter' => '"casE"',
      ],
      [
        'count' => 1,
        'filter' => '"bar"',
      ],
      [
        'count' => 1,
        'filter' => '"case"',
      ],
      [
        'count' => 1,
        'filter' => '"foobar"',
      ],
    ];

    // 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', [])['body'];
    usort($facets, [
      $this,
      'facetCompare',
    ]);
    $this
      ->assertEquals($expected, $facets, 'Correct facets were returned for a fulltext field.');
  }

  /**
   * Regression tests for multi word search results sets and wrong facet counts.
   *
   * @see https://www.drupal.org/node/1403916
   */
  protected function regressionTest1403916() {
    $query = $this
      ->buildSearch('test foo');
    $facets = [];
    $facets['type'] = [
      'field' => 'type',
      'limit' => 0,
      'min_count' => 1,
      'missing' => TRUE,
    ];
    $query
      ->setOption('search_api_facets', $facets);
    $query
      ->range(0, 0);
    $results = $query
      ->execute();
    $expected = [
      [
        'count' => 2,
        'filter' => '"item"',
      ],
      [
        'count' => 1,
        'filter' => '"article"',
      ],
    ];
    $facets = $results
      ->getExtraData('search_api_facets', [])['type'];
    usort($facets, [
      $this,
      'facetCompare',
    ]);
    $this
      ->assertEquals($expected, $facets, 'Correct facets were returned');
  }

  /**
   * Regression test for facet with "min_count" greater than 1.
   *
   * @see https://www.drupal.org/node/2783987
   */
  protected function regressionTest2783987() {
    $query = $this
      ->buildSearch('test foo');
    $facets = [];
    $facets['type'] = [
      'field' => 'type',
      'limit' => 0,
      'min_count' => 2,
      'missing' => TRUE,
    ];
    $query
      ->setOption('search_api_facets', $facets);
    $query
      ->range(0, 0);
    $results = $query
      ->execute();
    $expected = [
      [
        'count' => 2,
        'filter' => '"item"',
      ],
    ];
    $facets = $results
      ->getExtraData('search_api_facets', [])['type'];
    $this
      ->assertEquals($expected, $facets, 'Correct facets were returned');
  }

  /**
   * Regression test for multiple facets.
   *
   * @see https://www.drupal.org/node/2809753
   */
  protected function regressionTest2809753() {
    $query = $this
      ->buildSearch();
    $condition_group = $query
      ->createConditionGroup('OR', [
      'facet:type',
    ]);
    $condition_group
      ->addCondition('type', 'article');
    $query
      ->addConditionGroup($condition_group);
    $facets['type'] = [
      'field' => 'type',
      'limit' => 0,
      'min_count' => 1,
      'missing' => FALSE,
      'operator' => 'or',
    ];
    $facets['category'] = [
      'field' => 'category',
      'limit' => 0,
      'min_count' => 1,
      'missing' => FALSE,
      'operator' => 'or',
    ];
    $query
      ->setOption('search_api_facets', $facets);
    $results = $query
      ->execute();
    $this
      ->assertResults([
      4,
      5,
    ], $results, 'Multi-facets query');
    $expected = [
      [
        'count' => 3,
        'filter' => '"item"',
      ],
      [
        'count' => 2,
        'filter' => '"article"',
      ],
    ];
    $type_facets = $results
      ->getExtraData('search_api_facets')['type'];
    usort($type_facets, [
      $this,
      'facetCompare',
    ]);
    $this
      ->assertEquals($expected, $type_facets, 'Correct facets were returned for first facet');
    $expected = [
      [
        'count' => 2,
        'filter' => '"article_category"',
      ],
    ];
    $category_facets = $results
      ->getExtraData('search_api_facets')['category'];
    $this
      ->assertEquals($expected, $category_facets, 'Correct facets were returned for second facet');
  }

  /**
   * Regression test for conditions with empty strings as values.
   *
   * @see https://www.drupal.org/node/2767609
   */
  protected function regressionTest2767609() {
    $results = $this
      ->buildSearch(NULL, [
      'type,',
    ])
      ->execute();
    $this
      ->assertResults([], $results, 'Search for empty-string type');
    $results = $this
      ->buildSearch(NULL, [
      'category,',
    ])
      ->execute();
    $this
      ->assertResults([], $results, 'Search for empty-string category');
    $results = $this
      ->buildSearch()
      ->addCondition('category', '', '<>')
      ->execute();
    $this
      ->assertResults([
      1,
      2,
      3,
      4,
      5,
    ], $results, 'Search for items with category not an empty string');

    // It's not clear what the results for "category < ''" should be, but in
    // combination with the BETWEEN this should never return results.
    $results = $this
      ->buildSearch()
      ->addCondition('category', '', '<')
      ->addCondition('category', [
      '',
      'foo',
    ], 'BETWEEN')
      ->addCondition('category', [
      '',
      'a',
      'b',
    ], 'NOT IN')
      ->execute();
    $this
      ->assertResults([], $results, 'Search with various empty-string filters');
  }

  /**
   * Tests (NOT) NULL conditions on fulltext fields.
   *
   * @see https://www.drupal.org/node/2745655
   */
  protected function regressionTest2745655() {
    $name = $this->entities[3]->name[0]->value;
    $this->entities[3]->name[0]->value = NULL;
    $this->entities[3]
      ->save();
    $this
      ->indexItems($this->indexId);
    $results = $this
      ->buildSearch()
      ->addCondition('name', NULL)
      ->execute();
    $this
      ->assertResults([
      3,
    ], $results, 'Search for items without name');
    $results = $this
      ->buildSearch()
      ->addCondition('name', NULL, '<>')
      ->execute();
    $this
      ->assertResults([
      1,
      2,
      4,
      5,
    ], $results, 'Search for items with name');
    $this->entities[3]
      ->set('name', [
      $name,
    ]);
    $this->entities[3]
      ->save();
    $this
      ->indexItems($this->indexId);
  }

  /**
   * Compares two facet filters to determine their order.
   *
   * Used as a callback for usort() in regressionTests().
   *
   * Will first compare the counts, ranking facets with higher count first, and
   * then by filter value.
   *
   * @param array $a
   *   The first facet filter.
   * @param array $b
   *   The second facet filter.
   *
   * @return int
   *   -1 or 1 if the first filter should, respectively, come before or after
   *   the second; 0 if both facet filters are equal.
   */
  protected function facetCompare(array $a, array $b) {
    if ($a['count'] != $b['count']) {
      return $b['count'] - $a['count'];
    }
    return strcmp($a['filter'], $b['filter']);
  }

  /**
   * Clears the test index.
   */
  protected function clearIndex() {
    $this
      ->getIndex()
      ->clear();
  }

  /**
   * Executes regression tests which are unpractical to run in between.
   */
  protected function regressionTests2() {

    // Create a "prices" field on the test entity type.
    FieldStorageConfig::create([
      'field_name' => 'prices',
      'entity_type' => 'entity_test_mulrev_changed',
      'type' => 'decimal',
      'cardinality' => FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED,
    ])
      ->save();
    FieldConfig::create([
      'field_name' => 'prices',
      'entity_type' => 'entity_test_mulrev_changed',
      'bundle' => 'item',
      'label' => 'Prices',
    ])
      ->save();
    $this
      ->regressionTest1916474();
    $this
      ->regressionTest2284199();
    $this
      ->regressionTest2471509();
    $this
      ->regressionTest2616804();
  }

  /**
   * Regression tests for correctly indexing  multiple float/decimal fields.
   *
   * @see https://www.drupal.org/node/1916474
   */
  protected function regressionTest1916474() {
    $index = $this
      ->getIndex();
    $this
      ->addField($index, 'prices', 'decimal');
    $success = $index
      ->save();
    $this
      ->assertNotEmpty($success, 'The index field settings were successfully changed.');

    // Reset the static cache so the new values will be available.
    $this
      ->resetEntityCache('server');
    $this
      ->resetEntityCache();
    $this
      ->addTestEntity(6, [
      'prices' => [
        '3.5',
        '3.25',
        '3.75',
        '3.5',
      ],
      'type' => 'item',
    ]);
    $this
      ->indexItems($this->indexId);
    $query = $this
      ->buildSearch(NULL, [
      'prices,3.25',
    ]);
    $results = $query
      ->execute();
    $this
      ->assertResults([
      6,
    ], $results, 'Filter on decimal field');
    $query = $this
      ->buildSearch(NULL, [
      'prices,3.5',
    ]);
    $results = $query
      ->execute();
    $this
      ->assertResults([
      6,
    ], $results, 'Filter on decimal field');

    // Use the "prices" field, since we've added it now, to also check for
    // proper handling of (NOT) BETWEEN for multi-valued fields.
    $query = $this
      ->buildSearch()
      ->addCondition('prices', [
      3.6,
      3.8,
    ], 'BETWEEN');
    $results = $query
      ->execute();
    $this
      ->assertResults([
      6,
    ], $results, 'BETWEEN filter on multi-valued field');
    $query = $this
      ->buildSearch()
      ->addCondition('prices', [
      3.6,
      3.8,
    ], 'NOT BETWEEN');
    $results = $query
      ->execute();
    $this
      ->assertResults([
      1,
      2,
      3,
      4,
      5,
    ], $results, 'NOT BETWEEN filter on multi-valued field');
  }

  /**
   * Regression tests for problems with taxonomy term parent.
   *
   * @see https://www.drupal.org/node/2284199
   */
  protected function regressionTest2284199() {
    $this
      ->addTestEntity(7, [
      'type' => 'item',
    ]);
    $count = $this
      ->indexItems($this->indexId);
    $this
      ->assertEquals(1, $count, 'Indexing an item with an empty value for a non string field worked.');
  }

  /**
   * Regression tests for strings longer than 50 chars.
   *
   * @see https://www.drupal.org/node/2471509
   * @see https://www.drupal.org/node/2616268
   */
  protected function regressionTest2471509() {
    $this
      ->addTestEntity(8, [
      'name' => 'Article with long body',
      'type' => 'article',
      'body' => 'astringlongerthanfiftycharactersthatcantbestoredbythedbbackend',
    ]);
    $count = $this
      ->indexItems($this->indexId);
    $this
      ->assertEquals(1, $count, 'Indexing an item with a word longer than 50 characters worked.');
    $index = $this
      ->getIndex();
    $index
      ->getField('body')
      ->setType('string');
    $index
      ->save();
    $count = $this
      ->indexItems($this->indexId);
    $this
      ->assertEquals(count($this->entities), $count, 'Switching type from text to string worked.');

    // For a string field, 50 characters shouldn't be a problem.
    $query = $this
      ->buildSearch(NULL, [
      'body,astringlongerthanfiftycharactersthatcantbestoredbythedbbackend',
    ]);
    $results = $query
      ->execute();
    $this
      ->assertResults([
      8,
    ], $results, 'Filter on new string field');
    $index
      ->getField('body')
      ->setType('text');
    $index
      ->save();
    $count = $this
      ->indexItems($this->indexId);
    $this
      ->assertEquals(count($this->entities), $count, 'All items needed to be re-indexed after switching type from string to text.');
  }

  /**
   * Regression tests for multibyte characters exceeding 50 byte.
   *
   * @see https://www.drupal.org/node/2616804
   */
  protected function regressionTest2616804() {

    // The word has 28 Unicode characters but 56 bytes. Verify that it is still
    // indexed correctly.
    $mb_word = 'äöüßáŧæøðđŋħĸµäöüßáŧæøðđŋħĸµ';

    // We put the word 8 times into the body so we can also verify that the 255
    // character limit for strings counts characters, not bytes.
    $mb_body = implode(' ', array_fill(0, 8, $mb_word));
    $this
      ->addTestEntity(9, [
      'name' => 'Test item 9',
      'type' => 'item',
      'body' => $mb_body,
    ]);
    $count = $this
      ->indexItems($this->indexId);
    $this
      ->assertEquals(1, $count, 'Indexing an item with a word with 28 multi-byte characters worked.');
    $query = $this
      ->buildSearch($mb_word);
    $results = $query
      ->execute();
    $this
      ->assertResults([
      9,
    ], $results, 'Search for word with 28 multi-byte characters');
    $query = $this
      ->buildSearch($mb_word . 'ä');
    $results = $query
      ->execute();
    $this
      ->assertResults([], $results, 'Search for unknown word with 29 multi-byte characters');

    // Test the same body when indexed as a string (255 characters limit should
    // not be reached).
    $index = $this
      ->getIndex();
    $index
      ->getField('body')
      ->setType('string');
    $index
      ->save();
    $entity_count = count($this->entities);
    $count = $this
      ->indexItems($this->indexId);
    $this
      ->assertEquals($entity_count, $count, 'Switching type from text to string worked.');
    $query = $this
      ->buildSearch(NULL, [
      "body,{$mb_body}",
    ]);
    $results = $query
      ->execute();
    $this
      ->assertResults([
      9,
    ], $results, 'Search for body with 231 multi-byte characters');
    $query = $this
      ->buildSearch(NULL, [
      "body,{$mb_body}ä",
    ]);
    $results = $query
      ->execute();
    $this
      ->assertResults([], $results, 'Search for unknown body with 232 multi-byte characters');
    $index
      ->getField('body')
      ->setType('text');
    $index
      ->save();
  }

  /**
   * Checks the correct handling of an index without fields.
   *
   * @return \Drupal\search_api\IndexInterface
   *   The created test index.
   */
  protected function checkIndexWithoutFields() {
    $index = Index::create([
      'id' => 'test_index_2',
      'name' => 'Test index 2',
      'status' => TRUE,
      'server' => $this->serverId,
      'datasource_settings' => [
        'entity:entity_test_mulrev_changed' => [],
      ],
      'tracker_settings' => [
        'default' => [],
      ],
    ]);
    $index
      ->save();
    $indexed_count = $this
      ->indexItems($index
      ->id());
    $this
      ->assertEquals(count($this->entities), $indexed_count);
    $search_count = $index
      ->query()
      ->execute()
      ->getResultCount();
    $this
      ->assertEquals(count($this->entities), $search_count);
    return $index;
  }

  /**
   * Asserts that the given result set complies with expectations.
   *
   * @param int[] $result_ids
   *   The expected result item IDs, as raw entity IDs.
   * @param \Drupal\search_api\Query\ResultSetInterface $results
   *   The returned result set.
   * @param string $search_label
   *   (optional) A label for the search to include in assertion messages.
   * @param string[] $ignored
   *   (optional) The ignored keywords that should be present, if any.
   * @param string[] $warnings
   *   (optional) The ignored warnings that should be present, if any.
   */
  protected function assertResults(array $result_ids, ResultSetInterface $results, $search_label = 'Search', array $ignored = [], array $warnings = []) {
    $this
      ->assertEquals(count($result_ids), $results
      ->getResultCount(), "{$search_label} returned correct number of results.");
    if ($result_ids) {
      $this
        ->assertEquals($this
        ->getItemIds($result_ids), array_keys($results
        ->getResultItems()), "{$search_label} returned correct results.");
    }
    $this
      ->assertEquals($ignored, $results
      ->getIgnoredSearchKeys());
    $this
      ->assertEquals($warnings, $results
      ->getWarnings());
  }

  /**
   * Retrieves the search server used by this test.
   *
   * @return \Drupal\search_api\ServerInterface
   *   The search server.
   */
  protected function getServer() {
    return Server::load($this->serverId);
  }

  /**
   * Retrieves the search index used by this test.
   *
   * @return \Drupal\search_api\IndexInterface
   *   The search index.
   */
  protected function getIndex() {
    return Index::load($this->indexId);
  }

  /**
   * Adds a field to a search index.
   *
   * The index will not be saved automatically.
   *
   * @param \Drupal\search_api\IndexInterface $index
   *   The search index.
   * @param string $property_name
   *   The property's name.
   * @param string $type
   *   (optional) The field type.
   */
  protected function addField(IndexInterface $index, $property_name, $type = 'text') {
    $field_info = [
      'label' => $property_name,
      'type' => $type,
      'datasource_id' => 'entity:entity_test_mulrev_changed',
      'property_path' => $property_name,
    ];
    $field = \Drupal::getContainer()
      ->get('search_api.fields_helper')
      ->createField($index, $property_name, $field_info);
    $index
      ->addField($field);
    $index
      ->save();
  }

  /**
   * Resets the entity cache for the specified entity.
   *
   * @param string $type
   *   (optional) The type of entity whose cache should be reset. Either "index"
   *   or "server".
   */
  protected function resetEntityCache($type = 'index') {
    $entity_type_id = 'search_api_' . $type;
    \Drupal::entityTypeManager()
      ->getStorage($entity_type_id)
      ->resetCache([
      $this->{$type . 'Id'},
    ]);
  }

}

Members

Name	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::$indexId	protected	property	A search index ID.	1
BackendTestBase::$modules	public static	property	Modules to enable. Overrides KernelTestBase::$modules	1
BackendTestBase::$serverId	protected	property	A search server ID.	1
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::checkModuleUninstall	abstract protected	function	Tests whether removing the configuration again works as it should.	1
BackendTestBase::checkSecondServer	abstract protected	function	Tests that a second server doesn't interfere with the first.	1
BackendTestBase::checkServerBackend	abstract protected	function	Tests the correct setup of the server backend.	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.
BackendTestBase::setUp	public	function	Overrides KernelTestBase::setUp	1
BackendTestBase::testBackend	public	function	Tests various indexing scenarios for the search backend.
BackendTestBase::updateIndex	abstract protected	function	Checks whether changes to the index's fields are picked up by the server.	1
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::indexItems	protected	function	Indexes all (unindexed) items on the specified index.
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.
KernelTestBase::$backupGlobals	protected	property	Back up and restore any global variables that may be changed by tests.
KernelTestBase::$backupStaticAttributes	protected	property	Back up and restore static class properties that may be changed by tests.
KernelTestBase::$backupStaticAttributesBlacklist	protected	property	Contains a few static class properties for performance.
KernelTestBase::$classLoader	protected	property
KernelTestBase::$configImporter	protected	property	@todo Move into Config test base class.	7
KernelTestBase::$configSchemaCheckerExclusions	protected static	property	An array of config object names that are excluded from schema checking.
KernelTestBase::$container	protected	property
KernelTestBase::$databasePrefix	protected	property
KernelTestBase::$preserveGlobalState	protected	property	Do not forward any global state from the parent process to the processes that run the actual tests.
KernelTestBase::$root	protected	property	The app root.
KernelTestBase::$runTestInSeparateProcess	protected	property	Kernel tests are run in separate processes because they allow autoloading of code from extensions. Running the test in a separate process isolates this behavior from other tests. Subclasses should not override this property.
KernelTestBase::$siteDirectory	protected	property
KernelTestBase::$strictConfigSchema	protected	property	Set to TRUE to strict check all configuration saved.	6
KernelTestBase::$vfsRoot	protected	property	The virtual filesystem root directory.
KernelTestBase::assertPostConditions	protected	function		1
KernelTestBase::bootEnvironment	protected	function	Bootstraps a basic test environment.
KernelTestBase::bootKernel	private	function	Bootstraps a kernel for a test.
KernelTestBase::config	protected	function	Configuration accessor for tests. Returns non-overridden configuration.
KernelTestBase::disableModules	protected	function	Disables modules for this test.
KernelTestBase::enableModules	protected	function	Enables modules for this test.
KernelTestBase::getConfigSchemaExclusions	protected	function	Gets the config schema exclusions for this test.
KernelTestBase::getDatabaseConnectionInfo	protected	function	Returns the Database connection info to be used for this test.	1
KernelTestBase::getDatabasePrefix	public	function
KernelTestBase::getExtensionsForModules	private	function	Returns Extension objects for $modules to enable.
KernelTestBase::getModulesToEnable	private static	function	Returns the modules to enable for this test.
KernelTestBase::initFileCache	protected	function	Initializes the FileCache component.
KernelTestBase::installConfig	protected	function	Installs default configuration for a given list of modules.
KernelTestBase::installEntitySchema	protected	function	Installs the storage schema for a specific entity type.
KernelTestBase::installSchema	protected	function	Installs database tables from a module schema definition.
KernelTestBase::isTestInIsolation Deprecated	protected	function	Returns whether the current test method is running in a separate process.
KernelTestBase::prepareTemplate	protected	function
KernelTestBase::register	public	function	Registers test-specific services. Overrides ServiceProviderInterface::register	26
KernelTestBase::render	protected	function	Renders a render array.	1
KernelTestBase::setInstallProfile	protected	function	Sets the install profile and rebuilds the container to update it.
KernelTestBase::setSetting	protected	function	Sets an in-memory Settings variable.
KernelTestBase::setUpBeforeClass	public static	function		1
KernelTestBase::setUpFilesystem	protected	function	Sets up the filesystem, so things like the file directory.	2
KernelTestBase::stop	protected	function	Stops test execution.
KernelTestBase::tearDown	protected	function		6
KernelTestBase::tearDownCloseDatabaseConnection	public	function	@after
KernelTestBase::vfsDump	protected	function	Dumps the current state of the virtual filesystem to STDOUT.
KernelTestBase::__get Deprecated	public	function	BC: Automatically resolve former KernelTestBase class properties.
KernelTestBase::__sleep	public	function	Prevents serializing any properties.
PhpunitCompatibilityTrait::getMock Deprecated	public	function	Returns a mock object for the specified class using the available method.
PhpunitCompatibilityTrait::setExpectedException Deprecated	public	function	Compatibility layer for PHPUnit 6 to support PHPUnit 4 code.
RandomGeneratorTrait::$randomGenerator	protected	property	The random generator.
RandomGeneratorTrait::getRandomGenerator	protected	function	Gets the random generator for the utility methods.
RandomGeneratorTrait::randomMachineName	protected	function	Generates a unique random string containing letters and numbers.	1
RandomGeneratorTrait::randomObject	public	function	Generates a random PHP object.
RandomGeneratorTrait::randomString	public	function	Generates a pseudo-random string of ASCII characters of codes 32 to 126.
RandomGeneratorTrait::randomStringValidate	public	function	Callback for random string validation.
StorageCopyTrait::replaceStorageContents	protected static	function	Copy the configuration from one storage to another and remove stale items.
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.

You are here

abstract class BackendTestBase in Search API 8

Hierarchy

File

Namespace

Members

API Navigation