class BlockContentRevisionsTest in Drupal 10

Create a block with revisions.

@group block_content

Hierarchy

• class \Drupal\Tests\BrowserTestBase extends \PHPUnit\Framework\TestCase uses \Drupal\Tests\PhpUnitCompatibilityTrait, \Symfony\Bridge\PhpUnit\ExpectDeprecationTrait, FunctionalTestSetupTrait, TestSetupTrait, BlockCreationTrait, ConfigTestTrait, ExtensionListTestTrait, ContentTypeCreationTrait, NodeCreationTrait, RandomGeneratorTrait, TestRequirementsTrait, PhpUnitWarnings, UiHelperTrait, UserCreationTrait, XdebugRequestTrait
  • class \Drupal\Tests\block_content\Functional\BlockContentTestBase
    • class \Drupal\Tests\block_content\Functional\BlockContentRevisionsTest

File

core/modules/block_content/tests/src/Functional/BlockContentRevisionsTest.php, line 14

Namespace

Drupal\Tests\block_content\Functional

class BlockContentRevisionsTest extends BlockContentTestBase {

  /**
   * {@inheritdoc}
   */
  protected $defaultTheme = 'stark';

  /**
   * Stores blocks created during the test.
   * @var array
   */
  protected $blocks;

  /**
   * Stores log messages used during the test.
   * @var array
   */
  protected $revisionLogs;

  /**
   * Sets the test up.
   */
  protected function setUp() : void {
    parent::setUp();

    // Create initial block.
    $block = $this
      ->createBlockContent('initial');
    $blocks = [];
    $logs = [];

    // Get original block.
    $blocks[] = $block
      ->getRevisionId();
    $logs[] = '';

    // Create three revisions.
    $revision_count = 3;
    for ($i = 0; $i < $revision_count; $i++) {
      $block
        ->setNewRevision(TRUE);
      $block
        ->setRevisionLogMessage($this
        ->randomMachineName(32));
      $block
        ->setRevisionUser($this->adminUser);
      $block
        ->setRevisionCreationTime(REQUEST_TIME);
      $logs[] = $block
        ->getRevisionLogMessage();
      $block
        ->save();
      $blocks[] = $block
        ->getRevisionId();
    }
    $this->blocks = $blocks;
    $this->revisionLogs = $logs;
  }

  /**
   * Checks block revision related operations.
   */
  public function testRevisions() {
    $blocks = $this->blocks;
    $logs = $this->revisionLogs;
    foreach ($blocks as $delta => $revision_id) {

      // Confirm the correct revision text appears.

      /** @var \Drupal\block_content\BlockContentInterface  $loaded */
      $loaded = $this->container
        ->get('entity_type.manager')
        ->getStorage('block_content')
        ->loadRevision($revision_id);

      // Verify revision log is the same.
      $this
        ->assertEquals($logs[$delta], $loaded
        ->getRevisionLogMessage(), new FormattableMarkup('Correct log message found for revision @revision', [
        '@revision' => $loaded
          ->getRevisionId(),
      ]));
      if ($delta > 0) {
        $this
          ->assertInstanceOf(UserInterface::class, $loaded
          ->getRevisionUser());
        $this
          ->assertIsNumeric($loaded
          ->getRevisionUserId());
        $this
          ->assertIsNumeric($loaded
          ->getRevisionCreationTime());
      }
    }

    // Confirm that this is the default revision.
    $this
      ->assertTrue($loaded
      ->isDefaultRevision(), 'Third block revision is the default one.');

    // Make a new revision and set it to not be default.
    // This will create a new revision that is not "front facing".
    // Save this as a non-default revision.
    $loaded
      ->setNewRevision();
    $loaded
      ->isDefaultRevision(FALSE);
    $loaded->body = $this
      ->randomMachineName(8);
    $loaded
      ->save();

    // Confirm that revision body text is not present on default version of
    // block.
    $this
      ->drupalGet('block/' . $loaded
      ->id());
    $this
      ->assertSession()
      ->pageTextNotContains($loaded->body->value);

    // Verify that the non-default revision id is greater than the default
    // revision id.
    $default_revision = BlockContent::load($loaded
      ->id());

    // Verify that the revision ID is greater than the default revision ID.
    $this
      ->assertGreaterThan($default_revision
      ->getRevisionId(), $loaded
      ->getRevisionId());
  }

}