class ServerTaskTest in Search API 8

Tests whether the server task system works correctly.

@group search_api

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\Server\ServerTaskTest uses PluginTestTrait

Expanded class hierarchy of ServerTaskTest

File

tests/src/Kernel/Server/ServerTaskTest.php, line 17

Namespace

Drupal\Tests\search_api\Kernel\Server

View source

class ServerTaskTest extends KernelTestBase {
  use PluginTestTrait;

  /**
   * The test server.
   *
   * @var \Drupal\search_api\ServerInterface
   */
  protected $server;

  /**
   * The test index.
   *
   * @var \Drupal\search_api\IndexInterface
   */
  protected $index;

  /**
   * The content entity datasource.
   *
   * @var \Drupal\search_api\Datasource\DatasourceInterface
   */
  protected $datasource;

  /**
   * Modules to enable for this test.
   *
   * @var string[]
   */
  public static $modules = [
    'user',
    'search_api',
    'search_api_test',
  ];

  /**
   * The task manager to use for the tests.
   *
   * @var \Drupal\search_api\Task\TaskManagerInterface
   */
  protected $taskManager;

  /**
   * The server task manager to use for the tests.
   *
   * @var \Drupal\search_api\Task\ServerTaskManagerInterface
   */
  protected $serverTaskManager;

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

    // Create a test server.
    $this->server = Server::create([
      'name' => 'Test Server',
      'id' => 'test_server',
      'status' => 1,
      'backend' => 'search_api_test',
    ]);
    $this->server
      ->save();

    // Create a test index.
    $this->index = Index::create([
      'name' => 'Test index',
      'id' => 'test_index',
      'status' => 1,
      'datasource_settings' => [
        'entity:user' => [],
      ],
      'tracker_settings' => [
        'default' => [],
      ],
      'server' => $this->server
        ->id(),
      'options' => [
        'index_directly' => FALSE,
      ],
    ]);
    $this->index
      ->save();
    $this->taskManager = $this->container
      ->get('search_api.task_manager');
    $this->serverTaskManager = $this->container
      ->get('search_api.server_task_manager');

