You are here

Home » API reference » Search API 8 » TaskTest.php

class TaskTest in Search API 8

Tests whether the Search API task system works correctly.

@group search_api

Hierarchy

Expanded class hierarchy of TaskTest

See also

\Drupal\search_api_test_tasks\TestTaskWorker

File

tests/src/Kernel/System/TaskTest.php, line 20

Namespace

Drupal\Tests\search_api\Kernel\System
View source 
class TaskTest extends KernelTestBase {

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

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

  /**
   * {@inheritdoc}
   */
  public static $modules = [
    'user',
    'search_api',
    'search_api_test',
    'search_api_test_tasks',
  ];

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

  /**
   * The test task worker service.
   *
   * @var \Drupal\search_api_test_tasks\TestTaskWorker
   */
  protected $taskWorker;

  /**
   * {@inheritdoc}
   */
  public function setUp() {
    parent::setUp();
    $this
      ->installEntitySchema('search_api_task');
    $this->taskManager = $this->container
      ->get('search_api.task_manager');
    $this->taskWorker = $this->container
      ->get('search_api_test_tasks.test_task_worker');

    // 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' => 0,
      'datasource_settings' => [
        'entity:user' => [],
      ],
      'tracker_settings' => [
        'default' => [],
      ],
    ]);
    $this->index
      ->save();
  }

  /**
   * Tests successful task execution.
   */
  public function testTaskSuccess() {
    $task = $this
      ->addTask('success');
    $this
      ->assertEquals(1, $this->taskManager
      ->getTasksCount());
    $this->taskManager
      ->executeSingleTask();
    $this
      ->assertEquals(0, $this->taskManager
      ->getTasksCount());
    $this
      ->assertEquals($task
      ->toArray(), $this->taskWorker
      ->getEventLog()[0]);
  }

  /**
   * Tests failed task execution.
   */
  public function testTaskFail() {
    $task = $this
      ->addTask('fail', $this->server);
    $this
      ->assertEquals(1, $this->taskManager
      ->getTasksCount());
    try {
      $this->taskManager
        ->executeAllTasks([
        'server_id' => $this->server
          ->id(),
      ]);
      $this
        ->fail('Exception expected');
    } catch (SearchApiException $e) {
      $this
        ->assertEquals('fail', $e
        ->getMessage());
    }
    $this
      ->assertEquals(1, $this->taskManager
      ->getTasksCount());
    $this
      ->assertEquals($task
      ->toArray(), $this->taskWorker
      ->getEventLog()[0]);
  }

  /**
   * Tests ignored task execution.
   */
  public function testTaskIgnored() {
    $task = $this
      ->addTask('ignore', NULL, $this->index, 'foobar');
    $type = $task
      ->getType();
    $this
      ->assertEquals(1, $this->taskManager
      ->getTasksCount());
    try {
      $this->taskManager
        ->executeAllTasks([
        'type' => [
          $type,
          'unknown',
        ],
        'index_id' => $this->index
          ->id(),
      ]);
      $this
        ->fail('Exception expected');
    } catch (SearchApiException $e) {
      $id = $task
        ->id();
      $this
        ->assertEquals("Could not execute task #{$id} of type '{$type}'. Type seems to be unknown.", $e
        ->getMessage());
    }
    $this
      ->assertEquals(1, $this->taskManager
      ->getTasksCount());
    $this
      ->assertEquals($task
      ->toArray(), $this->taskWorker
      ->getEventLog()[0]);
  }

  /**
   * Tests unknown task execution.
   */
  public function testTaskUnknown() {
    $task = $this
      ->addTask('unknown');
    $this
      ->assertEquals(1, $this->taskManager
      ->getTasksCount());
    try {
      $this->taskManager
        ->executeAllTasks();
      $this
        ->fail('Exception expected');
    } catch (SearchApiException $e) {
      $id = $task
        ->id();
      $type = $task
        ->getType();
      $this
        ->assertEquals("Could not execute task #{$id} of type '{$type}'. Type seems to be unknown.", $e
        ->getMessage());
    }
    $this
      ->assertEquals(1, $this->taskManager
      ->getTasksCount());
    $this
      ->assertEquals([], $this->taskWorker
      ->getEventLog());
  }

  /**
   * Tests that duplicate tasks won't be created.
   */
  public function testTaskDuplicates() {

    // @todo Use named parameters here once we depend on PHP 8.0+.
    $data = [
      'foo' => 'bar',
      1,
    ];
    $task1 = $this
      ->addTask('success');
    $task2 = $this
      ->addTask('success', NULL, NULL, NULL, TRUE);
    $this
      ->assertEquals($task1
      ->id(), $task2
      ->id());
    $task1 = $this
      ->addTask('success', NULL, NULL, $data);
    $task2 = $this
      ->addTask('success', NULL, NULL, $data, TRUE);
    $this
      ->assertEquals($task1
      ->id(), $task2
      ->id());
    $task1 = $this
      ->addTask('success', $this->server);
    $task2 = $this
      ->addTask('success', $this->server, NULL, NULL, TRUE);
    $this
      ->assertEquals($task1
      ->id(), $task2
      ->id());
    $task1 = $this
      ->addTask('success', $this->server, NULL, $data);
    $task2 = $this
      ->addTask('success', $this->server, NULL, $data, TRUE);
    $this
      ->assertEquals($task1
      ->id(), $task2
      ->id());
    $task1 = $this
      ->addTask('success', NULL, $this->index);
    $task2 = $this
      ->addTask('success', NULL, $this->index, NULL, TRUE);
    $this
      ->assertEquals($task1
      ->id(), $task2
      ->id());
    $task1 = $this
      ->addTask('success', NULL, $this->index, $data);
    $task2 = $this
      ->addTask('success', NULL, $this->index, $data, TRUE);
    $this
      ->assertEquals($task1
      ->id(), $task2
      ->id());
    $task1 = $this
      ->addTask('success', $this->server, $this->index);
    $task2 = $this
      ->addTask('success', $this->server, $this->index, NULL, TRUE);
    $this
      ->assertEquals($task1
      ->id(), $task2
      ->id());
    $task1 = $this
      ->addTask('success', $this->server, $this->index, $data);
    $task2 = $this
      ->addTask('success', $this->server, $this->index, $data, TRUE);
    $this
      ->assertEquals($task1
      ->id(), $task2
      ->id());
    $data[] = 2;
    $task1 = $this
      ->addTask('success', NULL, NULL, $data);
    $task2 = $this
      ->addTask('success', NULL, NULL, $data, TRUE);
    $this
      ->assertEquals($task1
      ->id(), $task2
      ->id());
  }

  /**
   * Tests that multiple pending tasks are treated correctly.
   */
  public function testMultipleTasks() {

    // Add some tasks to the system. We use explicit indexes since we want to
    // verify that the tasks are executed in a different order than the one they
    // were added, if appropriate $conditions parameters are given.
    $tasks = [];
    $tasks[0] = $this
      ->addTask('success', $this->server, $this->index, [
      'foo' => 1,
      'bar',
    ]);
    $tasks[6] = $this
      ->addTask('fail');
    $tasks[1] = $this
      ->addTask('success', $this->server, NULL, TRUE);
    $tasks[4] = $this
      ->addTask('success', NULL, NULL, 1);
    $tasks[2] = $this
      ->addTask('fail', $this->server, $this->index);
    $tasks[5] = $this
      ->addTask('success');
    $tasks[3] = $this
      ->addTask('success', NULL, $this->index);
    $num = count($tasks);
    $this
      ->assertEquals($num, $this->taskManager
      ->getTasksCount());
    $this->taskManager
      ->executeSingleTask();
    $this
      ->assertEquals(--$num, $this->taskManager
      ->getTasksCount());
    $this->taskManager
      ->executeSingleTask([
      'server_id' => $this->server
        ->id(),
    ]);
    $this
      ->assertEquals(--$num, $this->taskManager
      ->getTasksCount());
    try {
      $this->taskManager
        ->executeAllTasks([
        'server_id' => $this->server
          ->id(),
      ]);
      $this
        ->fail('Exception expected');
    } catch (SearchApiException $e) {
      $this
        ->assertEquals('fail', $e
        ->getMessage());
    }
    $this
      ->assertEquals($num, $this->taskManager
      ->getTasksCount());
    $tasks[2]
      ->delete();
    $this
      ->assertEquals(--$num, $this->taskManager
      ->getTasksCount());
    $this->taskManager
      ->executeSingleTask([
      'index_id' => $this->index
        ->id(),
    ]);
    $this
      ->assertEquals(--$num, $this->taskManager
      ->getTasksCount());
    $this->taskManager
      ->executeAllTasks([
      'type' => [
        'search_api_test_tasks.success',
        'foobar',
      ],
    ]);
    $this
      ->assertEquals($num -= 2, $this->taskManager
      ->getTasksCount());

    // Need to include some data so the new task won't count as a duplicate.
    $tasks[7] = $this
      ->addTask('success', NULL, NULL, 1);
    $tasks[8] = $this
      ->addTask('success', NULL, NULL, 2);
    $tasks[9] = $this
      ->addTask('fail', NULL, NULL, 3);
    $tasks[10] = $this
      ->addTask('success', NULL, NULL, 4);
    $num += 4;
    try {
      $this->taskManager
        ->executeAllTasks();
      $this
        ->fail('Exception expected');
    } catch (SearchApiException $e) {
      $this
        ->assertEquals('fail', $e
        ->getMessage());
    }
    $this
      ->assertEquals($num, $this->taskManager
      ->getTasksCount());
    $tasks[6]
      ->delete();
    $this
      ->assertEquals(--$num, $this->taskManager
      ->getTasksCount());
    try {
      $this->taskManager
        ->executeAllTasks();
      $this
        ->fail('Exception expected');
    } catch (SearchApiException $e) {
      $this
        ->assertEquals('fail', $e
        ->getMessage());
    }
    $this
      ->assertEquals($num -= 2, $this->taskManager
      ->getTasksCount());
    $tasks[9]
      ->delete();
    $this
      ->assertEquals(--$num, $this->taskManager
      ->getTasksCount());
    $this->taskManager
      ->executeAllTasks();
    $this
      ->assertEquals(0, $this->taskManager
      ->getTasksCount());
    $to_array = function (TaskInterface $task) {
      return $task
        ->toArray();
    };
    $tasks = array_map($to_array, $tasks);
    $this
      ->assertEquals($tasks, $this->taskWorker
      ->getEventLog());
  }

  /**
   * Adds a new pending task.
   *
   * @param string $type
   *   The type of task, without "search_api_test_tasks." prefix.
   * @param \Drupal\search_api\ServerInterface|null $server
   *   (optional) The search server associated with the task, if any.
   * @param \Drupal\search_api\IndexInterface|null $index
   *   (optional) The search index associated with the task, if any.
   * @param mixed|null $data
   *   (optional) Additional, type-specific data to save with the task.
   * @param bool $duplicate
   *   (optional) TRUE if the task is expected to be a duplicate and not
   *   created.
   *
   * @return \Drupal\search_api\Task\TaskInterface
   *   The task returned by the task manager.
   */
  protected function addTask($type, ServerInterface $server = NULL, IndexInterface $index = NULL, $data = NULL, bool $duplicate = FALSE) {
    $type = "search_api_test_tasks.{$type}";
    $count_before = $this->taskManager
      ->getTasksCount();
    $conditions = [
      'type' => $type,
      'server_id' => $server ? $server
        ->id() : NULL,
      'index_id' => $index ? $index
        ->id() : NULL,
    ];
    $conditions = array_filter($conditions);
    $count_before_conditions = $this->taskManager
      ->getTasksCount($conditions);
    $task = $this->taskManager
      ->addTask($type, $server, $index, $data);
    $delta = $duplicate ? 0 : 1;
    $count_after = $this->taskManager
      ->getTasksCount();
    $this
      ->assertEquals($count_before + $delta, $count_after);
    $count_after_conditions = $this->taskManager
      ->getTasksCount($conditions);
    $this
      ->assertEquals($count_before_conditions + $delta, $count_after_conditions);
    return $task;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
AssertContentTrait::$content protected property The current raw content.
AssertContentTrait::$drupalSettings protected property The drupalSettings value from the current raw $content.
AssertContentTrait::$elements protected property The XML structure parsed from the current raw $content. 1
AssertContentTrait::$plainTextContent protected property The plain-text content of raw $content (text nodes).
AssertContentTrait::assertEscaped protected function Passes if the raw text IS found escaped on the loaded page, fail otherwise.
AssertContentTrait::assertField protected function Asserts that a field exists with the given name or ID.
AssertContentTrait::assertFieldById protected function Asserts that a field exists with the given ID and value.
AssertContentTrait::assertFieldByName protected function Asserts that a field exists with the given name and value.
AssertContentTrait::assertFieldByXPath protected function Asserts that a field exists in the current page by the given XPath.
AssertContentTrait::assertFieldChecked protected function Asserts that a checkbox field in the current page is checked.
AssertContentTrait::assertFieldsByValue protected function Asserts that a field exists in the current page with a given Xpath result.
AssertContentTrait::assertLink protected function Passes if a link with the specified label is found.
AssertContentTrait::assertLinkByHref protected function Passes if a link containing a given href (part) is found.
AssertContentTrait::assertNoDuplicateIds protected function Asserts that each HTML ID is used for just a single element.
AssertContentTrait::assertNoEscaped protected function Passes if the raw text IS NOT found escaped on the loaded page, fail otherwise.
AssertContentTrait::assertNoField protected function Asserts that a field does not exist with the given name or ID.
AssertContentTrait::assertNoFieldById protected function Asserts that a field does not exist with the given ID and value.
AssertContentTrait::assertNoFieldByName protected function Asserts that a field does not exist with the given name and value.
AssertContentTrait::assertNoFieldByXPath protected function Asserts that a field does not exist or its value does not match, by XPath.
AssertContentTrait::assertNoFieldChecked protected function Asserts that a checkbox field in the current page is not checked.
AssertContentTrait::assertNoLink protected function Passes if a link with the specified label is not found.
AssertContentTrait::assertNoLinkByHref protected function Passes if a link containing a given href (part) is not found.
AssertContentTrait::assertNoLinkByHrefInMainRegion protected function Passes if a link containing a given href is not found in the main region.
AssertContentTrait::assertNoOption protected function Asserts that a select option in the current page does not exist.
AssertContentTrait::assertNoOptionSelected protected function Asserts that a select option in the current page is not checked.
AssertContentTrait::assertNoPattern protected function Triggers a pass if the perl regex pattern is not found in raw content.
AssertContentTrait::assertNoRaw protected function Passes if the raw text is NOT found on the loaded page, fail otherwise.
AssertContentTrait::assertNoText protected function Passes if the page (with HTML stripped) does not contains the text.
AssertContentTrait::assertNoTitle protected function Pass if the page title is not the given string.
AssertContentTrait::assertNoUniqueText protected function Passes if the text is found MORE THAN ONCE on the text version of the page.
AssertContentTrait::assertOption protected function Asserts that a select option in the current page exists.
AssertContentTrait::assertOptionByText protected function Asserts that a select option with the visible text exists.
AssertContentTrait::assertOptionSelected protected function Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionSelectedWithDrupalSelector protected function Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionWithDrupalSelector protected function Asserts that a select option in the current page exists.
AssertContentTrait::assertPattern protected function Triggers a pass if the Perl regex pattern is found in the raw content.
AssertContentTrait::assertRaw protected function Passes if the raw text IS found on the loaded page, fail otherwise.
AssertContentTrait::assertText protected function Passes if the page (with HTML stripped) contains the text.
AssertContentTrait::assertTextHelper protected function Helper for assertText and assertNoText.
AssertContentTrait::assertTextPattern protected function Asserts that a Perl regex pattern is found in the plain-text content.
AssertContentTrait::assertThemeOutput protected function Asserts themed output.
AssertContentTrait::assertTitle protected function Pass if the page title is the given string.
AssertContentTrait::assertUniqueText protected function Passes if the text is found ONLY ONCE on the text version of the page.
AssertContentTrait::assertUniqueTextHelper protected function Helper for assertUniqueText and assertNoUniqueText.
AssertContentTrait::buildXPathQuery protected function Builds an XPath query.
AssertContentTrait::constructFieldXpath protected function Helper: Constructs an XPath for the given set of attributes and value.
AssertContentTrait::cssSelect protected function Searches elements using a CSS selector in the raw content.
AssertContentTrait::getAllOptions protected function Get all option elements, including nested options, in a select.
AssertContentTrait::getDrupalSettings protected function Gets the value of drupalSettings for the currently-loaded page.
AssertContentTrait::getRawContent protected function Gets the current raw content.
AssertContentTrait::getSelectedItem protected function Get the selected value from a select field.
AssertContentTrait::getTextContent protected function Retrieves the plain-text content from the current raw content.
AssertContentTrait::getUrl protected function Get the current URL from the cURL handler. 1
AssertContentTrait::parse protected function Parse content returned from curlExec using DOM and SimpleXML.
AssertContentTrait::removeWhiteSpace protected function Removes all white-space between HTML tags from the raw content.
AssertContentTrait::setDrupalSettings protected function Sets the value of drupalSettings for the currently-loaded page.
AssertContentTrait::setRawContent protected function Sets the raw content (e.g. HTML).
AssertContentTrait::xpath protected function Performs an xpath search on the contents of the internal browser.
AssertHelperTrait::castSafeStrings protected static function Casts MarkupInterface objects into strings.
AssertLegacyTrait::assert protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead.
AssertLegacyTrait::assertEqual protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead.
AssertLegacyTrait::assertIdentical protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertSame() instead.
AssertLegacyTrait::assertIdenticalObject protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead.
AssertLegacyTrait::assertNotEqual protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotEquals() instead.
AssertLegacyTrait::assertNotIdentical protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotSame() instead.
AssertLegacyTrait::pass protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead.
AssertLegacyTrait::verbose protected function
ConfigTestTrait::configImporter protected function Returns a ConfigImporter object to import test configuration.
ConfigTestTrait::copyConfig protected function Copies configuration objects from source storage to target storage.
KernelTestBase::$backupGlobals protected property Back up and restore any global variables that may be changed by tests.
KernelTestBase::$backupStaticAttributes protected property Back up and restore static class properties that may be changed by tests.
KernelTestBase::$backupStaticAttributesBlacklist protected property Contains a few static class properties for performance.
KernelTestBase::$classLoader protected property
KernelTestBase::$configImporter protected property @todo Move into Config test base class. 7
KernelTestBase::$configSchemaCheckerExclusions protected static property An array of config object names that are excluded from schema checking.
KernelTestBase::$container protected property
KernelTestBase::$databasePrefix protected property
KernelTestBase::$preserveGlobalState protected property Do not forward any global state from the parent process to the processes that run the actual tests.
KernelTestBase::$root protected property The app root.
KernelTestBase::$runTestInSeparateProcess protected property Kernel tests are run in separate processes because they allow autoloading of code from extensions. Running the test in a separate process isolates this behavior from other tests. Subclasses should not override this property.
KernelTestBase::$siteDirectory protected property
KernelTestBase::$strictConfigSchema protected property Set to TRUE to strict check all configuration saved. 6
KernelTestBase::$vfsRoot protected property The virtual filesystem root directory.
KernelTestBase::assertPostConditions protected function 1
KernelTestBase::bootEnvironment protected function Bootstraps a basic test environment.
KernelTestBase::bootKernel private function Bootstraps a kernel for a test.
KernelTestBase::config protected function Configuration accessor for tests. Returns non-overridden configuration.
KernelTestBase::disableModules protected function Disables modules for this test.
KernelTestBase::enableModules protected function Enables modules for this test.
KernelTestBase::getConfigSchemaExclusions protected function Gets the config schema exclusions for this test.
KernelTestBase::getDatabaseConnectionInfo protected function Returns the Database connection info to be used for this test. 1
KernelTestBase::getDatabasePrefix public function
KernelTestBase::getExtensionsForModules private function Returns Extension objects for $modules to enable.
KernelTestBase::getModulesToEnable private static function Returns the modules to enable for this test.
KernelTestBase::initFileCache protected function Initializes the FileCache component.
KernelTestBase::installConfig protected function Installs default configuration for a given list of modules.
KernelTestBase::installEntitySchema protected function Installs the storage schema for a specific entity type.
KernelTestBase::installSchema protected function Installs database tables from a module schema definition.
KernelTestBase::isTestInIsolation Deprecated protected function Returns whether the current test method is running in a separate process.
KernelTestBase::prepareTemplate protected function
KernelTestBase::register public function Registers test-specific services. Overrides ServiceProviderInterface::register 26
KernelTestBase::render protected function Renders a render array. 1
KernelTestBase::setInstallProfile protected function Sets the install profile and rebuilds the container to update it.
KernelTestBase::setSetting protected function Sets an in-memory Settings variable.
KernelTestBase::setUpBeforeClass public static function 1
KernelTestBase::setUpFilesystem protected function Sets up the filesystem, so things like the file directory. 2
KernelTestBase::stop protected function Stops test execution.
KernelTestBase::tearDown protected function 6
KernelTestBase::tearDownCloseDatabaseConnection public function @after
KernelTestBase::vfsDump protected function Dumps the current state of the virtual filesystem to STDOUT.
KernelTestBase::__get Deprecated public function BC: Automatically resolve former KernelTestBase class properties.
KernelTestBase::__sleep public function Prevents serializing any properties.
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.
TaskTest::$index protected property The test index.
TaskTest::$modules public static property Modules to enable. Overrides KernelTestBase::$modules
TaskTest::$server protected property The test server.
TaskTest::$taskManager protected property The task manager to use for the tests.
TaskTest::$taskWorker protected property The test task worker service.
TaskTest::addTask protected function Adds a new pending task.
TaskTest::setUp public function Overrides KernelTestBase::setUp
TaskTest::testMultipleTasks public function Tests that multiple pending tasks are treated correctly.
TaskTest::testTaskDuplicates public function Tests that duplicate tasks won't be created.
TaskTest::testTaskFail public function Tests failed task execution.
TaskTest::testTaskIgnored public function Tests ignored task execution.
TaskTest::testTaskSuccess public function Tests successful task execution.
TaskTest::testTaskUnknown public function Tests unknown task execution.
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.