class CronQueueTest in Drupal 10

Same name and namespace in other branches

8 core/modules/system/tests/src/Kernel/System/CronQueueTest.php \Drupal\Tests\system\Kernel\System\CronQueueTest
9 core/modules/system/tests/src/Kernel/System/CronQueueTest.php \Drupal\Tests\system\Kernel\System\CronQueueTest

Tests the Cron Queue runner.

@group system

Hierarchy

class \Drupal\KernelTests\KernelTestBase extends \PHPUnit\Framework\TestCase implements ServiceProviderInterface uses \Drupal\Tests\PhpUnitCompatibilityTrait, \Symfony\Bridge\PhpUnit\ExpectDeprecationTrait, AssertContentTrait, ConfigTestTrait, ExtensionListTestTrait, RandomGeneratorTrait, TestRequirementsTrait, PhpUnitWarnings
- class \Drupal\Tests\system\Kernel\System\CronQueueTest

Expanded class hierarchy of CronQueueTest

File

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

Namespace

Drupal\Tests\system\Kernel\System

View source

class CronQueueTest extends KernelTestBase {

  /**
   * The modules to enable.
   *
   * @var array
   */
  protected static $modules = [
    'system',
    'cron_queue_test',
  ];

  /**
   * The database connection.
   *
   * @var \Drupal\Core\Database\Connection
   */
  protected $connection;

  /**
   * The cron service.
   *
   * @var \Drupal\Core\Cron
   */
  protected $cron;

  /**
   * The fake current time used for queue worker / cron testing purposes.
   *
   * This value should be greater than or equal to zero.
   *
   * @var int
   */
  protected $currentTime = 1000;

  /**
   * {@inheritdoc}
   */
  protected function setUp() : void {
    parent::setUp();
    $this->connection = Database::getConnection();
    $this->cron = \Drupal::service('cron');
    $time = $this
      ->prophesize('Drupal\\Component\\Datetime\\TimeInterface');
    $time
      ->getCurrentTime()
      ->willReturn($this->currentTime);
    $time
      ->getRequestTime()
      ->willReturn($this->currentTime);
    \Drupal::getContainer()
      ->set('datetime.time', $time
      ->reveal());
    $this
      ->assertEquals($this->currentTime, \Drupal::time()
      ->getCurrentTime());
    $this
      ->assertEquals($this->currentTime, \Drupal::time()
      ->getRequestTime());
    $realQueueFactory = $this->container
      ->get('queue');
    $queue_factory = $this
      ->prophesize(get_class($realQueueFactory));
    $database = new DatabaseQueue('cron_queue_test_database_delay_exception', $this->connection);
    $memory = new Memory('cron_queue_test_memory_delay_exception');
    $queue_factory
      ->get('cron_queue_test_database_delay_exception', Argument::cetera())
      ->willReturn($database);
    $queue_factory
      ->get('cron_queue_test_memory_delay_exception', Argument::cetera())
      ->willReturn($memory);
    $queue_factory
      ->get(Argument::any(), Argument::cetera())
      ->will(function ($args) use ($realQueueFactory) {
      return $realQueueFactory
        ->get($args[0], $args[1] ?? FALSE);
    });
    $this->container
      ->set('queue', $queue_factory
      ->reveal());
  }

