class DatabaseBackendTest in Advanced Queue 8

@coversDefaultClass \Drupal\advancedqueue\Plugin\AdvancedQueue\Backend\Database @group advancedqueue

Hierarchy

class \Drupal\KernelTests\KernelTestBase extends \PHPUnit\Framework\TestCase implements ServiceProviderInterface uses AssertContentTrait, AssertLegacyTrait, AssertHelperTrait, ConfigTestTrait, PhpunitCompatibilityTrait, RandomGeneratorTrait, TestRequirementsTrait
- class \Drupal\Tests\advancedqueue\Kernel\DatabaseBackendTest

Expanded class hierarchy of DatabaseBackendTest

File

tests/src/Kernel/DatabaseBackendTest.php, line 14

Namespace

Drupal\Tests\advancedqueue\Kernel

View source

class DatabaseBackendTest extends KernelTestBase {

  /**
   * The first tested queue.
   *
   * @var \Drupal\advancedqueue\Entity\QueueInterface
   */
  protected $firstQueue;

  /**
   * The second tested queue.
   *
   * @var \Drupal\advancedqueue\Entity\QueueInterface
   */
  protected $secondQueue;

  /**
   * Modules to enable.
   *
   * @var array
   */
  public static $modules = [
    'advancedqueue',
  ];

  /**
   * {@inheritdoc}
   */
  protected function setUp() {
    parent::setUp();
    $this
      ->installSchema('advancedqueue', [
      'advancedqueue',
    ]);

    // Override the current time to control job timestamps.
    $mock_time = $this
      ->prophesize(TimeInterface::class);
    $mock_time
      ->getCurrentTime()
      ->willReturn(635814000);
    $this->container
      ->set('datetime.time', $mock_time
      ->reveal());
    $this->firstQueue = Queue::create([
      'id' => 'first_queue',
      'label' => 'First queue',
      'backend' => 'database',
      'backend_configuration' => [
        'lease_time' => 5,
      ],
    ]);
    $this->firstQueue
      ->save();
    $this->secondQueue = Queue::create([
      'id' => 'second_queue',
      'label' => 'Second queue',
      'backend' => 'database',
      'backend_configuration' => [
        'lease_time' => 5,
      ],
    ]);
    $this->secondQueue
      ->save();
  }

