function WorkspaceCRUDTest::testDeletingWorkspaces

Same name and namespace in other branches
  1. 9 core/modules/workspaces/tests/src/Kernel/WorkspaceCRUDTest.php \Drupal\Tests\workspaces\Kernel\WorkspaceCRUDTest::testDeletingWorkspaces()
  2. 8.9.x core/modules/workspaces/tests/src/Kernel/WorkspaceCRUDTest.php \Drupal\Tests\workspaces\Kernel\WorkspaceCRUDTest::testDeletingWorkspaces()
  3. 11.x core/modules/workspaces/tests/src/Kernel/WorkspaceCRUDTest.php \Drupal\Tests\workspaces\Kernel\WorkspaceCRUDTest::testDeletingWorkspaces()

Tests the deletion of workspaces.

File

core/modules/workspaces/tests/src/Kernel/WorkspaceCRUDTest.php, line 86

Class

WorkspaceCRUDTest
Tests CRUD operations for workspaces.

Namespace

Drupal\Tests\workspaces\Kernel

Code

public function testDeletingWorkspaces() : void {
  $admin = $this->createUser([
    'administer nodes',
    'create workspace',
    'view any workspace',
    'edit any workspace',
    'delete any workspace',
  ]);
  $this->setCurrentUser($admin);
  /** @var \Drupal\workspaces\WorkspaceAssociationInterface $workspace_association */
  $workspace_association = \Drupal::service('workspaces.association');
  // Create a workspace with a very small number of associated node revisions.
  $workspace_1 = Workspace::create([
    'id' => 'gibbon',
    'label' => 'Gibbon',
  ]);
  $workspace_1->save();
  $this->workspaceManager
    ->setActiveWorkspace($workspace_1);
  $workspace_1_node_1 = $this->createNode([
    'status' => FALSE,
  ]);
  $workspace_1_node_2 = $this->createNode([
    'status' => FALSE,
  ]);
  // Check that the workspace tracks the initial revisions for both nodes.
  $initial_revisions = $workspace_association->getAssociatedInitialRevisions($workspace_1->id(), 'node');
  $this->assertCount(2, $initial_revisions);
  for ($i = 0; $i < 4; $i++) {
    $workspace_1_node_1->setNewRevision(TRUE);
    $workspace_1_node_1->save();
    $workspace_1_node_2->setNewRevision(TRUE);
    $workspace_1_node_2->save();
  }
  // The workspace should now track 2 nodes.
  $tracked_entities = $workspace_association->getTrackedEntities($workspace_1->id());
  $this->assertCount(2, $tracked_entities['node']);
  // Since all the revisions were created inside a workspace, including the
  // default one, 'workspace_1' should be tracking all 10 revisions.
  $associated_revisions = $workspace_association->getAssociatedRevisions($workspace_1->id(), 'node');
  $this->assertCount(10, $associated_revisions);
  // Check that we are allowed to delete the workspace.
  $this->assertTrue($workspace_1->access('delete', $admin));
  // Delete the workspace and check that all the workspace_association
  // entities and all the node revisions have been deleted as well.
  $workspace_1->delete();
  // There are no more tracked entities in 'workspace_1'.
  $tracked_entities = $workspace_association->getTrackedEntities($workspace_1->id());
  $this->assertEmpty($tracked_entities);
  // There are no more revisions associated with 'workspace_1'.
  $associated_revisions = $workspace_association->getAssociatedRevisions($workspace_1->id(), 'node');
  $this->assertCount(0, $associated_revisions);
  // Create another workspace, this time with a larger number of associated
  // node revisions so we can test the batch purge process.
  $workspace_2 = Workspace::create([
    'id' => 'baboon',
    'label' => 'Baboon',
  ]);
  $workspace_2->save();
  $this->workspaceManager
    ->setActiveWorkspace($workspace_2);
  $workspace_2_node_1 = $this->createNode([
    'status' => FALSE,
  ]);
  for ($i = 0; $i < 59; $i++) {
    $workspace_2_node_1->setNewRevision(TRUE);
    $workspace_2_node_1->save();
  }
  // Now there is one entity tracked in 'workspace_2'.
  $tracked_entities = $workspace_association->getTrackedEntities($workspace_2->id());
  $this->assertCount(1, $tracked_entities['node']);
  // All 60 are associated with 'workspace_2'.
  $associated_revisions = $workspace_association->getAssociatedRevisions($workspace_2->id(), 'node', [
    $workspace_2_node_1->id(),
  ]);
  $this->assertCount(60, $associated_revisions);
  // Delete the workspace and check that we still have 10 revision left to
  // delete.
  $workspace_2->delete();
  $associated_revisions = $workspace_association->getAssociatedRevisions($workspace_2->id(), 'node', [
    $workspace_2_node_1->id(),
  ]);
  $this->assertCount(10, $associated_revisions);
  $workspace_deleted = \Drupal::state()->get('workspace.deleted');
  $this->assertCount(1, $workspace_deleted);
  // Check that we can not create another workspace with the same ID while its
  // data purging is not finished.
  $workspace_3 = Workspace::create([
    'id' => 'baboon',
    'label' => 'Baboon',
  ]);
  $violations = $workspace_3->validate();
  $this->assertCount(1, $violations);
  $this->assertEquals('A workspace with this ID has been deleted but data still exists for it.', $violations[0]->getMessage());
  // Running cron should delete the remaining data as well as the workspace ID
  // from the "workspace.delete" state entry.
  \Drupal::service('cron')->run();
  // Check that the actual node revisions were deleted as well.
  $node_storage = $this->entityTypeManager
    ->getStorage('node');
  $this->assertEmpty($node_storage->loadMultipleRevisions(array_keys($associated_revisions)));
  // 'workspace_2 'is empty now.
  $associated_revisions = $workspace_association->getAssociatedRevisions($workspace_2->id(), 'node', [
    $workspace_2_node_1->id(),
  ]);
  $this->assertCount(0, $associated_revisions);
  $tracked_entities = $workspace_association->getTrackedEntities($workspace_2->id());
  $this->assertCount(0, $tracked_entities);
  $workspace_deleted = \Drupal::state()->get('workspace.deleted');
  $this->assertCount(0, $workspace_deleted);
  // Check that the deleted workspace is no longer active.
  $this->assertFalse($this->workspaceManager
    ->hasActiveWorkspace());
}

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.