  /**
   * Tests that DelayedRequeueException behaves as expected when running cron.
   */
  public function testDelayException() {
    $database = $this->container
      ->get('queue')
      ->get('cron_queue_test_database_delay_exception');
    $memory = $this->container
      ->get('queue')
      ->get('cron_queue_test_memory_delay_exception');

    // Ensure that the queues are of the correct type for this test.
    $this
      ->assertInstanceOf('Drupal\\Core\\Queue\\DelayableQueueInterface', $database);
    $this
      ->assertNotInstanceOf('Drupal\\Core\\Queue\\DelayableQueueInterface', $memory);

    // Get the queue worker plugin manager.
    $manager = $this->container
      ->get('plugin.manager.queue_worker');
    $definitions = $manager
      ->getDefinitions();
    $this
      ->assertNotEmpty($database_lease_time = $definitions['cron_queue_test_database_delay_exception']['cron']['time']);
    $this
      ->assertNotEmpty($memory_lease_time = $definitions['cron_queue_test_memory_delay_exception']['cron']['time']);

    // Create the necessary test data and run cron.
    $database
      ->createItem('test');
    $memory
      ->createItem('test');
    $this->cron
      ->run();

    // Fetch the expiry time for the database queue.
    $query = $this->connection
      ->select('queue');
    $query
      ->condition('name', 'cron_queue_test_database_delay_exception');
    $query
      ->addField('queue', 'expire');
    $query
      ->range(0, 1);
    $expire = $query
      ->execute()
      ->fetchField();

    // Assert that the delay interval is greater than the lease interval. This
    // allows us to assume that (if updated) the new expiry time will be greater
    // than the initial expiry time. We can then also assume that the new expiry
    // time offset will be identical to the delay interval.
    $this
      ->assertGreaterThan($database_lease_time, CronQueueTestDatabaseDelayException::DELAY_INTERVAL);
    $this
      ->assertGreaterThan($this->currentTime + $database_lease_time, $expire);
    $this
      ->assertEquals(CronQueueTestDatabaseDelayException::DELAY_INTERVAL, $expire - $this->currentTime);

    // Ensure that the memory queue expiry time is unchanged after the
    // DelayedRequeueException has been thrown.
    $property = (new \ReflectionClass($memory))
      ->getProperty('queue');
    $property
      ->setAccessible(TRUE);
    $memory_queue_internal = $property
      ->getValue($memory);
    $this
      ->assertEquals($this->currentTime + $memory_lease_time, reset($memory_queue_internal)->expire);
  }

  /**
   * Tests that leases are expiring correctly, also within the same request.
   */
  public function testLeaseTime() {
    $queue = $this->container
      ->get('queue')
      ->get('cron_queue_test_lease_time');
    $queue
      ->createItem([
      $this
        ->randomMachineName() => $this
        ->randomMachineName(),
    ]);

    // Run initial queue job and ensure lease time variable is initialized.
    $this->cron
      ->run();
    static::assertEquals(1, \Drupal::state()
      ->get('cron_queue_test_lease_time'));

    // Ensure the same queue job is not picked up due to the extended lease.
    $this->cron
      ->run();
    static::assertEquals(1, \Drupal::state()
      ->get('cron_queue_test_lease_time'));

    // Set the expiration time to 3 seconds ago, so the lease should
    // automatically expire.
    \Drupal::database()
      ->update(DatabaseQueue::TABLE_NAME)
      ->fields([
      'expire' => $this->currentTime - 3,
    ])
      ->execute();

    // The queue job should now be picked back up since it's lease has expired,
    // and the state variable should be consequently incremented.
    $this->cron
      ->run();
    static::assertEquals(2, \Drupal::state()
      ->get('cron_queue_test_lease_time'));

    // Ensure the same queue job is not picked up again due to the extended
    // lease.
    $this->cron
      ->run();
    static::assertEquals(2, \Drupal::state()
      ->get('cron_queue_test_lease_time'));
  }