  /**
   * @covers ::deleteQueue
   * @covers ::countJobs
   * @covers ::enqueueJob
   * @covers ::enqueueJobs
   * @covers ::claimJob
   * @covers ::onSuccess
   * @covers ::onFailure
   * @covers ::deleteJob
   */
  public function testQueue() {
    $first_job = Job::create('simple', [
      'test' => '1',
    ]);
    $second_job = Job::create('simple', [
      'test' => '2',
    ]);
    $third_job = Job::create('simple', [
      'test' => '3',
    ]);
    $fourth_job = Job::create('simple', [
      'test' => '4',
    ]);
    $this->firstQueue
      ->getBackend()
      ->enqueueJobs([
      $first_job,
      $third_job,
    ]);

    // Confirm that the other needed fields have been populated.
    $this
      ->assertQueuedJob(1, 'first_queue', 0, $first_job);
    $this
      ->assertQueuedJob(2, 'first_queue', 0, $third_job);

    // Confirm that the queue now contains two jobs.
    $counts = $this->firstQueue
      ->getBackend()
      ->countJobs();
    $this
      ->assertEquals([
      Job::STATE_QUEUED => 2,
    ], array_filter($counts));

    // Update the jobs to match how they'll look when claimed.
    $first_job
      ->setState(Job::STATE_PROCESSING);
    $first_job
      ->setExpiresTime(635814000 + 5);
    $third_job
      ->setExpiresTime(635814000 + 5);
    $third_job
      ->setState(Job::STATE_PROCESSING);

    // Confirm that the jobs are returned in the correct order (FIFO).
    $first_claimed_job = $this->firstQueue
      ->getBackend()
      ->claimJob();
    $this
      ->assertEquals($first_job, $first_claimed_job);
    $third_claimed_job = $this->firstQueue
      ->getBackend()
      ->claimJob();
    $this
      ->assertEquals($third_job, $third_claimed_job);
    $this
      ->assertNull($this->firstQueue
      ->getBackend()
      ->claimJob());
    $this->firstQueue
      ->getBackend()
      ->enqueueJobs([
      $first_job,
      $third_job,
    ]);
    $this->secondQueue
      ->getBackend()
      ->enqueueJob($second_job);
    $this->secondQueue
      ->getBackend()
      ->enqueueJob($fourth_job);

    // Confirm that the other needed fields have been populated.
    $this
      ->assertQueuedJob(5, 'second_queue', 0, $second_job);
    $this
      ->assertQueuedJob(6, 'second_queue', 0, $fourth_job);

    // Update the jobs to match how they'll look when claimed.
    $second_job
      ->setState(Job::STATE_PROCESSING);
    $second_job
      ->setExpiresTime(635814000 + 5);
    $fourth_job
      ->setExpiresTime(635814000 + 5);
    $fourth_job
      ->setState(Job::STATE_PROCESSING);

    // Confirm that deleting the job works.
    $this->secondQueue
      ->getBackend()
      ->deleteJob($second_job
      ->getId());
    $fourth_claimed_job = $this->secondQueue
      ->getBackend()
      ->claimJob();
    $this
      ->assertEquals($fourth_job, $fourth_claimed_job);

    // Confirm fail -> retry -> success.
    $fourth_job
      ->setState(Job::STATE_FAILURE);
    $this->secondQueue
      ->getBackend()
      ->onFailure($fourth_job);
    $this
      ->assertEquals(635814000, $fourth_job
      ->getProcessedTime());
    $this
      ->assertEmpty($fourth_job
      ->getExpiresTime());
    $this->secondQueue
      ->getBackend()
      ->retryJob($fourth_job, 9);
    $this
      ->assertEquals(Job::STATE_QUEUED, $fourth_job
      ->getState());
    $this
      ->assertEquals(1, $fourth_job
      ->getNumRetries());
    $this
      ->assertEquals(635814000 + 9, $fourth_job
      ->getAvailableTime());
    $this
      ->assertEmpty($fourth_job
      ->getExpiresTime());
    $this
      ->rewindTime(635814010);
    $fourth_job
      ->setState(Job::STATE_PROCESSING);
    $fourth_job
      ->setExpiresTime(635814010 + 5);
    $fourth_claimed_job = $this->secondQueue
      ->getBackend()
      ->claimJob();
    $this
      ->assertEquals($fourth_job, $fourth_claimed_job);
    $fourth_job
      ->setState(Job::STATE_SUCCESS);
    $this->secondQueue
      ->getBackend()
      ->onSuccess($fourth_job);
    $this
      ->assertEquals(635814010, $fourth_job
      ->getProcessedTime());
    $this
      ->assertEmpty($fourth_job
      ->getExpiresTime());

    // Confirm updated counts.
    $this->secondQueue
      ->getBackend()
      ->enqueueJob($first_job);
    $this->secondQueue
      ->getBackend()
      ->enqueueJob($second_job);
    $counts = $this->secondQueue
      ->getBackend()
      ->countJobs();
    $this
      ->assertEquals([
      Job::STATE_QUEUED => 2,
      Job::STATE_PROCESSING => 0,
      Job::STATE_SUCCESS => 1,
      Job::STATE_FAILURE => 0,
    ], $counts);

    // Confirm that deleting the queue removes the jobs.
    $this->firstQueue
      ->getBackend()
      ->deleteQueue();
    $this
      ->assertNull($this->firstQueue
      ->getBackend()
      ->claimJob());
  }

  /**
   * @covers ::enqueueJob
   * @covers ::claimJob
   */
  public function testFutureQueue() {
    $first_job = Job::create('simple', [
      'test' => '1',
    ]);
    $second_job = Job::create('simple', [
      'test' => '2',
    ]);
    $this->firstQueue
      ->getBackend()
      ->enqueueJob($first_job, 5);
    $this->firstQueue
      ->getBackend()
      ->enqueueJob($second_job);
    $this
      ->assertQueuedJob(1, 'first_queue', 5, $first_job);
    $this
      ->assertQueuedJob(2, 'first_queue', 0, $second_job);

    // Update the job to match how it will look when claimed.
    $second_job
      ->setState(Job::STATE_PROCESSING);
    $second_job
      ->setExpiresTime(635814000 + 5);

    // Confirm that the first job isn't available because of the delay.
    $second_claimed_job = $this->firstQueue
      ->getBackend()
      ->claimJob();
    $this
      ->assertEquals($second_job, $second_claimed_job);
    $this
      ->assertNull($this->firstQueue
      ->getBackend()
      ->claimJob());

    // Confirm that rewinding time makes the first job available.
    $this
      ->rewindTime(635814010);
    $first_job
      ->setState(Job::STATE_PROCESSING);
    $first_job
      ->setExpiresTime(635814010 + 5);
    $first_claimed_job = $this->firstQueue
      ->getBackend()
      ->claimJob();
    $this
      ->assertEquals($first_job, $first_claimed_job);
  }

