public function CronQueueTest::testExceptions in Drupal 9

Same name and namespace in other branches

1. 8 core/modules/system/tests/src/Kernel/System/CronQueueTest.php \Drupal\Tests\system\Kernel\System\CronQueueTest::testExceptions()

Tests that exceptions thrown by workers are handled properly.

File

core/modules/system/tests/src/Kernel/System/CronQueueTest.php, line 126

Class

CronQueueTest

Tests the Cron Queue runner.

Namespace

Drupal\Tests\system\Kernel\System

Code

public function testExceptions() {

  // Get the queue to test the normal Exception.
  $queue = $this->container
    ->get('queue')
    ->get('cron_queue_test_exception');

  // Enqueue an item for processing.
  $queue
    ->createItem([
    $this
      ->randomMachineName() => $this
      ->randomMachineName(),
  ]);

  // Run cron; the worker for this queue should throw an exception and handle
  // it.
  $this->cron
    ->run();
  $this
    ->assertEquals(1, \Drupal::state()
    ->get('cron_queue_test_exception'));

  // The item should be left in the queue.
  $this
    ->assertEquals(1, $queue
    ->numberOfItems(), 'Failing item still in the queue after throwing an exception.');

  // Expire the queue item manually. system_cron() relies in REQUEST_TIME to
  // find queue items whose expire field needs to be reset to 0. This is a
  // Kernel test, so REQUEST_TIME won't change when cron runs.
  // @see system_cron()
  // @see \Drupal\Core\Cron::processQueues()
  $this->connection
    ->update('queue')
    ->condition('name', 'cron_queue_test_exception')
    ->fields([
    'expire' => REQUEST_TIME - 1,
  ])
    ->execute();
  $this->cron
    ->run();
  $this
    ->assertEquals(2, \Drupal::state()
    ->get('cron_queue_test_exception'));
  $this
    ->assertEquals(0, $queue
    ->numberOfItems(), 'Item was processed and removed from the queue.');

  // Get the queue to test the specific SuspendQueueException.
  $queue = $this->container
    ->get('queue')
    ->get('cron_queue_test_broken_queue');

  // Enqueue several item for processing.
  $queue
    ->createItem('process');
  $queue
    ->createItem('crash');
  $queue
    ->createItem('ignored');

  // Run cron; the worker for this queue should process as far as the crashing
  // item.
  $this->cron
    ->run();

  // Only one item should have been processed.
  $this
    ->assertEquals(2, $queue
    ->numberOfItems(), 'Failing queue stopped processing at the failing item.');

  // Check the items remaining in the queue. The item that throws the
  // exception gets released by cron, so we can claim it again to check it.
  $item = $queue
    ->claimItem();
  $this
    ->assertEquals('crash', $item->data, 'Failing item remains in the queue.');
  $item = $queue
    ->claimItem();
  $this
    ->assertEquals('ignored', $item->data, 'Item beyond the failing item remains in the queue.');

  // Test the requeueing functionality.
  $queue = $this->container
    ->get('queue')
    ->get('cron_queue_test_requeue_exception');
  $queue
    ->createItem([]);
  $this->cron
    ->run();
  $this
    ->assertEquals(2, \Drupal::state()
    ->get('cron_queue_test_requeue_exception'));
  $this
    ->assertEquals(0, $queue
    ->numberOfItems());
}