  /**
   * Tests that exceptions thrown by workers are handled properly.
   */
  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' => \Drupal::time()
        ->getRequestTime() - 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());
  }

  /**
   * Tests that database queue implementation complies with interfaces specs.
   */
  public function testDatabaseQueueReturnTypes() : void {

    /** @var \Drupal\Core\Queue\DatabaseQueue $queue */
    $queue = $this->container
      ->get('queue')
      ->get('cron_queue_test_database_delay_exception');
    static::assertInstanceOf(DatabaseQueue::class, $queue);
    $queue
      ->createItem(12);
    $item = $queue
      ->claimItem();
    static::assertTrue($queue
      ->delayItem($item, 1));
    static::assertTrue($queue
      ->releaseItem($item));
    $queue
      ->deleteItem($item);
    static::assertFalse($queue
      ->delayItem($item, 1));
    static::assertFalse($queue
      ->releaseItem($item));
  }

  /**
   * Test safeguard against invalid annotations in QueueWorkerManager.
   */
  public function testQueueWorkerManagerSafeguard() : void {
    $queue_worker_manager = $this->container
      ->get('plugin.manager.queue_worker');
    $plugin_id = 'test_plugin_id';

    // Ensure if no cron annotation is provided, none is added.
    $definition = [];
    $queue_worker_manager
      ->processDefinition($definition, $plugin_id);
    $this
      ->assertArrayNotHasKey('cron', $definition);

    // Ensure if an empty cron annotation is provided, the default lease time is
    // added.
    $definition = [
      'cron' => [],
    ];
    $queue_worker_manager
      ->processDefinition($definition, $plugin_id);
    $this
      ->assertArrayHasKey('time', $definition['cron']);
    $this
      ->assertEquals(QueueWorkerManagerInterface::DEFAULT_QUEUE_CRON_TIME, $definition['cron']['time']);

    // Ensure if an invalid lease time (less-than 1 second) is provided, it is
    // overridden with the default lease time.
    $definition = [
      'cron' => [
        'time' => 0,
      ],
    ];
    $queue_worker_manager
      ->processDefinition($definition, $plugin_id);
    $this
      ->assertEquals(QueueWorkerManagerInterface::DEFAULT_QUEUE_CRON_TIME, $definition['cron']['time']);
    $definition = [
      'cron' => [
        'time' => -1,
      ],
    ];
    $queue_worker_manager
      ->processDefinition($definition, $plugin_id);
    $this
      ->assertEquals(QueueWorkerManagerInterface::DEFAULT_QUEUE_CRON_TIME, $definition['cron']['time']);
  }

}

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::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.
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.
CronQueueTest::$connection	protected	property	The database connection.
CronQueueTest::$cron	protected	property	The cron service.
CronQueueTest::$currentTime	protected	property	The fake current time used for queue worker / cron testing purposes.
CronQueueTest::$modules	protected static	property	The modules to enable. Overrides KernelTestBase::$modules
CronQueueTest::setUp	protected	function	Overrides KernelTestBase::setUp
CronQueueTest::testDatabaseQueueReturnTypes	public	function	Tests that database queue implementation complies with interfaces specs.
CronQueueTest::testDelayException	public	function	Tests that DelayedRequeueException behaves as expected when running cron.
CronQueueTest::testExceptions	public	function	Tests that exceptions thrown by workers are handled properly.
CronQueueTest::testLeaseTime	public	function	Tests that leases are expiring correctly, also within the same request.
CronQueueTest::testQueueWorkerManagerSafeguard	public	function	Test safeguard against invalid annotations in QueueWorkerManager.
ExtensionListTestTrait::getModulePath	protected	function	Gets the path for the specified module.
ExtensionListTestTrait::getThemePath	protected	function	Gets the path for the specified theme.
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.	3
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.	4
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.	2
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::prepareTemplate	protected	function
KernelTestBase::register	public	function	Registers test-specific services. Overrides ServiceProviderInterface::register	14
KernelTestBase::render	protected	function	Renders a render array.
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
KernelTestBase::setUpFilesystem	protected	function	Sets up the filesystem, so things like the file directory.	1
KernelTestBase::stop	protected	function	Stops test execution.
KernelTestBase::tearDown	protected	function		3
KernelTestBase::tearDownCloseDatabaseConnection	public	function	@after
KernelTestBase::vfsDump	protected	function	Dumps the current state of the virtual filesystem to STDOUT.
KernelTestBase::__sleep	public	function	Prevents serializing any properties.
PhpUnitWarnings::$deprecationWarnings	private static	property	Deprecation warnings from PHPUnit to raise with @trigger_error().
PhpUnitWarnings::addWarning	public	function	Converts PHPUnit deprecation warnings to E_USER_DEPRECATED.
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.
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.
TestRequirementsTrait::checkModuleRequirements	private	function	Checks missing module requirements.
TestRequirementsTrait::checkRequirements	protected	function	Check module requirements for the Drupal use case.
TestRequirementsTrait::getDrupalRoot	protected static	function	Returns the Drupal root directory.

You are here

class CronQueueTest in Drupal 10

Hierarchy

File

Namespace

Members

API Navigation