  /**
   * @covers ::cleanupQueue
   */
  public function testQueueCleanup() {
    $job = Job::create('simple', [
      'test' => '1',
    ]);
    $this->firstQueue
      ->getBackend()
      ->enqueueJob($job);

    // Update the job to match how it will look when claimed.
    $job
      ->setState(Job::STATE_PROCESSING);
    $job
      ->setExpiresTime(635814000 + 5);
    $claimed_job = $this->firstQueue
      ->getBackend()
      ->claimJob();
    $this
      ->assertEquals($job, $claimed_job);
    $this
      ->rewindTime(635814000 + 6);
    $this
      ->assertNull($this->firstQueue
      ->getBackend()
      ->claimJob());

    // Running cleanup should expire the lease, making it possible to claim
    // the job for processing again.
    $this->firstQueue
      ->getBackend()
      ->cleanupQueue();
    $job
      ->setExpiresTime(635814000 + 6 + 5);
    $claimed_job = $this->firstQueue
      ->getBackend()
      ->claimJob();
    $this
      ->assertEquals($job, $claimed_job);
  }

  /**
   * Changes the current time.
   *
   * @param int $new_time
   *   The new time.
   */
  protected function rewindTime($new_time) {
    $mock_time = $this
      ->prophesize(TimeInterface::class);
    $mock_time
      ->getCurrentTime()
      ->willReturn($new_time);
    $this->container
      ->set('datetime.time', $mock_time
      ->reveal());

    // Reload the queues so that their backends get the updated service.
    $storage = $this->container
      ->get('entity_type.manager')
      ->getStorage('advancedqueue_queue');
    $storage
      ->resetCache([
      'first_queue',
      'second_queue',
    ]);
    $this->firstQueue = $storage
      ->load('first_queue');
    $this->secondQueue = $storage
      ->load('second_queue');
  }

  /**
   * Asserts that the queued job has the correct data.
   *
   * @param string $expected_id
   *   The expected job ID.
   * @param string $expected_queue_id
   *   The expected queue ID.
   * @param int $expected_delay
   *   The expected delay.
   * @param \Drupal\advancedqueue\Job $job
   *   The job.
   */
  protected function assertQueuedJob($expected_id, $expected_queue_id, $expected_delay, Job $job) {
    $this
      ->assertEquals($expected_id, $job
      ->getId());
    $this
      ->assertEquals($expected_queue_id, $job
      ->getQueueId());
    $this
      ->assertEquals(Job::STATE_QUEUED, $job
      ->getState());
    $this
      ->assertEquals(635814000 + $expected_delay, $job
      ->getAvailableTime());
  }

}

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.
DatabaseBackendTest::$firstQueue	protected	property	The first tested queue.
DatabaseBackendTest::$modules	public static	property	Modules to enable. Overrides KernelTestBase::$modules
DatabaseBackendTest::$secondQueue	protected	property	The second tested queue.
DatabaseBackendTest::assertQueuedJob	protected	function	Asserts that the queued job has the correct data.
DatabaseBackendTest::rewindTime	protected	function	Changes the current time.
DatabaseBackendTest::setUp	protected	function	Overrides KernelTestBase::setUp
DatabaseBackendTest::testFutureQueue	public	function	@covers ::enqueueJob @covers ::claimJob
DatabaseBackendTest::testQueue	public	function	@covers ::deleteQueue @covers ::countJobs @covers ::enqueueJob @covers ::enqueueJobs @covers ::claimJob @covers ::onSuccess @covers ::onFailure @covers ::deleteJob
DatabaseBackendTest::testQueueCleanup	public	function	@covers ::cleanupQueue
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.
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 DatabaseBackendTest in Advanced Queue 8

Hierarchy

File

Namespace

Members

API Navigation