    // Reset the list of called backend methods.
    $this
      ->getCalledMethods('backend');
  }

  /**
   * Tests task system integration for the server's addIndex() method.
   */
  public function testAddIndex() {

    // Since we want to add the index, we should first remove it (even though it
    // shouldn't matter – just for logic consistency).
    $this->index
      ->setServer(NULL);
    $this->index
      ->save();

    // Set exception for addIndex() and reset the list of successful backend
    // method calls.
    $this
      ->setError('backend', 'addIndex');
    $this
      ->getCalledMethods('backend');

    // Try to add the index.
    $this->server
      ->addIndex($this->index);
    $this
      ->assertEquals([], $this
      ->getCalledMethods('backend'), 'addIndex correctly threw an exception.');
    $tasks = $this
      ->getServerTasks();
    if (count($tasks) == 1) {
      $task_created = $tasks[0]->type === 'addIndex';
    }
    $this
      ->assertTrue(!empty($task_created), 'The addIndex task was successfully added.');
    if ($tasks) {
      $this
        ->assertEquals($this->index
        ->id(), $tasks[0]->index_id, 'The right index ID was used for the addIndex task.');
    }

    // Check whether other task-system-integrated methods now fail, too.
    $this->server
      ->updateIndex($this->index);
    $this
      ->assertEquals([], $this
      ->getCalledMethods('backend'), 'updateIndex was not executed.');
    $tasks = $this
      ->getServerTasks();
    if (count($tasks) == 2) {
      $this
        ->assertTrue(TRUE, "Second task ('updateIndex') was added.");
      $this
        ->assertEquals('addIndex', $tasks[0]->type, 'First task stayed the same.');
      $this
        ->assertEquals('updateIndex', $tasks[1]->type, 'New task was queued as last.');
    }
    else {
      $this
        ->fail("Second task (updateIndex) was not added.");
    }

    // Let addIndex() succeed again, then trigger the task execution with a cron
    // run.
    $this
      ->setError('backend', 'addIndex', FALSE);
    search_api_cron();
    $this
      ->assertEquals([], $this
      ->getServerTasks(), 'Server tasks were correctly executed.');
    $this
      ->assertEquals([
      'addIndex',
      'updateIndex',
    ], $this
      ->getCalledMethods('backend'), 'Right methods were called during task execution.');
  }

  /**
   * Tests task system integration for the server's updateIndex() method.
   */
  public function testUpdateIndex() {

    // Set exception for updateIndex().
    $this
      ->setError('backend', 'updateIndex');

    // Try to update the index.
    $this->server
      ->updateIndex($this->index);
    $this
      ->assertEquals([], $this
      ->getCalledMethods('backend'), 'updateIndex correctly threw an exception.');
    $tasks = $this
      ->getServerTasks();
    if (count($tasks) == 1) {
      $task_created = $tasks[0]->type === 'updateIndex';
    }
    $this
      ->assertTrue(!empty($task_created), 'The updateIndex task was successfully added.');
    if ($tasks) {
      $this
        ->assertEquals($this->index
        ->id(), $tasks[0]->index_id, 'The right index ID was used for the updateIndex task.');
    }

    // Check whether other task-system-integrated methods now fail, too.
    $this->server
      ->deleteAllIndexItems($this->index);
    $this
      ->assertEquals([], $this
      ->getCalledMethods('backend'), 'deleteAllIndexItems was not executed.');
    $tasks = $this
      ->getServerTasks();
    if (count($tasks) == 2) {
      $this
        ->assertTrue(TRUE, "Second task ('deleteAllIndexItems') was added.");
      $this
        ->assertEquals('updateIndex', $tasks[0]->type, 'First task stayed the same.');
      $this
        ->assertEquals('deleteAllIndexItems', $tasks[1]->type, 'New task was queued as last.');
    }
    else {
      $this
        ->fail("Second task (deleteAllIndexItems) was not added.");
    }

    // Let updateIndex() succeed again, then trigger the task execution with a
    // call to indexItems().
    $this
      ->setError('backend', 'updateIndex', FALSE);
    $this->server
      ->indexItems($this->index, []);
    $expected_methods = [
      'updateIndex',
      'deleteAllIndexItems',
      'indexItems',
    ];
    $this
      ->assertEquals([], $this
      ->getServerTasks(), 'Server tasks were correctly executed.');
    $this
      ->assertEquals($expected_methods, $this
      ->getCalledMethods('backend'), 'Right methods were called during task execution.');
  }

  /**
   * Tests task system integration for the server's removeIndex() method.
   */
  public function testRemoveIndex() {

    // Set exception for updateIndex() and removeIndex().
    $this
      ->setError('backend', 'updateIndex');
    $this
      ->setError('backend', 'removeIndex');

    // First try to update the index and fail. Then try to remove it and check
    // that the tasks were set correctly.
    $this->server
      ->updateIndex($this->index);
    $this->server
      ->removeIndex($this->index);
    $this
      ->assertEquals([], $this
      ->getCalledMethods('backend'), 'updateIndex and removeIndex correctly threw exceptions.');
    $tasks = $this
      ->getServerTasks();
    if (count($tasks) == 1) {
      $task_created = $tasks[0]->type === 'removeIndex';
    }
    $this
      ->assertTrue(!empty($task_created), 'The removeIndex task was successfully added and other tasks removed.');
    if ($tasks) {
      $this
        ->assertEquals($this->index
        ->id(), $tasks[0]->index_id, 'The right index ID was used for the removeIndex task.');
    }

    // Check whether other task-system-integrated methods now fail, too.
    try {
      $this->server
        ->indexItems($this->index, []);
      $this
        ->fail('Pending server tasks did not prevent indexing of items.');
    } catch (SearchApiException $e) {
      $label = $this->index
        ->label();
      $expected_message = "Could not index items on index '{$label}' because pending server tasks could not be executed.";
      $this
        ->assertEquals($expected_message, $e
        ->getMessage(), 'Pending server tasks prevented indexing of items.');
    }
    $this
      ->assertEquals([], $this
      ->getCalledMethods('backend'), 'indexItems was not executed.');
    $tasks = $this
      ->getServerTasks();
    $this
      ->assertEquals(1, count($tasks), 'No task added for indexItems.');

    // Let removeIndex() succeed again, then trigger the task execution with a
    // cron run.
    $this
      ->setError('backend', 'removeIndex', FALSE);
    search_api_cron();
    $this
      ->assertEquals([], $this
      ->getServerTasks(), 'Server tasks were correctly executed.');
    $this
      ->assertEquals([
      'removeIndex',
    ], $this
      ->getCalledMethods('backend'), 'Right methods were called during task execution.');
  }

  /**
   * Tests task system integration for the server's deleteItems() method.
   */
  public function testDeleteItems() {

    // Set exception for deleteItems().
    $this
      ->setError('backend', 'deleteItems');

    // Try to update the index.
    $this->server
      ->deleteItems($this->index, []);
    $this
      ->assertEquals([], $this
      ->getCalledMethods('backend'), 'deleteItems correctly threw an exception.');
    $tasks = $this
      ->getServerTasks();
    if (count($tasks) == 1) {
      $task_created = $tasks[0]->type === 'deleteItems';
    }
    $this
      ->assertTrue(!empty($task_created), 'The deleteItems task was successfully added.');
    if ($tasks) {
      $this
        ->assertEquals($this->index
        ->id(), $tasks[0]->index_id, 'The right index ID was used for the deleteItems task.');
    }

    // Check whether other task-system-integrated methods now fail, too.
    $this->server
      ->updateIndex($this->index);
    $this
      ->assertEquals([], $this
      ->getCalledMethods('backend'), 'updateIndex was not executed.');
    $tasks = $this
      ->getServerTasks();
    if (count($tasks) == 2) {
      $this
        ->assertTrue(TRUE, "Second task ('updateIndex') was added.");
      $this
        ->assertEquals('deleteItems', $tasks[0]->type, 'First task stayed the same.');
      $this
        ->assertEquals('updateIndex', $tasks[1]->type, 'New task was queued as last.');
    }
    else {
      $this
        ->fail("Second task (updateIndex) was not added.");
    }

    // Let deleteItems() succeed again, then trigger the task execution
    // with a cron run.
    $this
      ->setError('backend', 'deleteItems', FALSE);
    search_api_cron();
    $this
      ->assertEquals([], $this
      ->getServerTasks(), 'Server tasks were correctly executed.');
    $this
      ->assertEquals([
      'deleteItems',
      'updateIndex',
    ], $this
      ->getCalledMethods('backend'), 'Right methods were called during task execution.');
  }

  /**
   * Tests task system integration for the deleteAllIndexItems() method.
   */
  public function testDeleteAllIndexItems() {

    // Set exception for deleteAllIndexItems().
    $this
      ->setError('backend', 'deleteAllIndexItems');

    // Try to update the index.
    $this->server
      ->deleteAllIndexItems($this->index);
    $this
      ->assertEquals([], $this
      ->getCalledMethods('backend'), 'deleteAllIndexItems correctly threw an exception.');
    $tasks = $this
      ->getServerTasks();
    if (count($tasks) == 1) {
      $task_created = $tasks[0]->type === 'deleteAllIndexItems';
    }
    $this
      ->assertTrue(!empty($task_created), 'The deleteAllIndexItems task was successfully added.');
    if ($tasks) {
      $this
        ->assertEquals($this->index
        ->id(), $tasks[0]->index_id, 'The right index ID was used for the deleteAllIndexItems task.');
    }

    // Check whether other task-system-integrated methods now fail, too.
    $this->server
      ->updateIndex($this->index);
    $this
      ->assertEquals([], $this
      ->getCalledMethods('backend'), 'updateIndex was not executed.');
    $tasks = $this
      ->getServerTasks();
    if (count($tasks) == 2) {
      $this
        ->assertTrue(TRUE, "Second task ('updateIndex') was added.");
      $this
        ->assertEquals('deleteAllIndexItems', $tasks[0]->type, 'First task stayed the same.');
      $this
        ->assertEquals('updateIndex', $tasks[1]->type, 'New task was queued as last.');
    }
    else {
      $this
        ->fail("Second task (updateIndex) was not added.");
    }

    // Let deleteAllIndexItems() succeed again, then trigger the task execution
    // with a call to indexItems().
    $this
      ->setError('backend', 'deleteAllIndexItems', FALSE);
    $this->server
      ->indexItems($this->index, []);
    $expected_methods = [
      'deleteAllIndexItems',
      'updateIndex',
      'indexItems',
    ];
    $this
      ->assertEquals([], $this
      ->getServerTasks(), 'Server tasks were correctly executed.');
    $this
      ->assertEquals($expected_methods, $this
      ->getCalledMethods('backend'), 'Right methods were called during task execution.');
  }

  /**
   * Verifies that no more than 100 items will be executed at once.
   */
  public function testTaskCountLimit() {

    // Create 101 tasks.
    for ($i = 0; $i < 101; ++$i) {
      $this->taskManager
        ->addTask('deleteItems', $this->server, $this->index, [
        $i,
      ]);
    }

    // Verify that a new operation cannot be executed.
    $this->server
      ->updateIndex($this->index);
    $methods = $this
      ->getCalledMethods('backend');
    $this
      ->assertCount(100, $methods, '100 pending tasks were executed upon new operation.');
    $filter = function ($method) {
      return $method != 'deleteItems';
    };
    $this
      ->assertEmpty(array_filter($methods, $filter), 'The new operation was not executed.');
    $this
      ->assertEquals(2, $this->serverTaskManager
      ->getCount($this->server), 'A task was created for the new operation.');
  }

  /**
   * Tests the correct automatic removal of tasks upon certain operations.
   */
  public function testAutomaticTaskRemoval() {

    // Create a second server and index and add tasks for them.
    $server2 = Server::create([
      'name' => 'Test Server 2',
      'id' => 'test_server_2',
      'status' => 1,
      'backend' => 'search_api_test',
    ]);
    $server2
      ->save();
    $this->taskManager
      ->addTask('removeIndex', $server2, $this->index);
    $index_values = $this->index
      ->toArray();
    unset($index_values['uuid']);
    $index_values['id'] = 'test_index_2';
    $index2 = Index::create($index_values);
    $index2
      ->save();

    // Reset the called backend methods.
    $this
      ->getCalledMethods('backend');

    // Verify that adding an index ignores all tasks related to that index.
    $this
      ->addTasks($index2);
    $this->server
      ->addIndex($this->index);
    $this
      ->assertEquals([
      'addIndex',
      'addIndex',
    ], $this
      ->getCalledMethods('backend'), 'Re-adding an index ignored all its tasks.');
    $this
      ->assertEquals(0, $this->serverTaskManager
      ->getCount($this->server), 'No pending tasks for server.');
    $this
      ->assertEquals(1, $this->serverTaskManager
      ->getCount(), 'The tasks of other servers were not touched.');

    // Verify that removing an index ignores all tasks related to that index.
    $this
      ->addTasks($index2);
    $this->server
      ->removeIndex($this->index);
    $this
      ->assertEquals([
      'addIndex',
      'removeIndex',
    ], $this
      ->getCalledMethods('backend'), 'Removing an index ignored all its tasks.');
    $this
      ->assertEquals(0, $this->serverTaskManager
      ->getCount($this->server), 'No pending tasks for server.');
    $this
      ->assertEquals(1, $this->serverTaskManager
      ->getCount(), 'The tasks of other servers were not touched.');

    // Verify that deleting all of an index's items ignores all other deletion
    // tasks related to that index.
    $this
      ->addTasks($index2);
    $this->server
      ->deleteAllIndexItems($this->index);
    $called_methods = [
      'addIndex',
      'removeIndex',
      'addIndex',
      'updateIndex',
      'deleteAllIndexItems',
    ];
    $this
      ->assertEquals($called_methods, $this
      ->getCalledMethods('backend'), 'Deleting all items of an index ignored all its deletion tasks.');
    $this
      ->assertEquals(0, $this->serverTaskManager
      ->getCount($this->server), 'No pending tasks for server.');
    $this
      ->assertEquals(1, $this->serverTaskManager
      ->getCount(), 'The tasks of other servers were not touched.');

    // Verify that removing all items from the server automatically removes all
    // item deletion tasks as well.
    $this
      ->addTasks($index2);
    $this->server
      ->deleteAllItems();

    // deleteAllIndexItems() is called twice – once for each index.
    $this
      ->assertEquals([
      'deleteAllIndexItems',
      'deleteAllIndexItems',
    ], $this
      ->getCalledMethods('backend'), "Deleting all items from a server didn't execute any tasks.");
    $this
      ->assertEquals(4, $this->serverTaskManager
      ->getCount($this->server), 'Deleting all items from a server removed all its item deletion tasks.');
    $this
      ->assertEquals(5, $this->serverTaskManager
      ->getCount(), 'The tasks of other servers were not touched.');

    // Verify that deleting a server also deletes all of its tasks.
    $this
      ->addTasks($index2);
    $this
      ->setError('backend', 'addIndex');
    $this
      ->setError('backend', 'updateIndex');
    $this
      ->setError('backend', 'removeIndex');
    $this
      ->setError('backend', 'deleteItems');
    $this
      ->setError('backend', 'deleteAllIndexItems');
    $this->server
      ->delete();
    $this
      ->assertEquals(0, $this->serverTaskManager
      ->getCount($this->server), 'Upon server deletion, all of its tasks were deleted, too.');
    $this
      ->assertEquals(1, $this->serverTaskManager
      ->getCount(), 'The tasks of other servers were not touched.');
  }

  /**
   * Adds one task of each type for this test's server.
   *
   * @param \Drupal\search_api\IndexInterface $second_index
   *   A second index, for which one additional "addIndex" task is created.
   */
  protected function addTasks(IndexInterface $second_index) {
    $this->taskManager
      ->addTask('addIndex', $this->server, $second_index);
    $this->taskManager
      ->addTask('removeIndex', $this->server, $this->index);
    $this->taskManager
      ->addTask('addIndex', $this->server, $this->index);
    $this->taskManager
      ->addTask('updateIndex', $this->server, $this->index);
    $this->taskManager
      ->addTask('deleteItems', $this->server, $this->index, []);
    $this->taskManager
      ->addTask('deleteAllIndexItems', $this->server, $this->index);
  }

  /**
   * Retrieves the tasks set on the test server.
   *
   * @return object[]
   *   All tasks read from the database for the test server, with numeric keys
   *   starting with 0.
   */
  protected function getServerTasks() {
    $tasks = [];
    $select = \Drupal::database()
      ->select('search_api_task', 't');
    $select
      ->fields('t')
      ->orderBy('id')
      ->condition('server_id', $this->server
      ->id());
    foreach ($select
      ->execute() as $task) {
      if ($task->data) {
        $task->data = unserialize($task->data);
      }
      $tasks[] = $task;
    }
    return $tasks;
  }

}

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
ConfigTestTrait::configImporter	protected	function	Returns a ConfigImporter object to import test configuration.
ConfigTestTrait::copyConfig	protected	function	Copies configuration objects from source storage to target storage.
KernelTestBase::$backupGlobals	protected	property	Back up and restore any global variables that may be changed by tests.
KernelTestBase::$backupStaticAttributes	protected	property	Back up and restore static class properties that may be changed by tests.
KernelTestBase::$backupStaticAttributesBlacklist	protected	property	Contains a few static class properties for performance.
KernelTestBase::$classLoader	protected	property
KernelTestBase::$configImporter	protected	property	@todo Move into Config test base class.	7
KernelTestBase::$configSchemaCheckerExclusions	protected static	property	An array of config object names that are excluded from schema checking.
KernelTestBase::$container	protected	property
KernelTestBase::$databasePrefix	protected	property
KernelTestBase::$preserveGlobalState	protected	property	Do not forward any global state from the parent process to the processes that run the actual tests.
KernelTestBase::$root	protected	property	The app root.
KernelTestBase::$runTestInSeparateProcess	protected	property	Kernel tests are run in separate processes because they allow autoloading of code from extensions. Running the test in a separate process isolates this behavior from other tests. Subclasses should not override this property.
KernelTestBase::$siteDirectory	protected	property
KernelTestBase::$strictConfigSchema	protected	property	Set to TRUE to strict check all configuration saved.	6
KernelTestBase::$vfsRoot	protected	property	The virtual filesystem root directory.
KernelTestBase::assertPostConditions	protected	function		1
KernelTestBase::bootEnvironment	protected	function	Bootstraps a basic test environment.
KernelTestBase::bootKernel	private	function	Bootstraps a kernel for a test.
KernelTestBase::config	protected	function	Configuration accessor for tests. Returns non-overridden configuration.
KernelTestBase::disableModules	protected	function	Disables modules for this test.
KernelTestBase::enableModules	protected	function	Enables modules for this test.
KernelTestBase::getConfigSchemaExclusions	protected	function	Gets the config schema exclusions for this test.
KernelTestBase::getDatabaseConnectionInfo	protected	function	Returns the Database connection info to be used for this test.	1
KernelTestBase::getDatabasePrefix	public	function
KernelTestBase::getExtensionsForModules	private	function	Returns Extension objects for $modules to enable.
KernelTestBase::getModulesToEnable	private static	function	Returns the modules to enable for this test.
KernelTestBase::initFileCache	protected	function	Initializes the FileCache component.
KernelTestBase::installConfig	protected	function	Installs default configuration for a given list of modules.
KernelTestBase::installEntitySchema	protected	function	Installs the storage schema for a specific entity type.
KernelTestBase::installSchema	protected	function	Installs database tables from a module schema definition.
KernelTestBase::isTestInIsolation Deprecated	protected	function	Returns whether the current test method is running in a separate process.
KernelTestBase::prepareTemplate	protected	function
KernelTestBase::register	public	function	Registers test-specific services. Overrides ServiceProviderInterface::register	26
KernelTestBase::render	protected	function	Renders a render array.	1
KernelTestBase::setInstallProfile	protected	function	Sets the install profile and rebuilds the container to update it.
KernelTestBase::setSetting	protected	function	Sets an in-memory Settings variable.
KernelTestBase::setUpBeforeClass	public static	function		1
KernelTestBase::setUpFilesystem	protected	function	Sets up the filesystem, so things like the file directory.	2
KernelTestBase::stop	protected	function	Stops test execution.
KernelTestBase::tearDown	protected	function		6
KernelTestBase::tearDownCloseDatabaseConnection	public	function	@after
KernelTestBase::vfsDump	protected	function	Dumps the current state of the virtual filesystem to STDOUT.
KernelTestBase::__get Deprecated	public	function	BC: Automatically resolve former KernelTestBase class properties.
KernelTestBase::__sleep	public	function	Prevents serializing any properties.
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.
PluginTestTrait::getCalledMethods	protected	function	Retrieves the methods called on a given plugin.
PluginTestTrait::getMethodArguments	protected	function	Retrieves the arguments of a certain method called on the given plugin.
PluginTestTrait::setError	protected	function	Sets an exception to be thrown on calls to the given method.
PluginTestTrait::setMethodOverride	protected	function	Overrides a method for a certain plugin.
PluginTestTrait::setReturnValue	protected	function	Sets the return value for a certain method on a test plugin.
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.
ServerTaskTest::$datasource	protected	property	The content entity datasource.
ServerTaskTest::$index	protected	property	The test index.
ServerTaskTest::$modules	public static	property	Modules to enable for this test. Overrides KernelTestBase::$modules
ServerTaskTest::$server	protected	property	The test server.
ServerTaskTest::$serverTaskManager	protected	property	The server task manager to use for the tests.
ServerTaskTest::$taskManager	protected	property	The task manager to use for the tests.
ServerTaskTest::addTasks	protected	function	Adds one task of each type for this test's server.
ServerTaskTest::getServerTasks	protected	function	Retrieves the tasks set on the test server.
ServerTaskTest::setUp	public	function	Overrides KernelTestBase::setUp
ServerTaskTest::testAddIndex	public	function	Tests task system integration for the server's addIndex() method.
ServerTaskTest::testAutomaticTaskRemoval	public	function	Tests the correct automatic removal of tasks upon certain operations.
ServerTaskTest::testDeleteAllIndexItems	public	function	Tests task system integration for the deleteAllIndexItems() method.
ServerTaskTest::testDeleteItems	public	function	Tests task system integration for the server's deleteItems() method.
ServerTaskTest::testRemoveIndex	public	function	Tests task system integration for the server's removeIndex() method.
ServerTaskTest::testTaskCountLimit	public	function	Verifies that no more than 100 items will be executed at once.
ServerTaskTest::testUpdateIndex	public	function	Tests task system integration for the server's updateIndex() method.
StorageCopyTrait::replaceStorageContents	protected static	function	Copy the configuration from one storage to another and remove stale items.
TestRequirementsTrait::checkModuleRequirements	private	function	Checks missing module requirements.
TestRequirementsTrait::checkRequirements	protected	function	Check module requirements for the Drupal use case.	1
TestRequirementsTrait::getDrupalRoot	protected static	function	Returns the Drupal root directory.

You are here

class ServerTaskTest in Search API 8

Hierarchy

File

Namespace

Members

API Navigation