FileQueueTest.php in Purge 8.3

Namespace

Drupal\Tests\purge\Kernel\Queue

File

tests/src/Kernel/Queue/FileQueueTest.php

<?php

namespace Drupal\Tests\purge\Kernel\Queue;

use Drupal\Core\DestructableInterface;
use Drupal\Core\StreamWrapper\PublicStream;

/**
 * Tests \Drupal\purge\Plugin\Purge\Queue\FileQueue.
 *
 * @group purge
 */
class FileQueueTest extends PluginTestBase {

  /**
   * {@inheritdoc}
   */
  protected $pluginId = 'file';

  /**
   * The file under public:// to which the queue buffer gets written to.
   *
   * @var string
   *
   * @see \Drupal\purge\Plugin\Purge\Queue\File::$file
   */
  protected $file = 'purge-file.queue';

  /**
   * Set up the test.
   */
  public function setUp($switch_to_memory_queue = TRUE) : void {
    parent::setUp($switch_to_memory_queue);
    $this->file = DRUPAL_ROOT . '/' . PublicStream::basePath() . '/' . $this->file;
  }

  /**
   * Tests if the buffer gets written to disk properly.
   *
   * @see \Drupal\purge\Plugin\Purge\Queue\File::bufferInitialize
   * @see \Drupal\purge\Plugin\Purge\Queue\File::bufferCommit
   * @see \Drupal\purge\Plugin\Purge\Queue\File::deleteQueue
   * @see \Drupal\purge\Plugin\Purge\Queue\File::destruct
   */
  public function testBufferReadingAndWriting() : void {
    $this
      ->assertTrue($this->queue instanceof DestructableInterface);
    $this
      ->assertFalse(file_exists($this->file));

    // Two assertions within this test, check the raw payload written to
    // disk by the file queue. However, because of its dependence on time(),
    // this test is exposed to the hosts performance. This anonymous function
    // creates a range of payloads to make this test more resilient.
    $payloads = function ($base, $time) {
      return [
        $base . ($time - 2) . "\n",
        $base . ($time - 1) . "\n",
        $base . $time . "\n",
        $base . ($time + 1) . "\n",
        $base . ($time + 2) . "\n",
      ];
    };

    // Create one item without claiming it, and test the written output.
    $this->queue
      ->createItem('s1');
    $this
      ->assertFalse(file_exists($this->file));
    $this->queue
      ->destruct();
    $this
      ->assertTrue(file_exists($this->file));
    $this
      ->assertTrue(in_array(file_get_contents($this->file), $payloads('1|s:2:"s1";|0|', time())));

    // Delete the queue and assure the file is gone.
    $this->queue
      ->deleteQueue();
    $this
      ->assertFalse(file_exists($this->file));

    // Create one item and claim it, test the output written to disk.
    $this->queue
      ->createItem('s2');
    $i = $this->queue
      ->claimItem();
    $this->queue
      ->destruct();
    $this
      ->assertTrue(file_exists($this->file));
    $this
      ->assertTrue(in_array(file_get_contents($this->file), $payloads('1|s:2:"s2";|' . $i->expire . '|', $i->created)));

    // Delete the queue file, write our own file to disk and reload the queue.
    $this->queue
      ->deleteQueue();
    $this->queue = NULL;
    file_put_contents($this->file, '1|s:6:"qwerty";|0|12345' . "\n");
    $this
      ->assertTrue(file_exists($this->file));
    $this
      ->setUpQueuePlugin();
    $claim = $this->queue
      ->claimItem(1);
    $this
      ->assertTrue(is_object($claim));
    $this
      ->assertEquals(1, $claim->item_id);
    $this
      ->assertEquals('qwerty', $claim->data);
    $this
      ->assertEquals(12345, $claim->created);
    $this->queue
      ->deleteQueue();
  }

}

Classes

Name	Description
FileQueueTest	Tests \Drupal\purge\Plugin\Purge\Queue\FileQueue.