public function ModerationStateBlockTest::testCustomBlockModeration in Workbench Moderation 8.2

Tests moderating custom blocks.

Blocks and any non-node-type-entities do not have a concept of "published". As such, we must use the "default revision" to know what is going to be "published", i.e. visible to the user.

The one exception is a block that has never been "published". When a block is first created, it becomes the "default revision". For each edit of the block after that, Workbench Moderation checks the "default revision" to see if it is set to a published moderation state. If it is not, the entity being saved will become the "default revision".

The test below is intended, in part, to make this behavior clear.

See also

\Drupal\workbench_moderation\EntityOperations::entityPresave

\Drupal\workbench_moderation\Tests\ModerationFormTest::testModerationForm

File

src/Tests/ModerationStateBlockTest.php, line 51

Class

ModerationStateBlockTest

Tests general content moderation workflow for blocks.

Namespace

Drupal\workbench_moderation\Tests

Code

public function testCustomBlockModeration() {
  $this
    ->drupalLogin($this->rootUser);

  // Enable moderation for custom blocks at admin/structure/block/block-content/manage/basic/moderation.
  $edit = [
    'enable_moderation_state' => TRUE,
    'allowed_moderation_states_unpublished[draft]' => TRUE,
    'allowed_moderation_states_published[published]' => TRUE,
    'default_moderation_state' => 'draft',
  ];
  $this
    ->drupalPostForm('admin/structure/block/block-content/manage/basic/moderation', $edit, t('Save'));
  $this
    ->assertText(t('Your settings have been saved.'));

  // Create a custom block at block/add and save it as draft.
  $body = 'Body of moderated block';
  $edit = [
    'info[0][value]' => 'Moderated block',
    'body[0][value]' => $body,
  ];
  $this
    ->drupalPostForm('block/add', $edit, t('Save and Create New Draft'));
  $this
    ->assertText(t('basic Moderated block has been created.'));

  // Place the block in the Sidebar First region.
  $instance = array(
    'id' => 'moderated_block',
    'settings[label]' => $edit['info[0][value]'],
    'region' => 'sidebar_first',
  );
  $block = BlockContent::load(1);
  $url = 'admin/structure/block/add/block_content:' . $block
    ->uuid() . '/' . $this
    ->config('system.theme')
    ->get('default');
  $this
    ->drupalPostForm($url, $instance, t('Save block'));

  // Navigate to home page and check that the block is visible. It should be
  // visible because it is the default revision.
  $this
    ->drupalGet('');
  $this
    ->assertText($body);

  // Update the block.
  $updated_body = 'This is the new body value';
  $edit = [
    'body[0][value]' => $updated_body,
  ];
  $this
    ->drupalPostForm('block/' . $block
    ->id(), $edit, t('Save and Create New Draft'));
  $this
    ->assertText(t('basic Moderated block has been updated.'));

  // Navigate to the home page and check that the block shows the updated
  // content. It should show the updated content because the block's default
  // revision is not a published moderation state.
  $this
    ->drupalGet('');
  $this
    ->assertText($updated_body);

  // Publish the block so we can create a forward revision.
  $this
    ->drupalPostForm('block/' . $block
    ->id(), [], t('Save and Publish'));

  // Create a forward revision.
  $forward_revision_body = 'This is the forward revision body value';
  $edit = [
    'body[0][value]' => $forward_revision_body,
  ];
  $this
    ->drupalPostForm('block/' . $block
    ->id(), $edit, t('Save and Create New Draft'));
  $this
    ->assertText(t('basic Moderated block has been updated.'));

  // Navigate to home page and check that the forward revision doesn't show,
  // since it should not be set as the default revision.
  $this
    ->drupalGet('');
  $this
    ->assertText($updated_body);

  // Open the latest tab and publish the new draft.
  $edit = [
    'new_state' => 'published',
  ];
  $this
    ->drupalPostForm('block/' . $block
    ->id() . '/latest', $edit, t('Apply'));
  $this
    ->assertText(t('The moderation state has been updated.'));

  // Navigate to home page and check that the forward revision is now the
  // default revision and therefore visible.
  $this
    ->drupalGet('');
  $this
    ->assertText($forward_revision_body);
}